Java开发优质代码养成

目录

集合容器Collection

迭代entrySet()

使用Collection.isEmpty() 检测空

初始化集合时尽量指定其大小

使用静态代码块赋值静态成员变量

频繁调用Collection.contains

toArray

字符串

使用StringBuilder拼接字符串

工具类中屏蔽构造函数

避免 " " + value

String.split(String regex)部分符号转义

类与对象

equals

避免使用BigDecimal(double)

枚举字段

返回非null

优先使用常量equals

---

集合容器Collection

迭代entrySet()

当循环中只需要获取Map 的主键key时，迭代keySet() 是正确的；但是，当需要主键key 和取值value 时，迭代entrySet() 才是更高效的做法，其比先迭代keySet() 后再去通过get 取值性能更佳。

反例：

HashMap<String, String> map = new HashMap<>();
for (String key : map.keySet()) {
    String value = map.get(key);
}

正例：

HashMap<String, String> map = new HashMap<>();
for (Map.Entry<String, String> entry : map.entrySet()) {
    String key = entry.getKey();
    String value = entry.getValue();
}

使用Collection.isEmpty() 检测空

使用Collection.size() 来检测是否为空在逻辑上没有问题，但是使用Collection.isEmpty() 使得代码更易读，并且可以获得更好的性能；除此之外，任何Collection.isEmpty() 实现的时间复杂度都是O(1) ，不需要多次循环遍历，但是某些通过Collection.size() 方法实现的时间复杂度可能是O(n)

反例：

LinkedList<Object> collection = new LinkedList<>();
if (collection.size() == 0) {
    System.out.println("collection is empty.");
}

正例：

LinkedList<Object> collection = new LinkedList<>();
if (collection.isEmpty()) {
    System.out.println("collection is empty.");
}

if (CollectionUtils.isEmpty(collection)) {
    System.out.println("collection is null.");
}

初始化集合时尽量指定其大小

尽量在初始化时指定集合的大小，能有效减少集合的扩容次数，因为集合每次扩容的时间复杂度很可能时O(n)，耗费时间和性能。

反例：

int[] arr = new int[]{1, 2, 3, 4};
List<Integer> list = new ArrayList<>();
for (int i : arr) {
    list.add(i);
}

正例：

int[] arr = new int[]{1, 2, 3, 4};
List<Integer> list = new ArrayList<>(arr.length);
for (int i : arr) {
    list.add(i);
}

使用静态代码块赋值静态成员变量

对于集合类型的静态成员变量，应该使用静态代码块赋值，而不是使用集合实现来赋值。

反例：

private static Map<String, Integer> map = new HashMap<String, Integer>() {
    {
        map.put("Leo", 1);
        map.put("Family-loving", 2);
        map.put("Cold on the out side passionate on the inside", 3);
    }
};

正例：

private static Map<String, Integer> map = new HashMap<String, Integer>();
static {
    map.put("Leo", 1);
    map.put("Family-loving", 2);
    map.put("Cold on the out side passionate on the inside", 3);
}

频繁调用Collection.contains

在Java 集合类库中，List的contains 方法普遍时间复杂度为O(n)，若代码中需要频繁调用contains 方法查找数据则先将集合list 转换成HashSet 实现，将O(n) 的时间复杂度将为O(1)。

反例：

List<Object> list = new ArrayList<>();
for (int i = 0; i <= Integer.MAX_VALUE; i++) {
    if (list.contains(i))
        System.out.println("list contains " + i);
}

正例:

List<Object> list = new ArrayList<>();
Set<Object> set = new HashSet<>();
for (int i = 0; i <= Integer.MAX_VALUE; i++) {
    if (set.contains(i)) {
        System.out.println("list contains " + i);
    }
}

toArray

使用集合转数组的方法，必须使用集合的toArray(T[] array)，传入的是类型完全一样的数组，大小就是list.size()。

反例：

List<String> list = new ArrayList<String>(2);
list.add("我是");
list.add("好人");
String[] strings = new String[2];
strings = list.toArray();

正例：

