阿里巴巴开发规约之编程规约（2）

最新推荐文章于 2024-03-12 07:45:00 发布

敲敲牛皮糖

最新推荐文章于 2024-03-12 07:45:00 发布

阅读量619

点赞数

分类专栏： java 文章标签： java

本文链接：https://blog.csdn.net/PINfine/article/details/122652157

版权

java 专栏收录该内容

15 篇文章 0 订阅

订阅专栏

前言

碎碎念

最近快过年了，无心工作，只想回家过年。听着外面的鸟叫，明明是冬天却感觉像是春天才会出现的鸟儿。看来是小鸟说回家过年，回家过年了。哈哈哈，废话不多说，咱么继续书接上回。
在这里插入图片描述

正文

上回分享了规约的来历，以及规约的好处。好的，现在脑袋里都有了概念，我们继续。

常量定义

没学习规约之前，我的常量定义的都很随意。随用随定义，你问我不要用魔法值，我说Java还有魔法值？

【强制】不允许任何魔法值(即未经预先定义的常量)直接出现在代码中。
反例:
// 本例中，开发者 A 定义了缓存的 key，然后开发者 B 使用缓存时少了下划线，即 key 是"Id#taobao"+tradeId，导致出现故障
String key = “Id#taobao_” + tradeId;
cache.put(key, value);
说明：常量的含义就是不变量的量，说明任何人想使用这个值都是不变的。我工作中一般这样使用常量(常量名大写)：

private static final String NAME = "哪吒三太子";
private static final Integer AGE =  18;

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

//正例
private static final Long money = 10000000000000L; 
//反例（禁止使用）
private static final Long money = 10000l;

代码格式

1. 【强制】如果是大括号内为空，则简洁地写成{}即可，大括号中间无需换行和空格;如果是非空代码块则:

左大括号前不换行。
左大括号后换行。
右大括号前换行。
右大括号后还有 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 。
正例: (涉及 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”);
// 在右大括号后直接结束，则必须换行
} }
;而在 Eclipse 中，必须勾选
insert spaces for tabs
5/59
Java 开发手册
6. 【强制】注释的双斜线与注释内容之间有且仅有一个空格。
正例:
// 这是示例注释，请注意在双斜线之后有一个空格
String commentString = new String();
7. 【强制】在进行类型强制转换时，右括号与强制转换值之间不需要任何空格隔开。
正例:
8. 【强制】单行字符数限制不超过 120 个，超出需要换行，换行时遵循如下原则: 1)第二行相对第一行缩进 4 个空格，从第三行开始，不再继续缩进，参考示例。 2)运算符与下文一起换行。
3)方法调用的点符号与下文一起换行。 4)方法调用中的多个参数需要换行时，在逗号后进行。
5)在括号前不要换行，见反例。正例:
StringBuilder sb = new StringBuilder();
// 超过 120 个字符的情况下，换行缩进 4 个空格，并且方法前的点号一起换行 sb.append(“yang”).append(“hao”)…
.append(“chen”)… .append(“chen”)… .append(“chen”);
反例:
StringBuilder sb = new StringBuilder();
// 超过 120 个字符的情况下，不要在括号前换行 sb.append(“you”).append(“are”)…append
(“lucky”);
// 参数很多的方法调用可能超过 120 个字符，逗号后才是换行处
method(args1, args2, args3, … , argsX);
9. 【强制】方法参数在定义和传入时，多个参数逗号后面必须加空格。正例:下例中实参的 args1，后边必须要有一个空格。
method(args1, args2, args3);
10.【强制】IDE 的 text file encoding 设置为 UTF-8; IDE 中文件的换行符使用 Unix 格式，不要使用 Windows 格式。

总结

教大家一招，只需要两步，自动搞定格式化。
1、control + A
2、option + command + L（Mac ） ctrl + alt + L（windows）

OOP规约

OOP（object oriente programming）面向对象程序设计。万物皆可对象，这是Java的设计理念。
1. 【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法，无谓增加编译器解析成本，直接用类名来访问即可。
说明：首先要明白，虚拟机是如何处理静态变量和静态方法。静态变量和静态方法随着类的加载而加载，是早于对象的创建，同时存放于方法区的静态领域中。因此可以直接使用类名进行访问。
对象创建的顺序可简化成：类加载检查—>分配内存—>初始化零值—>设置对象头—>执行 init 。由此可见，使用对象去访问静态方法或静态变量岂不是脱裤子放屁多此一举。

