【开发规范】
admin
2024-01-21 03:10:23

统一命名风格

  1. 包名统一使用小写,包名统一使用单数形式,但是类名如果有复数含义,类名可以使用复数形式。例如:controller/service
  2. 类名统一使用 UpperCamelCase 风格,必须遵从驼峰形式。例如:NotifyPersonService
  3. 方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格,必须遵从驼峰形式。例如: localValue / getHttpMessage() / inputUserId
  4. 常量命名全部大写,单词间用下划线隔开。例如: MAX_STOCK_COUNT
  5. 接口类中的方法和属性不要加任何修饰符号(public 也不要加)。例如:String getUserById(String userId)
  6. 对于Service,实现类用 Impl 的后缀与接口区别,接口实现类需单独设置一个impl包。例如:CacheServiceImpl 实现 CacheService 接口。
  7. 如果是形容能力的接口名称,取对应的形容词做接口名(通常是–able 的形式)。例如:AbstractTranslator 实现 Translatable。

Service/DAO 层方法命名规约(crud)

  •  获取单个对象的方法用 get 做前缀。
  •  获取多个对象的方法用 list 做前缀。
  •  获取统计值的方法用 count 做前缀。
  •  插入的方法用 insert 做前缀。
  •  删除的方法用 delete 做前缀。
  •  修改的方法用 update 做前缀。
  • 如果有条件使用 By + 条件

领域模型命名规约

        以下领域模型统一新建pojo包,放在pojo包中

  • 实体对象:xxxPO,xxx 即为数据表名。
  • 数据传输对象:xxxDTO,xxx 为业务领域相关的名称。
  • 展示对象:xxxVO,xxx 一般为网页名称。

相关内容

热门资讯

文博场馆优化提升 “双奥园区”... 观众在中国考古博物馆参观 朝阳区持续探索奥运场馆赛后可持续运营路径,推动各场馆提质增效。北京青年报记...
怎么挑选适配不同场景的儿童游乐... 随着亲子消费业态的发展以及城市公共服务配套的不断完善,各类游乐设施的市场需求持续增长,不同场景、不同...
发布会深一度|金色吉林,已备好... (来源:中国吉林网) 转自:中国吉林网 图片来源 图虫创意 金风送爽,吉林大地迎来了层林尽染的最美...