List<String> list = new ArrayList<String>(2);
list.add("我是");
list.add("好人");
String[] strings = new String[2];
strings = list.toArray(strings);

 

字符串

使用StringBuilder拼接字符串

一般的字符串拼接在编译期Java 会对其进行优化，但是在循环中字符串的拼接Java 编译期无法执行优化，所以需要使用StringBuilder 进行替换。

反例：

String str = "";
for (int i = 0; i < 10; i++) {
    str += i;
}

正例：

StringBuilder sb = new StringBuilder();
for (int i = 0; i < 10; i++) {
    sb.append(i);
}

工具类中屏蔽构造函数

工具类是一堆静态字段和函数的集合，其不应该被实例化；但是，Java 类有隐藏的无参构造，为了避免不必要的实例化，应该显式定义私有构造函数来屏蔽这个隐式公有构造函数。

避免 " " + value

把其它对象或类型转化为字符串时，使用String.valueOf(value) 比 ""+value 的效率更高。

反例：

int num = 520;
String strLove = "" + num;

正例：

int num = 520;
String strLove = String.valueOf(num);

String.split(String regex)部分符号转义

使用字符串String 的plit 方法时，传入的分隔字符串是正则表达式，则部分关键字（比如 .[]()| 等）需要转义。

反例：

String[] split = "a.ab.abc".split(".");
System.out.println(Arrays.toString(split));   // 结果为[]

String[] split1 = "a|ab|abc".split("|");
System.out.println(Arrays.toString(split1));  // 结果为["a", "|", "a", "b", "|", "a", "b", "c"]

正例：

String[] split2 = "a.ab.abc".split("\\.");
System.out.println(Arrays.toString(split2));  // 结果为["a", "ab", "abc"]

String[] split3 = "a|ab|abc".split("\\|");
System.out.println(Arrays.toString(split3));  // 结果为["a", "ab", "abc"]

 

类与对象

equals

所有的相同类型的包装类对象之间值的比较，全部使用equals方法比较。例如在-128至127范围内的赋值，Integer对象是在IntegerCache.cache产生，可以用==比较，超出范围就是堆上产生，只能用equals方法

避免使用BigDecimal(double)

BigDecimal(double) 存在精度损失风险，在精确计算或值比较的场景中可能会导致业务逻辑异常。

反例：

// BigDecimal 反例    
BigDecimal bigDecimal = new BigDecimal(0.11D);

正例：

// BigDecimal 正例
BigDecimal bigDecimal1 = bigDecimal.valueOf(0.11D);

 

枚举字段

枚举通常被当做常量使用，如果枚举中存在公共属性字段或设置字段方法，那么这些枚举常量的属性很容易被修改；理想情况下，枚举中的属性字段是私有的，并在私有构造函数中赋值，没有对应的Setter 方法，最好加上final 修饰符。

反例：

public enum ProdType {

    public int value;

    private SwitchStatus(int value) {
        this.value = value;
    }

    public String getValue() {
        return value;
    }

    public void setValue(String description) {
        this.value= value;
    }
}

正例：

public enum ProdType {

    public final int value;

    private SwitchStatus(int value) {
        this.value = value;
    }

    public String getValue() {
        return value;
    }
}

返回非null

若程序运行返回null，需要调用方强制检测null，否则就会抛出空指针异常；返回空数组或空集合，有效地避免了调用方因为未检测null而抛出空指针异常的情况，还可以删除调用方检测null 的语句使代码更简洁。

优先使用常量equals

对象的equals 方法容易抛空指针异常，应使用常量或确定有值的对象来调用equals 方法。

反例：

//调用equals方法反例
private static boolean fileReader(String fileName)throws IOException{

    //可能抛空指针异常
    return fileName.equals("我是好人");
}

正例：

//调用 equals 方法正例
private static boolean fileReader(String fileName)throws IOException{

    // 使用常量或确定有值的对象来调用 equals 方法
    return "我是好人".equals(fileName);

    //或使用：java.util.Objects.equals() 方法
   return Objects.equals("我是好人",fileName);
}