Java 开发命名规范
文章插图
包名的命名规范(Package)推荐使用公司或机构的顶级域名作为包名的前缀 , 所使用的包名的唯一性 。 包名的命名必须全部为小写字母 , 且具有实际的区分意义 。
结合应用分层 , Web层(页面控制action类) , Service层(业务处理)、 Dao层(数据库访问) , 关于模块的访问操作 , 采用分层形式,一般分为:
- Dao层操作:使用 dao 做后缀 。
- Service层操作:使用 servie 做后缀 。
- Web层操作:使用 action 做后缀 。
Dao层
- Dao层接口类:一般采用 "实体对象+nterface+Dao" 的命名形式 。
- Dao层接口实现类:一般采用 "实体对象+Interface+Impl+Dao" 的命名形式 。
- Service层接口类:一般采用 "模块+Interface+Service" 的命名形式 。
- Service层接口实现类:一般采用 "模块+Interface+Impl+Service" 的命名形式 。
- Web层实现类:一般采用 "模块+操作+Action" 的命名形式 。
- DO(Data Object):与数据库表结构对应 , 通过DAO层向上传输数据源对象 。
- DTO(Data Transfer Object):数据传输对象 , Service或Manager向外传输的对象 。
- BO(Business Object):业务对象 , 由Service层输出的封装业务逻辑的对象 。
- AO(Application Object):应用对象 , 在Web层与Service层之间抽象的复用对象模型 , 极为贴近展示层 , 复用度很低 。
- VO(View Object):显示层对象 , 通常是Web向模板渲染引擎层传输的对象 。
- Query:数据查询对象 , 各层接收上层的查询请求 , 超过2个参数的查询封装 , 禁止使用Map类传输 。
- 数据对象:xxxxDO , xxxx为数据表名 。
- 数据传输对象:xxxxDTO , xxxx为业务领域相关的名称 。
- 展示对象:xxxxVO , xxxx一般为网页名称 。
Service/DAO层的方法命名规约
- 插入的方法命名使用 insert或save 做前缀 。
- 删除的方法命名使用 delete或remove 做前缀 。
- 修改的方法命名使用 update 做前缀 。
- 获取单个对象的方法命名使用 get 做前缀 。
- 获取多个对象的方法命名使用 list 做前缀 , 复数结尾 。
- 获取统计值的方法命名使用 count 做前缀 。
- 黑莓(BB.US)盘前涨逾32%,将与亚马逊开发智能汽车数据平台|美股异动 | US
- 现状|程序员现状揭秘:平均年薪20.36万,Java人才需求量最大
- 开发自|不妥协不追随 Member’s Mark升级背后的“山姆哲学”
- 新一代|外媒: 高通新一代旗舰处理器或命名为骁龙888
- 确认|三星确认正在开发“轻薄轻巧”的可折叠手机
- 推广|Josh Elman加盟苹果 负责开发者关系与软件推广工作
- 微信广告|小程序开发者看过来 流量变现倍增的秘籍来了!
- 首发|高通旗舰芯片命名骁龙888,真我高管开启预热,新机或抢首发
- 小米|小米10i/Redmi 9 Power曝光:或为国内Redmi Note 9海外重命名版
- 骁龙|曝骁龙新旗舰不叫875 或命名为骁龙888