Tránh lỗi NullPointerException trong Java như thế nào?

Trong bài này, tôi muốn chia sẽ với các bạn một vài kinh nghiệm code để hạn chế lỗi NullPointerException (NPE) trong chương trình Java.

Nguyên tắc chung: KHÔNG khởi tạo, truyền tham số, trả kết quả về là một giá trị NULL và giữ cho code càng đơn giản càng tốt.

Dưới đây là một vài kỹ thuật hạn chế lỗi NPE:

1. Return giá trị

1.1. Return một EMPTY collection thay vì giá trị NULL

Trong Java, mặc định một biến Object được định nghĩa sẽ có giá trị null. Các Collection như List, Set, Map, … được sử dụng rất nhiều trong ứng dụng. Nếu mọi phương thức đều return về null, thì khi sử dụng chúng ta phải kiểm tra null ở khắp mọi người và điều này không cần thiết cũng như gây code rất khó đọc.

Một ví dụ dễ thấy nhất là các bạn có một class DAO, class này có nhiệm vụ truy vấn dữ liệu từ database.

class UserDao {
    public List<User> getUsers () {
        // Query database and convert to list
        boolean hasData = false;
        if (hasData) {
            // return list of users
        }
        // There is no user
        return null;
    }
}
 
class UserService {
    private UserDao dao = new UserDao();
    public void showUsers () {
        List<User> users = dao.getUsers();
        if (users != null) { // Must be checked null
            // Show user information
        }
    }
     
    public void exportToCsv () {
        List<User> users = dao.getUsers();
        if (users != null) { // Must be checked null
            // Export to csv file
        }
    }
}

Như bạn thấy, chúng ta phải check null ở khắp nơi (showUsers, exportToCsv). Thử tưởng tượng nếu chúng ta return về một empty list thì khi đó chúng ta chỉ việc lấy ra và sử dụng, không cần quan tâm những đoạn code vô nghĩa về mặt business.

Đối với Collection, chúng ta có thể sử dụng từ khóa new hoặc sử dụng các phương thức sau để khởi tạo mọi Collection rỗng sử dụng lớp tiện ích java.util.Collections.

• List: Collections.emptyList()
• Set: Collections.emptySet()
• Map: Collections.emptyMap()

1.2. Return một EMPTY String

Các bạn có thể return một chuỗi rỗng “” hoặc sử dụng một constant có sẵn, chẳng hạn org.apache.commons.lang.StringUtils.EMPTY

1.3. Return một giá trị Unknown/ Default thay vì Null

Sử dụng Null Object Pattern:

public User getUser(UserType type){
    switch(type) {
        case ADMIN:
            return getAdmin();
        case MANAGER:
            return getManager();
        default:
            break;
    }
    return null;
}

Có thể viết tránh lỗi NULL như sau:

public User getUser(UserType type){
    switch(type) {
        case ADMIN:
            return getAdmin();
        case MANAGER:
            return getManager();
        default:
        break;
    }
    return NullUser ();
}
 
class NullUser extends User {
    // Implement all abstract methods of User
    // Override neccessary methods to drive to do "Nothing" or "Default" action.
}

2. Luôn kiểm tra NULL trước khi sử dụng

Điều này nói ra thì hơi trái ngược với return về empty data và không cần check null. Nếu tất cả mọi người đều tuân thủ theo quy ước chung về return empty data thay vì null thì chúng ta sẽ không cần check null, mọi thức qua tuyệt vời. Nhưng đôi khi có một số trường hợp chúng ta cần return về null hay trong các hệ thống code cũ (legacy code) thì điều này là nên làm.

Kiểm tra Null-safe

Ví dụ:

if("Hello".equals(hello)) { }

Thay vì:

if(hello != null) {
    if(hello.equals("Hello")) { }
}
 
// hoặc
 
if(hello.equals("Hello")) { }

4. Hạn chế sử dụng multi-dot syntax

Tuân thủ theo Law of Demeter Principle (LoD.

getLoggedinUser().getUser().getRole().setRoleName("Developer");

Như bạn thấy đoạn code trên rất dễ gặp lỗi NPE nếu bất kỳ object LoggedinUser, User, hay Role trả về giá trị null.

5. Khởi tạo giá trị trước khi sử dụng

Một trong những thói quen tốt giúp giảm NPE rất nhiều là khởi tạo giá trị empty cho các property khi một instance của object được tạo.

Có một số chỗ có thể khởi tạo giá trị cho property như sau:

Khởi tạo ngay khi khai báo property :

private List<User> users = new ArrayList<>();

Khởi tạo trong hàm constructor:

public UserManager() {
    users = new ArrayList<>();
}

Khởi tạo trong Getter:

public List<User> getUsers() {
    if(users == null) {
        users = new ArrayList<>();
    }
    return users ;
}

6. Sử dụng tính năng mới trong Java 8 – Optional

Trong Java 8, chúng ta có một lớp Optional<T> mới được giới thiệu trong gói java.util. Nó được sử dụng để kiểm tra xem một biến có giá trị tồn tại giá trị hay không. Ưu điểm chính của cấu trúc mới này là không có quá nhiều kiểm tra null và tránh lỗi NullPointerException (NPE) lúc runtime.

Chi tiết về Optional, các bạn hãy tham khảo ở bài viết : Optional trong Java 8.