JAVA代码规范详细版.pdfVIP

JJAAVVAA代代码码规规范范

本Java代码规范以SUN的标准Java代码规范为基础，为适应我们公司的实际需要，可能

做一些修改。本文档中没有说明的地方，请参看SUNJava标准代码规范。如果两边有冲突，

以SUNJava标准为准。

11..标标识识符符命命名名规规范范

概概述述

标识符的命名力求做到统一、达意和简洁。

统统一一

统一是指，对于同一个概念，在程序中用同一种表示方法，比如对于供应商，既可以用

supplier，也可以用provider，但是我们只能选定一个使用，至少在一个Java项目中保持

统一。统一是作为重要的，如果对同一概念有不同的表示方法，使代码混乱难以理解。即

使不能取得好的名称，但是只要统一，阅读起来也不太困难，因为阅读者只要理解一次。

达达意意

达意是指，标识符能准确的表达出它所代表的意义，比如：newSupplier,

OrderPaymentGatewayService等；而supplier1,service2，idtts等则不是好的命名方式。

准确有两成含义，一是正确，而是丰富。如果给一个代表供应商的变量起名是order，显然

没有正确表达。同样的，supplier1,远没有targetSupplier意义丰富。

简简洁洁

简洁是指，在统一和达意的前提下，用尽量少的标识符。如果不能达意，宁愿不要简洁。比

如：theOrderNameOfTheTargetSupplierWhichIsTransfered太长，

transferedTargetSupplierOrderName则较好，但是transTgtSplOrdNm就不好了。省略元

音的缩写方式不要使用，我们的英语往往还没有好到看得懂奇怪的缩写。

骆骆驼驼法法则则

Java中，除了包名，静态常量等特殊情况，大部分情况下标识符使用骆驼法则，单词之

间不使用特殊符号分割，而是通过首字母大写来分割。比如:supplierName,

addNewContract，而不是supplier_name,add_new_contract。

英英文文vvss拼拼音音

尽量使用通俗易懂的英文单词，如果不会可以向队友求助，实在不行则使用汉语拼音，避免

拼音与英文混用。比如表示归档，用archive比较好,用pigeonhole则不好，用guiDang

尚可接受。

包包名名

使用小写字母如，不要

单词间不要用字符隔开，比如，而不要类类名名

首首字字母母大大写写

类名要首字母大写，比如SupplierService,PaymentOrderAction；不要supplierService,

paymentOrderAction.

后后缀缀

类名往往用不同的后缀表达额外的意思，如下表：

#

后缀名举例

意义

表明这个类是个服务类，里面包含了给其他类提同

ServicePaymentOrderService

业务服务的方法

Impl这个类是一个实现类，而不是接口PaymentOrderServiceImpl

Inter这个类是一个接口LifeCycleInter

$

这个类封装了数据访问方法PaymentOrderDao

Dao

Action直接处理页面请求，管理页面逻辑了类UpdateOrderListAction

Listener响应某种事件的类PaymentSuccessListener

{

Event这个类代表了某种事件

PaymentSucc