【开发规范】
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 一般为网页名称。

相关内容

热门资讯

山水皆有情!丽江两山一江的千年... 去过丽江、走过虎跳峡的人,大概率都听过哈巴雪山和金沙江的传说。很多人站在峡谷之下,望着奔腾不息的金沙...
活力中国调研行丨“殷”你而来 ... 9月12日,游客在殷墟博物馆“甲骨文展厅”内参观。位于河南省安阳市的殷墟博物馆新馆是首个全景式展现商...
浦江之夜赴美好相逢,第37届上... 9月12日晚,黄浦江畔灯火璀璨,第37届上海旅游节大巡游在外滩中山东一路上演。不少观众早早便来到外滩...
美丽中国丨秋韵紫鹊界 梯田入画... 这是9月11日拍摄的紫鹊界梯田(无人机照片)。 金秋九月,湖南省娄底市新化县紫鹊界梯田稻谷渐次成熟。...
中国之巅奏响《共同的节日》,千... 千吨阻尼器,“迎世赛、游上海旅游节”。9月13日,由上海市文化和旅游局指导推出上海旅游·会客│巅峰之...