Java开发详细规范word版

Java开发详细规范word版

目录

第1章    序言    3
第2章    java一般性研发规范    5
2.1    代码格式    5
2.1.1    包、类、方法的命名规范:    5
2.1.2    方法的命名应注意避免与java中具有特殊意义的名称例如equals，hashCode，clone，finalizer等冲突    7
2.1.3    Java bean中取得boolean类型的属性值必须使用is****形式命名    8
2.1.4    if,else,while,for等必须使用{}    9
2.1.5    类必须包含在包里，禁止出现无包的类    10
2.1.6    类和方法必须拥有注释，注释量占总体代码25%以上，类头部，以及方法头部的注释应符合javadoc标准。    10
2.2    基本语法    11
2.2.1    不能随意捕捉异常，原则上谁捕捉谁处理    11
2.2.2    if，while，try，finally，switch ， synchronized ， static instantiation 里面应有相应的逻辑处理，不能为空。    12
2.2.3    在处理循环中，不能在程序中人为的改变步长。    13
2.2.4    将简单类型int，short，float，double等转化成字符串时，需使用其对应类的toString方法。    13
2.2.5    javaBean中hashCode，以及equals方法必须同时override。    14
2.2.6    懒式方式创建对象：不能采用双检查惯用法    17
2.2.7    不能在finally中返回值。    18
2.2.8    Boolean实例化时，应用使用Boolean.valueOf，Boolean.TRUE，Boolean.FALSE。    19
2.2.9    Integer,Byte,Short,Long等实例化时，应用使用valueOf    19
2.2.10    对于多个if语句嵌套的情况下能够整合尽量整合。    20
2.2.11    override function，不能只有super.function语句，否则视为无效代码    20
2.2.12    Collection.toArray的注意事项。    21
2.2.13    对于BigDecimal方法，应避免使用float值，double值进行创建，应使用字符串形式创建。    21
2.2.14    String,BigDecimal,BigInteger等值类型调用replace，add等方法的注意事项。    22
2.2.15    需要注意的引起NullException的语句。    22
2.2.16    ResultSet使用next时，需要判断是否具有记录再进行一下步操作。    24
2.2.17    字符串使用相应的规则。    25
2.2.18    禁止直接调用System.gc(),System.getRuntime().gc(),System.runFinalization()。    26
2.2.19    finalize相应的规则。    27
2.2.20    禁止在代码中使用System.out,ex.printStackTrace打印日志。    27
2.2.21    系统资源释放（谁创建的，谁关闭）    28
2.2.22    使用Clone时相应的规则。    32
2.2.23    java Bean类必须实现Serialize接口。    32
2.2.24    比较对象相等应使用equals，而不是==。    32
2.2.25    Array数组拷贝应使用System.arrayCopy。    33
2.3    耦合性以及设计    33
2.3.1    switch语句必须包含default标签。    33
2.3.2    精简boolean表达式以及boolean返回值。    34
2.3.3    在方法实现中应避免对输入的值参进行改变。    35
2.3.4    在创建方法中，应避免调用被override的方法    35
2.3.5    public static常量属性必须final。    36
2.3.6    Abstract 类必须含有abstract方法。    37
2.3.7    接口依赖性。    37
2.4    代码质量因素    38
2.4.1    Class代码行数限制    38
2.4.2    函数代码质量    38
第3章    java安全性检查规范    40
3.1    跨站脚本XSS    40
3.2    违反信任边界规则（Trust Boundary Violation）    41
3.3    不安全的反射（Unsafe Reflection）    42
3.4    SQL 注入（SQL Injection）    43
3.5    系统信息泄露（System Information Leakage）    44
3.6    资源注入(resource injection)    45