如何使用 YAML 配置文件使用对象参数实例化新对象？

Question

我正在尝试使用配置文件来允许用户选择实现某些抽象类或接口的具体聚类算法。每种算法的先决条件输入可能略有不同。一个小的概念示例：

• KMedoids 只需要用户设置k 即可。
• SpectralClustering 还需要 k，但还需要其他一些东西，例如 Enums 表示图的类型，以及在其内部计算中使用的拉普拉斯算子类型。

两者的共同点都定义在一个抽象类中。

为了让事情更笼统，我做了一个虚拟的例子。假设我有一个 Configuration 类，该类将被传递给某种“引擎”或“驱动程序”，以根据生成的 Configuration 实例完成一项工作。

public class Configuration {

    private AbstractAlgorithm algo;
    private AbstractParameter param1;
    private ConcreteEnum.Enum1 param2;
    private ConcreteEnum.Enum2 param3;
   
    // getters and setters...

那我上课了

abstract class AbstractAlgorithm{
    AbstractParameter abstractParam;
    public void setParam(AbstractParam p) {
        this.abstractParam = p;
    }

    public RandomObject runAlgo(DataObject data);
}

和ConcreteAlgorithm:

public class ConcreteAlgorithm extends AbstractAlgorithm {

    ConcreteEnum.enum1 concreteParam1;
    ConcreteEnum.enum2 concreteParam2;

    public ConcreteAlgorithm(ConcreteParameter p1, ConcreteParameter p2) {
        this.concreteParam1 = p1;
        this.concreteParam2 = p2;
    }

    public abstract void runAlgo(DataObject data) {
        if (abstractParam == null) {
            throw new IllegalStateException();
        } else {
        // do calculations based on enums and abstractParam value
        }
    }

那么我的问题是：随附的 .yaml 文件看起来如何，以便可以将其解析为实例化的 Configuration 对象，该对象可以传递给使用它的对象？ p>

Answer 1

与序列化一样，你的类应该有一个不带参数的构造函数：

abstract class AbstractAlgorithm {
    public AbstractParameter abstractParam;
}

public class ConcreteAlgorithm extends AbstractAlgorithm {
    public ConcreteEnum.Enum1 param1;
    public ConcreteEnum.Enum2 param2;
}

他们除了字段之外的任何接口都与这个问题无关。我公开了这些字段，因为当你进行反序列化时，它们并没有真正的意义，除非你想在 setter 中处理给定的值，在这种情况下你会使用 setter。

现在定义了这些类型，加载将按如下方式进行：

Constructor constructor = new Constructor();
constructor.addTypeDescription(
    new TypeDescription(ConcreteAlgorithm.class, new Tag("!concrete")));
yaml = new Yaml(constructor);
AbstractAlgorithm = yaml.loadAs(someInput, AbstractAlgorithm.class);

正在加载的 YAML 如下所示：

--- !concrete
abstractParam: spam
param1: egg
param2: sausage

--- 是指令结束标记，它开始文档的内容并且是可选的。我们在这里使用它来明确以下标签适用于文档的根节点。

!concrete 是根节点的标记。由于我们用 SnakeYAML 注册它，它会导致 SnakeYAML 从这个文件构造一个 ConcreteAlgorithm 对象。

以下键值对为 ConcreteAlgorithm 的每个字段提供值，包括继承的字段。 SnakeYAML 将根据使用的类的性质处理字段值——AbstractParameter 可能希望在 YAML 文件中具有嵌套映射（如果它是一个类）。如果AbstractParameter 是另一个抽象类并且有ConcreteParameter 作为实现，你会这样做

--- !concrete
abstractParam: !cp
  droggel: jug
param1: egg
param2: sausage

并将!cp 注册为ConcreteParameter 的标记。然后，包含键 droggel 的嵌套映射将生成 ConcreteParameter 的实例并分配给字段 abstractParam。

由于您可以在任何级别上添加标签，因此您可以在将 YAML 加载到的结构中的任何位置嵌套具有抽象类类型的字段。