包含来自snakeyaml的YAML文件

Question

我希望YAML文件有一个包含，类似于这个问题，但与Snakeyaml：How can I include an YAML file inside another?

例如：

%YAML 1.2
---
!include "load.yml"

!include "load2.yml"

我对它有很多麻烦。我定义了构造器，可以让它导入一个文档，但不能导入两个文档。我得到的错误是：

Exception in thread "main" expected '<document start>', but found Tag
 in 'reader', line 5, column 1:
    !include "load2.yml"
    ^

有了一个include，Snakeyaml很高兴它能找到一个EOF并处理导入。有了两个，它就不高兴了(上图)。

我的java源码是：

package yaml;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.InputStream;

import org.yaml.snakeyaml.Yaml;
import org.yaml.snakeyaml.constructor.AbstractConstruct;
import org.yaml.snakeyaml.constructor.Constructor;
import org.yaml.snakeyaml.nodes.Node;
import org.yaml.snakeyaml.nodes.ScalarNode;
import org.yaml.snakeyaml.nodes.Tag;

public class Main {
    final static Constructor constructor = new MyConstructor();

    private static class ImportConstruct extends AbstractConstruct {
        @Override
        public Object construct(Node node) {
            if (!(node instanceof ScalarNode)) {
                throw new IllegalArgumentException("Non-scalar !import: " + node.toString());
            }

            final ScalarNode scalarNode = (ScalarNode)node;
            final String value = scalarNode.getValue();

            File file = new File("src/imports/" + value);
            if (!file.exists()) {
                return null;
            }

            try {
                final InputStream input = new FileInputStream(new File("src/imports/" + value));
                final Yaml yaml = new Yaml(constructor);
                return yaml.loadAll(input);
            } catch (FileNotFoundException ex) {
                ex.printStackTrace();
            }
            return null;
        }
    }

    private static class MyConstructor extends Constructor {
        public MyConstructor() {
            yamlConstructors.put(new Tag("!include"), new ImportConstruct());
        }
    }

    public static void main(String[] args) {
        try {
            final InputStream input = new FileInputStream(new File("src/imports/example.yml"));
            final Yaml yaml = new Yaml(constructor);
            Object object = yaml.load(input);
            System.out.println("Loaded");

        } catch (FileNotFoundException ex) {
            ex.printStackTrace();
        }
        finally {
        }
    }
}

问题是，有没有人用Snakeyaml做过类似的事情？有没有想过我可能做错了什么？

Answer 1

我认为有两个问题：

final InputStream input = new FileInputStream(new File("src/imports/" + value));
            final Yaml yaml = new Yaml(constructor);
            return yaml.loadAll(input);

您应该使用yaml.load(input)，而不是yaml.loadAll(input)。loadAll()方法返回多个对象，但construct()方法期望返回单个对象。

另一个问题是，您可能对YAML processing pipeline的工作方式有一些不一致的期望：

​

​

如果您认为!include的工作方式类似于C中的预处理器插入所包含文件的内容，那么实现它的方法应该是在表示阶段(解析)或序列化阶段(合成)处理它。但是您已经在表示阶段(构造)实现了它，所以!include返回一个对象，并且您的YAML文件的结构必须与此一致。

假设您有以下文件：

test1a.yaml

activity: "herding cats"

test1b.yaml

33

test1.yaml

favorites: !include test1a.yaml
age:       !include test1b.yaml

这将工作得很好，并且等同于

favorites:
  activity: "herding cats"
age: 33

但以下文件将不起作用：

!include test1a.yaml
!include test1b.yaml

因为没有什么可以说明如何在一个更大的层次结构中组合这两个值。如果你想要一个数组，你需要这样做：

- !include test1a.yaml
- !include test1b.yaml

或者，再次在较早的阶段处理此自定义逻辑，例如解析或组合。

或者，您需要告诉YAML库您正在启动第二个文档(这正是错误所抱怨的：expected '<document start>')，因为YAML在单个.yaml文件中支持多个“文档”(顶层值)。