Skip to content
发布于 更新于

1. 编程方法论 ​

  • 不能确定的就定义为一个接口
  • 面向接口编码
  • DO / PO / DTO / BO / VO / UID

1.1. 命令参考 ​

1.1.1. Service / DAO 层方法命名规约: ​

  • 1)获取单个对象的方法用 get 做前缀。
  • 2)获取多个对象的方法用 list 做前缀,复数结尾,如:listObjects
  • 3)获取统计值的方法用 count 做前缀。
  • 4)插入的方法用 save / insert 做前缀。
  • 5)删除的方法用 remove / delete 做前缀。
  • 6)修改的方法用 update 做前缀。

1.1.2. 领域模型命名规约: ​

  • 1)数据对象:xxxDO,xxx 即为数据表名。
  • 2)数据传输对象:xxxDTO,xxx 为业务领域相关的名称。
  • 3)展示对象:xxxVO,xxx 一般为网页名称。
  • 4)POJO 是 DO / DTO / BO / VO 的统称,禁止命名成 xxxPOJO。

1.2. 落地建议 ​

  • 先划清领域边界,再设计接口和数据对象,避免一个类承担过多职责。
  • DTO、VO、DO 不要混用,否则后续接口演进和数据库变更都会很痛苦。
  • 命名规约的意义不在“形式统一”,而在于降低团队协作时的理解成本。

基于 VitePress + GitHub Actions 自动部署