网站默认后台,17网做网站,html网页设计作品中国传统文化,做游戏网站公司文章目录 编程规约的意义#xff08;一#xff09;命名风格#xff08;二#xff09;常量定义#xff08;三#xff09;代码格式#xff08;四#xff09;OOP 规约#xff08;五#xff09;日期时间#xff08;六#xff09;集合处理#xff08;七#xff09;并发… 文章目录 编程规约的意义一命名风格二常量定义三代码格式四OOP 规约五日期时间六集合处理七并发处理八控制语句九注释规约十其它 前言本文章为瑞_系列专栏之《Java开发手册》的编程规约篇本篇章主要介绍命名风格、常量定义、代码格式、OOP规约、日期时间、集合处理、并发处理、控制语句、注释规约以及其它常见的编程规约。由于博主是从阿里的《Java开发手册》学习到Java的编程规约所以本系列专栏主要以这本书进行讲解和拓展有需要的小伙伴可以点击链接下载。本文仅供大家交流、学习及研究使用禁止用于商业用途违者必究 本系列第一篇链接一编程规约 本系列第二篇链接二异常日志 本系列第三篇链接三单元测试 本系列第四篇链接四安全规约 持续更新中… 编程规约的意义 当亲爱的你参加工作后如果不幸接手到屎山那不用我多说你就能瞬间明白编码规范的重要性了。编码规范的意义主要体现在提高代码的可读性、可维护性和合作效率降低软件的维护成本。它像一个地图帮助开发人员在复杂的代码世界里找到他们需要的部分。试想一下如果你在一个庞大的代码森林中迷失方向没有路径指引你会如何找到出去的路这就是编码规范的重要性所在。此外编码规范不仅有助于提高个人编写代码的效率和质量也有利于团队合作。想象一下如果一个团队中的所有成员都遵循同一套编码规范那么他们就可以轻松地理解彼此的代码从而提高整个团队的工作效率。 博主曾遇到一个项目的同一张数据表对应的实体类po就有四五个而且每个po内的字段都不相同并且对比数据表都不全简直无语了真的如果你想统一这五个实体类那就得去项目里找到该表相关的所有业务进行统一修改但即使时间允许你去修改但你敢吗万一修改启动之后过一段时间该业务崩掉了怎么办本着多一事不如少一事的原则也只有加入它们被迫成为依托答辩 所谓“屎山”是程序员间流传的一个梗指陈年累月且复杂低效的代码因为改动成本巨大所有人避之不及。 (图源网络) 所以编程规约就是给代码世界创造“规则”。正所谓“无规矩不成方圆无规范难以协同”不遵循这些规则你的代码可能仍然可以运行就像汽车可以在没有交通规则的路上行驶一样。但是一旦违反了编程规约就容易给开发团队的其它成员甚至自己造成困扰。因此学习编程规约对于编写高质量、高效的代码至关重要。 对软件来说适当的规范和标准绝不是消灭代码内容的创造性、优雅性而是像交通规则一样限制了过度的个性化让我们能以一种大家都认可的统一方式来行事。这样协作效率得以提升沟通成本得以降低。代码就像是软件系统的血液质量的提升意味着我们尽量少走弯路、不重复犯错从而切实提升系统的稳定性。遵循规范让代码质量更上一层楼 《Java开发手册》是阿里巴巴集团技术团队的集体智慧结晶和经验总结经历了多次大规模一线实战的检验及不断完善公开到业界后众多社区开发者踊跃参与共同打磨完善系统化地整理成册以 Java 开发者为中心视角划分为编程规约、异常日志、单元测试、安全规约、MySQL 数据库、工程结构、设计规约七个维度再根据内容特征细分成若干二级子目录。另外依据约束力强弱及故障敏感性规约依次分为强制、推荐、参考三大类。在延伸信息中“说明”对规约做了适当扩展和解释“正例”提倡什么样的编码和实现方式“反例”说明需要提防的雷区以及真实的错误案例。下面主要围绕该书的编程规约章节进行讲解和拓展感兴趣的小伙伴可以点击链接下载 一命名风格
【强制】代码中的命名均不能以下划线或美元符号开始也不能以下划线或美元符号结束。 反例_name / $name / name_ / name$ / name_ 瑞以数字或其它符号开头直接编译不通过 【强制】所有编程相关的命名严禁使用拼音与英文混合的方式更不允许直接使用中文的方式。 说明正确的英文拼写和语法可以让阅读者易于理解避免歧义。注意纯拼音命名方式更要避免采用。 正例ali / alibaba / taobao / cainiao/ aliyun/ youku / hangzhou 等国际通用的名称可视同英文。 反例DaZhePromotion [打折] / getPingfenByName() [评分] / int 某变量 3 瑞真的真的真的千万不要用拼音尤其是拼音还取首字母的那种千万不要❗️❗️❗️ 【强制】类名使用 UpperCamelCase 风格但以下情形例外DO / BO / DTO / VO / AO / PO / UID 等。 正例ForceCode / UserDO / HtmlDTO / XmlService / TcpUdpDeal / TaPromotion 反例forcecode / UserDo / HTMLDto / XMLService / TCPUDPDeal / TAPromotion 瑞类名建议不要进行任何的缩写例如常量类要命名为 AbstractXXX 缩写命名成❌ AbsXXX ❌ 【强制】方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格。 正例 localValue / getHttpMessage() / inputUserId 瑞此处仍然建议不要进行任何的缩写除非是公认的如msg是messagedesc是describe 【强制】常量命名全部大写单词间用下划线隔开力求语义表达完整清楚不要嫌名字长。 正例MAX_STOCK_COUNT / CACHE_EXPIRED_TIME 反例MAX_COUNT / EXPIRED_TIME 瑞尤其是带有含义的整型常量不要直接定义成英文数字如❌ Integer ONE 1;❌可以写 IS_DELETED 【强制】抽象类命名使用 Abstract 或 Base 开头异常类命名使用 Exception 结尾测试类命名以它要测试的类的名称开始以 Test 结尾。 瑞比如AbstractRayFactory、BaseController、RayException、RayUserTest 【强制】类型与中括号紧挨相连来表示数组。 正例定义整形数组 int[] arrayDemo; 反例在 main 参数中使用 String args[]来定义。 瑞虽然中括号无论写前面还是后面编译都会通过但这种方式更简洁明了易于阅读和理解 【强制】POJO 类中的任何布尔类型的变量都不要加 is 前缀否则部分框架解析会引起序列化错误。 说明在本文 MySQL 规约中的建表约定第一条表达是与否的值采用 is_xxx 的命名方式所以需要在resultMap设置从 is_xxx 到 xxx 的映射关系。 反例定义为基本数据类型 Boolean isDeleted 的属性它的方法也是 isDeleted()框架在反向解析的时候“误以为”对应的属性名称是 deleted导致属性获取不到进而抛出异常。 瑞博主的解决方法是不定义逻辑删除字段为布尔型可以定义为 Byte 或者 Integer 。关于空间浪费的问题《Java虚拟机规范》中写到Java语言表达式所操作的 boolean 值在编译之后都使用Java虚拟机中的 int 数据类型来代替。 浅浅吐槽一下阿里开发手册这点里提到的部分框架解析会引起序列化错误其实阿里的fastjson框架就有可能出现这个问题当然这不影响它是个很好用的json工具包 【强制】包名统一使用小写点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式但是类名如果有复数含义类名可以使用复数形式。 正例应用工具类包名为 com.alibaba.ei.kunlun.aap.util、类名为 MessageUtils此规则参考 spring 的框架结构 瑞包名统一使用单数形式例如某常量包名com.ray.constant。某工具类名RayTools 【强制】避免在子父类的成员变量之间、或者不同代码块的局部变量之间采用完全相同的命名使可读性降低。 说明子类、父类成员变量名相同即使是 public 类型的变量也是能够通过编译而局部变量在同一方法内的不同代码块中同名也是合法的但是要避免使用。对于非 setter/getter 的参数名称也要避免与成员变量名称相同。 反例
public class ConfusingName {public int stock;// 非 setter/getter 的参数名称不允许与本类成员变量同名public void get(String alibaba) {if (condition) {final int money 666;// ...}for (int i 0; i 10; i) {// 在同一方法体中不允许与其它代码块中的 money 命名相同final int money 15978;// ...}}
}class Son extends ConfusingName {// 不允许与父类的成员变量名称相同public int stock;
}瑞使用同一个参数名容易让人产生误解属于前人挖坑的典型案例 【强制】杜绝完全不规范的缩写避免望文不知义。 反例AbstractClass“缩写”命名成 AbsClasscondition“缩写”命名成 condi此类随意缩写严重降低了代码的可阅读性。 瑞除非是实在全拼太长且缩写公认的情况如message缩写为msgdescribe缩写为desc 【推荐】为了达到代码自解释的目标任何自定义编程元素在命名时使用尽量完整的单词组合来表达。 正例在 JDK 中对某个对象引用的 volatile 字段进行原子更新的类名为AtomicReferenceFieldUpdater。 反例常见的方法内变量为 int a;的定义方式。 瑞同上 【推荐】在常量与变量的命名时表示类型的名词放在词尾以提升辨识度。 正例startTime / workQueue / nameList / TERMINATED_THREAD_COUNT 反例startedAt / QueueOfWork / listName / COUNT_TERMINATED_THREAD 【推荐】如果模块、接口、类、方法使用了设计模式在命名时需体现出具体模式。 说明将设计模式体现在名字中有利于阅读者快速理解架构设计理念。 正例 public class OrderFactory; public class LoginProxy; public class ResourceObserver; 【推荐】接口类中的方法和属性不要加任何修饰符号public 也不要加保持代码的简洁性并加上有效的 Javadoc 注释。尽量不要在接口里定义变量如果一定要定义变量确定与接口方法相关并且是整个应用的基础常量。 正例 接口方法签名 void commit(); 接口基础常量 String COMPANY “alibaba”; 反例接口方法定义 public abstract void f(); 说明JDK8 中接口允许有默认实现那么这个 default 方法是对所有实现类都有价值的默认实现。 瑞在接口中的注释建议写好写全因为以面向接口编程的思维大多数时候看到的直接注释是接口内的注释 接口和实现类的命名有两套规则 1【强制】对于 Service 和 DAO 类基于 SOA 的理念暴露出来的服务一定是接口内部的实现类用 Impl 的后缀与接口区别。 正例CacheServiceImpl 实现 CacheService 接口。 2【推荐】如果是形容能力的接口名称取对应的形容词为接口名通常是–able 的形容词。 正例AbstractTranslator 实现 Translatable 接口。 瑞自定义接口建议在前面加上大写的 i 即 I 作为接口名称的前缀比如IUserUservice 这样能够清楚地表达这是一个接口而不是一个类 【参考】枚举类名带上 Enum 后缀枚举成员名称需要全大写单词间用下划线隔开。 说明枚举其实就是特殊的常量类且构造方法被默认强制是私有。 正例枚举名字为 ProcessStatusEnum 的成员名称SUCCESS / UNKNOWN_REASON。 【参考】各层命名规约 A) Service/DAO 层方法命名规约 1 获取单个对象的方法用 get 做前缀。 2 获取多个对象的方法用 list 做前缀复数结尾如listObjects。 3 获取统计值的方法用 count 做前缀。 4 插入的方法用 save/insert 做前缀。 5 删除的方法用 remove/delete 做前缀。 6 修改的方法用 update 做前缀。 B) 领域模型命名规约 1 数据对象xxxDOxxx 即为数据表名。 2 数据传输对象xxxDTOxxx 为业务领域相关的名称。 3 展示对象xxxVOxxx 一般为网页名称。 4 POJO 是 DO/DTO/BO/VO 的统称禁止命名成 xxxPOJO。 二常量定义
【强制】不允许任何魔法值即未经预先定义的常量直接出现在代码中。 反例 //本例中同学 A 定义了缓存的 key然后缓存提取的同学 B 使用了 Id#taobao 来提取少了下划线导致故障。 String key “Id#taobao_” tradeId; cache.put(key, value); 瑞原书没有给出正例博主理解的正例如下 final int STATUS_TYPE 2; String key “Id#taobao_” tradeId “_status_type_” STATUS_TYPE; cache.put(key, value); 【强制】在 long 或者 Long 赋值时数值后使用大写的 L不能是小写的 l小写容易跟数字混淆造成误解。 说明Long a 2l; 写的是数字的 21还是 Long 型的 2。 瑞需要注意float基本数据类型需要添加后缀f以及它的包装类Float的后缀F不写后缀会默认为double类型 【推荐】不要使用一个常量类维护所有常量要按常量功能进行归类分开维护。 说明大而全的常量类杂乱无章使用查找功能才能定位到修改的常量不利于理解也不利于维护。 正例缓存相关常量放在类 CacheConsts 下系统配置相关常量放在类 ConfigConsts 下。 瑞不仅仅是常量工具类也是如此不要一个工具类包含了非常多的工具方法。写的人是真的爽维护的人是真的想 【推荐】常量的复用层次有五层跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。 1 跨应用共享常量放置在二方库中通常是 client.jar 中的 constant 目录下。 2 应用内共享常量放置在一方库中通常是子模块中的 constant 目录下。 反例易懂变量也要统一定义成应用内共享常量两位工程师在两个类中分别定义了“YES”的变量 类 A 中public static final String YES “yes”; 类 B 中public static final String YES “y”; A.YES.equals(B.YES)预期是 true但实际返回为 false导致线上问题。 3 子工程内部共享常量即在当前子工程的 constant 目录下。 4 包内共享常量即在当前包下单独的 constant 目录下。 5 类内共享常量直接在类内部 private static final 定义。 【推荐】如果变量值仅在一个固定范围内变化用 enum 类型来定义。 说明如果存在名称之外的延伸属性应使用 enum 类型下面正例中的数字就是延伸信息表示一年中的第几个季节。 正例
public enum SeasonEnum {SPRING(1), SUMMER(2), AUTUMN(3), WINTER(4);private int seq;SeasonEnum(int seq) {this.seq seq;}public int getSeq() {return seq;}
}三代码格式
【强制】如果是大括号内为空则简洁地写成{}即可大括号中间无需换行和空格如果是非空代码块则 1 左大括号前不换行。 2 左大括号后换行。 3 右大括号前换行。 4 右大括号后还有 else 等代码则不换行表示终止的右大括号后必须换行。 瑞IDEA代码格式化快捷键ctrl alt L2、3、4点也可用 【强制】左小括号和右边相邻字符之间不出现空格右小括号和左边相邻字符之间也不出现空格而左大括号前需要加空格。详见第 5 条下方正例提示。 反例if (空格 a b 空格) 【强制】if/for/while/switch/do 等保留字与括号之间都必须加空格。 【强制】任何二目、三目运算符的左右两边都需要加一个空格。 说明包括赋值运算符、逻辑运算符、加减乘除符号等。 【强制】采用 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) {// 缩进 4 个空格String say hello;// 运算符的左右必须有一个空格int flag 0;// 关键词 if 与括号之间必须有一个空格括号内的 f 与左括号0 与右括号不需要空格if (flag 0) {System.out.println(say);}// 左大括号前加空格且不换行左大括号后换行if (flag 1) {System.out.println(world);// 右大括号前换行右大括号后有 else不用换行} else {System.out.println(ok);// 在右大括号后直接结束则必须换行}}【强制】注释的双斜线与注释内容之间有且仅有一个空格。 正例 // 这是示例注释请注意在双斜线之后有一个空格 String commentString new String(); 【强制】在进行类型强制转换时右括号与强制转换值之间不需要任何空格隔开。 正例 long first 1000000000000L; int second (int)first 2; 【强制】单行字符数限制不超过 120 个超出需要换行换行时遵循如下原则 1第二行相对第一行缩进 4 个空格从第三行开始不再继续缩进参考示例。 2运算符与下文一起换行。 3方法调用的点符号与下文一起换行。 4方法调用中的多个参数需要换行时在逗号后进行。 5在括号前不要换行见反例。 正例 StringBuilder sb new StringBuilder(); // 超过 120 个字符的情况下换行缩进 4 个空格并且方法前的点号一起换行 sb.append(“zi”).append(“xin”)… .append(“huang”)… .append(“huang”)… .append(“huang”); 反例 StringBuilder sb new StringBuilder(); // 超过 120 个字符的情况下不要在括号前换行 sb.append(“you”).append(“are”)…append (“luckly”); // 参数很多的方法调用可能超过 120 个字符逗号后才是换行处 method(args1, args2, args3, … , argsX); 【强制】方法参数在定义和传入时多个参数逗号后边必须加空格。 正例下例中实参的 args1后边必须要有一个空格。 method(args1, args2, args3); 【强制】IDE 的 text file encoding 设置为 UTF-8; IDE 中文件的换行符使用 Unix 格式不要使用 Windows 格式。 【推荐】单个方法的总行数不超过 80 行。 说明除注释之外的方法签名、左右大括号、方法内代码、空行、回车及任何不可见字符的总行数不超过80 行。 正例代码逻辑分清红花和绿叶个性和共性绿叶逻辑单独出来成为额外方法使主干代码更加清晰共性逻辑抽取成为共性方法便于复用和维护。 【推荐】没有必要增加若干空格来使变量的赋值等号与上一行对应位置的等号对齐。 正例 int one 1; long two 2L; float three 3F; StringBuilder sb new StringBuilder(); 说明增加 sb 这个变量如果需要对齐则给 one、two、three 都要增加几个空格在变量比较多的情况下是非常累赘的事情。 【推荐】不同逻辑、不同语义、不同业务的代码之间插入一个空行分隔开来以提升可读性。 说明任何情形没有必要插入多个空行进行隔开。 四OOP 规约
【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法无谓增加编译器解析成本直接用类名来访问即可。 瑞IDEA默认不会给出通过一个类的对象引用访问此类的静态变量或静态方法的提示但是可以通过手动强制输入具体可以参考文章《Java为什么可以使用实例对象调用静态变量和静态方法》 【强制】所有的覆写方法必须加Override 注解。 说明getObject()与 get0bject()的问题。一个是字母的 O一个是数字的 0加Override 可以准确判断是否覆盖成功。另外如果在抽象类中对方法签名进行修改其实现类会马上编译报错。 瑞顺手就加上的真的求求了。有时候遵守规范会有点麻烦但是真的是为你好为我好为大家好。 【强制】相同参数类型相同业务含义才可以使用 Java 的可变参数避免使用 Object。 说明可变参数必须放置在参数列表的最后。提倡同学们尽量不用可变参数编程 正例public List listUsers(String type, Long… ids) {…} 瑞由于省略号可以表示任意数量的参数因此很难确定方法的实际参数列表是什么。此外如果方法有多个可变参数那么这些参数的类型和顺序也可能会变得混乱。还是那句话写的人爽维护的人想 【强制】外部正在调用或者二方库依赖的接口不允许修改方法签名避免对接口调用方产生影响。接口过时必须加Deprecated 注解并清晰地说明采用的新接口或者新服务是什么。 瑞加上 Deprecated 注解后请记得修改对应注释属于很容易忘的坑 【强制】不能使用过时的类或方法。 说明java.net.URLDecoder 中的方法 decode(String encodeStr) 这个方法已经过时应该使用双参数decode(String source, String encode)。接口提供方既然明确是过时接口那么有义务同时提供新的接口作为调用方来说有义务去考证过时方法的新实现是什么。 瑞别人都写明过时你还要调用那出事了别人可就不管了拒绝背锅从我做起 【强制】Object 的 equals 方法容易抛空指针异常应使用常量或确定有值的对象来调用 equals。 正例“test”.equals(object); 反例object.equals(“test”); 说明推荐使用 java.util.Objects#equalsJDK7 引入的工具类。 【强制】所有整型包装类对象之间值的比较 全部使用 equals 方法比较。 说明对于 Integer var ? 在-128 至 127 之间的赋值Integer 对象是在 IntegerCache.cache 产生会复用已有对象这个区间内的 Integer 值可以直接使用进行判断但是这个区间之外的所有数据都会在堆上产生并不会复用已有对象这是一个大坑推荐使用 equals 方法进行判断。 瑞后续博主会出一篇专门讲解这一点的博客先留个位置 【强制】任何货币金额均以最小货币单位且整型类型来进行存储。 瑞如RMB使用“分”且整型类型来进行存储 【强制】浮点数之间的等值判断基本数据类型不能用来比较包装数据类型不能用 equals来判断。 说明浮点数采用“尾数阶码”的编码方式类似于科学计数法的“有效数字指数”的表示方式。二进制无法精确表示大部分的十进制小数具体原理参考《码出高效》。 瑞推荐阅读《瑞_Java中浮点数精度误差产生原因_浮点数底层存储结构详细附代码》详细说明了浮点数采用“尾数阶码”的编码方式验证了0.1f 0.2f 0.3f为true而0.3f 0.6f 0.9f为false的原因 反例 float a 1.0f - 0.9f;float b 0.9f - 0.8f;if (a b) {// 预期进入此代码快执行其它业务逻辑// 但事实上 ab 的结果为 false}Float x Float.valueOf(a);Float y Float.valueOf(b);if (x.equals(y)) {// 预期进入此代码快执行其它业务逻辑// 但事实上 equals 的结果为 false}正例 (1) 指定一个误差范围两个浮点数的差值在此范围之内则认为是相等的。 float a 1.0f - 0.9f;float b 0.9f - 0.8f;float diff 1e-6f;if (Math.abs(a - b) diff) {System.out.println(true);}(2) 使用 BigDecimal 来定义值再进行浮点数的运算操作。 BigDecimal a new BigDecimal(1.0);BigDecimal b new BigDecimal(0.9);BigDecimal c new BigDecimal(0.8);BigDecimal x a.subtract(b);BigDecimal y b.subtract(c);if (x.equals(y)) {System.out.println(true);}【强制】定义数据对象 DO 类时属性类型要与数据库字段类型相匹配。 正例数据库字段的 bigint 必须与类属性的 Long 类型相对应。 反例某个案例的数据库表 id 字段定义类型 bigint unsigned实际类对象属性为 Integer随着 id 越来越大超过 Integer 的表示范围而溢出成为负数。 瑞反例是巨坑之一 【强制】禁止使用构造方法 BigDecimal(double)的方式把 double 值转化为 BigDecimal 对象。 说明BigDecimal(double)存在精度损失风险在精确计算或值比较的场景中可能会导致业务逻辑异常。 如BigDecimal g new BigDecimal(0.1f); 实际的存储值为0.10000000149 正例优先推荐入参为 String 的构造方法或使用 BigDecimal 的 valueOf 方法此方法内部其实执行了Double 的 toString而 Double 的 toString 按 double 的实际能表达的精度对尾数进行了截断。 BigDecimal recommend1 new BigDecimal(0.1 ); BigDecimal recommend2 BigDecimal.valueOf (0.1); 关于基本数据类型与包装数据类型的使用标准如下 1 【强制】所有的 POJO 类属性必须使用包装数据类型。 2 【强制】RPC 方法的返回值和参数必须使用包装数据类型。 3 【推荐】所有的局部变量使用基本数据类型。 说明POJO 类属性没有初值是提醒使用者在需要使用时必须自己显式地进行赋值任何 NPE 问题或者入库检查都由使用者来保证。 正例数据库的查询结果可能是 null因为自动拆箱用基本数据类型接收有 NPE 风险。 反例某业务的交易报表上显示成交总额涨跌情况即正负 x%x 为基本数据类型调用的 RPC 服务调用不成功时返回的是默认值页面显示为 0%这是不合理的应该显示成中划线-。所以包装数据类型的 null 值能够表示额外的信息如远程调用失败异常退出。 瑞名词解释 POJOPlain Ordinary Java Object: 在本规约中POJO 专指只有 setter/getter/toString 的简单类包括 DO/DTO/BO/VO 等。 RPC是指远程调用。 NPEjava.lang.NullPointerException: 空指针异常。 【强制】定义 DO/DTO/VO 等 POJO 类时不要设定任何属性默认值。 反例POJO 类的 createTime 默认值为 new Date()但是这个属性在数据提取时并没有置入具体值在更新其它字段时又附带更新了此字段导致创建时间被修改成当前时间。 瑞建议在业务逻辑处理层进行赋值操作 名词解释 DOData Object: 阿里巴巴专指数据库表一一对应的 POJO 类。 DTOData Transfer Object数据传输对象 VOView Object视图对象 【强制】序列化类新增属性时请不要修改 serialVersionUID 字段避免反序列失败如果完全不兼容升级避免反序列化混乱那么请修改 serialVersionUID 值。 说明注意 serialVersionUID 不一致会抛出序列化运行时异常。 瑞后续博主会出一篇专门讲解这一点的博客先留个位置 【强制】构造方法里面禁止加入任何业务逻辑如果有初始化逻辑请放在 init 方法中。 【强制】POJO 类必须写 toString 方法。使用 IDE 中的工具source generate toString 时如果继承了另一个 POJO 类注意在前面加一下 super.toString。 说明在方法执行抛出异常时可以直接调用 POJO 的 toString()方法打印其属性值便于排查问题。 【强制】禁止在 POJO 类中同时存在对应属性 xxx 的 isXxx()和 getXxx()方法。 说明框架在调用属性 xxx 的提取方法时并不能确定哪个方法一定是被优先调用到神坑之一。 瑞如说明神坑之一 【推荐】使用索引访问用 String 的 split 方法得到的数组时需做最后一个分隔符后有无内容的检查否则会有抛 IndexOutOfBoundsException 的风险。 说明 String str “a,b,c ,,”; String[] ary str.split (“,”); // 预期大于 3结果是 3 System.out.println (ary.length); 【推荐】当一个类有多个构造方法或者多个同名方法这些方法应该按顺序放置在一起便于阅读此条规则优先于下一条。 【推荐】类内方法定义的顺序依次是公有方法或保护方法 私有方法 getter / setter 方法。 说明公有方法是类的调用者和维护者最关心的方法首屏展示最好保护方法虽然只是子类关心也可能是“模板设计模式”下的核心方法而私有方法外部一般不需要特别关心是一个黑盒实现因为承载的信息价值较低所有 Service 和 DAO 的 getter/setter 方法放在类体最后。 【推荐】setter 方法中参数名称与类成员变量名称一致this.成员名 参数名。在 getter/setter 方法中不要增加业务逻辑增加排查问题的难度。 反例 public Integer getData () {if (condition) {return this.data 100;} else {return this.data - 100;}}瑞常见的如分页对象总是有大聪明喜欢修改setter方法 【推荐】循环体内字符串的连接方式使用 StringBuilder 的 append 方法进行扩展。 说明下例中反编译出的字节码文件显示每次循环都会 new 出一个 StringBuilder 对象然后进行 append 操作最后通过 toString 方法返回 String 对象造成内存资源浪费。 反例 String str start;for (int i 0; i 100; i) {str str hello;}瑞关于这点博主保留意见博主通过字节码文件发现字符串的 “” 运算符在底层调用的就是StringBuilder.append() 【推荐】final 可以声明类、成员变量、方法、以及本地变量下列情况使用 final 关键字 1 不允许被继承的类如String 类。 2 不允许修改引用的域对象如POJO 类的域变量。 3 不允许被覆写的方法如POJO 类的 setter 方法。 4 不允许运行过程中重新赋值的局部变量。 5 避免上下文重复使用一个变量使用 final 可以强制重新定义一个变量方便更好地进行重构。 瑞此点需牢记 【推荐】慎用 Object 的 clone 方法来拷贝对象。 说明对象 clone 方法默认是浅拷贝若想实现深拷贝需覆写 clone 方法实现域对象的深度遍历式拷贝。 瑞后续博主会出一篇专门讲解这一点的博客先留个位置 【推荐】类成员与方法访问控制从严 1 如果不允许外部直接通过 new 来创建对象那么构造方法必须是 private。 2 工具类不允许有 public 或 default 构造方法。 3 类非 static 成员变量并且与子类共享必须是 protected。 4 类非 static 成员变量并且仅在本类使用必须是 private。 5 类 static 成员变量如果仅在本类使用必须是 private。 6 若是 static 成员变量考虑是否为 final。 7 类成员方法只供类内部调用必须是 private。 8 类成员方法只对继承类公开那么限制为 protected。 说明任何类、方法、参数、变量严控访问范围。过于宽泛的访问范围不利于模块解耦。思考如果是一个 private 的方法想删除就删除可是一个 public 的 service 成员方法或成员变量删除一下不得手心冒点汗吗变量像自己的小孩尽量在自己的视线内变量作用域太大无限制的到处跑那么你会担心的。 五日期时间 【强制】日期格式化时传入 pattern 中表示年份统一使用小写的 y。 说明日期格式化时yyyy 表示当天所在的年而大写的 YYYY 代表是 week in which yearJDK7 之后引入的概念意思是当天所在的周属于的年份一周从周日开始周六结束只要本周跨年返回的 YYYY就是下一年。 正例表示日期和时间的格式如下所示 new SimpleDateFormat(“yyyy-MM-dd HH:mm:ss”) 【强制】在日期格式中分清楚大写的 M 和小写的 m大写的 H 和小写的 h 分别指代的意义。 说明日期格式中的这两对字母表意如下 1 表示月份是大写的 M 2 表示分钟则是小写的 m 3 24 小时制的是大写的 H 4 12 小时制的则是小写的 h。 【强制】获取当前毫秒数System.currentTimeMillis(); 而不是 new Date().getTime()。 说明如果想获取更加精确的纳秒级时间值使用 System.nanoTime 的方式。在 JDK8 中针对统计时间 等场景推荐使用 Instant 类。 瑞如果是JDK1.8及往后的版本建议使用 Instant 类Instant 线程安全 【强制】不允许在程序任何地方中使用1java.sql.Date 2java.sql.Time 3java.sql.Timestamp。 说明第 1 个不记录时间getHours()抛出异常第 2 个不记录日期getYear()抛出异常第 3 个在构造方法 super((time/1000)*1000)fastTime 和 nanos 分开存储秒和纳秒信息。 反例 java.util.Date.after(Date)进行时间比较时当入参是 java.sql.Timestamp 时会触发 JDK BUG(JDK9 已修复)可能导致比较时的意外结果。 【强制】不要在程序中写死一年为 365 天避免在公历闰年时出现日期转换错误或程序逻辑错误。 正例 // 获取今年的天数 int daysOfThisYear LocalDate.now().lengthOfYear(); /// 获取指定某年的天数 LocalDate.of(2011, 1, 1).lengthOfYear(); 反例 // 第一种情况在闰年 366 天时出现数组越界异常 int [] dayArray new int[365]; // 第二种情况一年有效期的会员制今年 1 月 26 日注册硬编码 365 返回的却是 1 月 25 日 Calendar calendar Calendar.getInstance (); calendar.set ( 2020, 1, 26); calendar.add (Calendar.DATE, 365 ); 【推荐】避免公历闰年 2 月问题。闰年的 2 月份有 29 天一年后的那一天不可能是 2 月 29日。 【推荐】使用枚举值来指代月份。如果使用数字注意 DateCalendar 等日期相关类的月份month 取值在 0-11 之间。 说明参考 JDK 原生注释Month value is 0-based. e.g., 0 for January. 正例 Calendar.JANUARYCalendar.FEBRUARYCalendar.MARCH 等来指代相应月份来进行传参或比较。 六集合处理
【强制】关于 hashCode 和 equals 的处理遵循如下规则 1 只要重写 equals就必须重写 hashCode。 2 因为 Set 存储的是不重复的对象依据 hashCode 和 equals 进行判断所以 Set 存储的对象必须重写这两个方法。 3 如果自定义对象作为 Map 的键那么必须覆写 hashCode 和 equals。 说明String 因为重写了 hashCode 和 equals 方法所以我们可以愉快地使用 String 对象作为 key 来使用。 瑞重写equals()和hashCode()方法在一定情况下可以防止内存泄漏问题的出现 【强制】判断所有集合内部的元素是否为空使用 isEmpty()方法而不是 size()0 的方式。 说明前者的时间复杂度为 O(1)而且可读性更好。 正例 MapString, Object map new HashMap(); if(map.isEmpty()) { System.out.println(“no element in this map.”); } 【强制】在使用 java.util.stream.Collectors 类的 toMap()方法转为 Map 集合时一定要使用含有参数类型为 BinaryOperator参数名为 mergeFunction 的方法否则当出现相同 key值时会抛出 IllegalStateException 异常。 说明参数 mergeFunction 的作用是当出现 key 重复时自定义对 value 的处理策略。 正例 ListPairString, Double pairArrayList new ArrayList(3); pairArrayList.add(new Pair(“version”, 6.19)); pairArrayList.add(new Pair(“version”, 10.24)); pairArrayList.add(new Pair(“version”, 13.14)); MapString, Double map pairArrayList.stream().collect( // 生成的 map 集合中只有一个键值对{version13.14} Collectors.toMap(Pair::getKey, Pair::getValue, (v1, v2) - v2)); 反例 String[] departments new String[] {“iERP”, “iERP”, “EIBU”}; // 抛出 IllegalStateException 异常 MapInteger, String map Arrays.stream(departments) .collect(Collectors.toMap(String::hashCode, str - str)); 【强制】在使用 java.util.stream.Collectors 类的 toMap()方法转为 Map 集合时一定要注意当 value 为 null 时会抛 NPE 异常。 说明在 java.util.HashMap 的 merge 方法里会进行如下的判断 if (value null || remappingFunction null) throw new NullPointerException(); 反例 ListPairString, Double pairArrayList new ArrayList(2); pairArrayList.add(new Pair(“version1”, 4.22)); pairArrayList.add(new Pair(“version2”, null)); MapString, Double map pairArrayList.stream().collect( // 抛出 NullPointerException 异常 Collectors.toMap(Pair::getKey, Pair::getValue, (v1, v2) - v2)); 【强制】ArrayList 的 subList 结果不可强转成 ArrayList否则会抛出ClassCastException 异常java.util.RandomAccessSubList cannot be cast to java.util.ArrayList。 说明subList 返回的是 ArrayList 的内部类 SubList并不是 ArrayList 而是 ArrayList 的一个视图对于 SubList 子列表的所有操作最终会反映到原列表上。 【强制】使用 Map 的方法 keySet()/values()/entrySet()返回集合对象时不可以对其进行添加元素操作否则会抛出 UnsupportedOperationException 异常。 【强制】Collections 类返回的对象如emptyList()/singletonList()等都是 immutable list 不可对其进行添加或者删除元素的操作。 反例如果查询无结果返回 Collections.emptyList()空集合对象调用方一旦进行了添加元素的操作就会触发 UnsupportedOperationException 异常 【强制】在 subList 场景中高度注意对父集合元素的增加或删除均会导致子列表的遍历、增加、删除产生 ConcurrentModificationException 异常。 【强制】使用集合转数组的方法必须使用集合的 toArray(T[] array)传入的是类型完全一致、长度为 0 的空数组。 反例直接使用 toArray 无参方法存在问题此方法返回值只能是 Object[]类若强转其它类型数组将出现ClassCastException 错误。 正例 ListString list new ArrayList(2); list.add(“guan”); list.add(“bao”); String[] array list.toArray(new String[0]); 说明使用 toArray 带参方法数组空间大小的 length 1 等于 0动态创建与 size 相同的数组性能最好。 2 大于 0 但小于 size重新创建大小等于 size 的数组增加 GC 负担。 3 等于 size在高并发情况下数组创建完成之后size 正在变大的情况下负面影响与 2 相同。 4 大于 size空间浪费且在 size 处插入 null 值存在 NPE 隐患。 【强制】在使用 Collection 接口任何实现类的 addAll()方法时都要对输入的集合参数进行NPE 判断。 说明在 ArrayList#addAll 方法的第一行代码即 Object[] a c.toArray(); 其中 c 为输入集合参数如果为 null则直接抛出异常。 【强制】使用工具类 Arrays.asList()把数组转换成集合时不能使用其修改集合相关的方法它的 add/remove/clear 方法会抛出 UnsupportedOperationException 异常。 说明asList 的返回对象是一个 Arrays 内部类并没有实现集合的修改方法。Arrays.asList 体现的是适配器模式只是转换接口后台的数据仍是数组。 String[] str new String[] { “yang”, “hao” }; List list Arrays.asList(str); 第一种情况list.add(“yangguanbao”); 运行时异常。 第二种情况str[0] “changed”; 也会随之修改反之亦然。 【强制】泛型通配符? extends T来接收返回的数据此写法的泛型集合不能使用 add 方法而? super T不能使用 get 方法两者在接口调用赋值的场景中容易出错。 说明扩展说一下 PECS(Producer Extends Consumer Super)原则第一、频繁往外读取内容的适合用? extends T。第二、经常往里插入的适合用? super T 【强制】在无泛型限制定义的集合赋值给泛型限制的集合时在使用集合元素时需要进行instanceof 判断避免抛出 ClassCastException 异常。 说明毕竟泛型是在 JDK5 后才出现考虑到向前兼容编译器是允许非泛型集合与泛型集合互相赋值。 反例 ListString generics null; List notGenerics new ArrayList(10); notGenerics.add(new Object()); notGenerics.add(new Integer(1)); generics notGenerics; // 此处抛出 ClassCastException 异常 String string generics.get(0); 【强制】不要在 foreach 循环里进行元素的 remove/add 操作。remove 元素请使用 Iterator方式如果并发操作需要对 Iterator 对象加锁。 正例 ListString list new ArrayList(); list.add(“1”); list.add(“2”); IteratorString iterator list.iterator(); while (iterator.hasNext()) { String item iterator.next(); if (删除元素的条件) { iterator.remove(); } } 反例 for (String item : list) { if (“1”.equals(item)) { list.remove(item); } } 说明以上代码的执行结果肯定会出乎大家的意料那么试一下把“1”换成“2”会是同样的结果吗 【强制】在 JDK7 版本及以上Comparator 实现类要满足如下三个条件不然 Arrays.sortCollections.sort 会抛 IllegalArgumentException 异常。 说明三个条件如下 1 xy 的比较结果和 yx 的比较结果相反。 2 xyyz则 xz。 3 xy则 xz 比较结果和 yz 比较结果相同。 反例下例中没有处理相等的情况交换两个对象判断结果并不互反不符合第一个条件在实际使用中可能会出现异常。 new ComparatorStudent() { Override public int compare(Student o1, Student o2) { return o1.getId() o2.getId() ? 1 : -1; } }; 【推荐】集合泛型定义时在 JDK7 及以上使用 diamond 语法或全省略。 说明菱形泛型即 diamond直接使用来指代前边已经指定的类型。 正例 // diamond 方式即 HashMapString, String userCache new HashMap(16); // 全省略方式 ArrayListUser users new ArrayList(10); 【推荐】集合初始化时指定集合初始值大小。 说明HashMap 使用 HashMap(int initialCapacity) 初始化如果暂时无法确定集合大小那么指定默认值16即可。 正例initialCapacity (需要存储的元素个数 / 负载因子) 1。注意负载因子即 loader factor默认为 0.75如果暂时无法确定初始值大小请设置为 16即默认值。 反例HashMap 需要放置 1024 个元素由于没有设置容量初始大小随着元素不断增加容量 7 次被迫扩大resize 需要重建 hash 表。当放置的集合元素个数达千万级别时不断扩容会严重影响性能。 瑞推荐阅读《Java集合_快速理解ArrayList的扩容机制》建议通过该文的测试代码多进行测试就能深刻明白本条规约的意义 【推荐】使用 entrySet 遍历 Map 类集合 KV而不是 keySet 方式进行遍历。 说明keySet 其实是遍历了 2 次一次是转为 Iterator 对象另一次是从 hashMap 中取出 key 所对应的value。而 entrySet 只是遍历了一次就把 key 和 value 都放到了 entry 中效率更高。如果是 JDK8使用Map.forEach 方法。 正例values()返回的是 V 值集合是一个 list 集合对象keySet()返回的是 K 值集合是一个 Set 集合对象entrySet()返回的是 K-V 值组合集合。 【推荐】高度注意 Map 类集合 K/V 能不能存储 null 值的情况如下表格
集合类KeyValueSuper说明Hashtable不允许为 null不允许为 nullDictionary线程安全ConcurrentHashMap不允许为 null不允许为 nullAbstractMap锁分段技术JDK8:CASTreeMap不允许为 null允许为 nullAbstractMap线程不安全HashMap允许为 null允许为 nullAbstractMap线程不安全
反例由于 HashMap 的干扰很多人认为 ConcurrentHashMap 是可以置入 null 值而事实上存储null 值时会抛出 NPE 异常 【参考】合理利用好集合的有序性(sort)和稳定性(order)避免集合的无序性(unsort)和不稳定性(unorder)带来的负面影响。 说明有序性是指遍历的结果是按某种比较规则依次排列的。稳定性指集合每次遍历的元素次序是一定的。 如ArrayList 是 order/unsortHashMap 是 unorder/unsortTreeSet 是 order/sort。 【参考】利用 Set 元素唯一的特性可以快速对一个集合进行去重操作避免使用 List 的contains()进行遍历去重或者判断包含操作。 七并发处理
【强制】获取单例对象需要保证线程安全其中的方法也要保证线程安全。 说明资源驱动类、工具类、单例工厂类都需要注意。【强制】创建线程或线程池时请指定有意义的线程名称方便出错时回溯。 正例自定义线程工厂并且根据外部特征进行分组比如来自同一机房的调用把机房编号赋值给whatFeaturOfGroup public class UserThreadFactory implements ThreadFactory {private final String namePrefix;private final AtomicInteger nextId new AtomicInteger(1);// 定义线程组名称在 jstack 问题排查时非常有帮助UserThreadFactory(String whatFeaturOfGroup) {namePrefix From UserThreadFactorys whatFeaturOfGroup -Worker-;}Overridepublic Thread newThread(Runnable task) {String name namePrefix nextId.getAndIncrement();Thread thread new Thread(null, task, name, 0, false);System.out.println(thread.getName());return thread;}}【强制】线程资源必须通过线程池提供不允许在应用中自行显式创建线程。 说明线程池的好处是减少在创建和销毁线程上所消耗的时间以及系统资源的开销解决资源不足的问题。 如果不使用线程池有可能造成系统创建大量同类线程而导致消耗完内存或者“过度切换”的问题。 【强制】线程池不允许使用 Executors 去创建而是通过 ThreadPoolExecutor 的方式这 样的处理方式让写的同学更加明确线程池的运行规则规避资源耗尽的风险。 说明Executors 返回的线程池对象的弊端如下 1 FixedThreadPool 和 SingleThreadPool 允许的请求队列长度为 Integer.MAX_VALUE可能会堆积大量的请求从而导致 OOM。 2 CachedThreadPool 允许的创建线程数量为 Integer.MAX_VALUE可能会创建大量的线程从而导致 OOM。 【强制】SimpleDateFormat 是线程不安全的类一般不要定义为 static 变量如果定义为 static必须加锁或者使用 DateUtils 工具类。 正例注意线程安全使用 DateUtils。亦推荐如下处理 private static final ThreadLocalDateFormat df new ThreadLocalDateFormat() { Override protected DateFormat initialValue() { return new SimpleDateFormat(“yyyy-MM-dd”); } }; 说明如果是 JDK8 的应用可以使用 Instant 代替 DateLocalDateTime 代替 CalendarDateTimeFormatter 代替 SimpleDateFormat官方给出的解释simple beautiful strong immutable thread-safe。 【强制】必须回收自定义的 ThreadLocal 变量尤其在线程池场景下线程经常会被复用如果不清理自定义的 ThreadLocal 变量可能会影响后续业务逻辑和造成内存泄露等问题。尽量在代理中使用 try-finally 块进行回收。 正例 objectThreadLocal.set(userInfo); try { // … } finally { objectThreadLocal.remove(); } 【强制】高并发时同步调用应该去考量锁的性能损耗。能用无锁数据结构就不要用锁能锁区块就不要锁整个方法体能用对象锁就不要用类锁。 说明尽可能使加锁的代码块工作量尽可能的小避免在锁代码块中调用 RPC 方法。 【强制】对多个资源、数据库表、对象同时加锁时需要保持一致的加锁顺序否则可能会造成死锁。 说明线程一需要对表 A、B、C 依次全部加锁后才可以进行更新操作那么线程二的加锁顺序也必须是 A、B、C否则可能出现死锁。 【强制】在使用阻塞等待获取锁的方式中必须在 try 代码块之外并且在加锁方法与 try 代码块之间没有任何可能抛出异常的方法调用避免加锁成功后在 finally 中无法解锁。 说明一如果在 lock 方法与 try 代码块之间的方法调用抛出异常那么无法解锁造成其它线程无法成功获取锁。 说明二如果 lock 方法在 try 代码块之内可能由于其它方法抛出异常导致在 finally 代码块中unlock对未加锁的对象解锁它会调用 AQS 的 tryRelease 方法取决于具体实现类抛出IllegalMonitorStateException 异常。 说明三在 Lock 对象的 lock 方法实现中可能抛出 unchecked 异常产生的后果与说明二相同。 正例 Lock lock new XxxLock(); // … lock.lock(); try { doSomething(); doOthers(); } finally { lock.unlock(); } 反例 Lock lock new XxxLock(); // … try { // 如果此处抛出异常则直接执行 finally 代码块 doSomething(); // 无论加锁是否成功finally 代码块都会执行 lock.lock(); doOthers(); } finnal { lock.unlock(); } 【强制】在使用尝试机制来获取锁的方式中进入业务代码块之前必须先判断当前线程是否持有锁。锁的释放规则与锁的阻塞等待方式相同。 说明Lock 对象的 unlock 方法在执行时它会调用 AQS 的 tryRelease 方法取决于具体实现类如果当前线程不持有锁则抛出 IllegalMonitorStateException 异常。 正例 Lock lock new XxxLock(); // … boolean isLocked lock.tryLock(); if (isLocked) { try { doSomething(); doOthers(); } finally { lock.unlock(); } } 【强制】并发修改同一记录时避免更新丢失需要加锁。要么在应用层加锁要么在缓存加锁要么在数据库层使用乐观锁使用 version 作为更新依据。 说明如果每次访问冲突概率小于 20%推荐使用乐观锁否则使用悲观锁。乐观锁的重试次数不得小于3 次。 【强制】多线程并行处理定时任务时Timer 运行多个 TimeTask 时只要其中之一没有捕获抛出的异常其它任务便会自动终止运行使用 ScheduledExecutorService 则没有这个问题。 【推荐】资金相关的金融敏感信息使用悲观锁策略。 说明乐观锁在获得锁的同时已经完成了更新操作校验逻辑容易出现漏洞另外乐观锁对冲突的解决策略有较复杂的要求处理不当容易造成系统压力或数据异常所以资金相关的金融敏感信息不建议使用乐观锁更新。 正例悲观锁遵循一锁二判三更新四释放的原则 【推荐】使用 CountDownLatch 进行异步转同步操作每个线程退出前必须调用 countDown 方法线程执行代码注意 catch 异常确保 countDown 方法被执行到避免主线程无法执行至await 方法直到超时才返回结果。 说明注意子线程抛出异常堆栈不能在主线程 try-catch 到。 【推荐】避免 Random 实例被多线程使用虽然共享该实例是线程安全的但会因竞争同一 seed导致的性能下降。 说明Random 实例包括 java.util.Random 的实例或者 Math.random()的方式。 正例在 JDK7 之后可以直接使用 API ThreadLocalRandom而在 JDK7 之前需要编码保证每个线程持有一个单独的 Random 实例。 【推荐】通过双重检查锁double-checked locking在并发场景下实现延迟初始化的优化问题隐患(可参考 The “Double-Checked Locking is Broken” Declaration)推荐解决方案中较为简单一种适用于 JDK5 及以上版本将目标属性声明为 volatile 型比如修改 helper 的属 性声明为 private volatile Helper helper null; 。 反例 public class LazyInitDemo {private Helper helper null;public Helper getHelper() {if (helper null) {synchronized (this) {if (helper null) { helper new Helper(); }}}return helper;}// other methods and fields... }【参考】volatile 解决多线程内存不可见问题。对于一写多读是可以解决变量同步问题但是如果多写同样无法解决线程安全问题。 说明如果是 count操作使用如下类实现AtomicInteger count new AtomicInteger(); count.addAndGet(1); 如果是 JDK8推荐使用 LongAdder 对象比 AtomicLong 性能更好减少乐观锁的重试次数。 【参考】HashMap 在容量不够进行 resize 时由于高并发可能出现死链导致 CPU 飙升在开发过程中注意规避此风险。 【参考】ThreadLocal 对象使用 static 修饰ThreadLocal 无法解决共享对象的更新问题。 说明这个变量是针对一个线程内所有操作共享的所以设置为静态变量所有此类实例共享此静态变量也就是说在类第一次被使用时装载只分配一块存储空间所有此类的对象(只要是这个线程内定义的)都可以操控这个变量。 八控制语句 【强制】在一个 switch 块内每个 case 要么通过 continue/break/return 等来终止要么注释说明程序将继续执行到哪一个 case 为止在一个 switch 块内都必须包含一个 default 语句并且放在最后即使它什么代码也没有。 说明注意 break 是退出 switch 语句块而 return 是退出方法体。 【强制】当 switch 括号内的变量类型为 String 并且此变量为外部参数时必须先进行 null判断。 反例如下的代码输出是什么 public class SwitchString {public static void main(String[] args) {method(null);}public static void method(String param) {switch (param) {// 肯定不是进入这里case sth:System.out.println(its sth);break;// 也不是进入这里case null:System.out.println(its null);break;// 也不是进入这里default:System.out.println(default);}}}【强制】在 if/else/for/while/do 语句中必须使用大括号。 说明即使只有一行代码禁止不采用大括号的编码方式if (condition) statements; 【强制】三目运算符 condition? 表达式 1 : 表达式 2 中高度注意表达式 1 和 2 在类型对齐时可能抛出因自动拆箱导致的 NPE 异常。 说明以下两种场景会触发类型对齐的拆箱操作 1 表达式 1 或表达式 2 的值只要有一个是原始类型。 2 表达式 1 或表达式 2 的值的类型不一致会强制拆箱升级成表示范围更大的那个类型。 反例 Integer a 1; Integer b 2; Integer c null; Boolean flag false; // a*b 的结果是 int 类型那么 c 会强制拆箱成 int 类型抛出 NPE 异常 Integer result(flag? a*b : c) 【强制】在高并发场景中避免使用”等于”判断作为中断或退出的条件。 说明如果并发控制没有处理好容易产生等值判断被“击穿”的情况使用大于或小于的区间判断条件来代替。 反例判断剩余奖品数量等于 0 时终止发放奖品但因为并发处理错误导致奖品数量瞬间变成了负数这样的话活动无法终止。 【推荐】当某个方法的代码行数超过 10 行时return / throw 等中断逻辑的右大括号后加一个空行。 说明这样做逻辑清晰有利于代码阅读时重点关注。 【推荐】表达异常的分支时少用 if-else 方式这种方式可以改写成 if (condition) { … return obj; } // 接着写 else 的业务逻辑代码; 说明如果非使用 if()…else if()…else…方式表达逻辑避免后续代码维护困难请勿超过 3 层。 正例超过 3 层的 if-else 的逻辑判断代码可以使用卫语句、策略模式、状态模式等来实现其中卫语句 示例如下 public void findBoyfriend (Man man){if (man.isUgly()) {System.out.println(本姑娘是外貌协会的资深会员);return;}if (man.isPoor()) {System.out.println(贫贱夫妻百事哀);return;}if (man.isBadTemper()) {System.out.println(银河有多远你就给我滚多远);return;}System.out.println(可以先交往一段时间看看);}【推荐】除常用方法如 getXxx/isXxx等外不要在条件判断中执行其它复杂的语句将复杂逻辑判断的结果赋值给一个有意义的布尔变量名以提高可读性。 说明很多 if 语句内的逻辑表达式相当复杂与、或、取反混合运算甚至各种方法纵深调用理解成本非常高。如果赋值一个非常好理解的布尔变量名字则是件令人爽心悦目的事情。 正例 // 伪代码如下 final boolean existed (file.open(fileName, font colorgreen“w”) ! null) (…) || (…); if (existed) { … } 反例 public final void acquire ( long arg){ if (!tryAcquire(arg) acquireQueued(addWaiter(Node.EXCLUSIVE), arg)) { selfInterrupt(); } 【推荐】不要在其它表达式尤其是条件表达式中插入赋值语句。 说明赋值点类似于人体的穴位对于代码的理解至关重要所以赋值语句需要清晰地单独成为一行。 反例 public Lock getLock(boolean fair) { // 算术表达式中出现赋值操作容易忽略 count 值已经被改变 threshold (count Integer.MAX_VALUE) - 1; // 条件表达式中出现赋值操作容易误认为是 syncfair return (sync fair) ? new FairSync() : new NonfairSync(); } 【推荐】循环体中的语句要考量性能以下操作尽量移至循环体外处理如定义对象、变量、获取数据库连接进行不必要的 try-catch 操作这个 try-catch 是否可以移至循环体外。 【推荐】避免采用取反逻辑运算符。 说明取反逻辑不利于快速理解并且取反逻辑写法必然存在对应的正向逻辑写法。 正例使用 if (x 628) 来表达 x 小于 628。 反例使用 if (!(x 628)) 来表达 x 小于 628。 【推荐】接口入参保护这种场景常见的是用作批量操作的接口。 反例某业务系统提供一个用户批量查询的接口API 文档上有说最多查多少个但接口实现上没做任何保护导致调用方传了一个 1000 的用户 id 数组过来后查询信息后内存爆了。 【参考】下列情形需要进行参数校验 1 调用频次低的方法。 2 执行时间开销很大的方法。此情形中参数校验时间几乎可以忽略不计但如果因为参数错误导致中间执行回退或者错误那得不偿失。 3 需要极高稳定性和可用性的方法。 4 对外提供的开放接口不管是 RPC/API/HTTP 接口。 5 敏感权限入口。 【参考】下列情形不需要进行参数校验 1 极有可能被循环调用的方法。但在方法说明里必须注明外部参数检查。 2 底层调用频度比较高的方法。毕竟是像纯净水过滤的最后一道参数错误不太可能到底层才会暴露问题。一般 DAO 层与 Service 层都在同一个应用中部署在同一台服务器中所以 DAO 的参数校验可以省略。 3 被声明成 private 只会被自己代码所调用的方法如果能够确定调用方法的代码传入参数已经做过检 查或者肯定不会有问题此时可以不校验参数。 九注释规约
【强制】类、类属性、类方法的注释必须使用 Javadoc 规范使用/** 内容*/格式不得使用 // xxx 方式。 说明在 IDE 编辑窗口中Javadoc 方式会提示相关注释生成 Javadoc 可以正确输出相应注释在 IDE中工程调用方法时不进入方法即可悬浮提示方法、参数、返回值的意义提高阅读效率。 瑞推荐阅读《【IDEA】瑞_IDEA模版注释设置_IDEA自动生成注释模版详细图文步骤》将注释模版设置好提升开发效率 【强制】所有的抽象方法包括接口中的方法必须要用 Javadoc 注释、除了返回值、参数、异常说明外还必须指出该方法做什么事情实现什么功能。 说明对子类的实现要求或者调用注意事项请一并说明。 【强制】所有的类都必须添加创建者和创建日期。 说明在设置模板时注意 IDEA 的author 为${USER}而 eclipse 的author 为${user}大小写有区别而日期的设置统一为 yyyy/MM/dd 的格式。 正例
/*** author yangguanbao* date 2016/10/31*/瑞推荐阅读《【IDEA】瑞_IDEA模版注释设置_IDEA自动生成注释模版详细图文步骤》将注释模版设置好提升开发效率 【强制】方法内部单行注释在被注释语句上方另起一行使用 // 注释。方法内部多行注释使用/* */注释注意与代码对齐。 瑞IDEA代码格式化快捷键ctrl alt L 【强制】所有的枚举类型字段必须要有注释说明每个数据项的用途。 【推荐】与其“半吊子”英文来注释不如用中文注释把问题说清楚。专有名词与关键字保持英文原文即可。 反例“TCP 连接超时”解释成“传输控制协议连接超时”理解反而费脑筋。 瑞咱就是说推广普通话让生活更精彩让代码更贴心 【推荐】代码修改的同时注释也要进行相应的修改尤其是参数、返回值、异常、核心逻辑等的修改。 说明代码与注释更新不同步就像路网与导航软件更新不同步一样如果导航软件严重滞后就失去了导航的意义。 【推荐】在类中删除未使用的任何字段和方法在方法中删除未使用的任何参数声明与内部变量。 【参考】谨慎注释掉代码。在上方详细说明而不是简单地注释掉。如果无用则删除。 说明代码被注释掉有两种可能性1后续会恢复此段代码逻辑。2永久不用。前者如果没有备注信息难以知晓注释动机。后者建议直接删掉即可假如需要查阅历史代码登录代码仓库即可。 【参考】对于注释的要求第一、能够准确反映设计思想和代码逻辑第二、能够描述业务含义使别的程序员能够迅速了解到代码背后的信息。完全没有注释的大段代码对于阅读者形同天书注释是给自己看的即使隔很长时间也能清晰理解当时的思路注释也是给继任者看的使其能够快速接替自己的工作。 【参考】好的命名、代码结构是自解释的注释力求精简准确、表达到位。避免出现注释的一个极端过多过滥的注释代码的逻辑一旦修改修改注释是相当大的负担。 反例 // put elephant into fridge put(elephant, fridge); 方法名 put加上两个有意义的变量名 elephant 和 fridge已经说明了这是在干什么语义清晰的代码不 需要额外的注释。 【参考】特殊注释标记请注明标记人与标记时间。注意及时处理这些标记通过标记扫描经常清理此类标记。线上故障有时候就是来源于这些标记处的代码。 1 待办事宜TODO:标记人标记时间[预计处理时间] 表示需要实现但目前还未实现的功能。这实际上是一个 Javadoc 的标签目前的 Javadoc 还没 有实现但已经被广泛使用。只能应用于类接口和方法因为它是一个 Javadoc 标签。 2 错误不能工作FIXME:标记人标记时间[预计处理时间] 在注释中用 FIXME 标记某代码是错误的而且不能工作需要及时纠正的情况。 十其它 【强制】在使用正则表达式时利用好其预编译功能可以有效加快正则匹配速度。 说明不要在方法体内定义Pattern pattern Pattern.compile(“规则”); 【强制】避免用 Apache Beanutils 进行属性的 copy。 说明Apache BeanUtils 性能较差可以使用其他方案比如 Spring BeanUtils, Cglib BeanCopier注意均是浅拷贝。 瑞实在不行就无脑 get 再 set 吧用最原始的方式达到最好的效果 【强制】velocity 调用 POJO 类的属性时直接使用属性名取值即可模板引擎会自动按规范调用 POJO 的 getXxx()如果是 boolean 基本数据类型变量boolean 命名不需要加 is 前缀会自动调用 isXxx()方法。 说明注意如果是 Boolean 包装类对象优先调用 getXxx()的方法。 【强制】后台输送给页面的变量必须加$!{var}——中间的感叹号。 正例如果 var 等于 null 或者不存在那么${var}会直接显示在页面上。 【强制】注意 Math.random() 这个方法返回是 double 类型注意取值的范围 0≤x1能够取到零值注意除零异常如果想获取整数类型的随机数不要将 x 放大 10 的若干倍然后取整直接使用 Random 对象的 nextInt 或者 nextLong 方法。 【推荐】不要在视图模板中加入任何复杂的逻辑。 说明根据 MVC 理论视图的职责是展示不要抢模型和控制器的活。 【推荐】任何数据结构的构造或初始化都应指定大小避免数据结构无限增长吃光内存。 【推荐】及时清理不再使用的代码段或配置信息。 说明对于垃圾代码或过时配置坚决清理干净避免程序过度臃肿代码冗余。 正例对于暂时被注释掉后续可能恢复使用的代码片断在注释代码上方统一规定使用三个斜杠(///)来说明注释掉代码的理由。如 public static void hello() { /// 业务方通知活动暂停 // Business business new Business(); // business.active(); System.out.println(“it’s finished”); } 瑞再不济你加个TODO留个言也行啊不然后面接手的人不删难受删又不敢 本文是博主的粗浅理解可能存在一些错误或不完善之处如有遗漏或错误欢迎各位补充谢谢 如果觉得这篇文章对您有所帮助的话请动动小手点波关注你的点赞收藏⭐️转发评论都是对博主最好的支持~
