南京Java培训分享Java程序员不可不留意的编码规范

　　好的编码规范可以尽可能的减少一个软件的维护本钱 , 并且几乎没有任何一个软件，在其整个生命周期中，均由最初的开发职员来维护。今天南京万和Java培训和大家分享的是Java程序员不可不留意的编码规范，希望能大家能从中有所收获。

　　1、规范存在的意义

　　应用编码规范对于软件本身和软件开发职员而言尤为重要，有以下几个原因：

　　⑴.好的编码规范可以尽可能的减少一个软件的维护本钱 , 并且几乎没有任何一个软件，在其整个生命周期中，均由最初的开发职员来维护；

　　⑵.好的编码规范可以改善软件的可读性，可以让开发职员尽快而彻底地理解新的代码；

　　⑶.好的编码规范可以最大限度的进步团队开发的合作效率；

　　⑷.长期的规范性编码还可以让开发职员养成好的编码习惯，甚至锻炼出更加严谨的思维；

　　2、命名规范

　　◎一般概念

　　⑴.尽量使用完整的英文描述符

　　⑵采用适用于相关领域的术语

　　⑶采用大小写混合使名字可读

　　⑷尽量少用缩写，但假如用了，必须符合整个工程中的同一定义

　　⑸避免使用长的名字（小于 15 个字母为正常选择）

　　⑹避免使用类似的名字，或者仅仅是大小写不同的名字

　　⑺避免使用下划线（除静态常量等）。更多内容，请咨询南京万和Java培训。

　　◎标识符类型说明

　　⑴包（ Package ）的命名

　　Package 的名字应该采用完整的英文描述符，都是由一个小写单词组成。并且包名的前缀总是一个顶级域名， 通常是 com、edu、gov、mil、net、org 等；

　　如： com.yjhmily.test

　　⑵类（ Class ）的命名

　　类名应该是个一名词，采用大小写混合的方式，每个单词的首字母大写。尽量保证类名简洁而富于描述。

　　使用完整单词，避免缩写词 ( 除非工程内有同一缩写规范或该缩写词被更广泛使用，像 URL ， HTML)

　　如： FileDescription

　　⑶接口（ Inte***ce ）的命名

　　基本与 Class 的命名规范类似。在满足 Classd 命名规则的基础之上，保证开头第一个字母为 ”I”， 便于与普通的 Class区别开。实在现类名称取接口名的第二个字母到最后，且满足类名的命名规范；

　　如： IMenuEngine

　　⑷枚举（ Enum ）的命名

　　基本与 Class 的命名规范类似。在满足 Classd 命名规则的基础之上，保证开头第一个字母为 ”E” ， 便于与普通的 Class区别开。

　　如： EUserRole

　　⑸异常（ Exception ）的命名

　　异常（ Exception ） 通常采用字母 e 表示异常，对于自定义的异常类，其后缀必须为 Exception

　　如： BusinessException

　　⑹方法（ Method ）的命名

　　方法名是一个动词，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。

　　方法名尽可能的描述出该方法的动作行为。返回类型为 Boolean 值的方法一般由“ is ”或“ has ”来开头

　　如： getCurrentUser() 、 addUser() 、 hasAuthority()

　　⑺参数（ Param ）的命名

　　第一个单词的首字母小写，其后单词的首字母大写。参数目名不答应以下划线或美元符号开头， 固然这在语法上是答应的。参数名应简短且富于描述。

　　如： public UserContext getLoginUser(String loginName);

　　⑻常量字段 （ Constants ）的命名

　　静态常量字段（ static final ） 全部采用大写字母，单词之间用下划线分隔；更多内容，请咨询南京万和Java培训。

　　如： public static final Long FEEDBACK;

　　public static Long USER_STATUS;

　　3、注释规范

　　一个很好的可遵循的有关注释的经验法则是：

　　问问你自己，你假如从未见过这段代码，要在公道的时间内有效地明白这段代码，你需要一些什么信息？？？

　　◎一般概念

　　⑴.注释应该增加代码的清楚度

　　⑵.保持注释的简洁

　　⑶.在写代码之前或同时写注释

　　⑷.注释出为什么做了一些事，而不仅仅是做了什么

　　◎注释哪些部分

　　⑴.Java 文件：必须写明版权信息以及该文件的创建时间和作者；

　　⑵.类：类的目的、即类所完成的功能，以及该类创建的时间和作者名称；多人一次编辑或修改同一个类时，应在作者名称处出现多人的名称；

　　⑶.接口： 在满足类注释的基础之上，接口注释应该包含设置接口的目的、它应如何被使用以及如何不被使用。在接口注释清楚的条件下对应的实现类可以不加注释；