class Item{
	private static final String NAME = "哪吒三太子";
}
//访问
Item.SNAME;

2. 【强制】所有的覆写方法，必须加@Override注解。
方法签名： 1、方法名 2、参数列表（形参类别、个数、顺序）
说明:getObject()与 get0bject()的问题。一个是字母的 O，一个是数字的 0，加@Override 可以准确判断是否覆盖成功。另外，如果在抽象类中对方法签名进行修改，其实现类会马上编译报错。

public abstract class ItemAbstract {
    void getObject(){
        System.out.println("haha");
    }
}
public class Item extends ItemAbstract{
    @Override
    void getObject() {
        super.getObject();
    }
    
    void get0bject() {
        super.getObject();
    }
}

3、【强制】相同参数类型，相同业务含义，才可以使用 Java 的可变参数，避免使用 Object。
说明:可变参数必须放置在参数列表的最后。(建议开发者尽量不用可变参数编程)
正例:public List listUsers(String type, Long… ids) {…}
使用可变参数，会存在风险性，你不清楚调用法会给你传输什么，恰巧你代码中有没有对入参进行校验，会使你的系统具有风险性。

public class Test02 {
    public static void main(String[] args) {
        test("123", "123", 123);
    }
    public static void test(Object ...objects){
       for(Object o : objects){
           if(o == null){
               continue;
           }
           System.out.println(Long.valueOf((String) o));
       }
    }
}

当执行到第三个参数的时候控制台会抛出异常：
Exception in thread "main" java.lang.ClassCastException: java.lang.Integer cannot be cast to java.lang.String

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

   /*二方包V1*/
    public static void test(Long money){
    }
    /*二方包V2*/
    public static void test(Long money , String name){
    }
    如果此时你没有通知调用方升级版本，调用方就会调用失败，找不到test方法。

5. 【强制】不能使用过时的类或方法。
说明:java.net.URLDecoder 中的方法 decode(String encodeStr) 这个方法已经过时，应该使用双参数 decode(String source, String encode)。接口提供方既然明确是过时接口，那么有义务同时提供新的接口; 作为调用方来说，有义务去考证过时方法的新实现是什么。
6. 【强制】Object的equals方法容易抛空指针异常，应使用常量或确定有值的对象来调用equals。
正例:“test”.equals(object);
反例:object.equals(“test”);
说明：object当你不能完全保证不为null的时候，此时调用equals就会失败。就算你当前能保证，但是你能保证数据库中突然来个脏数据，或者环境的原因恰巧到你服务到你的方法上，出现烦人的空指针异常，是不是很头大。
7. 【强制】所有整型包装类对象之间值的比较，全部使用equals方法比较。
说明:对于 Integer var = ? 在-128 至 127 之间的赋值，Integer 对象是在 IntegerCache.cache 产生，会复用已有对象，这个区间内的 Integer 值可以直接使用==进行判断，但是这个区间之外的所有数据，都会在堆上产生，并不会复用已有对象，这是一个大坑，推荐使用 equals 方法进行判断。
看下源码可知道，当值在-128和127之间是去cache中拿的，大于在则会新new一个对象。

部分源码
    public static Integer valueOf(int i) {
        if (i >= IntegerCache.low && i <= IntegerCache.high)
            return IntegerCache.cache[i + (-IntegerCache.low)];
        return new Integer(i);
    }
 private static class IntegerCache {
        static final int low = -128;
        static final int high;
        static final Integer cache[];

        static {
            // high value may be configured by property
            int h = 127;
            String integerCacheHighPropValue =
                sun.misc.VM.getSavedProperty("java.lang.Integer.IntegerCache.high");
            if (integerCacheHighPropValue != null) {
                try {
                    int i = parseInt(integerCacheHighPropValue);
                    i = Math.max(i, 127);
                    // Maximum array size is Integer.MAX_VALUE
                    h = Math.min(i, Integer.MAX_VALUE - (-low) -1);
                } catch( NumberFormatException nfe) {
                    // If the property cannot be parsed into an int, ignore it.
                }
            }
            high = h;

            cache = new Integer[(high - low) + 1];
            int j = low;
            for(int k = 0; k < cache.length; k++)
                cache[k] = new Integer(j++);

            // range [-128, 127] must be interned (JLS7 5.1.7)
            assert IntegerCache.high >= 127;
        }

    }

