《JAVA-WEB应用系统编码规范》由会员分享，可在线阅读，更多相关《JAVA-WEB应用系统编码规范（40页珍藏版）》请在金锄头文库上搜索。
1、 内部类内部类 Java 编码规范 部门：信息技术部版本号:V 1.0 编制：规划及管理部编号： 第 1 页 共 38 页 文档安全级别：内部类内部类 Java 编码规范编码规范 版本版本 V 1.0 信息技术部信息技术部 编制日期：2009 年 2 月 18 日 文档安全级别文档安全级别: 普通类普通类 内部类内部类 限制类限制类 绝密类绝密类 内部类内部类 Java 编码规范 部门：信息技术部版本号:V 1.0 编制：规划及管理部编号： 第 2 页 共 38 页 文档修改历史记录文档修改历史记录 文档批准文档批准 角色角色姓名姓名 职责职责签名签名审批日期审批日期 内部类内部类 Java
2、编码规范 部门：信息技术部版本号:V 1.0 编制：规划及管理部编号： 第 3 页 共 38 页 JAVA 编码规范编码规范 1 1.说明说明8 2.命名规范命名规范8 2.1.PACKAGE的命名规范.8 2.2.CLASS命名规范9 2.3.METHOD命名规范11 2.4.变量命名规范.12 3.注释规范注释规范13 3.1.变更履历注释规范.14 3.2.类头注释规范.14 3.3.成员注释规范.16 3.4.方法注释规范.17 3.5.代码修改注释规范.18 4.排版规范排版规范18 4.1.详细规范内容.18 5.语句规范语句规范21 5.1.控制语句风格规范.21 5.2.命令语
3、句风格规范.23 5.3.声明语句风格规范.26 6.设计规范设计规范27 6.1.复杂度控制规范.27 6.2.CLASS设计规范28 6.3.METHOD设计规范29 6.4.变量设计规范.31 7.常用类规范常用类规范32 7.1.OBJECT整体规范32 7.2.修饰符规范.33 内部类内部类 Java 编码规范 部门：信息技术部版本号:V 1.0 编制：规划及管理部编号： 第 4 页 共 38 页 7.3.字符串规范.35 7.4.数值规范.37 7.5.集合规范.37 7.6.STREAM规范.38 7.7.例外规范.39 7.8.线程规范.40 8.日志规范日志规范42 8.1.
4、详细规范内容.42 内部类内部类 Java 编码规范 部门：信息技术部版本号:V 1.0 编制：规划及管理部编号： 第 5 页 共 38 页 1. 说明说明 本文对Web 应用系统开发规范作适当扩充，规定了Java编程的规范，主要包括命名、注释、 排版、语句、设计、常用类以及日志规范。统一规范的格式有利于项目的交付和后续维护。 本文档适用于所有以Java为开发语言的定制开发应用系统。 2. 命名规范命名规范 命名规范使程序易读，从而更易于理解。 2.1. Package 的命名的命名规范规范 2.1.1.Package 名要使用小写字 如无特殊规定，请将Package名统一成小写字。这是Jav
5、a的一般规则。 例如： com.citicpru.fins.Banking.ACCOUNT /错误 com.citicpru.fins.banking.account /正确 2.1.2.Package 名要有意义 尽量给Package命名一个能联想到Package内容的名字。如果使用功能ID、流水号等来命 名Package的话，不能马上明白其意思。遵守此规范，将提高代码的易读性。 例如： com.citicpru.fins.banking.a00001 /错误 com.citicpru.fins.banking.account /正确 2.1.3.Package 名不应缩写 即使Packag
6、e名长，也请尽量不要缩写，而使用易懂的名字。 例如： 内部类内部类 Java 编码规范 部门：信息技术部版本号:V 1.0 编制：规划及管理部编号： 第 6 页 共 38 页 com.citicpru.fins.bk.acc /错误 com.citicpru.fins.banking.account /正确 2.1.4.Package 名的组成 标准的package名分为三部分：，本公司均 使用com.citicpru。 例如： com.pksoft.fins.banking.account /错误 com.citicpru.fins.banking.account /正确 2.2. Clas
7、s 命名规范命名规范 2.2.1.Class 的名称应该是一个名词短语 Class的名称应是“形容词/名词+名词”的形式。 例如： public class SomethingManage /错误 public class SomethingManagement /正确 2.2.2.Class 名要能体现其作用 Class名中，请不要使用功能ID、流水号等难懂的名字。Class名要使用有意义的字符串， 以便能联想到其Class的内容。这样将提高代码的易读性。 例如： public class S0001 /错误 public class Sample /正确 2.2.3.Class 名中单词的
8、第 1 个字母要大写 请大写Class名的第1个字母。当Class名由多个单词组成时，每个单词的第1个字母（段 落）都要大写,其余字母小写。这是Java的一般规则。 例如： 内部类内部类 Java 编码规范 部门：信息技术部版本号:V 1.0 编制：规划及管理部编号： 第 7 页 共 38 页 public class sampleclass /错误 public class SampleClass /正确 2.2.4.例外 Class 名的最后要加上“Exception” 对例外Class名，请在名字最后加上“Exception”。统一此写法，将提高代码的易读性。 例如： public cl
9、ass Sample extends Exception /错误 public class SampleException extends Exception /正确 2.2.5.Interface 名要基于 Class 名 Interface的命名规则基本上要基于Class名。统一此写法，将提高代码的易读性。如果 需要与Class名区分，请在开头加上“I”。 例如： public class Sample implements ISample 2.2.6.抽象 Class 名要基于 Class 名 抽象Class名的命名规则基本上要基于Class名。统一此写法，将提高代码的易读性。名 字要以
10、“Abstract”开始，再加上能联想到Subclass名的名字。 例如： public abstract class AbstractSample 2.2.7.实体 Class 名要基于 Interface 名 实体Class名的命名规则基本上要基于Interface名。统一此写法，将提高代码的易读性。 如果需要与Interface区分，请在最后加上“Impl”。 例如： public class SampleImpl implements ISample 2.2.8.在能力附加型的 Interface 名后面加上“able” 对于Class来说，会存在附加某能力的Interface，如Ru
11、nnable, Cloneable等。定义能 力附加型的Interface时，请使用能表示其能力的形容词(able）来命名。统一此写法， 内部类内部类 Java 编码规范 部门：信息技术部版本号:V 1.0 编制：规划及管理部编号： 第 8 页 共 38 页 将提高代码的易读性。 例如： public class Sample implements Pluggable 2.3. Method 命名规范命名规范 2.3.1.Method 名只在段落时采用大写字 关于Method名，只有一个单词时，全部采用小写字。当由多个单词组成时，第2个以后 的单词的第1个字母要大写。这是Java的一般规则。
12、例如： public void Samplemethod() /错误 public void sampleMethod() /正确 2.3.2.生成 Object 的 Method 名的格式是“create“+Object 名” 关于生成Object的Method（Factory Method）名，以“create”开始，并在其之后加上 此Method生成的Object名。统一此写法，将提高代码的易读性。 例如： public Sample createSample() 2.3.3.转换 Method 名的格式是“to“+Object 名” 关于将Object转换成其他Object的Metho
13、d（Converter Method），以“to”开始，并在 其之后加上转换后的Object的名字。统一此写法，将提高代码的易读性。 例如： public Another toAnother() 2.3.4.Getter Method 名的格式是“get“+属性名” 关于取得属性的Method（Getter Method）的名字，以“get”开始，并在其之后加上取 得的属性名。统一此写法，将提高代码的易读性。这是JavaBeans的规范。 例如： public String getSampleName() 内部类内部类 Java 编码规范 部门：信息技术部版本号:V 1.0 编制：规划及管理部
14、编号： 第 9 页 共 38 页 2.3.5.Setter Method 名的格式是“set“+属性名” 关于设定属性的Method（Setter Method）名字，以“set”开始，并在其之后加上设定 的属性名。统一此写法，将提高代码的易读性。这是JavaBeans的规范。 例如： public void setSampleName(String name) 2.3.6.boolean 通过返回变量的 Method 名要能看出 true/false 的状态 关于返回boolean变量的Method名，要能看出其返回值的true/false指的是什么样的状 态。推荐使用表示Yes或No的疑问
15、句的描述形式（例：is+名片）。统一此写法，将提高代 码的易读性。 例如： public boolean isAsleep() public boolean canSpeak() public boolean hasExpired() public boolean exists() public boolean hasValue() 2.4. 变量命名规范变量命名规范 2.4.1.通过 boolean 变量要能看出 true/false 的状态 关于boolean变量名，要能看出其变量的true/false指的是什么样的状态。推荐使用表 示Yes或No的疑问句的描述形式（例：is+名片）。统一
16、此写法，将提高代码的易读性。 例如： private boolean isAsleep; private boolean canSpeak; private boolean hasExpired; private boolean exists; private boolean hasValue; 内部类内部类 Java 编码规范 部门：信息技术部版本号:V 1.0 编制：规划及管理部编号： 第 10 页 共 38 页 2.4.2.常量全部为 static final、全部是大写字、段落用“_” 常量全部用static final声明，变量名全部用大写字描述。常量名由多个单词组成时， 各单词之间用“_”分开。统一此写法，将提高代码的易读性。 例如： public static final int SAMPLE_VALUE = 10; 2.4.3.变量名要反映其作用 变量名要能反映出其作用。统一此写法，将提高代码的易读
