Java静态工厂方法：实例管理与唯一性保障

大家好，今天本人给大家带来文章《Java静态工厂方法：管理实例与保持唯一性》，文中内容主要涉及到，如果你对文章方面的知识点感兴趣，那就请各位朋友继续看下去吧~希望能真正帮到你们，谢谢！

本文探讨了在Java中如何高效地追踪类所有实例的创建，并将其存储在一个静态集合中。通过引入静态工厂方法，我们解决了在构造函数中直接添加 `this` 实例的挑战，并规避了构造函数过早返回的问题。文章详细阐述了如何利用静态工厂方法实现实例的唯一性检查、控制对象创建流程，并提供了代码示例和最佳实践，以确保类实例管理的健壮性和可维护性。

Java 类实例的追踪与管理

在Java应用程序开发中，有时我们需要追踪某个类的所有已创建实例，并将其集中管理。例如，在一个模拟系统中，我们可能需要一个列表来存储所有已注册的“船舶”对象。直接在类的构造函数中将当前对象（this）添加到静态集合中，看似直观，但却存在一些潜在的问题，特别是当构造函数中包含复杂的业务逻辑（如唯一性检查）时。

初始问题与挑战

考虑以下场景：我们有一个 Ship 类，希望在创建每个 Ship 对象时，将其添加到一个静态的 ArrayList 中。同时，我们还需要确保每艘船的名称是唯一的。

import java.util.ArrayList;

static public class Ship {
    // 存储船只名称，用于唯一性检查 (后续将被优化)
    private static ArrayList<String> ships = new ArrayList<String>();
    // 存储Ship对象本身
    private static ArrayList<Ship> shipObs = new ArrayList<Ship>();
    String name;
    private ArrayList<String> cruises = new ArrayList<String>();
    int maxPassengers;
    private static final String[] CABINS = new String[] {"Balcony", "Ocean View", "Suite", "Interior"};
    private int[] passengers = new int[] {0,0,0,0};
    boolean inService = false;

    public Ship(String name, int maxPassengers) {
        // 确保船只名称唯一性
        if (ships.size() == 0) {
            this.name = name;
            ships.add(name);
        } else {
            for (int i=0; i < ships.size(); i++) {
                if (ships.get(i).equals(name)) {
                    System.out.println("Ship "+name+" cannot be created because that name already exists");
                    return; // 构造函数中过早返回
                }
            }
            this.name = name;
            ships.add(name);
        }
        this.maxPassengers = maxPassengers;
        // 尝试在此处添加this到shipObs，但可能不完整或存在逻辑问题
        // shipObs.add(this); // 无法直接在此处有效处理所有情况
    }
}

上述代码中存在两个主要问题：

1. 构造函数中的 return 语句： 在Java中，构造函数的主要职责是初始化对象。如果构造函数在对象完全初始化之前通过 return 语句退出，可能会导致对象处于不一致的状态。更恰当的做法是抛出异常，而不是提前返回。
2. this 对象的添加时机： 尽管 shipObs.add(this) 看似可行，但如果构造函数在唯一性检查失败时提前返回，那么未成功创建的对象就不会被添加到 shipObs 中，这本身不是问题。然而，将复杂逻辑（如唯一性检查和错误处理）直接放在构造函数中，会使构造函数职责过重，并可能与上述 return 问题冲突。

解决方案：使用静态工厂方法

为了优雅地解决这些问题，我们可以采用静态工厂方法（Static Factory Method）模式。静态工厂方法是一个静态方法，负责创建并返回类的实例。通过这种方式，我们可以将对象创建前的验证逻辑、对象创建逻辑以及对象添加到集合的逻辑封装在一个方法中，从而更好地控制对象的生命周期和状态。

以下是使用静态工厂方法重构后的 Ship 类：

import java.util.ArrayList;

public final class Ship {

    // 存储Ship对象本身，现在直接用于唯一性检查
    private static final ArrayList<Ship> shipObs = new ArrayList<>();
    String name;
    private final ArrayList<String> cruises = new ArrayList<>();
    int maxPassengers;
    private static final String[] CABINS =
            new String[]{"Balcony", "Ocean View", "Suite", "Interior"};
    private final int[] passengers = new int[]{0, 0, 0, 0};
    boolean inService = false;

    // 1. 将构造函数设为私有
    private Ship(String name, int maxPassengers) {
        this.name = name;
        this.maxPassengers = maxPassengers;
        // 构造函数只负责初始化，不进行复杂业务逻辑或集合添加
    }

