阿里巴巴编码规范 一、编程规约

1.【强制】代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束。

2.【强制】代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。

3.【强制】类名使用UpperCamelCase风格,但一下情形例外:DO/BO/DTO/VO/AO/PO/UID 等。

4.【强制】方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase风格,必须遵从驼峰形式

5.【强制】常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌名字长。

6.【强制】抽象类命名使用Abstract 或 Base 开头;异常类命名使用Exception结尾;测试类命名以它要测试的类的名称开始,以Test结尾。

7.【强制】类型与中括号紧挨相连来表示数组。

8.【强制】POJO类中布尔类型变量都不要加is前缀,否则部分框架解析会引起序列化错误。

9.【强制】包名统一使用小写,点分隔符之间有且仅有一个自然语义的英文单词。包名统一使用单数形式,但是类名如果有复数含义,类名可以使用复数形式

10.【强制】避免在子父类的成员变量之间、或者不同代码快的局部变量之间采用完全相同的命名,使可读性降低。

      说明:子类、父类成员变量名相同,即使是public类型的变量也是能够通过编译,而局部变量在同一个方法内的不同代码块中同名也是合法的,但是避免使用。对于非setter/getter的参数名称也要避免与成员变量名称相同。

11.【强制】杜绝完全不规范的缩写,避免望文不如义。

12.【推荐】为了达到代码自解释的目标,任务自定义编程元素在命名时,使用尽量完整的单词组合来表达其意。

13.【推荐】在常量与变量的命名时,表示类型的名字放在词尾,以提升辨识度。

14.【推荐】如果模块、接口、类、方法使用了设计模式,在命名时需体现出具体模式。

     说明:将设计模式 体现在名字中,有利于阅读者快速理解架构设计理念

15.【推荐】接口类中的方法和属性不要加任何修饰符(public 也不要加),保持代码的简洁性,并加上有效的JavaDoc注释。尽量不要在接口里定义变量,如果一定要定义变量,肯定时与接口方法相关,并且时整个应用的基础常量。

    正例:接口方法签名void commit();

               接口基础常量 String COMPANY = “alibaba”;

    反列:接口方法定义 public abstract void f();

16.接口和实现类的命名有两套规则:

    1)【强制】对于Service 和 DAO 类,基于SOA的理念,暴露出来的服务一定是接口,内部的实现类用Impl 的后缀与接口区别

    2)【推荐】如果是形容能力的接口名称,取对应的形容词为接口名(通常是-able的形容词)。

17.【参考】枚举类名带上 Enum 后缀,枚举成员名称需要全大写,单词间用下划线隔开。   

    说明:枚举其实就是特殊的类,域成员均为常量,且构造方法被默认强制是私有。

    正列:枚举名字为 ProcessStatusEnum 的成员名称:SUCCESS/ UNKNOWN_REASON

18.【参考】各层命名规约:

    A)Service/DAO层方法命名规约

       1)获取单个对象的方法用 get 做前缀。

        2)获取多个对象的方法用 list 做前缀,复数形式结尾如:listObjects。

        3)获取统计值的方法用 count 做前缀。

        4)  插入的方法用 save/insert 做前缀。

        5)删除的方法用 remove/delete 做前缀。

        6)修改的方法用 update 做前缀。

    B)领域模型命名规约

        1) 数据对象:xxxDO,xxx即为数据表名。

         2)数据传输对象:xxxDTO,xxx 为业务领域相关的名称。

         3) 展示对象:xxxVO,xxx一般为网页名称。

          4)POJO 是 DO/DTO/BO/VO的统称,禁止命名成xxxPOJO。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,496评论 6 501
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,407评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,632评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,180评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,198评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,165评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,052评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,910评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,324评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,542评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,711评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,424评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,017评论 3 326
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,668评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,823评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,722评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,611评论 2 353

推荐阅读更多精彩内容