没有合适的资源?快使用搜索试试~ 我知道了~
java代码规范
资源推荐
资源详情
资源评论
产品二科
Java 代码规范
本 Java 代码规范以 SUN 的标准 Java 代码规范为基础,为适应我们公司的实际需要,可能
会做一些修改。本文档中没有说明的地方,请参看 SUN Java 标准代码规范。如果两边有
冲突,以 SUN Java 标准为准。
1. 标识符命名规范
1.1 概述
标识符的命名力求做到统一、达意和简洁。尽量做到每个人按照规范来,多人开发如一人
开发一样。
1.1.1 统一
统一是指,对于同一个概念,在程序中用同一种表示方法,比如对于供应商,既可以用
supplier,也可以用 provider,但是我们只能选定一个使用,至少在一个 Java 项目中保持
统一。统一是作为重要的,如果对同一概念有不同的表示方法,会使代码混乱难以理解。
即使不能取得好的名称,但是只要统一,阅读起来也不会太困难,因为阅读者只要理解一
次。
1.1.2 达意
达意是指,标识符能准确的表达出它所代表的意义,比如: newSupplier,
OrderPaymentGatewayService 等;而 supplier1, service2,idtts 等则不是好的命名方式。
准确有两成含义,一是正确,而是丰富。如果给一个代表供应商的变量起名是 order,显
然没有正确表达。同样的,supplier1, 远没有 targetSupplier 意义丰富。
1.1.3 简洁
简洁是指,在统一和达意的前提下,用尽量少的标识符。如果不能达意,宁愿不要简洁。
比如:theOrderNameOfTheTargetSupplierWhichIsTransfered 太长,
transferedTargetSupplierOrderName 则较好,但是 transTgtSplOrdNm 就不好了。省略元
音的缩写方式不要使用,我们的英语往往还没有好到看得懂奇怪的缩写。
1.1.4 骆驼法则
Java 中,除了包名,静态常量等特殊情况,大部分情况下标识符使用骆驼法则,即单词之
间不使用特殊符号分割,而是通过首字母大写来分割。比如: supplierName,
addNewContract,而不是 supplier_name, add_new_contract。
1.1.5 英文 vs 拼音
产品二科
尽量使用通俗易懂的英文单词,如果不会可以向队友求助,实在不行则使用汉语拼音,避
免拼音与英文混用。比如表示归档,用 archive 比较好, 用 pigeonhole 则不好,用 guiDang
尚可接受。
1.2 包名
使用小写字母如 com.amerisia.ebills,不要 com.amerisia.Ebills
单词间不要用字符隔开,比如 com.amerisia.ebills,而不要 com.amerisia.ebills _util
1.3 类名
1.3.1 首字母大写
类名要首字母大写,比如 LCIssueInfoManagerEJB, LCIssueAction;不要
lcIssueInfoManagerEJB, lcIssueAction.
1.3.2 后缀
类名往往用不同的后缀表达额外的意思,如下表:
后缀名 意义 举例
EJB
表示这个类为 EJB 类
LCIssueInfoManagerEJB
Service
表明这个类是个服务类,里面包含了给其他类提同
业务服务的方法
PaymentOrderService
Impl
这个类是一个实现类,而不是接口
PaymentOrderServiceImpl
Inter
这个类是一个接口
LifeCycleInter
Dao
这个类封装了数据访问方法
PaymentOrderDao
Action
直接处理页面请求,管理页面逻辑了类
UpdateOrderListAction
Listener
响应某种事件的类
PaymentSuccessListener
Event
这个类代表了某种事件
PaymentSuccessEvent
Servlet
一个 Servlet
PaymentCallbackServlet
Factory
生成某种对象工厂的类
PaymentOrderFactory
Adapter
用来连接某种以前不被支持的对象的类
DatabaseLogAdapter
Job
某种按时间运行的任务
PaymentOrderCancelJob
Wrapper
这是一个包装类,为了给某个类提供没有的能力
SelectableOrderListWrapper
Bean
这是一个 POJO
MenuStateBean
1.4 方法名
首字母小写,如 addOrder() 不要 AddOrder()
动词在前,如 addOrder(),不要 orderAdd()
产品二科
查询方法要查询的内容在前,条件在后。 如 getXxByXx()
动词前缀往往表达特定的含义,如下表:
前缀名 意义 举例
create
创建
createOrder()
delete
删除
deleteOrder()
add
创建,暗示新创建的对象属于某个集合
addPaidOrder()
remove
删除
removeOrder()
init 或则 initialize
初始化,暗示会做些诸如获取资源等特
殊动作
initializeObjectPool
destroy
销毁,暗示会做些诸如释放资源的特殊
动作
destroyObjectPool
open
打开
openConnection()
close
关闭
closeConnection()<
read
读取
readUserName()
write
写入
writeUserName()
get
获得
getName()
set
设置
setName()
prepare
准备
prepareOrderList()
copy
复制
copyCustomerList()
modity
修改
modifyActualTotalAmount()
calculate
数值计算
calculateCommission()
do
执行某个过程或流程
doOrderCancelJob()
dispatch
判断程序流程转向
dispatchUserRequest()
start
开始
startOrderProcessing()
stop
结束
stopOrderProcessing()
send
发送某个消息或事件
sendOrderPaidMessage()
receive
接受消息或时间
receiveOrderPaidMessgae()
respond
响应用户动作
responseOrderListItemClicked()
find
查找对象
findNewSupplier()
update
更新对象
updateCommission()
find 方法在业务层尽量表达业务含义,比如 findUnsettledOrders(),查询未结算订单,而
不要 findOrdersByStatus()。 数据访问层,find,update 等方法可以表达要执行的 sql,比如
findByStatusAndSupplierIdOrderByName(Status.PAID, 345)
1.5 域(field)名
剩余12页未读,继续阅读
资源评论
Cssis
- 粉丝: 0
- 资源: 6
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功