软件编程规范剖析.docxVIP

软件变成规范 版权所有 密级： 第 PAGE \* MERGEFORMAT 28页共 NUMPAGES 28页 软件变成规范（java） (V1.0.0) 工程目录 WEB-ROOT ? : ? 根目录，一般虚拟目录会直接在此目录中设置 | ?WEB-INF ?整个WEB中最安全的目录，无法直接访问，若访问，需要在web.xml中配置：见图 |-- classes 保存所有的*.class文件 所有的class都要放在 包中 |-- lib 存放第三方的jar文件 |-- web.xml WEB的部署描述符 | css 存放所有的*.css文件 | js 存放所有的*.js文件 | jsp 存放所有的jsp文件 | index.htm, index.jsp 欢迎页面 Java代码规范 本Java代码规范以SUN的标准Java代码规范为基础，为适应我们公司的实际需要，可能会做一些修改。本文档中没有说明的地方，请参看SUN Java标准代码规范。如果两边有冲突，以SUN Java??准为准。 标识命名规范 概述 标识符的命名力求做到统一、达意和简洁。 统一： 统一是指，对于同一个概念，在程序中用同一种表示方法，比如对于供应商，既可以用supplier，也可以用provider，但是我们只能选定一个使用，至少在一个Java项目中保持统一。统一是作为重要的，如果对同一概念有不同的表示方法，会使代码混乱难以理解。即使不能取得好的名称，但是只要统一，阅读起来也不会太困难，因为阅读者只要理解一次。 达意： 达意是指，标识符能准确的表达出它所代表的意义，比如： newSupplier, OrderPaymentGatewayService等；而 supplier1, service2，idtts等则不是好的命名方式。准确有两成含义，一是正确，而是丰富。如果给一个代表供应商的变量起名是 order，显然没有正确表达。同样的，supplier1, 远没有targetSupplier意义丰富。 简洁： 简洁是指，在统一和达意的前提下，用尽量少的标识符。如果不能达意，宁愿不要简洁。比如：theOrderNameOfTheTargetSupplierWhichIsTransfered 太长， transferedTargetSupplierOrderName则较好，但是transTgtSplOrdNm就不好了。省略元音的缩写方式不要使用，我们的英语往往还没有好到看得懂奇怪的缩写。 骆驼法则： Java中，除了包名，静态常量等特殊情况，大部分情况下标识符使用骆驼法则，即单词之间不使用特殊符号分割，而是通过首字母大写来分割。比如: supplierName, addNewContract，而不是 supplier_name, add_new_contract。 英文VS拼音： 尽量使用通俗易懂的英文单词，如果不会可以向队友求助，实在不行则使用汉语拼音，避免拼音与英文混用。比如表示归档，用archive比较好, 用pigeonhole则不好，用guiDang尚可接受。 包名 使用小写字母如 com.xxx.settlment，不要 com.xxx.Settlement单词间不要用字符隔开，比如 com.xxx.settlment.jsfutil，而不要com.xxx.settlement.jsf_util 类名 首字母大写： 类名要首字母大写，比如 SupplierService, PaymentOrderAction；不要 supplierService, paymentOrderAction 后缀： 类名往往用不同的后缀表达额外的意思，如下表： 后缀名意义举例Service表明这个类是个服务类，里面包含了给其他类提同业务服务的方法PaymentOrderServiceImpl这个类是一个实现类，而不是接口PaymentOrderServiceImplInter这个类是一个接口LifeCycleInterDao这个类封装了数据访问方法PaymentOrderDaoAction直接处理页面请求，管理页面逻辑了类UpdateOrderListActionListener响应某种事件的类PaymentSuccessListenerEvent这个类代表了某种事件PaymentSuccessEventServlet一个ServletPaymentCallbackServletFactory生成某种对象工厂的类PaymentOrderFactory