阿里巴巴Java编码规范.pdf

5星(超过95%的资源)
所需积分/C币:42 2018-02-26 22:01:13 798KB PDF
162
收藏 收藏
举报

编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范
目录 前言 、编程规约 (一)命名风格 (二)常量定义 (三)代码格式 画 (四)00P规约 (五)集合处理 469 (六)并发处理. .12 (七)控制语句. ....14 (八)注释规约 (九)其它 17 、异常日志 18 (一)异常处理. 18 (二)日志规约 19 、单元测试 21 四、安全规约 23 五、 MySQL数据库 24 (一)建表规约 24 (二)索引规约. 25 (三)SQL语句 27 (四)0RM映射..28 六、工程结构 30 (-)应用分层 30 (二)二方库依赖 31 (三)服务器 32 附1:版本历史. 34 附2:本手册专有名词 35 (注:浏览时请使用PDF左侧导航栏 阿里巴巴]ava开发手册 java开发手册 版本号 制定团队 更新日期 备注 阿里巴巴集团技术团队 2017。9。25 增加单元测试规约(PDF终极版) 、编程规约 (一)命名风格 1.【强制】代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结東 Ix1:_name/name object name/ name$ Object$ 2.【强制】代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。 说眀:正确的英文拼写和语法可以让阅读者易于理解,避免歧义。注意,即使纯拼音命名方式 也要避免采用 正例: alibaba/ taobao/ youku/ hangzhou等国际通用的名称,可视同英文 反例: DaZhe promotion[打折]/ getpingfenByName()[评分]/int某变量=3 3.【强制】类名使用 Upper CamelCase风格,必须遵从驼峰形式,但以下情形例外:Do/Bo/ DTO/V0/ IEB: MarcoPolo UserDO XmlService TcpUdp Deal/TaPromotion kv: macroPolo/UserDo/ XMLService TCPUD PDeal/TAPromotion 4。【强制】方法名、参数名、成员变量、局部变量都统一使用1 ower CamelCase风格,必须遵从 驼峰形式 IeB:Localvalue/gethttpmesSage()/inputUserid 5.【强制】常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌名字长。 正例: MAX STOCK COUNT 反例: MAX COUNT 6.【强制】抽象类命名使用 Abstract或Base开头:异常类命名使用 Exception结尾:测试类 命名以它要测试的类的名称开始,以Test结尾 7.【強制】中括号是数组类型的一部分,数组定义如下: string[]args; 反例:使用 String aIgs[]的方式来定义。 8.【强制】P0〕0类中布尔类型的变量,都不要加is,否则部分框架解析会引起序列化错误 反例:定义为基木数据类型 BooLean isdeleted;的属性,它的方法也是 is Deleted(),RPC -禁止用于商业用途,违者必究一 /35 阿里巴巴]ava开发手册 框架在反向解析的时候,“以为”对应的属性名称是 deleted,导致属性获取不到,进而拋岀异 常 9.【强制】包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。包名统一使川 单数形式,但是类名如果有复数含义,类名可以使用复数形式。 正例:应用工具类包名为com, alibaba.open,utiL、类名为 MessageUtils(此规则参考 spring的框架结构) 1⑧.【强制】杜绝完全不规范的缩写,避免望文不知义。 反例: Abstractclass“缩写”命名成 Absciss; condition“缩写”命名成 condi,此类随 意缩写严重降低了代码的可阅读性。 11.【推荐】为了达到代码白解释的目标,任何自定义编程元素在命名时,使用尽量完整的单词 组合来表达其意。 正例:从远程仓库拉取代码的类命名为 PullCode From Remote Repository 反例:变量inta;的随意命名方式 12.【推荐】如果模块、接口、类、方法使用了设计模式,在命名时体现岀具体模式。 说明:将设计模式休现在名字中,有利于阅读者快速理解架构设计理念。 正例: public class0 IderFactory; public class LoginProxy i public class Resourceobserver; 13.【推荐】接口类中的方法和属性不要加任何修饰符号( public也不要加),保持代码的简洁 性,并加上冇效的 Javadoc注释。尽量不要在接凵里定乂变量,如果定要定义变量,肯定是 与接口方法相关,并且是整个应用的基础常量 正例:接口方法签名: void f(); 接口基础常量表示: String COMPANY=" alibaba"; 反例:接口方法定义: public abstract void f(); 说明:jDK8中接口允许有默认实现,那么这个 default方法,是对所有实现类都有价值的默 认实现。 14.接口和实现类的命名有两套规则: 1)【强制】对于 Service和DAo0类,基于S0A的理念,暴露出来的服务一定是接口,内部 的实现类用Impl的后缀与接口区别。 正例: CacheserviceImpl实现 Cacheservice接口。 2)【推荐】如果是形容能力的接凵名称,取对应的形容词做接凵名(通常是-abLe的形式) 正例: Abstracttranslator实现 Translatable —棼止用于商业用途,违者必究 2/35 阿里巴巴]ava开发手册 15.【参考】枚举类名建议带上Enum后缀,枚举成员名称需要全大写,单词间用下划线隔开 说眀:枚举其实就是特殊的常量类,且构造方法被默认强制是私有。 正例:枚举名字为 Processstatus enum的成员名称: SUCCESS/ UNKOWN REASON 16.【参考】各层命名规约 A) Service/DAo层方法命名规约 1)获取单个对象的方法用get做前缀。 2)获取多个对象的方法用tist做前缀。 3)获取统计值的方法用 count做前缀。 4)插入的方法用save/ insert做前缀。 5)删除的方法用 remove/ delete做前缀 6)修改的方法用 update做前缀 B)领域模型命名规约 1)数据对象:XXxD0,xXx即为数据表名。 2)数据传输对象:xxDT0,xx为业务领域相关的名称 3)展示对象:XXxV0,XX一般为网页名称。 4)PoJ0是Do/DTO/B0/Vo的统称,禁止命名成xxxP0J0 (二)常量定义 1.【强制】不允许仁何魔法值(即未经定义的常量)直接出现在代码中 反例: String key="Id# taobao_"+ traded; cache put(key, value); 2.【强制】ong或者Long初始赋值时,使用大写的L,不能是小写的,小写容易跟数字1混 淆,造成误解 说明: Long a=21;写的是数字的21,还是Long型的2? 3.【推荐】不要使用一个常量类维护所有常量,按常量功能进行归类,分开维扩。 说明:大而仝的常量类,非得使用査找功能才能定位到修改的常量,不利于理解和维护 正例:缓存相关常量放在类 Cacheconsts下:系统配置相关常量放在类 Configconsts下 4.【推荐】常量的复川层次有五层:跨应用共享常量、应川内共享常量、子工程内共享常量、包 内共享常量、类内共享常量。 1)跨应用共享常量:放置在二方库中,通常是 client.jar中的 constant目录下。 2)应用内共享常量:放置在一方库中,通常是modu1es中的 constant日录下 反例:易懂变量也要统一定义成应用内共享常量,两位攻城师在两个类中分別定义了表示 是”的变量: 一禁止用于商业用途,违者必究 3/35 阿里巴巴]ava开发手册 类A中: public static final String YES="yes"; 类B中: public static final String YES A.YES. equals(B.YES),预期是true,但实际返回为 false,导致线上问题 3)子工程内部共享常量:即在当前子工程的 constant目录下 4)包内共亨常量:即在当前包下单独的 constant目录下 5)类内共享常量:直接在类内部 private static fina定义。 5.【推荐】如果变量值仅在一个范围内变化,且带有名称之外的延伸属性,定义为枚举类。下面 正例中的数字就是延伸信息,表示星期几。 IEv ] public Enum MONDAY (1), TUESDAY( 2), WEDNESDAY(3), THURSDAY(4), FRIDAY(5), SATURDAY(6) SUNDAY (7) (三)代码格式 1.【强制】大括号的使用约定。如果是大括号内为空,则简洁地写成{}即可,不需要换行;如果 是非空代码块则: 1)左大括号前不换行 2)左人括号后换行 3)右大括号前换行。 4)右大括号后还有else等代码则不换行;表示终止的右大括号后必须换行 2.【强制】左小括号和字符之间不出现空格;同样,右小括号和字符之间也不出现空格。详见 第5条下方正例提示 反例:if(空格a=b空格) 3.【强制】if/for/ while/ switch/do等保留字与括号之间都必须加空格。 4.【强制】任何二日、三目运算符的左右两边都需要加一个空格。 说明:运算符包括赋值运算符=、逻辑运算符&&、加减乘除符号等。 5.【强制】采用4个空格缩进,禁止使用tab字符。 说明:如果使用tab缩进,必须设置1个tab为4个空格。IDEA设置tab为4个空格时 请勿勾选 Use tab character;而在 eclipse中,必须勾选 insert spaces for tabs。 正例:(涉及1-5点) public static void main(String[] args)i //缩进4个空格 String say -"hello"j //运算符的左右必须有一个空格 int flag —棼止用于商业用途,违者必究 4/35 阿里巴巴]ava开发手册 /}关键词if与括号之间必须有一个空格,括号内的f与左括号,⑧与右括号不需要空格 if (flag ==0)t System. out. printIn(say) //左大活号前加空格且不换行:左大括号后換行 f (flag = 1)i ystem out println("world"); 右大括号前换行,右大括号后有eLse,不用换行 y else i ystem out println("ok" //在右大括号后直接结束,则必须換行 6.【强制】注释的双斜线与注释内容之间有且仅有一个空格。 正例://注释内容,注意在//和注释内容之间有一个空格。 7.【强制】单行字符数限制不超过120个,超岀需要换行,换行时遵循如下原则: 1)第二行相对第一行缩进4个空格,从第三行开始,不再继续缩进,参考示例。 2)运算符与下文一起换行。 3)方法调用的点符号与下文一起换行。 4)方法调用时,多个参数,需要换行吋,在逗号后进行。 5)在括号前不要换行,见反例。 正例 StringBuffer sb= new StringBuffer(): ∥超过120个字符的情况下,换行缩进4个空格,点号和方法名称一起换行 sb. append ("zi").append (" xin") append("huang") append ("huang") append("huang"); 反例: StringBuffer sb= new StringBuffer(); //超过126个字符的情况下,不要在括号前换行 sb. append ("zi"). append("xin"). append (" huang") /参数很多的方法调用可能超过120个字符,不要在逗号前换行 method (argsl, args2, args, args); 8.【强制】方法参数在定义和传入时,多个参数逗号后边必须加空格。 正例:下例中实参的"a",后边必须要有一个空格。 method ("a","b","c") 9.【强制】IDE的 text file encoding设置为UTF-8;IDE中文件的换行符使用Unix格式, 不要使用 Windows格式。 一禁止用于商业用途,违者必究 5/35 阿里巴巴]ava开发手册 1θ.【推荐】没有必要增加若十空格来使某一行的字符与上一行对应位置的字符对齐。 正例: int a =3 Long b = 4L; float c= 5f: StringBuffer sb= new StringBuffer(): 说明:增加sb这个变量,如果需要对齐,则给a、b、c都要增加几个空格,在变量比较多的 情况下,是一种累赘的事情。 11.【推荐】方法体内的执行语句组、变量的定义语句组、不同的业务逻辑之间或者不同的语义 之间插入一个空行。相同业务逻辑和语义之间不需要插入空行 说明:没有必要插入多个空行进行隔开。 (四)0OP规约 1.【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法,无谓增加编译器解析成 本,直接用类名来访问即可 2.【强制】所有的覆写方法,必须加@ Override注解 说明: getobject()与get0 bject()的问题。个是字母的0,个是数字的⊙,加@ Override 可以准确判断是否覆盖成功。另外,如果在抽象类中对方法签名进行修改,其实现类会马上编 译报错。 3.【强制】相同参数类型,相同业务含义,才可以使用java的可变参数,避免使用 object。 说明:可变参数必须放置在参数列表的最后。(提倡同学们尽量不用可变参数编程) IE1]: public User getUsers(String type, Integer.. ids)f.) 4。【强制】外部正在调用或者二方库依赖的接口,不允许修改方法签名,避免对接口调用方产生 影响。接口过时必须加@ Deprecated注解,并清晰地说明采用的新接口或者新服务是什么。 5.【强制】不能使用过时的类或方法 说明:java.net. URLDecoder中的方法 decode( String encodestr)这个方法已经过时,应 该使用双参数 decode( String source, String encode)。接凵提供方既然明确是过时接凵, 那么有义务同时提供新的接口;作为调用方来说,有义务去考证过时方法的新实现是什么。 6.【强制】 object的 equals方法容易抛空指针异常,应使用常量或铕定有值的对象来调用 equals。 正例:"test". equals( object); 反例 object equals( ntest 说明:推荐使用java.uti1.0 bjects# equals(]DK7引入的工具类 7.【强制】所有的相同类型的包装类对象之间值的比较,全部使用 equals方法比较。 说明:对于 Integer var=?在-128至127范围内的赋值, Integer对象是在 一禁止用于商业用途,违者必究 6/35 阿里巴巴]ava开发手册 Integer Cache, cache产生,会复用己有对象,这个区间内的 Integer值可以直接使用=进行 判断,但是这个区间之外的所有数据,都会在堆上产生,并不会复用已有对象,这是一个大坑, 推荐使用 equals方法进行判断 8.关于基本数据类型与包装数据类型的使用标准如下: 1)【强制】所有的P0]0类属性必须使用包装数据类型。 2)【强制】RPC方法的返回值和参数必须使用包装数据类型。 3)【推荐】所有的局部变量使用基本数据类型 说眀:PoJ0类属性没冇初值是提醒使用者在需要使用时,必须自己显式地进行赋值,任何 NPE问题,或者入库检查,都由使用者来保证。 正例:数据库的查询结果可能是nu1L,因为自动拆箱,用基本数据类型接收有NPE风险。 反例:比如显示成交总额涨跌情况,即正负x%,ⅹ为基木数据类型,调用的RPC服务,调用 不成功时,返回的是默认值,页面显小为0‰,这是不合理的,应该显小成中划线。所以包装 数据类型的nulL值,能够表示额外的信息,如:远程调用失败,异常退出。 9.【强制】定义D0/DT0/V0等PO]0类时,不要设定任何属性默认值。 反例:P00类的 gmtcreate默认值为 new Date();但是这个属性在数据提取时并没有置入具 体值,在更新其它字段吋又附带更新了此字段,导致创建吋间被修改成当前吋间。 1θ.【强制】序列化类新增属性时,请不要修改 serialversionUiD字段,避免反序列失败;如 果完全不兼容升级,避免反序列化混乱,那么请修改 serialversionUID值 说明:注意 serialversionulD不一致会抛出序列化运行时异常 11.【强制】构造方法里面禁止加入任何业务逻辑,如果有初始化逻辑,请放在init方法中。 12.【强制】P00类必须写 tostring方法。使用IDE的中工具: source> generate tostring 时,如果继承了另一个P0J0类,注意在前面加一下 super. tostring。 说明:在方法执行抛出异常时,可以直接调用P0]o的 tostring()方法打印其属性值,便于排 查问题。 13.【推荐】使用索引访问用 String的spit方法得到的数组时,需做最后一个分隔符后有无 内容的检查,否则会有抛 IndexoutofBoundsException的风险 说明 String str =a, b,c String[] ary str split( /预期大于3,结果是3 System. out. println(ary length); 14.【推荐】当一个类有多个构造方法,或者多个同名方法,这些方法应该按顺序放置在一起, 便于阅读,此条规则优先于第15条规则。 15.【推荐】类内方法定义顺序依次是:公有方法或保护方法>私有方法> getter/ setter 方法 一禁止用于商业用途,违者必究 7/35

...展开详情
试读 39P 阿里巴巴Java编码规范.pdf
立即下载 低至0.43元/次 身份认证VIP会员低至7折
一个资源只可评论一次,评论内容不能少于5个字
多来哈米 感情我下载两次了,还是要积分呢
2020-01-20
回复
君梦无悔 3q,共同学习,共同进步
2019-03-24
回复
您会向同学/朋友/同事推荐我们的CSDN下载吗?
谢谢参与!您的真实评价是我们改进的动力~
关注 私信
上传资源赚钱or赚积分
最新推荐
阿里巴巴Java编码规范.pdf 42积分/C币 立即下载
1/39
阿里巴巴Java编码规范.pdf第1页
阿里巴巴Java编码规范.pdf第2页
阿里巴巴Java编码规范.pdf第3页
阿里巴巴Java编码规范.pdf第4页
阿里巴巴Java编码规范.pdf第5页
阿里巴巴Java编码规范.pdf第6页
阿里巴巴Java编码规范.pdf第7页
阿里巴巴Java编码规范.pdf第8页

试读结束, 可继续读4页

42积分/C币 立即下载 >