Java 中的 Non - Nullable：确保代码的健壮性

简介

在 Java 编程中，空指针异常（NullPointerException）是一个常见且令人头疼的问题。它常常在运行时突然出现，导致程序崩溃，排查和修复这类问题往往需要花费大量时间和精力。Non - Nullable（非空）概念的引入就是为了在编译阶段尽可能地避免空指针异常，增强代码的健壮性和可读性。本文将深入探讨 Java 中Non - Nullable的相关知识，包括基础概念、使用方法、常见实践以及最佳实践。

基础概念
使用方法
- Java 8 及以前的方式
- Java 14+ 的Records与Sealed Classes
- 使用第三方库（如 Lombok）
常见实践
- 方法参数和返回值的非空检查
- 类属性的非空处理
最佳实践
- 明确的空值处理策略
- 结合单元测试
小结
参考资料

基础概念

Non - Nullable意味着一个变量、方法参数或返回值不能为null。在传统 Java 中，变量可以随意赋值为null，这在某些情况下会带来风险。例如：

String str = null;
// 这里如果调用 str 的方法，会抛出 NullPointerException
int length = str.length();

为了避免这种情况，我们需要确保变量在使用前不为null。现代 Java 通过一些特性和工具来强化这种约束，使得在编译阶段就能发现潜在的空指针问题。

使用方法

Java 8 及以前的方式

在 Java 8 及以前，我们主要通过手动检查来确保非空性。

方法参数的非空检查

public class Example {
    public void printLength(String str) {
        if (str == null) {
            throw new IllegalArgumentException("str cannot be null");
        }
        System.out.println(str.length());
    }
}

方法返回值的非空检查

public class Example {
    public String getNonNullString() {
        String result = someMethodThatMayReturnNull();
        if (result == null) {
            result = ""; // 或者抛出异常
        }
        return result;
    }

    private String someMethodThatMayReturnNull() {
        // 可能返回 null 的逻辑
        return null;
    }
}

Java 14+ 的`Records`与`Sealed Classes`

Records

Java 14 引入的Records是一种紧凑的语法，用于创建不可变类，并且其属性默认是非空的（除非显式声明为可空）。

public record Person(String name, int age) {}

在上面的例子中，name和age属性都是非空的。如果尝试创建一个Person对象，传入null值作为name，会在编译阶段报错。

Sealed Classes

Sealed Classes允许限制一个类的直接子类。结合Non - Nullable特性，可以确保子类的某些属性非空。

public sealed class Shape permits Rectangle, Circle {
    // 可以定义非空属性
    public final String color;

    public Shape(String color) {
        this.color = color;
    }
}

public final class Rectangle extends Shape {
    public Rectangle(String color) {
        super(color);
    }
}

public final class Circle extends Shape {
    public Circle(String color) {
        super(color);
    }
}

使用第三方库（如 Lombok）

Lombok 提供了@NonNull注解来简化非空检查。

首先，在项目中添加 Lombok 依赖。然后，可以在方法参数上使用@NonNull注解：

import lombok.NonNull;

public class Example {
    public void printLength(@NonNull String str) {
        System.out.println(str.length());
    }
}

Lombok 会在编译时自动生成空值检查代码，如果传入null，会抛出NullPointerException。

常见实践

方法参数和返回值的非空检查

在方法定义时，对参数进行非空检查是一个好习惯。这不仅可以防止方法内部出现空指针异常，还能明确方法的输入要求。

public class Calculator {
    public int divide(int numerator, @NonNull Integer denominator) {
        if (denominator == 0) {
            throw new IllegalArgumentException("denominator cannot be zero");
        }
        return numerator / denominator;
    }
}

对于方法返回值，确保返回的对象不为null，可以增强调用者的代码健壮性。

public class UserService {
    public User getUserById(int id) {
        User user = database.findUserById(id);
        if (user == null) {
            // 可以创建一个默认用户或者抛出异常
            user = new User();
        }
        return user;
    }
}

类属性的非空处理

在类中定义属性时，尽量确保属性在初始化后不为null。

public class Book {
    private final String title;

    public Book(String title) {
        if (title == null) {
            throw new IllegalArgumentException("title cannot be null");
        }
        this.title = title;
    }

    public String getTitle() {
        return title;
    }
}

最佳实践

明确的空值处理策略

在整个项目中，应该制定明确的空值处理策略。例如，是返回默认值、抛出特定异常还是进行其他处理，要保持一致。

结合单元测试

编写单元测试来验证方法参数和返回值的非空性。例如，使用 JUnit 进行测试：

import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.assertThrows;

public class ExampleTest {
    @Test
    public void testPrintLengthWithNull() {
        Example example = new Example();
        assertThrows(IllegalArgumentException.class, () -> {
            example.printLength(null);
        });
    }
}

小结

通过本文，我们深入了解了 Java 中的Non - Nullable概念。从基础概念到不同版本的使用方法，再到常见实践和最佳实践，掌握这些知识可以有效减少空指针异常的发生，提高代码的质量和可靠性。无论是手动检查、利用 Java 新特性还是借助第三方库，都要根据项目的实际情况选择合适的方式来确保代码的非空性。

参考资料

Java 官方文档
Lombok 官方文档
《Effective Java》第三版