Java开发规范(公司规范)

Java开发规范第1章序言本规范的目的在于：建立一个可行可操作的编程标准、约定和指南，以规范公司java代码研发工作。

2013年为公司的质量年，为了提高公司研发能力，该规范的制定是为了规范java代码开发，提高java开发质量，从代码的层面规范并提高java项目的研发水平。

该规范由运营中心技术小组制定，运营中心技术小组将结合PMD检查工具以及相应的检查工具，组织技术监控人员对重点项目以及新的java项目定期检查，对代码质量进行评估，对代码质量较差限期整改，并报运营中心备案作为项目考核依据。

本规范适用于2013年公司java代码研发规范。

本规范的内容包括两个方面：java开发一般规范，以及java代码开发安全性规范。

Java代码开发一般规范主要从java基本语法，代码格式，耦合性以及设计方面，以及代码质量因子等进行描述；java代码开发安全性规范主要从sql注入，资源注入，跨站脚步，安全边界违例，系统信息泄露进行描述。

为了方便并配合PMD检查工具等相应检查工具，方便开发者针对违规代码进行调整，本规范中java一般开发规范描述形式将结合PMD，并提供示例代码，其形式如下：⏹规范描述：⏹PMD规则名称：⏹PMD级别（注1）：⏹违规示例代码：⏹合法示例代码：本规范中java安全开发规范部分将结合具体项目，对出现安全隐患的代码进行分析，以及相应的解决办法和思路上进行分析,其具体格式如下：⏹风险及危害：⏹应对措施：⏹非安全代码示例⏹安全代码示例本规范解释权归运营中心技术小组，属于运营中心为了提供公司研发水平以及质量的一系列措施中的一部分，在后续的版本中将根据具体需要进行修改以及调整。

技术小组审核后给出相应的整改意见，对于有争议的问题，可直接与运营中心技术小组领导成员沟通。

第2章要求气象局项目组的所有java开发人员，编写的代码必须满足第三章的所有规范（每个标题为一个规范）。

项目组成员之间每周或每月互相检查对方编写的代码，若发现问题，要求对方及时更正。

项目经理应该随时抽查、并最终审查代码，保证代码的规范性。

第3章java一般性研发规范3.1 代码格式3.1.1包、类、方法的命名规范:⏹规范描述：包，类，方法命名只能为27个英文字符以及数字，不能包括特殊字符例如-，_,$等;包命名，首字符必须小写；类命名，首字符必须大写；方法命名，首字符必须小写；常量命名，必须全部大写；变量，以及属性命名，首字符必须小写；在类中非创建方法其命名应避免与类名一致；在类中属性的命名应避免与类名一致；在同一类中属性命令应避免与方法命名一致；在方法中命名临时变量时应避免与方法的参数名一致；⏹PMD规则名称：AvoidDollarSignsPackageCaseClassNamingConventionsMethodNamingConventionsSuspiciousConstantFieldNameVariableNamingConventionsMethodWithSameNameAsEnclosingClassAvoidFieldNameMatchingTypeNameMisleadingVariableName⏹规则级别：Error Highwarn Highwarn Highwarn Highwarn HighError HighError HighError High⏹违规示例代码：1、常量、变量命名public static final int my_num = 0; //常量应大写public String MyTest = ""; //变量命名，首字符小写DataModule DMTest = new DataModule();//变量命名，首字符小写2、方法命名public class Foo {public void FooStuff() {}}3、类命名:首字符应大写public class foo {}4、非法使用特殊字符命名public class Fo$o { // yikes!}5、非创建方法命名应避免与类名一致public class MyClass {// this is bad because it is a methodpublic void MyClass() {}// this is OK because it is a constructorpublic MyClass() {}}6、方法中临时变量的命名应避免与其参数一致：public void bar(String m_baz) { // Badint m_boz = 42; // Bad}7、在类中属性的命名应避免与类名一致：public class Foo extends Bar {// There's probably a better name for fooint foo;}8、在同一类中属性命名应避免与方法命名一致：public class Foo {Object bar;// bar is data or an action or both?void bar() {}}⏹合法代码示例：1、常量、变量命名：public static final int MY_NUM = 0; //public String myTest = "";DataModule dmTest = new DataModule();2、方法命名：首字符应小写public class Foo {public void fooStuff() {}}3、类命名：首字符应大写public class Foo {}3.1.2方法的命名应注意避免与java中具有特殊意义的名称例如equals，hashCode，clone，finalizer等冲突⏹规范描述：在java中某些方法是具有特殊意义的，例如boolean equals(Object o)是比较两个对象是否相等；int hashCode()取得hash值，主要用于hash表；Object clone()用于复制对象；void finalizer()用于该类实例化的对象释放时系统调用释放该对象使用的资源。

这些方法具有固定的形参格式，固定的返回值，不能被其他形式或者用于其他方面的方法override，否则将降低代码可读性，并为代码维护带来隐患。

⏹PMD规则名称：SuspiciousEqualsMethodNameSuspiciousHashcodeMethodName；FinalizeOverloaded；BooleanGetMethodName；⏹规则级别：Error HighError HighError HighError High⏹违规示例代码：1、可疑的equals方法命名public class Foo {public int equals(Object o) {// oops, this probably was supposed to be boolean equals}public boolean equals(String s) {// oops, this probably was supposed to be equals(Object)}}2、可疑的hashCode命名public class Foo {public int hashCode(int value) {// oops, this probably was supposed to be hashCode}}⏹合法代码示例：1、正确的equals方法命名public class Foo {public boolean equals(Object o) {// oops, this probably was supposed to be boolean equals}}2、正确的hashCode命名public class Foo {public int hashCode() {// oops, this probably was supposed to be hashCode}}注：一般来说override hashCode方法为了避免键值冲突，提高hash表的查询效率，可采用37乘法原则，例如某javabean中包含两个关键属性str1，str2，str3该关键属性不能为空，这其hash值按以下算法获得：str1.hashCode()+str2.hashCode()*37+str3.hashCode()*37*37。

3.1.3Java bean中取得boolean类型的属性值必须使用is****形式命名⏹规范描述：对于java bean来说，get***是取得该bean的属性值，set***为设置该bean 的属性值，is***是获得该bean中为boolean类型的属性值，这些方法对java bean来说是具有特殊意义，如果命名不规范将导致在使用java bean内置方法时出现取值，或者设值不成功。

⏹PMD规则名称：BooleanGetMethodName⏹规则级别：Error High⏹违规示例代码：public boolean getFoo(); // bad⏹合法代码示例：public boolean isFoo(); // ok3.1.4if,else,while,for等必须使用{}⏹规范描述：If,else,while,for等分支循环语句，必须使用{}将业务处理逻辑包含在内，这样可大大提高代码可读性，有利于后续代码维护。

⏹PMD规则名称：IfStmtsMustUseBracesWhileLoopsMustUseBracesIfElseStmtsMustUseBracesForLoopsMustUseBraces⏹规则级别：warn High⏹违规示例代码：1、if语句违例代码if (foo) x++;2、else语句违例代码if (foo)x++elsex--;3、while语句违例代码while(x<100)x++;4、for语句违例代码for(int i=0;i<10;i++)x++;⏹合法代码示例：1、if语句if (foo){x++;}2、else语句if (foo){x++}else{x--;}3、while语句while(x<100){x++;}5、for语句for(int i=0;i<10;i++){x++;}3.1.5类必须包含在包里，禁止出现无包的类⏹规范描述：包是java中类所在命名空间，用于类载入时，虚拟机快速定位并查找该类；如果一个无包类，在类载入时，耗时较多，并且很可能无法找到该类。