JAVA编码规范V10

Java编码规范目录1 说明 (3)1.1 版本说明 (3)1.1.1 V1.0 (3)1.2 文档阅读说明 (3)2 项目规范 (3)2.1 项目编码 (3)3 JAVA规范 (3)3.1 构建 (3)3.2 代码架构 (4)3.3 排版 (4)3.4 注释 (5)3.5 命名 (7)3.6 编码 (9)3.7 性能与可靠性 (14)4 附录........................................................................................................... 错误!未定义书签。

4.1 代码管理规范............................................................................... 错误!未定义书签。

4.2 MyEclipse优化设置...................................................................... 错误!未定义书签。

1说明1.1版本说明1.1.1V1.0初始版本，根据2013年公司J2EE版本规范修订而来。

去除了JavaScript规范（该部分规划为未来单独整理）；去除了代码评审相关评审表格（这部分该由项目管理流程提供）；去除了项目目录规划部分的描述（该规划后续单独提供）。

1.2文档阅读说明R：规则，必须遵守S：建议，根据实际情况而定2项目规范2.1项目编码项目编码统一使用utf-8进行编码，包括java、jsp、js、css、properties、xml等。

3JAVA规范3.1构建R1 Java项目均应采用maven进行项目构建，并能实现通过命令行自动构建。

说明：采用Maven或Gradle进行项目构建是Java项目开发工作自动化的常见选项。

Gradle目前普及程度不及Maven。

故此公司决定采用Maven作为项目构建的基础工具。

未来推广自动构建、持续集成、代码自动审查等工作，均依赖于项目最基础的标准化工作。

希望大家遵守。

3.2代码架构S1 如果类在当前定义文件外被使用，则需要定义为public说明：Java强制要求每个Java文件中有一个public类型的类。

因此，public类和Java文件具有一一对应关系。

这背后隐含着Java语言推荐的代码组织规则。

我们在编码过程中，也应尽量遵循该规则，避免非public 类在当前定义文件外被使用的情况。

如果需要被当前定义文件外的类使用，请声明为public，以增加代码可读性。

3.3排版R1程序块要采用缩进风格编写，代码缩进单位为4个空格，不使用Tab缩进。

R2左分界符（如大括号‘{’）应在语句同一行，并与语句间隔一个空格，右分界符（如大括号‘}’）独占一行，同时与引用它们的语句左对齐。

在函数体的开始、类和接口的定义、以及if、for、do、while、switch、case语句中的程序或者static、,synchronized等语句块中都要采用如上的缩进方式。

R3每行语句字符不超过100字符，对于较长的语句、表达式或参数要分成多行书写，换行应遵循逗号后面，操作符前面的原则。

R4不允许把多个短语句写在一行中，即一行只写一条语句。

说明：阅读代码更加清晰示例：如下例子不符合规范。

Object o = new Object(); Object b = null;R5if, for, do, while, case, switch, default 等语句自占一行，且if, for, do, while,switch等语句的执行语句无论多少都要加括号{},case 的执行语句中如果定义变量必须加括号{}。

说明：阅读代码更加清晰，减少错误产生R6在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或者前后要加空格；进行非对等操作时，如果是关系密切的立即操作符（如.），后不应加空格。

说明：阅读代码更加清晰S1类属性和类方法不要交叉放置，不同存取范围的属性或者方法也尽量不要交叉放置。

格式：类定义{类的静态属性定义类的静态方法定义类的私有属性定义类的保护属性定义类的公有属性定义类的私有方法定义类的保护方法定义类的公有方法定义}S2修饰词按照指定顺序书写：[访问权限][static][final] 。

示例：public static final String str = “abc”;S3可以使用MyEclipse或Eclipse自带的ctrl+shift+F来自动格式化编码排版，格式化后请认真检查一下。

说明：注意如果使用搜狗输入法，请确认与其快捷键不冲突，详细参照：3.4注释R1类和接口的注释放在class 或者interface 关键字之前，import 关键字之后。

注释主要是功能简述。

类注释使用“/** */”注释方式。

说明：类和接口注释要着重功能描述、作者、交付后修改记录。

/*** 〈功能简述〉* @author [作者]（必须）*/示例：package m;import java.util.Date;/*** LogManager 类集中控制对日志读写的操作。

* @author 张三，李四，王五*/public class LogManagerR2类属性(成员变量)、公有和保护方法注释：写在类属性、公有和保护方法上面，注释方式为“/** */”。

示例：/*** 注释内容*/private String logType;/*** 注释内容*/public void write()R3公有和保护方法注释内容：列出方法的一句话功能简述、功能详细描述、输入参数、输出参数、返回值、异常等。

