包含snakeyaml的YAML文件

时间:2014-08-18 20:48:59

标签: yaml snakeyaml

我想要包含类似于此问题的包含的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"
    ^

有了一个包含,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做过类似的事情?关于我可能做错什么的任何想法?

1 个答案:

答案 0 :(得分:2)

我看到两个问题:

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中预处理器在所包含文件的内容中所处的位置,那么实现它的方法是在Presentation阶段(解析)或序列化阶段处理它(构成)。但是你已经在Representation阶段(构建)实现了它,所以!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支持多个&#34;文档&#34;单个.yaml文件中的(顶级值)。