java代码规范版v1.1

《java代码规范版v1.1》由会员上传分享，免费在线阅读，更多相关内容在学术论文-天天文库。

1、XXXX远程管理平台—JAVA代码编写规范XXXX公司XXXXXX有限公司XXXXXX管理平台JAVA代码编写规范文件状态：[√]草稿[]正式发布[]正在修改文件标识：当前版本：1.1作者：李光强完成日期：2016.1.30XXXXXX2016年1月XXXX远程管理平台—JAVA代码编写规范XXXX公司修改历史编号修订后版本号修订人修订内容简述修订日期11.0李光强起草2016.1.3021.1李光强修改包命名规则、增加持久层规范2016.1.30XXXX远程管理平台—JAVA代码编写规范XXXX公司Java代码规范本Java代码规范以SUN的标准Jav

2、a代码规范为基础，为适应我们公司的实际需要，可能会做一些修改。本文档中没有说明的地方，请参看SUNJava标准代码规范。如果两边有冲突，以SUNJava标准为准。1.标识符命名规范1.1概述标识符的命名力求做到统一、达意和简洁。1.1.1统一统一是指对于同一个概念在程序中用同一种表示方法。比如设备，既可以用equipment，也可以用device，但是我们只能选定一个使用，至少在一个Java项目中保持统一。统一是作为重要的，如果对同一概念有不同的表示方法，会使代码混乱难以理解。即使不能取得好的名称，但是只要统一，阅读起来也不会太困难，因为阅读者只要理解一

3、次。1.1.2达意达意是指标识符能准确的表达出它所代表的意义，比如：newSupplier,OrderPaymentGatewayService等；而supplier1,service2，idtts等则不是好的命名方式。准确有两成含义，一是正确，二是丰富。如果给一个代表供应商的变量起名是order，显然没有正确表达。同样的，supplier1,远没有targetSupplier意义丰富。1.1.3简洁简洁是指在统一和达意的前提下，用尽量少的标识符。如果不能达意，宁愿不要简洁。比如：theOrderNameOfTheTargetSupplierWhichI

4、sTransfered太长，transferedTargetSupplierOrderName则较好，但是transTgtSplOrdNm就不好了。省略元音的缩写方式不要使用，我们的英语往往还没有好到看得懂奇怪的缩写。XXXX远程管理平台—JAVA代码编写规范XXXX公司1.1.4骆驼法则Java中，除了包名，静态常量等特殊情况，大部分情况下标识符使用骆驼法则，即单词之间不使用特殊符号分割，而是通过首字母大写来分割。比如:supplierName,addNewContract，而不是supplier_name,add_new_contract。1.1.5

5、英文vs拼音尽量使用通俗易懂的英文单词，如果不会可以向队友求助，实在不行则使用汉语拼音，避免拼音与英文混用。比如表示归档，用archive比较好,用pigeonhole则不好，用guiDang尚可接受。1.2包名包名尽可能使用能表达包单方的单一英文单词，尽可能避免多个单词，且使用小写字母，如com.xxx.settlment，不要使用com.xxx.Settlement。如果使用多个单词，则单词间不要用字符隔开，比如com.xxx.settlment.jsfutil，而不要使用com.xxx.settlement.jsf_util。本项目包名统一使用co

6、m.hezo.crems.aaa.bbb前缀，其中aaa表示功能性分类，bbb表示子系统。“aaa”包括：控制层：controller活动层：action持久层:persistence核心层：core“bbb”包括：后台管理：admin设备管理：equipment……XXXX远程管理平台—JAVA代码编写规范XXXX公司1.3类名1.3.1首字母大写类名要首字母大写，比如SupplierService,PaymentOrderAction；不要使用supplierService,paymentOrderAction。类名要使用名词单数。1.3.2后缀类名

7、往往用不同的后缀表达额外的意思，如下表：后缀名意义举例Service表明这个类是个服务类，里面包含了给其他类提同业务服务的方法PaymentOrderServiceImpl这个类是一个实现类，而不是接口PaymentOrderServiceImplInter这个类是一个接口LifeCycleInterDao这个类封装了数据访问方法PaymentOrderDaoControllerspringMVC控制器StoreControllerAction直接处理页面请求，管理页面逻辑类UpdateOrderListActionListener响应某种事件的类Pay

8、mentSuccessListenerEvent这个类代表了某种事件Paymen