java编码标准规范专业资料.doc

开发过程中，建立JAVA开发规范，统一JAVA代码编码风格，可以增长清晰性和可阅读性，便于走查和维护！一 工程编码建议工程名表意明确工程项目编码格式使用UTF-8文献编码类型统一为UTF-8二 开发编码规范2.1 排版规范规定2.1.1 缩进风格规则：代码采用缩进风格， tab用4个空格代替。代码中避免使用tab。阐明：用不同编辑器阅读程序时，因TAB键所设立空格数目不同而导致程序布局不整洁。在eclipse和myeclipse中可以设立tab转换为空格。配备办法如下：（1）点击window - preferences -General - Editors - Text Editors ，设立如下界面中红色标记内容。2.1.2 分界符2.2.2.1 大括号规则1：大括号与if，else，for，do，while语句一起使用，虽然只有一条语句(或是空)，也应当把大括号写上。示例：规则2：左大括号前不换行，左大括号后换行，右大括号前换行如果右大括号是一种语句、函数体或类终结，则右大括号后换行；否则不换行。例如，如果右大括号背面是else， catch或逗号，则不换行。示例：一种空块状构造里什么也不包括，大括号可以简洁地写成，不需要换行，如构造函数等2.2.2.2 空格规则1：除办法声明和调用外，小括号前一定要有一种空格。规则2：分隔任何保存字与紧随其后左括号( 如if，for catch等。规则3：分隔任何保存字与其前面右大括号 如else，catch。规则4：在任何左大括号前 要有空格规则5：在任何二元或三元运算符两侧。这也合用于如下“类运算符”符号：类型界限中&()。规则6：在 ， ： ；及右括号 ) 后 要有一种空格规则7： 声明变量时，在类型和变量之间要有一种空格，如intnumber。规则8：单目操作符先后不加空格如：!、“+、-、&（地址运算符）等先后不需要加空格。规则9： .先后不加空格。2.1.3 代码行字数限制规则：每行代码字符数应当不超过125个字符。阐明：较长语句、表达式或参数（125字符）要提成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出新行要进行恰当缩进，使排版整洁，语句可读。MyEclipse设立办法：window-preferences-java-code style-formatter-edit-line wrapping-maximum line width new一种新Code Style模板，并将该项设为1252.1.4 代码行语句限制规则1：每行代码不能浮现各种语句，每行只能有一种语句。规则2：每行不能声明各种变量，一行只能声明一种变量，且声明变量时应当有初始化值。2.1.5 定义排序规则：类属性和类办法不要交叉放置，不同存取范畴属性或者办法也尽量不要交叉放置格式：2.2 命名规范规定2.2.1 包名规范包名采用域后缀倒置加上自定义包名，包名采用小写字母。在部门内部应当规划好包名范畴，防止产生冲突。部门内部产品使用部门名称加上项目名称。产品线产品使用产品名称加上模块名称。格式：com.demo.b2b.模块名称 com.demo.bookStore.项目名称2.2.2 类名规范规则1：类名和接口名，是个名词，使用类意义完整英文描述，每个英文单词首字母使用大写、别的字母使用小写大小写混合法，俗称：驼峰命名法。如：OrderInformation，CustomerList，LogManager， PropertiesManager规则2：定义接口，名称前面要加I，接口实现，背面要加Impl，如：IUserService：表达接口IUserServiceImpl：表达接口实现2.2.3 办法名规范规则1：办法名是一种动名词，使用类意义完整英文描述：第一种单词字母使用小写、剩余单词首字母大写别的字母小写大小写混合法。规则2：办法中，存取属性办法采用setter 和 getter办法，动作办法采用动词和动宾构造。规则3：返回类型为boolean办法，必要以is开头。格式：get + 非布尔属性名()is + 布尔属性名()set + 属性名()动词()动词 + 宾语()示例：2.2.4 属性名规范规则1：属性名使用意义完整英文描述：第一种单词字母使用小写、剩余单词首字母大写，别的字母小写。规则2：属性名不能与办法名相似。规则3：类型为boolean属性名称前必要以is开头。规则4：变量名不应如下划线或美元符号开头。 规则5：具有集合意义属性命名，尽量包括其复数意义。示例： 2.2.5 常量名规范规则：常量名使用全大写英文描述，英文单词之间用下划线分隔开，并且使用 static final修饰。示例： 建议：对于Long型数据，必要在背面加L标记。Double类型数据，必要在背面加D标记。Float类型数据，必要在背面加F标记。2.2.6 缩写规则：如果函数名超过15个字母，可采用以去掉元音字母办法或者以行业内商定俗成缩写方式缩写函数名。如： 2.3 编码规范2.3.1 办法体长度规则1：函数体不超过300行。规则2：一种函数仅完毕一种功能，虽然简朴功能也应当编写办法实现。 阐明：虽然为仅用一两行就可完毕功能去编办法好象没有必要，但用办法可使功能明确化，增长程序可读性，亦可以便维护、测试。此外，一种办法体如果太长，也许会导致阅读、理解困难，或是功能复杂没有拆分，这时应当进行办法体拆分。2.3.2 文献规则：一种文献一种类（匿名类除外），文献长度不超过行。阐明：此规范来自sun JAVA规范，“Files longer than lines are cumbersome and should be avoided”规则2：文献编码类型统一为UTF-82.3.3内敛(inline)表达式规则：不使用内敛表达式来进行逻辑判断阐明：这样看起来比较难以阅读和理解。2.3.4输出调试规则：在开发中不应当使用System.out.print*等原则输出函数来进行调试和输出信息，而应当使用log API等（SLF4J，log4J等）2.3.5 包引入规则1：不使用import * 来导入包类。应导入详细类。阐明：使用 * 导入会增长类加载过程。规则2：不使用静态导入阐明：使用静态导入容易导致包和类冲突。2.3.5 字符串比较规则1：字符串比较不要使用“=”，而应当使用equals函数来。阐明：“=”是进行地址比较，而equals是值比较。如果String是通过定义，那么str1 = str2为true。Str1.equals(str2)为true。（jvm将她们视为常量，放在常量存储区，str1和str2引用是同一种地址）。如果是通过定义，那么str1 = str2 为false，str1.equals（str2）为true。（JVM将str2放在堆上）。因此，在比较字符串值相似时，使用equals办法，而不是“=”规则2：进行判断、比较时，如果有常量，常量应当放在比较左边。阐明：将常量放在左边，可以避免由于输入错误（=变为=）导致赋值表达式，判断成果始终为true。2.3.6 Swtich语句规则： Switch语句必要有default语句结束。2.3.7 办法参数个数规则：办法体参数个数不能超过7个，否则难以理解和维护。2.3.8 资源释放规则：对于需要释放资源操作，释放办法必要放在finally块中阐明：数据库操作、IO操作等需要使用结束close()对象必要在try -catch-finally finally中。对于异常解决，finally块总会被执行，因而，释放资源必要放在finally中。2.3.9 异常解决规则1： 异常捕获后，如果不对该异常进行解决，则应当纪录日记或者使用ex.printStackTrace()打印出来。规则2：自己抛出异常必要要填写详细描述信息。阐明：便于问题定位。示例：规则3：一种办法中不应当抛出太多异常（最佳不要超过3个），而应当进行细分解决。规则4：不要使用catch(Exception e) 和catch (Throwable e)来捕获异常，而应当分层次来捕获（先子异常，在父异常）。除非是在最外层调用，最后一次异常捕获，否则尽量不使用全局捕获。2.3.10 运算优先级规则：注意运算符优先级，并用括号明确表达式操作顺序，避免使用默认优先级。阐明：防止阅读程序时产生误解，防止因默认优先级与设计思想不符而导致程序出错。示例：下列语句中表达式如果书写为：（1）（2）虽然不会出错，但语句不易理解；（3）导致了判断条件出错。 2.3.11 代码中常量使用规则1：避免使用不易理解数字，而用故意义标记来代替。涉及物理状态或者具有物理意义常量，不应直接使用数字，必要用故意义静态变量来代替。规则2：系统中使用常量都应当定义到一种类中，并使用 public static final 来修饰，而不应随意定义。建议：常量类建议取名为SystemConstants规则3：常量定义不应当使用接口(interface)，而应当使用一种普通类，并把类构造函数私有化。阐明：接口重要是用来定义办法调用，是需要被其她类来实现，如果接口中只有常量而没有办法，这就违背了接口意义。为了不让调用者对常量类进行实例化，需要显示声明一种私有构造办法。示例：如下程序可读性差。如下程序常量定义未知不符合规范，应当放到一种统一定义常量类中，并使用JavaDoc注释方式进行注释，而不应当放在本类中定义。应改为如下形式：常量定义如下：2.3.12 数组声明规则：数组声明使用 类型 变量 而不是 类型 变量2.4 注释规范2.4.1 文献注释规则：文献注释写入文献头部，包名之前位置。阐明：注意以 /* 开始示例：/* * 注释内容 */package m；文献注释内容涉及：版权阐明、描述信息、生成日期、修改历史。2.4.2 类与接口注释规则：该注释放在 package 核心字之后，class 或者 interface 核心字之前。阐明：以便JavaDoc收集示例：package m;/* * 注释内容 */public class CommManager类和接口注释内容：类注释重要是一句话功能简述、功能详细描述2.4.3 办法注释规则：列出办法一句话功能简述、功能详细描述、输入参数、输出参数、返回值、违例等。阐明：since 表达从哪个版本开始就有这个办法；exception或throws 列出也许抛出异常；2.4.4 异常注释规则：对于办法内部用throw语句抛出异常，必要在办法注释中标明，对于所调用其她办法所抛出异常，选取重要在注释中阐明。 对于非RuntimeException，即throws子句声明会抛出异常，必要在办法注释中标明。阐明：异常注释用exception或throws表达，在JavaDoc中两者等价，但推荐用exception标注Runtime异常，throws标注非Runtime异常。异常注释必要阐明该异常含义及什么条件下抛出该异常。2.4.5 属性注释规则：属性注释采用JavaDoc注释方式（/* */）描述该属性代表意思和描述。局部变量注释可以采用单行注释（/）或多行注释（/* */）方式。对于意思特别清晰变量名或属性可以不增长注释。/属性注释/* * 顾客类型1：买家，2：卖家，3：后台顾客 */2.4.6 语句注释规则：对于注释掉语句需要阐明注释掉因素、时间，姓名和版本信息。