java代码规范详细版

《java代码规范详细版》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、JAVA代码规范本Java代码规范以SUN的标准Java代码规范为基础，为适应我们公司的实际需要，可能会做一些修改。本文档中没有说明的地方，请参看SUNJava标准代码规范。如果两边有冲突，以SUNJava标准为准。1.标识符命名规范1.1概述标识符的命名力求做到统一、达意和简洁。1.1.1统一统一是指，对于同一个概念，在程序中用同一种表示方法，比如对于供应商，既可以用supplier，也可以用provider，但是我们只能选定一个使用，至少在一个Java项目中保持统一。统一是作为重要的，如果对同一概念有不同的表示

2、方法，会使代码混乱难以理解。即使不能取得好的名称，但是只要统一，阅读起来也不会太困难，因为阅读者只要理解一次。1.1.2达意达意是指，标识符能准确的表达出它所代表的意义，比如：newSupplier,OrderPaymentGatewayService等；而supplier1,service2，idtts等则不是好的命名方式。准确有两成含义，一是正确，而是丰富。如果给一个代表供应商的变量起名是order，显然没有正确表达。同样的，supplier1,远没有targetSupplier意义丰富。1.1.3简洁简洁是指

3、，在统一和达意的前提下，用尽量少的标识符。如果不能达意，宁愿不要简洁。比如：theOrderNameOfTheTargetSupplierWhichIsTransfered太长，transferedTargetSupplierOrderName则较好，但是transTgtSplOrdNm就不好了。省略元音的缩写方式不要使用，我们的英语往往还没有好到看得懂奇怪的缩写。1.1.4骆驼法则Java中，除了包名，静态常量等特殊情况，大部分情况下标识符使用骆驼法则，即单词之间不使用特殊符号分割，而是通过首字母大写来分割。比如

4、:supplierName,addNewContract，而不是supplier_name,add_new_contract。1.1.5英文vs拼音尽量使用通俗易懂的英文单词，如果不会可以向队友求助，实在不行则使用汉语拼音，避免拼音与英文混用。比如表示归档，用archive比较好,用pigeonhole则不好，用guiDang尚可接受。1.2包名使用小写字母如com.xxx.settlment，不要com.xxx.Settlement单词间不要用字符隔开，比如com.xxx.settlment.jsfutil，而不

5、要com.xxx.settlement.jsf_util1.3类名1.3.1首字母大写类名要首字母大写，比如SupplierService,PaymentOrderAction；不要supplierService,paymentOrderAction.1.3.2后缀类名往往用不同的后缀表达额外的意思，如下表：后缀名意义举例Service表明这个类是个服务类，里面包含了给其他类提同业务服务的方法PaymentOrderServiceImpl这个类是一个实现类，而不是接口PaymentOrderServiceImplI

6、nter这个类是一个接口LifeCycleInterDao这个类封装了数据访问方法PaymentOrderDaoAction直接处理页面请求，管理页面逻辑了类UpdateOrderListActionListener响应某种事件的类PaymentSuccessListenerEvent这个类代表了某种事件PaymentSuccessEventServlet一个ServletPaymentCallbackServletFactory生成某种对象工厂的类PaymentOrderFactoryAdapter用来连接某种以

7、前不被支持的对象的类DatabaseLogAdapterJob某种按时间运行的任务PaymentOrderCancelJobWrapper这是一个包装类，为了给某个类提供没有的能力SelectableOrderListWrapperBean这是一个POJOMenuStateBean1.4方法名首字母小写，如addOrder()不要AddOrder()动词在前，如addOrder()，不要orderAdd()动词前缀往往表达特定的含义，如下表：前缀名意义举例create创建createOrder()delete删除d

8、eleteOrder()add创建，暗示新创建的对象属于某个集合addPaidOrder()remove删除removeOrder()init或则initialize初始化，暗示会做些诸如获取资源等特殊动作initializeObjectPooldestroy销毁，暗示会做些诸如释放资源的特殊动作destroyObjectPoolopen打开openConn