精华内容
下载资源
问答
  • java开发规范手册 doc

    2018-10-31 17:09:36
    阿里Java开发手册终极版v1.9.0 word
  • Java开发规范

    2019-01-16 11:35:36
    阿里Java开发规范,帮助初学者能快速形成编码规范。
  • 阿里巴巴JAVA开发规范word 编程规约 异常日志 MySQL 规约 工程规约 阿里巴巴JAVA开发规范word 编程规约 异常日志 MySQL 规约 工程规约 阿里巴巴JAVA开发规范word 编程规约 异常日志 MySQL 规约 工程规约 阿里巴巴...
  • java开发规范

    2018-06-20 11:00:17
    Java开发规范编码规范开发的规范点击上传资源即表示您确认该资源不违反资源分享的使用条款,并且您拥有该资源的所有版权或者上传资源的授权
  • 阿里巴巴Java开发规范

    2018-05-21 14:11:09
    《阿里巴巴Java开发手册》,首次公开阿里官方Java代码规范标准。这套Java统一规范标准将有助于提高行业编码规范化水平,帮助行业人员提高开发质量和效率、大大降低代码维护成本。
  • java规范,阿里编码规约,规范开发java,编码规范,阿里,华山
  • Java开发规范(通用)

    2018-12-18 13:17:18
    这是一个很全面的Java开发规范,涉及到命名规则,常量定义,格式制约,oop,集合处理,并发处理,控制语句,注释规约,接口文档,异常处理,日志规约,建表规约,索引规约,SQL规约,orm规约,安全规约,git版本控制...
  • 阿里java开发规范插件idea eclipse 亲测好用,不好用退你积分
  • Java开发规范,Java开发标准,本规范是根据业界知名大厂结合本公司信息化标准要求制定的规范,现开放网络,希望对读者有所启示,带来参考意义
  • 阿里java开发规范

    2019-03-20 16:07:00
    阿里java开发规范
  • java开发规范思维导图,java开发规范脑图,xmind思维导图,可以继续编辑和修改
  • java开发规范文档

    2018-01-03 16:30:00
    java开发规范文档,适合初级开发者使用,第一次写java开发文档。
  • 阿里巴巴JAVA开发规范word和pdf去水印高清版
  • 新手入门必备java开发规范,不管是新手还是有经验的程序员,还是要按照规范来开发,大家都要认真阅读,并且规范自己公司的开发
  • 阿里Java开发规范

    2017-08-28 08:27:49
    阿里Java开发规范
  • Java开发规范.docx

    2020-03-26 10:18:43
    java开发规范,参照阿里的java开发规范进行编写。主要针对,代码的命名,代码的异处理,以及数据库的规范,进行了详细说明
  • Java项目开发规范参考

    2019-01-24 16:05:54
    为了使软件开发过程顺畅,保证软件质量,于是有了这份开发规范文档。 • 项目以功能模块来划分分工 • 数据库不能随意修改,本地数据库须统一 • 有标准的Java代码风格,有良好习惯 • 时刻考虑代码的可复用性 • 每...
  • 阿里巴巴Java代码开发规范,自动识别Java代码中的规范,语法错误等
  • 阿里巴巴 Java 开发规范手册.pdf.doc 同学们值得用户学习借鉴参考
  • 阿里巴巴java开发规范高清版pdf,非常好的java开发规范
  • 谷歌Java开发规范.rar

    2020-03-26 15:58:19
    Google公司推行的Java开发规范,旨在规范Java开发人员的编码。这套Java统一规范标准将有助于提高行业编码规范化水平,帮助行业人员提高开发质量和效率、大大降低代码维护成本。
  • 看到好多java开发规范手册都要10积分,资源是用来共享的,这个手册还行,给需要的人
  • java开发必备的东西,对于开发者来说用处非常大,给你保驾护航
  • 阿里巴巴java开发规范学习

    千次阅读 2019-05-12 10:39:31
    目录 一、编程规约 ...最近回顾了下一个多月前写的新项目,发现很多地方总感觉不太规范,从代码到数据库等,因此从网上下载了这份阿里巴巴java开发规范,学习记录下。 完整版手册下载地址:https:...

    目录

    一、编程规约

    1.1 命名风格

    1.2 常量定义

    1.3 代码格式

    ​1.4 OOP规约

    1.5 集合处理

    二、异常

    三、MYSQL数据库

    3.1 建表规约

    3.2 索引规约

    3.3 SQL语句


    最近回顾了下一个多月前写的新项目,发现很多地方总感觉不太规范,从代码到数据库等,因此从网上下载了这份阿里巴巴java开发规范,学习记录下。

    完整版手册下载地址:https://102.alibaba.com/downloadFile.do?file=1528269849853/Java_manual.pdf

    本文会记录一些从中摘取的内容。

    一、编程规约

    1.1 命名风格

    1、【强制】常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌名字长。 
    正例:MAX_STOCK_COUNT
    反例:MAX_COUNT

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

    3、【强制】类型与中括号紧挨相连来表示数组。 
    正例:定义整形数组 int[] arrayDemo;
    反例:在 main 参数中,使用 String args[]来定义。

    4、【强制】POJO 类中布尔类型的变量,都不要加 is 前缀,否则部分框架解析会引起序列化错误。 反例:定义为基本数据类型Boolean isDeleted的属性,它的方法也是isDeleted(),RPC
    框架在反向解析的时候,“误以为”对应的属性名称是 deleted,导致属性获取不到,进而抛
    出异常。

    5、【强制】包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用 单数形式,但是类名如果有复数含义,类名可以使用复数形式。
    正例:应用工具类包名为 com.alibaba.ai.util、类名为 MessageUtils(此规则参考 spring 的框架结构)

    6、【推荐】接口类中的方法和属性不要加任何修饰符号(public 也不要加),保持代码的简洁 性,并加上有效的 Javadoc 注释。尽量不要在接口里定义变量,如果一定要定义变量,肯定是 与接口方法相关,并且是整个应用的基础常量。
    正例:接口方法签名void commit();
    接口基础常量String COMPANY = "alibaba";
    反例:接口方法定义public abstract void f();
    说明:JDK8 中接口允许有默认实现,那么这个 default 方法,是对所有实现类都有价值的默 认实现。

    7、【参考】枚举类名建议带上 Enum 后缀,枚举成员名称需要全大写,单词间用下划线隔开。
    说明:枚举其实就是特殊的类,域成员均为常量,且构造方法被默认强制是私有。 正例:枚举名字为ProcessStatusEnum的成员名称:SUCCESS / UNKNOWN_REASON。

    8、【参考】各层命名规约:
    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。

    1.2 常量定义

    1、【强制】在 long 或者 Long 赋值时,数值后使用大写的 L,不能是小写的 l,小写容易跟数字 1 混淆,造成误解。
    说明:Long a = 2l; 写的是数字的21,还是Long型的2?

    1.3 代码格式

    1、【强制】单行字符数限制不超过 120 个,超出需要换行,换行时遵循如下原则: 1) 第二行相对第一行缩进 4 个空格,从第三行开始,不再继续缩进,参考示例。
    2) 运算符与下文一起换行。
    3) 方法调用的点符号与下文一起换行。
    4) 方法调用中的多个参数需要换行时,在逗号后进行。 
    5) 在括号前不要换行,见反例。
    正例:

    反例:

    2、【推荐】不同逻辑、不同语义、不同业务的代码之间插入一个空行分隔开来以提升可读性。 说明:任何情形,没有必要插入多个空行进行隔开。

    3、【强制】采用 4 个空格缩进,禁止使用 tab 字符。
    说明:如果使用 tab 缩进,必须设置 1 个 tab 为 4 个空格。IDEA 设置 tab 为 4 个空格时, 请勿勾选Use tab character;而在 eclipse 中,必须勾选insert spaces for tabs

    正例:


    1.4 OOP规约

    1、【强制】外部正在调用或者二方库依赖的接口,不允许修改方法签名,避免对接口调用方产生 影响。接口过时必须加@Deprecated 注解,并清晰地说明采用的新接口或者新服务是什么。

    2、【强制】POJO 类必须写 toString 方法。使用 IDE 中的工具:source> generate toString 时,如果继承了另一个 POJO 类,注意在前面加一下 super.toString。 
    说明:在方法执行抛出异常时,可以直接调用 POJO 的 toString()方法打印其属性值,便于排查问题。

    3、【推荐】 类内方法定义的顺序依次是:公有方法或保护方法 > 私有方法 > getter/setter 方法。
    说明:公有方法是类的调用者和维护者最关心的方法,首屏展示最好;保护方法虽然只是子类 关心,也可能是“模板设计模式”下的核心方法;而私有方法外部一般不需要特别关心,是一个 黑盒实现;因为承载的信息价值较低,所有 Service 和 DAO 的 getter/setter 方法放在类体 最后。

    4、【推荐】循环体内,字符串的连接方式,使用 StringBuilder 的 append 方法进行扩展。 说明:下例中,反编译出的字节码文件显示每次循环都会 new 出一个 StringBuilder 对象, 然后进行 append 操作,最后通过 toString 方法返回 String 对象,造成内存资源浪费。 反例:
    String str = "start";
    for (int i = 0; i < 100; i++) {
    str = str + "hello"; }

    5、【推荐】final 可以声明类、成员变量、方法、以及本地变量,下列情况使用 final 关键字: 1) 不允许被继承的类,如:String 类。
    2) 不允许修改引用的域对象。
    3) 不允许被重写的方法,如:POJO 类的 setter 方法。
    4) 不允许运行过程中重新赋值的局部变量。
    5) 避免上下文重复使用一个变量,使用 final 描述可以强制重新定义一个变量,方便更好 地进行重构。

    1.5 集合处理

    1、【强制】ArrayList的subList结果不可强转成ArrayList,否则会抛出ClassCastException 异常,即java.util.RandomAccessSubList cannot be cast to java.util.ArrayList。 说明:subList 返回的是 ArrayList 的内部类 SubList,并不是 ArrayList 而是 ArrayList 的一个视图,对于 SubList 子列表的所有操作最终会反映到原列表上。

    2、【强制】使用集合转数组的方法,必须使用集合的toArray(T[] array),传入的是类型完全
    一样的数组,大小就是 list.size()。
    说明:使用 toArray 带参方法,入参分配的数组空间不够大时,toArray 方法内部将重新分配
    内存空间,并返回新数组地址;如果数组元素个数大于实际所需,下标为[ list.size() ]
    的数组元素将被置为 null,其它数组元素保持原值,因此最好将方法入参数组大小定义与集
    合元素个数一致。
    正例:
    List<String> list = new ArrayList<String>(2); list.add("guan");
    list.add("bao");
    String[] array = new String[list.size()]; array = list.toArray(array);


    3、【强制】使用工具类 Arrays.asList()把数组转换成集合时,不能使用其修改集合相关的方 法,它的 add/remove/clear 方法会抛出 UnsupportedOperationException 异常。 说明:asList 的返回对象是一个 Arrays 内部类,并没有实现集合的修改方法。Arrays.asList 体现的是适配器模式,只是转换接口,后台的数据仍是数组。
           String[] str = new String[] { "you", "wu" };
    List list = Arrays.asList(str); 第一种情况:list.add("yangguanbao"); 运行时异常。 第二种情况:str[0] = "gujin"; 那么list.get(0)也会随之修改。

    4、【强制】 在 JDK7 版本及以上,Comparator 实现类要满足如下三个条件,不然 Arrays.sort, Collections.sort 会报 IllegalArgumentException 异常。
    说明:三个条件如下
    1) x,y的比较结果和y,x的比较结果相反。
    2) x>y,y>z,则x>z。
    3) x=y,则x,z比较结果和y,z比较结果相同。
     反例:下例中没有处理相等的情况,实际使用中可能会出现异常:
    new Comparator<Student>() {
    @Override
    public int compare(Student o1, Student o2) {
    return o1.getId() > o2.getId() ? 1 : -1; }
    };

    5、【参考】利用 Set 元素唯一的特性,可以快速对一个集合进行去重操作,避免使用 List 的 contains 方法进行遍历、对比、去重操作。

     

    二、异常

    1、【推荐】防止 NPE,是程序员的基本修养,注意 NPE 产生的场景: 1)返回类型为基本数据类型,return 包装数据类型的对象时,自动拆箱有可能产生 NPE。
    反例:public int f() { return Integer 对象}, 如果为 null,自动解箱抛 NPE。
    2) 数据库的查询结果可能为null。
    3) 集合里的元素即使isNotEmpty,取出的数据元素也可能为null。
    4) 远程调用返回对象时,一律要求进行空指针判断,防止NPE。
    5) 对于Session中获取的数据,建议NPE检查,避免空指针。
    6) 级联调用obj.getA().getB().getC();一连串调用,易产生NPE。
    正例:使用 JDK8 的 Optional 类来防止 NPE 问题。

     

    三、MYSQL数据库

    这也是我来寻找这篇规范的最初目的...

    3.1 建表规约

    1. 【强制】表达是与否概念的字段,必须使用 is_xxx 的方式命名,数据类型是 unsigned tinyint (1 表示是,0 表示否)。
    说明:任何字段如果为非负数,必须是 unsigned。
    注意:POJO 类中的任何布尔类型的变量,都不要加 is 前缀,所以,需要在<resultMap>设置 从 is_xxx 到 Xxx 的映射关系。数据库表示是与否的值,使用 tinyint 类型,坚持 is_xxx 的 命名方式是为了明确其取值含义与取值范围。
    正例:表达逻辑删除的字段名 is_deleted,1 表示删除,0 表示未删除。


    2. 【强制】表名、字段名必须使用小写字母或数字,禁止出现数字开头,禁止两个下划线中间只 出现数字。数据库字段名的修改代价很大,因为无法进行预发布,所以字段名称需要慎重考虑。 说明:MySQL 在 Windows 下不区分大小写,但在 Linux 下默认是区分大小写。因此,数据库名、 表名、字段名,都不允许出现任何大写字母,避免节外生枝。 正例:aliyun_admin,rdc_config,level3_name 反例:AliyunAdmin,rdcConfig,level_3_name


    3. 【强制】表名不使用复数名词。 说明:表名应该仅仅表示表里面的实体内容,不应该表示实体数量,对应于 DO 类名也是单数 形式,符合表达习惯。


    4. 【强制】禁用保留字,如 desc、range、match、delayed 等,请参考 MySQL 官方保留字。


    5. 【强制】主键索引名为 pk_字段名;唯一索引名为 uk_字段名;普通索引名则为 idx_字段名。
    说明:pk_ 即 primary key;uk_ 即 unique key;idx_ 即 index 的简称。


    6. 【强制】小数类型为 decimal,禁止使用 float 和 double。
    说明:float 和 double 在存储的时候,存在精度损失的问题,很可能在值的比较时,得到不 正确的结果。如果存储的数据范围超过 decimal 的范围,建议将数据拆成整数和小数分开存储。


    7. 【强制】如果存储的字符串长度几乎相等,使用 char 定长字符串类型。


    8. 【强制】varchar 是可变长字符串,不预先分配存储空间,长度不要超过 5000,如果存储长 度大于此值,定义字段类型为 text,独立出来一张表,用主键来对应,避免影响其它字段索 引效率。


    9. 【强制】表必备三字段:id, gmt_create, gmt_modified。 说明:其中id必为主键,类型为bigint unsigned、单表时自增、步长为1。gmt_create, gmt_modified 的类型均为 datetime 类型,前者现在时表示主动创建,后者过去分词表示被 动更新。


    10. 【推荐】表的命名最好是加上“业务名称_表的作用”。
    正例:alipay_task / force_project / trade_config


    11. 【推荐】库名与应用名称尽量一致。


    12. 【推荐】如果修改字段含义或对字段表示的状态追加时,需要及时更新字段注释。


    13. 【推荐】字段允许适当冗余,以提高查询性能,但必须考虑数据一致。冗余字段应遵循: 1)不是频繁修改的字段。
    2)不是 varchar 超长字段,更不能是 text 字段。
    正例:商品类目名称使用频率高,字段长度短,名称基本一成不变,可在相关联的表中冗余存 储类目名称,避免关联查询。


    14. 【推荐】单表行数超过 500 万行或者单表容量超过 2GB,才推荐进行分库分表。 说明:如果预计三年后的数据量根本达不到这个级别,请不要在创建表时就分库分表。


    15. 【参考】合适的字符存储长度,不但节约数据库表空间、节约索引存储,更重要的是提升检 索速度。
    正例:如下表,其中无符号值可以避免误存负数,且扩大了表示范围。

     

    对象

      

    年龄区间

      

    类型

     

    字节

     

    表示范围

     
     

      

    150 岁之内

      

    tinyint unsigned

     

    1

     

    无符号值:0 到 255

     
     

      

    数百岁

      

    smallint unsigned

     

    2

     

    无符号值:0 到 65535

     
     

    恐龙化石

      

    数千万年

      

    int unsigned

     

    4

     

    无符号值:0 到约 42.9 亿

     
     

    太阳

      

    约 50 亿年

      

    bigint unsigned

     

    8

     

    无符号值:0 到约 10 的 19 次方

     

     

    3.2 索引规约

    1. 【强制】业务上具有唯一特性的字段,即使是多个字段的组合,也必须建成唯一索引。 说明:不要以为唯一索引影响了 insert 速度,这个速度损耗可以忽略,但提高查找速度是明 显的;另外,即使在应用层做了非常完善的校验控制,只要没有唯一索引,根据墨菲定律,必 然有脏数据产生。


    2. 【强制】超过三个表禁止 join。需要 join 的字段,数据类型必须绝对一致;多表关联查询时, 保证被关联的字段需要有索引。
    说明:即使双表 join 也要注意表索引、SQL 性能。


    3. 【强制】在 varchar 字段上建立索引时,必须指定索引长度,没必要对全字段建立索引,根据 实际文本区分度决定索引长度即可。
    说明:索引的长度与区分度是一对矛盾体,一般对字符串类型数据,长度为 20 的索引,区分
    度会高达 90%以上,可以使用 count(distinct left(列名, 索引长度))/count(*)的区分度 来确定。


    4. 【强制】页面搜索严禁左模糊或者全模糊,如果需要请走搜索引擎来解决。 说明:索引文件具有 B-Tree 的最左前缀匹配特性,如果左边的值未确定,那么无法使用此索 引。


    5. 【推荐】如果有 order by 的场景,请注意利用索引的有序性。order by 最后的字段是组合 索引的一部分,并且放在索引组合顺序的最后,避免出现 file_sort 的情况,影响查询性能。 正例:where a=? and b=? order by c; 索引:a_b_c 反例:索引中有范围查找,那么索引有序性无法利用,如:WHERE a>10 ORDER BY b; 索引 a_b 无法排序。


    6. 【推荐】利用覆盖索引来进行查询操作,避免回表。
    说明:如果一本书需要知道第 11 章是什么标题,会翻开第 11 章对应的那一页吗?目录浏览 一下就好,这个目录就是起到覆盖索引的作用。 正例:能够建立索引的种类分为主键索引、唯一索引、普通索引三种,而覆盖索引只是一种查 询的一种效果,用explain的结果,extra列会出现:using index。


    7. 【推荐】利用延迟关联或者子查询优化超多分页场景。
    说明:MySQL 并不是跳过 offset 行,而是取 offset+N 行,然后返回放弃前 offset 行,返回 N 行,那当 offset 特别大的时候,效率就非常的低下,要么控制返回的总页数,要么对超过 特定阈值的页数进行 SQL 改写。
    正例:先快速定位需要获取的 id 段,然后再关联:
    SELECT a.* FROM 表 1 a, (select id from 表 1 where 条件 LIMIT 100000,20 ) b where a.id=b.id


    8. 【推荐】SQL 性能优化的目标:至少要达到 range 级别,要求是 ref 级别,如果可以是 consts 最好。
    说明:
    1)consts 单表中最多只有一个匹配行(主键或者唯一索引),在优化阶段即可读取到数据。 2)ref 指的是使用普通的索引(normal index)。
    3)range 对索引进行范围检索。
    反例:explain 表的结果,type=index,索引物理文件全扫描,速度非常慢,这个 index 级 别比较 range 还低,与全表扫描是小巫见大巫。


    9. 【推荐】建组合索引的时候,区分度最高的在最左边。
    正例:如果 where a=? and b=? ,如果 a 列的几乎接近于唯一值,那么只需要单建 idx_a 索引即可。 说明:存在非等号和等号混合时,在建索引时,请把等号条件的列前置。如:where c>? and d=? 那么即使 c 的区分度更高,也必须把 d 放在索引的最前列,即索引 idx_d_c。


    10. 【推荐】防止因字段类型不同造成的隐式转换,导致索引失效。


    11. 【参考】创建索引时避免有如下极端误解: 1)宁滥勿缺。认为一个查询就需要建一个索引。 2)宁缺勿滥。认为索引会消耗空间、严重拖慢更新和新增速度。 3)抵制惟一索引。认为业务的惟一性一律需要在应用层通过“先查后插”方式解决。

     

    3.3 SQL语句

    1. 【强制】不要使用 count(列名)或 count(常量)来替代 count(*),count(*)是 SQL92 定义的 标准统计行数的语法,跟数据库无关,跟 NULL 和非 NULL 无关。 说明:count(*)会统计值为 NULL 的行,而 count(列名)不会统计此列为 NULL 值的行。


    2. 【强制】count(distinct col) 计算该列除 NULL 之外的不重复行数,注意 count(distinct col1, col2) 如果其中一列全为NULL,那么即使另一列有不同的值,也返回为0。


    3. 【强制】当某一列的值全是 NULL 时,count(col)的返回结果为 0,但 sum(col)的返回结果为 NULL,因此使用 sum()时需注意 NPE 问题。 正例:可以使用如下方式来避免sum的NPE问题:SELECT IF(ISNULL(SUM(g)),0,SUM(g)) FROM table;


    4. 【强制】使用 ISNULL()来判断是否为 NULL 值。 说明:NULL 与任何值的直接比较都为 NULL。
    1) NULL<>NULL的返回结果是NULL,而不是false。 2) NULL=NULL的返回结果是NULL,而不是true。 3) NULL<>1的返回结果是NULL,而不是true。


    5. 【强制】 在代码中写分页查询逻辑时,若 count 为 0 应直接返回,避免执行后面的分页语句。


    6. 【强制】不得使用外键与级联,一切外键概念必须在应用层解决。 说明:以学生和成绩的关系为例,学生表中的 student_id 是主键,那么成绩表中的 student_id 则为外键。如果更新学生表中的 student_id,同时触发成绩表中的 student_id 更新,即为 级联更新。外键与级联更新适用于单机低并发,不适合分布式、高并发集群;级联更新是强阻 塞,存在数据库更新风暴的风险;外键影响数据库的插入速度。


    7. 【强制】禁止使用存储过程,存储过程难以调试和扩展,更没有移植性。


    8. 【强制】数据订正(特别是删除、修改记录操作)时,要先 select,避免出现误删除,确认无误才能执行更新语句。


    9. 【推荐】in 操作能避免则避免,若实在避免不了,需要仔细评估 in 后边的集合元素数量,控 制在 1000 个之内。


    10. 【参考】如果有国际化需要,所有的字符存储与表示,均以 utf-8 编码,注意字符统计函数
    的区别。
    说明:
    SELECT LENGTH("轻松工作"); 返回为12
    SELECT CHARACTER_LENGTH("轻松工作"); 返回为4 如果需要存储表情,那么选择 utf8mb4 来进行存储,注意它与 utf-8 编码的区别。


    11. 【参考】TRUNCATE TABLE 比 DELETE 速度快,且使用的系统和事务日志资源少,但 TRUNCATE 无事务且不触发 trigger,有可能造成事故,故不建议在开发代码中使用此语句。 说明:TRUNCATE TABLE 在功能上与不带 WHERE 子句的 DELETE 语句相同。

    展开全文
  • 1. 【强制】所有编程相关命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束。 反例: _name / __name / $Object / name_ / name$ / Object$ 2. 【强制】所有编程相关的命名严禁使用拼音与英文混合的...
  • 阿里最新Java开发规范

    2019-01-22 19:21:06
    阿里内部最新开发规范 Java开发规范最新版详解中文大全
  • 主要介绍了JAVA开发中的一些规范讲解(阿里巴巴Java开发规范手册),需要的朋友可以参考下
  • Java开发规范之常量定义篇

    千次阅读 2020-03-27 18:06:50
    之前的文章已经介绍过命名规范(点击Java开发规范之命名篇(上)和Java开发规范之命名篇(下)访问),本文将进一步介绍常量定义规范,虽然之前的文章有提到常量规范但也只是限于命名,本篇将讨论常量定义和使用过程...

    开发团队在开发过程中,由于每个人的开发习惯,以及对于技术的理解深浅程度不一,往往一个项目在开发过程中,代码的质量,代码的风格都不尽相似,所以有一份适合团队的代码规范是非常有必要的,而一个团队的代码规范,包含了开发常见的风格习惯以及一些常见代码细节的写法规范等。

    本系列文章将整合 阿里巴巴《Java开发手册》和 谷歌《Java编程规范》,总结Java开发过程的编码规范,并通过具体编码案例给出编码规范的原因,如果总结内容存在问题还望指出。


    目录

    1.禁止魔法值

    2.长整性类型赋值数值后使用大写L

    3.常量需要根据功能放置在不同常量类

    4.常量的复用层次

    5.固定范围的变量使用enum类型


    之前的文章已经介绍过命名规范(点击 Java开发规范之命名篇(上)和 Java开发规范之命名篇(下)访问),本文将进一步介绍常量定义规范,虽然之前的文章有提到常量规范但也只是限于命名,本篇将讨论常量定义和使用过程的具体细则,包括定义格式,如何归类和复用范围等。

    1.禁止魔法值

    【Alibaba】不允许任何魔法值(即未经预先定义的常量)直接出现在代码中。

    【Google】未明确定义类似规范

    说明:魔法值是指带代码中直接使用的数值或者字符串,只有在这个数值记述的那部分代码中才能明确了解其含义,比如拼接字符串前缀。

    反例:

    补充:反例1和2出现了魔法值  “1”  和   “stop”,可以使用static final 定义常量或使用enum值

    2.长整性类型赋值数值后使用大写L

    【Alibaba】在long或者Long赋值时,数值后使用大写的L,不能是小写的l,小写容易跟数字1混淆,造成误解。

    【Google】未明确定义类似规范

    说明:小写的l无法区分写的是数字的1,还是Long型标识。

    反例:

    3.常量需要根据功能放置在不同常量类

    【Alibaba】不要使用一个常量类维护所有常量,要按常量功能进行归类,分开维护。

    【Google】未明确定义类似规范

    说明:大而全的常量类,杂乱无章,使用查找功能才能定位到修改的常量,不利于理解和维护。

    正例:【Alibaba】缓存相关常量放在类CacheConsts下;系统配置相关常量放在类ConfigConsts下。

    反例:【Alibaba】日期格式常量和字符串常量放置在同一个常量类中。

    4.常量的复用层次

    【Alibaba】常量的复用层次有五层:跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。

    • 1) 跨应用共享常量:放置在二方库中,通常是client.jar中的constant目录下。
    • 2) 应用内共享常量:放置在一方库中,通常是子模块中的constant目录下。
    • 3) 子工程内部共享常量:即在当前子工程的constant目录下。
    • 4) 包内共享常量:即在当前包下单独的constant目录下。
    • 5) 类内共享常量:直接在类内部private static final定义。

    【Google】未明确定义类似规范

    反例:【Alibaba】针对上述条例 2,易懂变量也要统一定义成应用内共享常量,两位工程师在两个类中分别定义了“YES”的变量: 类A中:public static final String YES = "yes"; 类B中:public static final String YES = "y"; A.YES.equals(B.YES),预期是true,但实际返回为false,导致线上问题。

    5.固定范围的变量使用enum类型

    【Alibaba】如果变量值仅在一个固定范围内变化用enum类型来定义。

    【Google】未明确定义类似规范

    说明:如果存在名称之外的延伸属性应使用enum类型。

    正例:

     

     

     

    展开全文

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 426,868
精华内容 170,747
关键字:

java开发规范

java 订阅
友情链接: DPD.zip