使用Getters时返回不可修改的列表

基础概念

在面向对象编程中，Getter 方法用于获取对象的属性值。返回不可修改的列表是一种常见的做法，以确保调用者无法通过返回的列表修改原始数据，从而保持数据的封装性和安全性。

类型与应用场景

类型

Collections.unmodifiableList：Java 标准库提供的方法，用于创建不可修改的列表视图。
Guava 的 ImmutableList：Google Guava 库提供的不可变集合类。

应用场景

配置管理：返回配置信息的列表，确保配置不会被意外更改。
数据传输对象（DTO）：在服务层和表示层之间传递数据时，确保数据不被修改。
公共 API：提供给外部使用的 API，防止外部代码篡改内部数据。

示例代码

以下是使用 Java 标准库和 Guava 库实现返回不可修改列表的示例：

使用 Java 标准库

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

public class Example {
    private List<String> internalList = new ArrayList<>();

    public Example() {
        internalList.add("Item1");
        internalList.add("Item2");
    }

    public List<String> getUnmodifiableList() {
        return Collections.unmodifiableList(internalList);
    }

    public static void main(String[] args) {
        Example example = new Example();
        List<String> list = example.getUnmodifiableList();
        // 尝试修改列表会抛出 UnsupportedOperationException
        // list.add("Item3"); // 这行代码会抛出异常
    }
}

使用 Guava 库

import com.google.common.collect.ImmutableList;

import java.util.ArrayList;
import java.util.List;

public class Example {
    private List<String> internalList = new ArrayList<>();

    public Example() {
        internalList.add("Item1");
        internalList.add("Item2");
    }

    public ImmutableList<String> getUnmodifiableList() {
        return ImmutableList.copyOf(internalList);
    }

    public static void main(String[] args) {
        Example example = new Example();
        ImmutableList<String> list = example.getUnmodifiableList();
        // 尝试修改列表会抛出 UnsupportedOperationException
        // list.add("Item3"); // 这行代码会抛出异常
    }
}

可能遇到的问题及解决方法

问题：返回的不可修改列表仍然可以被修改

原因：可能是因为原始列表本身是可变的，调用者通过其他途径修改了原始列表。
解决方法：确保原始列表在创建不可修改视图之前是不可变的，或者在每次返回不可修改视图时都创建一个新的副本。

示例代码

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

public class Example {
    private List<String> internalList = new ArrayList<>();

    public Example() {
        internalList.add("Item1");
        internalList.add("Item2");
    }

    public List<String> getUnmodifiableList() {
        return Collections.unmodifiableList(new ArrayList<>(internalList));
    }

    public static void main(String[] args) {
        Example example = new Example();
        List<String> list = example.getUnmodifiableList();
        // 即使修改原始列表，返回的不可修改列表也不会受到影响
        example.internalList.add("Item3");
        System.out.println(list); // 输出: [Item1, Item2]
    }
}

通过这种方式，可以确保返回的不可修改列表在任何情况下都不会被修改，从而提高代码的安全性和可靠性。