无知的小狼

【强制】类、类属性、类方法的注释必须使用Javadoc规范，使用/*内容/格式，不得使用// xxx方式。 说明：在IDE编辑窗口中，Javadoc方式会提示相关注释，生成Javadoc可以正确输出相应注释；在IDE中，工程调用方法时，不进入方法即可悬浮提示方法、参数、返回值的意义，提高阅读效率。 【强制】所有的抽象方法（包括接口中的方法）必须要用Javadoc注释、除了返回值、参数、异常说明外，还必须指出该方法做什么事情，实现什么功能。 说明：对子类的实现要求，或者调用注意事项，请一并说明。 【强制】所有的类都必须添加创建者和创建日期。 说明：在设置模板时，注意IDEA的@author为${USER}，而eclipse的@author为${user}，大小写有区别，而日期的设置统一为yyyy/MM/dd的格式。 正例： /** @author yangguanbao @date 2016/10/31*/ 【强制】方法内部单行注释，...

【强制】在一个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(“it’s sth”);break;// 也不是进入这里case “null”:System.out.println(“i...

【强制】获取单例对象需要保证线程安全，其中的方法也要保证线程安全。 说明：资源驱动类、工具类、单例工厂类都需要注意。 【强制】创建线程或线程池时请指定有意义的线程名称，方便出错时回溯。 正例：自定义线程工厂，并且根据外部特征进行分组，比如，来自同一机房的调用，把机房编号赋值给whatFeaturOfGrouppublic class UserThreadFactory implements ThreadFactory {private final String namePrefix;private final AtomicInteger nextId = new AtomicInteger(1);// 定义线程组名称，在jstack问题排查时，非常有帮助UserThreadFactory(String whatFeaturOfGroup) {namePrefix = “From UserThreadFactory’s “ + whatFeaturOfGroup + “-Worker-“;}@Overridepublic Thread ne...

【强制】关于hashCode和equals的处理，遵循如下规则： 1） 只要重写equals，就必须重写hashCode。 2） 因为Set存储的是不重复的对象，依据hashCode和equals进行判断，所以Set存储的对象必须重写这两个方法。 3） 如果自定义对象作为Map的键，那么必须覆写hashCode和equals。 说明：String因为重写了hashCode和equals方法，所以我们可以愉快地使用String对象作为key来使用。 【强制】判断所有集合内部的元素是否为空，使用isEmpty()方法，而不是size()==0的方式。 说明：前者的时间复杂度为O(1)，而且可读性更好。 正例：Map<String, Object> map = new HashMap<>();if(map.isEmpty()) {System.out.println(“no element in this map.”);} 【强制】在使用java.util.stream.Collectors类的toMap()方法转为Map集合时，...

(五) 日期时间 【强制】日期格式化时，传入 pattern 中表示年份统一使用小写的 y。说明：日期格式化时，yyyy 表示当天所在的年，而大写的 YYYY 代表是 week in which year（JDK7 之后引入的概念），意思是当天所在的周属于的年份，一周从周日开始，周六结束，只要本周跨年，返回的 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 中，针对统计时间等场景，推荐使...

(四) OOP 规约 【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法，无谓增加编译器解析成本，直接用类名来访问即可。 【强制】所有的覆写方法，必须加@Override 注解。说明：getObject()与 get0bject()的问题。一个是字母的 O，一个是数字的 0，加@Override 可以准确判断是否覆盖成功。另外，如果在抽象类中对方法签名进行修改，其实现类会马上编译报错。 【强制】相同参数类型，相同业务含义，才可以使用 Java 的可变参数，避免使用 Object。说明：可变参数必须放置在参数列表的最后。（提倡同学们尽量不用可变参数编程）正例：public List listUsers(String type, Long… ids) {…} 【强制】外部正在调用或者二方库依赖的接口，不允许修改方法签名，避免对接口调用方产生影响。接口过时必须加@Deprecated 注解，并清晰地说明采用的新接口或者新服务是什么。 【强制】不能使用过时的类或方法。说明：java.net.URLDecoder 中的方法 decode(String encodeS...

(三) 代码格式 【强制】 如果是大括号内为空，则简洁地写成{}即可，大括号中间无需换行和空格；如果是非空代码块则：1） 左大括号前不换行。2） 左大括号后换行。3） 右大括号前换行。4） 右大括号后还有 else 等代码则不换行；表示终止的右大括号后必须换行。 【强制】 左小括号和右边相邻字符之间不出现空格； 右小括号和左边相邻字符之间也不出现空格；而左大括号前需要加空格。详见第 5 条下方正例提示。反例： if (空格 a == b 空格) 【强制】 if/for/while/switch/do 等保留字与括号之间都必须加空格。 【强制】 任何二目、 三目运算符的左右两边都需要加一个空格。说明： 包括赋值运算符=、逻辑运算符&&、加减乘除符号等。 【强制】 采用 4 个空格缩进，禁止使用 tab 字符。说明：如果使用 tab 缩进，必须设置 1 个 tab 为 4 个空格。 IDEA 设置 tab 为 4 个空格时，请勿勾选 Use tabcharacter；而在 eclipse 中，必须...

【强制】不允许任何魔法值（即未经预先定义的常量）直接出现在代码中。反例：(二) 常量定义//本例中同学 A 定义了缓存的 key，然后缓存提取的同学 B 使用了 Id#taobao 来提取，少了下划线，导致故障。String key = “Id#taobao_” + tradeId;cache.put(key, value); 【强制】在 long 或者Long 赋值时，数值后使用大写的 L，不能是小写的 l，小写容易跟数字混淆，造成误解。说明：Long a = 2l; 写的是数字的 21，还是Long 型的 2。 【推荐】不要使用一个常量类维护所有常量，要按常量功能进行归类，分开维护。说明：大而全的常量类，杂乱无章，使用查找功能才能定位到修改的常量，不利于理解，也不利于维护。正例：缓存相关常量放在类 CacheConsts 下；系统配置相关常量放在类 ConfigConsts 下。 【推荐】常量的复用层次有五层：跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。1） 跨应用共享常量：放置在二方库中，通常...

泰山版，首次发布错误码统一方案一、 编程规约(一) 命名风格 【强制】代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。反例：name / name / $name / name / name$ / name 【强制】所有编程相关的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，纯拼音命名方式更要避免采用。正例：ali / alibaba / taobao / cainiao/ aliyun/ youku / hangzhou 等国际通用的名称，可视同英文。反例：DaZhePromotion [打折] / getPingfenByName() [评分] / int 某变量 = 3 【强制】类名使用 UpperCamelCase 风格，但以下情形例外：DO / BO / DTO / VO ...

最近公司也在培训编程规范，个人呢，顺道把疫情期间阿里云1分钱的羊毛机会也用了。大家感兴趣的话，可以去考一下这个。感觉编程的规范还是有必要学习一下的。毕竟别人的代码你看着顺眼，你的代码别人看着顺眼，工作起来才更加舒服。才不会被打。最近的话，就分享一下各种的编程规范了。 泰山版，首次发布错误码统一方案一、 编程规约(一) 命名风格 【强制】代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。反例：name / name / $name / name / name$ / name 【强制】所有编程相关的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，纯拼音命名方式更要避免采用。正例：ali / alibaba / taobao / cainiao/ aliyun/ youku / hangzhou 等国际通用的名称，可视同英文。反例：DaZhePromotio...