HTTP 与 Web 标准 / 系统课时
决定哪些字段使用属性
决定哪些字段使用属性
订单层级确定后,还需要决定具体字段写成元素还是属性。本节以订单编号、状态、名称和金额为例,建立一套可实际应用的判断方法,并完成一份兼顾可读性与扩展性的订单 XML。
学习目标
- 根据字段的语义判断应使用属性还是子元素
- 理解标识、状态与业务内容在 XML 表达上的差异
- 设计一份结构清晰且便于扩展的订单 XML
属性更适合描述元素本身
属性通常适合短小、单值、用于标识或描述当前元素状态的数据。例如订单编号用于唯一标识一张订单,订单状态描述当前订单所处阶段,把它们写成 order 的属性会比较紧凑。
<order id="ORD-1001" status="paid">
</order>这段内容是结构示例。验证时只需确认 id 与 status 位于开始标签内部,并且属性值使用引号包围。
相比之下,客户姓名、商品名称和金额属于实际业务内容,通常更适合作为元素。元素能够自然包含文本,还可以在需求增长时继续增加子元素或其他结构。
用语义而不是长度做判断
不能简单地认为“短字段都用属性,长字段都用元素”。更可靠的判断依据是字段在数据模型中的职责。
| 字段 | 推荐表示 | 主要原因 |
|---|---|---|
| 订单编号 | 属性 | 用于标识当前订单 |
| 订单状态 | 属性 | 描述当前订单的状态 |
| 商品编号 | 属性 | 用于标识当前商品明细引用的商品 |
| 客户姓名 | 元素 | 属于客户业务内容 |
| 商品名称 | 元素 | 属于商品业务内容 |
| 数量 | 元素 | 属于订单明细数据 |
| 单价、总额 | 元素 | 属于需要读取和处理的业务数值 |
金额尤其不应因为写法短就全部变成属性。金额可能进一步需要币种、折扣、税费等信息,用元素表示更容易扩展,也更符合“业务数据作为内容”的阅读习惯。
完成订单 XML
综合这些规则,可以把标识和状态放入属性,同时保留主要业务数据为元素:
<?xml version="1.0" encoding="UTF-8"?>
<order id="ORD-1001" status="paid">
<customer>
<name>Chen Ming</name>
<email>chen@example.com</email>
</customer>
<items>
<item productId="P-101">
<name>Mechanical Keyboard</name>
<quantity>1</quantity>
<unitPrice>399.00</unitPrice>
</item>
<item productId="P-205">
<name>USB-C Cable</name>
<quantity>2</quantity>
<unitPrice>39.00</unitPrice>
</item>
</items>
<amounts>
<subtotal>477.00</subtotal>
<shipping>12.00</shipping>
<total>489.00</total>
</amounts>
</order>这是完整的数据结构示例,不需要程序运行即可检查。验证时首先确认整个文档只有一个根元素,其次确认属性只出现在对应元素的开始标签中,最后检查客户、商品和金额等业务内容仍保持清晰的元素层级。
避免两个常见极端
第一种极端是把所有内容都写成属性。例如把姓名、数量、价格甚至地址全部塞进一个开始标签,会使标签迅速变长,而且复杂内容无法自然形成层级。
第二种极端是完全不用属性。这样虽然语法没有问题,但订单编号、商品编号和状态等简短描述信息会占用更多层级,使真正的业务内容不够突出。
实际设计时可以采用一个简单原则:用于标识或描述当前元素的简短元数据优先考虑属性,需要作为业务内容读取、扩展或形成结构的数据优先使用元素。 只要同一份文档持续遵守这套规则,结构通常就能保持一致且容易理解。