java编程命名规范

Posted 2021-01-17 西红柿爱吃马铃薯

面向对象命名规范：
一、包名的书写规范（Package）
推荐使用公司或机构的顶级域名为包名的前缀，目的是保证各公司/机构内所使用的包名的唯一性。包名全部为小写字母，且具有实际的区分意义
　　1.1 一般要求
　　　　1、选择有意义的名字，能快速地传达该类的用途。
　　　　2、所有包的命名必须采用小写英文字母。
　　1.2 实际应用
　　　　应用系统中经常应用分层，Dao层（数据库访问）、Service层（业务处理）、Web层（页面控制action类）。
　　　　1、包名的前几个为固定名称, 如果是网站的话，采用网站的域名的反写，如果域名还没有确定的话，采用公司固定的几个名称。如：net.vschool
　　　　2、在包名的接下来一个单词为模块的名称。如：用户模块，包名为net.vschool.user
　　　　3、关于模块的访问操作，采用分层形式,一般分为：
　　　　Dao层操作：一般定义在net.vschool.xxx.dao中，其中xxx为模块名称。
　　　　Service层操作：一般定义在net.vschool.xxx.servie中。
　　　　 web层操作：一般定义在net.vschool.xxx.action中。

　　1.3 如下关于用户模块的例子：
　　　　net.vschool.user
　　　　net.vschool.user.dao
　　　　net.vschool.user.action
　　　　net.vschool.user.service
二、不同层级对象命名方式：
　　A) Service / DAO 层方法命名规约
　　　　1 ） 获取单个对象的方法用 get 做前缀。
　　　　2 ） 获取多个对象的方法用 list 做前缀。
　　　　3 ） 获取统计值的方法用 count 做前缀。
　　　　4 ） 插入的方法用 save（ 推荐 ） 或 insert 做前缀。
　　　　5 ） 删除的方法用 remove（ 推荐 ） 或 delete 做前缀。
　　　　6 ） 修改的方法用 update 做前缀。
　　B) 领域模型命名规约
　　　　1 ） 数据对象： xxxDO ， xxx 即为数据表名。DO（Domain Object）：领域对象，就是从现实世界中抽象出来的有形或无形的业务实体。
　　　　2 ） 数据传输对象： xxxDTO ， xxx 为业务领域相关的名称。 DTO（Data Transfer Object）：数据传输对象，这个概念来源于J2EE的设计模式，原来的目的是为了EJB的分布式应用提供粗粒度的数据实体，以减少分布式调用的次数，从而提高分布式调用的性能和降低网络负载，但在这里，我泛指用于展示层与服务层之间的数据传输对象。
　　　　3 ） 展示对象： xxxVO ， xxx 一般为网页名称。VO（View Object）：视图对象，用于展示层，它的作用是把某个指定页面（或组件）的所有数据封装起来。