20个 Java 优秀实践，让你的代码更丝滑

2023-03-16 今日头条迷路的架构师

1 尽可能使用基本类型而不是包装类型

Long idNumber;
long idNumber; // long 比 Long 占用更少的内存

2 为变量选择合适的类型

如果两种或多种类型满足功能需求，请使用占用内存空间较小的类型。

int birthYear;
short birthYear; // 更好，因为出生年份不能超过 32767 

int personRunningSpeedKmHour;
byte personRunningSpeedKmHour; // 更好，因为一个人的速度不能超过 127 公里/小时

3 检查数字是否奇数，按位与运算符比算术模运算符快得多

public boolean isOdd(int num) {
return (num & 1) != 0;
} 
// 判断数字为奇数的最佳方法

4 避免冗余初始化

不要用默认值来初始化类变量，例如，boolean默认情况下值为false，所以用 false 值初始化是多余的。

String name = null; // 冗余
int speed = 0; // 冗余
boolean isOpen = false; // 冗余


String name; 
int speed;
boolean isOpen;
// 这样更清晰

5 尽可能将类成员声明为私有

public int age; // 非常差
int age; // 差
private int age; // 好

6 在创建字符串时避免使用'new'关键字

String s1 = new String("AnyString") ; // 不好：初始化慢
// 需要构造函数创建一个新对象，并将文字添加到堆中


String s2 = "AnyString" ; // 好：快速实例化
// 此快捷方式引用字符串池中的项
// 并且仅当文字不在字符串池中时才创建新对象。

7 对于多个字符串连接，使用 StringBuilder 或 StringBuffer

+运算符效率低下，因为 JAVA 编译器在创建最终串联字符串之前会创建多个中间字符串对象。而StringBuilder或者StringBuffer是在不创建中间 String 对象的情况下修改 String。

String address = streetNumber +" "+ streetName +" "
+cityName+" "+cityNumber+" "+ countryName; // 差


StringBuilder address = new StringBuilder(streetNumber).Append(" ")
.append(streetName).append(" ").append(cityName).append(" ")
.append(cityNumber).append(" ").append(countryName); // 好

注意：StringBuilder不是线程安全的，不是同步的，StringBuffer线程安全和同步的，StringBuilder 比 StringBuffer 更快。

8 在数字文字中使用下划线

int myMoneyInBank = 58356823;
int myMoneyInBank = 58_356_823; // 更易读

long billsToPay = 1000000000L;
long billsToPay = 1_000_000_000L; // 更易读

9 避免使用索引进行“for 循环”

如果可以用增强的 for 循环（自 Java 5 起）或 forEach（自 Java 8 起）。因为索引变量容易出错，因为我们可能会在循环体中更改它，或者遍历的时候可能会从 1 而不是 0 开始索引。

for (int i = 0; i < names.length; i++) {
  saveInDb(names[i]);
}


for (String name : names) { 
  saveInDb(name);
} // 更清晰

10 将 try–catch-finally 替换为 try-with-resources

Scanner scanner = null;
try {
  scanner = new Scanner(new File("test.txt"));
  while (scanner.hasNext()) {
    System.out.println(scanner.nextLine());
  }
} 
catch (FileNotFoundException e) {
  e.printStackTrace();
} 
finally {
  if (scanner != null) {
    scanner.close();
  }
}
// 容易出错，因为我们可能会忘记在 finally 块中关闭扫描器



try (Scanner scanner = new Scanner(new File("test.txt"))) {
  while (scanner.hasNext()) {
    System.out.println(scanner.nextLine());
  }
} 
catch (FileNotFoundException fnfe) {
  fnfe.printStackTrace();
} 
// 更清晰更简洁

11 catch块不为空

一个空的catch块会使程序默默地失败并且不会给出任何关于出错的信息。

try { 
  productPrice = Integer.parseInt(integer); 
} 
catch (NumberFormatException ex){
} 
// 静默失败，不提供任何反馈


try {
  productPrice = Integer.parseInt(integer);
} 
catch (NumberFormatException ex) {
  unreadablePrices.add(productPrice); // 处理错误
  log.error("Cannot read price : ", productPrice );// 打印正确且有意义的消息
}

12 尽可能避免空指针异常

通过以下方式尽量避免运行时可能出现的空指针异常：

返回空集合而不是返回 Null 元素
尽可能使用 Optional
使用 java.utils.Objects 的requireNonNull方法
使用NotNull, NotEmpty,NotBlank 注解
在Streams 使用 Objects::nonNull
java.util.Objects 中的 requireNonNull方法

13 只添加需要的 getters/setters 和构造函数并避免使用 lombok (YAGNI)

Lombok 是一个很棒的工具，可以帮助你生成一些样板代码，但它有一些缺点，例如 IDE 不兼容、使用非公共 API 且与 Java 编译器紧密耦合。

14 检查相等性

使用==判断引用是否相等，使用 equals 判断对象是否相等。

// 先决条件：person 类重写 equals() 和 hashCode() 
Person  p1  =  new  Person ( "John" , "Doe" ); 
Person  p2  =  new  Person ( "John" , "Doe" ); 

System.out.println(p1 == p2); // false
System.out.println(p1.equals(p2)); // true

15 在实现 equals 时始终实现 hashCode

如果你重写了 hashCode，必须要重写 equals。
根据 API，如果两个对象的 equals 相等，那么他们的 hashCode() 返回的结果必须相等。反之则不一定成立。

16 不可变数据的 record（自 java14 起关键字）

public final class Person {
    private final String name;
    private final long idNumber;

    public Person(String name, long idNumber) {
        this.name = name;
        this.idNumber = idNumber;
    }

    public boolean equals(Object other) {
        if (other == this) return true;
        if (other == null) return false;
        if (other.getClass() != this.getClass()) return false;
        Person that = (Person) other;
        return (this.name.equals(that.name)) && (this.idNumber == that.idNumber);
    }

    public String toString() {
        return name + " " + idNumber;
    }

    public int hashCode() {
        return Objects.hash(idNumber, name);
    }
}



// 这个类可以转化为一条记录：
record Person(String name, long idNumber) { } // 更简洁

17 定义常量，使用枚举或 final 类而不是接口

使用 final 类，并定义一个私有构造函数。

public final class MyValues {
  private MyValues() {
    // 无需实例化类，我们可以隐藏其构造函数
  }
  public static final String VALUE1 = "foo";
  public static final String VALUE2 = "bar";
}

18 注解前加空行

// <-- 空行
@Repository 
public class ...

19 静态字段应该放在类的顶部

20 日期类型处理

建议使用 java.localDateTime（从 Java 8 开始）而不是 java.util.Date 。