格式：/*** 〈功能简述〉* @param [参数1] [参数1说明]* @param [参数2] [参数2说明]* @return [返回类型说明]* @exception/throws [异常类型] [异常说明]*/示例：/*** 根据日志类型和时间读取日志。

* 分配对应日志类型的LogReader，指定类型、查询时间段、条件和反复器缓冲数，* 读取日志记录。

查询条件为null或0的表示没有限制，反复器缓冲数为0读不到日志。

* 查询时间为左包含原则，即[startTime, endTime) 。

* @param logTypeName 日志类型名（在配置文件中定义的）* @param startTime 查询日志的开始时间* @param endTime 查询日志的结束时间* @param logLevel 查询日志的级别* @param userName 查询该用户的日志* @param bufferNum 日志反复器缓冲记录数* @return 结果集，日志反复器*/public static LogIterator read(String logType, Date startTime, Date endTime, int logLevel, String userName, int bufferNum)R4对于方法内部用throw语句抛出的异常，必须在方法的注释中标明，对于所调用的其他方法所抛出的异常，选择主要的在注释中说明。

对于非RuntimeException，即throws子句声明会抛出的异常，必须在方法的注释中标明。

说明：异常注释用@exception或@throws表示，在JavaDoc中两者等价，但推荐用@exception标注Runtime 异常，@throws标注非Runtime异常。

异常的注释必须说明该异常的含义及什么条件下抛出该异常。

R5注释应与其描述的代码相近，对代码的注释应放在其上方，并与其上面的代码用空行隔开，注释与所描述内容进行同样的缩排。

说明：可使程序排版整齐，并方便注释的阅读与理解。

示例：/*** 注释*/public void example2( ) {// 注释CodeBlock One// 注释CodeBlock Two}/*** 注释*/public void example( ) {// 注释CodeBlock One// 注释CodeBlock Two}R6修改代码同时修改相应的注释，以保证注释与代码的一致性。

R7避免在注释中使用缩写，特别是不常用缩写。

说明：在使用缩写时或之前，应对缩写进行必要的说明。

R8对重写父类的方法必须进行@Override声明。

说明：可清楚说明此方法是重写父类的方法，保证重写父类的方法时不会因为单词写错而造成错误(写错方法名或者参数个数，类型都会编译无法通过)示例：@Overridepublic void doRequest(SipServletRequest req) throws ServletException,IOExceptionR9 对于需要注释掉（不使用）的代码，应使用//注释，而不是/**/注释考虑到对SCM系统（SVN等）的友好，注释掉的代码段，应采用//而不是/**/，因为采用/**/注释，修改的代码行只有首位两行，中间的代码段无任何变化。

这样svn工具无法判断出实际所做的修改。

而通过//注释的代码，必须逐行注释，在svn工具中可以很容易判断出整个被注释掉的代码段。

这对于依赖svn等SCM系统进行代码审查的工作来说，是很有价值的。

S1在代码的功能、意图层次上进行注释，提供有用、额外的信息。

说明：注释的目的是解释代码的目的、功能和采用的方法，提供代码以外的信息，帮助读者理解代码，防止没必要的重复注释信息。

S2对关键变量的定义和分支语句（条件分支、循环语句等）编写注释。

说明：这些语句往往是程序实现某一特定功能的关键，对于维护人员来说，良好的注释帮助更好的理解程序，有时甚至优于看设计文档。

注释应考虑程序易读及外观排版的因素，使用的语言若是中、英兼有的，建议多使用中文，除非能用非常流利准确的英文表达。

中文注释中需使用中文标点。

方法和类描述的第一句话尽量使用简洁明了的话概括一下功能，然后加以句号。

接下来的部分可以详细描述。

说明：注释语言不统一，影响程序易读性和外观排版，出于对维护人员的考虑，建议使用中文。

JavaDoc工具收集简介的时候使用选取第一句话。

S3一些复杂的代码需要说明。

示例：这里主要是对闰年算法的说明。

//1. 如果能被4整除，是闰年；//2. 如果能被100整除，不是闰年；//3. 如果能被400整除，是闰年。

3.5命名R1类名和接口使用意义完整的英文描述，每个英文单词的首字母使用大写、其余字母使用小写的大小写混合法。

（Pascal命名法）示例：OrderInformation, CustomerList, LogManager, LogConfig, SmpTransactionR2方法名使用类意义完整的英文描述：第一个单词的字母使用小写、剩余单词首字母大写、其余字母小写。