public static void main(String[] args) {
        Integer value1 = 126;
        Integer value2 = 126;
        Integer value3 = 876;
        Integer value4 = 876;
        System.out.println(value1 == value2);
        System.out.println(value3 == value4);
        System.out.println(value3.equals(value4));
     }
控制台输出：
true
false
true

8. 【强制】任何货币金额，均以最小货币单位且整型类型来进行存储。
说明：防止因为精度问题，导致金额信息丢失。毕竟关于钱的要锱铢必较。
9. 【强制】浮点数之间的等值判断，基本数据类型不能用来比较，包装数据类型不能用 equals 来判断。
说明:浮点数采用“尾数+阶码”的编码方式，类似于科学计数法的“有效数字+指数”的表示方式。二进制无法精确表示大部分的十进制小数，具体原理参考《码出高效》。
反例:
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
}
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©;
if (x.compareTo(y) == 0) { System.out.println(“true”);
}
10.【强制】如上所示 BigDecimal 的等值比较应使用 compareTo()方法，而不是 equals()方法。
说明:equals()方法会比较值和精度(1.0 与 1.00 返回结果为 false)，而 compareTo()则会忽略精度。

public static void main(String[] args) {
        BigDecimal v1 = new BigDecimal("1.00");
        BigDecimal v2 = new BigDecimal("1.0");
        //比较精度
        System.out.println(v1.equals(v2));
        //忽略精度
        System.out.println(v1.compareTo(v2) == 0);
     }
控制台输出
false
true

11.【强制】定义数据对象 DO 类时，属性类型要与数据库字段类型相匹配。
正例:数据库字段的 bigint 必须与类属性的 Long 类型相对应。
反例:某个案例的数据库表 id 字段定义类型 bigint unsigned，实际类对象属性为 Integer，随着 id 越来越大，超过 Integer 的表示范围而溢出成为负数。
因为二进制的第一位表示的是数的正负。1表示的是负数，0表示的是正数

  public static void main(String[] args) {
        Integer integer = Integer.MAX_VALUE;
        System.out.println(integer + 1);
     }
控制台输出
-2147483648

12.【强制】禁止使用构造方法 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 值，能够表示额外的信息，如:远程调用失败，异常退出。
14.【强制】定义 DO/DTO/VO 等 POJO 类时，不要设定任何属性默认值。
反例:POJO 类的 createTime 默认值为 new Date()，但是这个属性在数据提取时并没有置入具体值，在更新其它字段时又附带更新了此字段，导致创建时间被修改成当前时间。说明：数据库中取出来的数据可能会为NULL，有默认值的话，则就改变了此值在数据库中表示的含义了。
15.【强制】序列化类新增属性时，请不要修改 serialVersionUID 字段，避免反序列失败;如果完全不兼容升级，避免反序列化混乱，那么请修改 serialVersionUID 值。
说明:注意 serialVersionUID 不一致会抛出序列化运行时异常。
16.【强制】构造方法里面禁止加入任何业务逻辑，如果有初始化逻辑，请放在 init 方法中。
17.【强制】POJO 类必须写 toString 方法。使用 IDE 中的工具:source> generate toString 时，如果继承了另一个 POJO 类，注意在前面加一下 super.toString。说明:在方法执行抛出异常时，可以直接调用 POJO 的 toString()方法打印其属性值，便于排查问题。

18. 【强制】禁止在POJO类，同时存在对应的属性xxx的isXxx（）和getXxx（）方法。
说明:框架在调用属性 xxx 的提取方法时，并不能确定哪个方法一定是被优先调用到的。

总结

好啦，今天就到这里了。上传睡觉。看到这不同意在给大家看个美女，解解乏。
在这里插入图片描述

敲敲牛皮糖

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
1
评论
阿里巴巴开发规约之编程规约（2）

前言碎碎念最近快过年了，无心工作，只想回家过年。听着外面的鸟叫，明明是冬天却感觉像是春天才会出现的鸟儿。看来是小鸟说回家过年，回家过年了。哈哈哈，废话不多说，咱么继续书接上回。正文上回分享了规约的来历，以及规约的好处。好的，现在脑袋里都有了概念，我们继续。常量定义没学习规约之前，我的常量定义的都很随意。随用随定义，你问我不要用魔法值，我说Java还有魔法值？【强制】不允许任何魔法值(即未经预先定义的常量)直接出现在代码中。反例:// 本例中，开发者 A 定义了缓存的 key，然后开发者
复制链接

扫一扫