    // 2. 提供一个静态工厂方法来创建Ship实例
    public static Ship createAShip(String name, int maxPassengers) {
        // 2.1 在创建前进行唯一性检查
        for (Ship existingShip : shipObs) {
            if (existingShip.name.equals(name)) {
                System.out.println("Ship " + name
                        + " cannot be created because that name already exists. Returning existing ship.");
                return existingShip; // 如果名称已存在，返回现有对象
            }
        }

        // 2.2 如果名称唯一，则创建新对象
        Ship theShip = new Ship(name, maxPassengers);
        // 2.3 将新创建的对象添加到静态集合中
        shipObs.add(theShip);
        return theShip; // 返回新创建的对象
    }

    // 可以添加其他方法，例如获取所有船只列表
    public static ArrayList<Ship> getAllShips() {
        return new ArrayList<>(shipObs); // 返回副本以防止外部修改
    }

    // 示例：添加一个获取船只名称的方法
    public String getName() {
        return name;
    }

    @Override
    public String toString() {
        return "Ship{" +
               "name='" + name + '\'' +
               ", maxPassengers=" + maxPassengers +
               '}';
    }

    public static void main(String[] args) {
        Ship ship1 = Ship.createAShip("Titanic", 2200);
        Ship ship2 = Ship.createAShip("Queen Mary 2", 2691);
        Ship ship3 = Ship.createAShip("Titanic", 2000); // 尝试创建同名船只

        System.out.println("All created ships: " + Ship.getAllShips());

        // 验证 ship1 和 ship3 是否是同一个对象
        System.out.println("Is ship1 the same as ship3? " + (ship1 == ship3));
    }
}

代码解析与最佳实践

1. 私有构造函数 (private Ship(...))：

   • 通过将构造函数设为 private，我们阻止了外部代码直接通过 new Ship(...) 的方式创建对象。这强制所有对象创建都必须通过 createAShip 静态工厂方法进行。
   • 构造函数现在只负责最基本的对象初始化（this.name = name; this.maxPassengers = maxPassengers;），不包含任何业务逻辑，如唯一性检查或集合添加。

2. final 类 (public final class Ship)：

   • 由于构造函数是私有的，该类实际上无法被继承（子类无法调用父类的私有构造函数）。为了明确这一点，并防止其他开发者尝试继承，我们添加了 final 关键字。final 类表示该类不能被继承。

3. 静态工厂方法 (public static Ship createAShip(...))：

   • 这是创建 Ship 实例的唯一入口。
   • 唯一性检查： 在创建新对象之前，它会遍历 shipObs 集合，检查是否存在同名船只。
     • 如果找到同名船只，它会打印一条消息并返回已存在的 Ship 对象。这种策略可以实现“单例”或“享元”模式的变体，即对于相同的名称，始终返回同一个实例。
     • 替代方案：
       • 抛出异常： 如果不允许创建同名船只并希望明确指示错误，可以抛出 IllegalArgumentException 或自定义异常（例如 DuplicateShipNameException）。
       • 返回 null： 另一种选择是返回 null，但这要求调用者显式处理 null 值。
       • 无论选择哪种策略，都应通过 Javadoc 清晰地文档化，以便使用者理解其行为。
   • 对象创建与添加： 如果名称唯一，工厂方法会调用私有构造函数创建新的 Ship 实例，然后将其添加到 shipObs 集合中，最后返回新创建的对象。
   • 简化唯一性检查： 原始代码中 if (ships.size() == 0) 的判断是不必要的。当 shipObs 为空时，for 循环自然不会执行，直接进入创建新对象的逻辑。

4. 移除冗余 ArrayList ships：

   • 由于 shipObs 已经存储了 Ship 对象，并且每个 Ship 对象都有一个 name 字段，因此专门维护一个 ArrayList ships 来存储名称是冗余的。我们可以直接通过 shipObs 中的 Ship 对象来访问其名称进行唯一性检查。

5. 集合的访问与封装：

   • getAllShips() 方法返回 shipObs 的一个副本 (new ArrayList<>(shipObs))。这是一个良好的实践，可以防止外部代码直接修改原始的 shipObs 集合，从而维护内部状态的封装性。

总结

通过采用静态工厂方法，我们能够：

• 集中控制对象创建： 将对象的创建逻辑封装在一个方法中，使得创建过程更易于管理和维护。
• 实现复杂创建逻辑： 在创建对象之前执行验证、唯一性检查或其他业务规则，确保创建的对象符合系统要求。
• 避免构造函数中的副作用： 构造函数专注于初始化，而不会有过早返回或执行复杂业务逻辑的风险。
• 提高代码可读性和健壮性： 清晰地分离了对象创建和对象初始化职责，使代码结构更清晰，更不容易出错。

这种模式在需要管理有限数量的实例、实现单例模式、或者根据输入参数返回不同类型实例的场景中尤其有用。

终于介绍完啦！小伙伴们，这篇关于《Java静态工厂方法：实例管理与唯一性保障》的介绍应该让你收获多多了吧！欢迎大家收藏或分享给更多需要学习的朋友吧~golang学习网公众号也会发布文章相关知识，快来关注吧！