　　⑷.方法注释： 对于设置 (Set 方法 ) 与获取 (Get 方法 ) 成员的方法，在成员变量已有说明的情况下，可以不加注释；普通成员方法要求说明完成什么功能，参数含义是什么且返回值什么；另外方法的创建时间必须注释清楚，为将来的维护和阅读提供宝贵线索；

　　⑸方法内部注释： 控制结构，代码做了些什么以及为什么这样做，处理顺序等，特别是复杂的逻辑处理部分，要尽可能的给出具体的注释；

　　⑹参数： 参数含义、及其它任何约束或条件条件；

　　⑺属性： 字段描述；

　　⑻局部 ( 中间 ) 变量： 无特别意义的情况下不加注释；更多内容，请咨询南京万和Java培训。

　　◎注释格式

　　遵循工程规定的同一注释格式，一般情况下会以 codetemplates.xml 格式的文件导进 IDE(Eclipse) 或者用Eclipse默认的；

　　4、代码格式规范

　　遵循工程规定的同一代码格式，一般情况下直接使用 IDE(Eclipse) 自带的默认代码格式对代码进行格式化；

　　5、其他规范

　　JSP 文件命名

　　用完整的英文描述说明 JSP 所完成的功能，尽可能包括一个生动的动词，第一个字母小写，

　　如： viewMessage.jsp 、editUser.jsp 等。

　　6、工程特有命名规范

　　◎持久层

　　⑴.Hibernate 映射文件及实体与数据库表名称完全对应；

　　如： Advertisement.hbm.xml 、 Advertisement.java

　　⑵.数据访问 DAO

　　DAO 接口和实现类名称必须完全符合正常接口和实现类的命名规则，且最后以 ”DAO” 结尾DAO 内的数据访问方法必须足够抽象的描述出对数据库的基本 CRUD 操纵；

　　如： ICrossAdDAO( 接口 ) 、 CrossAdDAO( 实现类 )

　　⑶.各种操纵数据库的 HQL 配置文件

　　HQL 文件的个数原则上与系统的 Services 层的服务个数相等，且以服务名称命名 HQL 文件；

　　如： resource.hbm.xml

　　◎服务层

　　⑴.服务接口和实现

　　服务接口和实现类必须完全符合正常接口和实现类的命名规则；以工程定义的服务名为主体， 并同一以 ”Serv” 结尾

　　如： IResourceServ( 服务接口 ) 、 ResourceServ( 接口实现类 )

　　⑵.服务接口方法

　　方法名是一个动词，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。

　　方法名尽可能的描述出该方法的动作行为。

　　返回类型为 Boolean 值：用“ is ”或“ has ”来开头

　　得到某数据： get+ 数据描述名词复数 + 数据类型；

　　得到所有数据： get+All+ 数据描述名词复数 + 数据类型；

　　通过 XXX 得到 / 查询某数据： get/query+ 数据描述名词复数 + 数据类型 +By+ 条件；

　　添加某数据： save/add+ 数据描述名词 ()

　　更新某数据： save/update+ 数据描述名词；

　　删除某数据： delete/remove+ 数据描述名词；

　　⑶.业务对象

　　业务名称 +BO

　　⑷.查询参数对象

　　凡是继续 Abst***QuerySpec 的查询参数类全部满足以下规则：

　　Query+ 所要查询的数据描述名词 +Spec

　　作为参数传进时，参数名必须为：所要查询的数据描述名词 +Spec

　　如： QueryProgramSpec

　　◎MVC 层

　　⑴.Action 控制层

　　Action 类名：功能模块名称 +Action ；

　　Actoin 方法名称尽可能的描述出页面迁移的往向

　　如： LoginAction( 登录用 action) ， toWelcome( 转向欢迎页的 action 方法 )

　　⑵.资源文件

　　系统全局资源文件： globalMessages_+ 字符编码类型 +.properties

　　功能模块内部的资源文件： package.properties。更多内容，请咨询南京万和Java培训。

　　◎Spring 配置文件

　　⑴.Action 相关配置文件

　　文件目录： WebRoot/WEB-INF/spring/action/ 功能模块名称 +_ApplicationContext.xml

　　⑵.Services 相关配置文件

　　文件目录： WebRoot/WEB-INF/spring/services/Services_ApplicationContext.xml

　　⑶.全局性配置文件

　　文件目录： WebRoot/WEB-INF/spring/工程名+_ApplicationContext.xml

　　◎JSP 文件

　　采用完整的英文描述说明 JSP 所完成的功能，尽可能包括一个生动的动词，第一个字母小写，

　　如： viewMessage.jsp 、editUser.jsp 等。

　　想和兴趣相投的朋友们一起交流吗？那就来江苏万和计算机培训中心吧。而江苏万和作为南京专业的Java培训中心，欢迎广大有志于此行业发展的学员们加入。