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

相关内容

热门资讯

延安旅游攻略:一家老小5口人,... 每到暑假或国庆长假,总有很多家庭游客向我们咨询:“我们一家老小来延安,有老人有孩子,行程该怎么安排才...
原创 韩... 韩国明星到延吉旅游,第一次挑战吃羊鞭,惊得嘴都合不上了! 全昭旻等人在延吉录制节目,刚到延吉,他们...
国庆黄金周景区情况:大同古城半... 文| 芙昕 编辑 | 芙昕 国庆长假,很多人都计划着出门走走,可一到了那些热门景点,看到的往往不是山...
来大东北一共分两步:先“冷藏”... 还在被“东北=冰窖”的刻板印象吓退? 南方的“小土豆”们 别急着裹紧小棉袄 这个冬天 让“气候缓冲带...
第三届“长城之约”活动在河北涞... 11月15日,第三届"长城之约"全球推广活动暨世界文化遗产对话15日在河北省保定市涞源县启幕。 本次...