实体命名规范

Sailing

背景

目前框架下, 修改实体算是重量级的工作, 一方面需要动代码, 无法热修改; 另一方面影响深远, 所有涉及的元数据, 易客报表都有可能需要调整.
因此需要在项目上避免调整实体命名. 因此制定这份命名规范, 统一语义, 减少项目上的实体调整.

通用

• 用字段的本质语义来命名, 对该字段的操作方式的区别不要体现在命名中. 例如合同中的累计出运金额, 可能是反写的, 也可以是填写的. 字段命名中不考虑这一点.
• 对于多种单据重用的实体, 重用的字段需保持本质语义一致. 例如: 国外销售合同和国内销售合同中, 明细表的商品总价字段, 国外销售合同表示成交价格, 原则上按这个金额向客人收取货款, 那么在国内销售合同中这个字段就用来表示含税金额, 表示向客人收取的货款金额.
• 组合字段的层级关系用后缀修饰, 下划线_连接.
• 语义修饰用前缀, (组合之前的)后缀, 或中间, 不加连接符.

供应链管理域

规则

• 金额/数量类
  
  • 表示价格的字段, 叫XX单价. 例如: 销售单价, 销售不含税单价.
  • 表示金额的字段, 叫XX金额. 例如: 采购金额, 费用金额.
  • 涉及外币的, 表示原币的不加后缀, 视情况直接采用金额类型或者金额-币别组合类型. 例如: 销售合同费用表的, 费用金额_币别, 费用金额_金额.
  • 金额字段明确确定币别的, 增加折XXX后缀, 例如: 销售金额折CNY.
  • 单价, 金额不特别说明, 表示含税, 需表示不含税时, 增加不含税中间修饰. 例如, 采购不含税单价.
  • 主表中从各种明细合计而来的字段, 加上合计前缀. 例如: 销售合同主表中的合计金额.
  • 本单据以外的金额合计, 加上累计前缀. 例如: 外销合同里的累计出运金额.
• 组织/人员类
  
  • 所有记录组织单元的字段, 用组织后缀