阿里巴巴开发规范文档解读(一):命名规范

此文档为阿里巴巴开发规范,网上即可找到。闲时看的话做不到学以致用,吸收效率低;在开发途中研究此文档将事半功倍,但是开发的时候时间紧,任务重,没有时间去看这种文档,真是悖论啊。本博主按照比较适用的方式解读,希望能够让你很容易的记住这些规范,归纳如下:

一.命名风格

1.包名:全部使用小写,点分隔符之间有且仅有一个单词

2.类名:驼峰式命名,不能使用拼音

i.测试类以测试类开头,以Test结尾; 
ii.异常类以Exception结尾; 
iii.抽象类以Abstract或Base开头。
iv.工厂类以Factory结尾
v.公共类以Command结尾
vi.枚举类型以Enum结尾,成员变量全部大写,单词之间以_隔开,
vii.常数类以Constant结尾

3.方法名:首字母小写, 其他单词首字母大写

i.获取单个对象使用get-
ii.获取多个对象使用list-
iii.获取统计值使用count-
iv.插入使用insert-/save-
v.删除使用remove-/delete-
vi.修改使用update-
vii.manage 中的方法和字段不要加任何修饰符(public也不要加,保持代码的整洁性)
viii.对于Service和Dao层的实现类,使用Impl后缀; 
	对于形容能力的接口,其实现类推荐使用-able后缀。 AbstractTranslate -- Translatable   

4.成员变量名:首字母小写其他单词首字母大写,不能以_与$开始(杜绝不规范缩写,最好使用完整的单词,尽量不要缩写)

 VO(view object, 值对象, 出参),DTO(data transfer object, 数据传输对象, 入参),
 BO(business, 业务对象),DO(domain, 领域对象), AO(),PO(持久对象)
i.-DO :数据表名对象以DO结尾
ii.-DTO : 非查询入参以DTO结尾
iii.-Query : 查询类入参以Query结尾
iv.-VO : 出参以VO结尾
v.常量使用全大写,单词之间用_分隔

你可能感兴趣的:(java代码规范)