包含来自snakeyaml 的YAML 文件

Posted 2023-02-26

【中文标题】包含来自snakeyaml 的YAML 文件

【英文标题】：Include YAML files from snakeyaml

【发布时间】：2014-10-11 20:48:16

【问题描述】：

我想要包含包含的 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 做过类似的事情吗？关于我可能做错了什么有什么想法吗？

【问题讨论】：

附注感谢您发布这个问题；它给了我一个支持!include标签的良好开端。

【参考方案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 中一样工作，预处理器会保留包含文件的内容，那么实现它的方法是在演示阶段（解析）或序列化阶段（组合）处理它.但是你已经在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 在单个 . yaml 文件。