Включить файлы YAML из snakeyaml

Question

Я хотел бы иметь файлы YAML с включением, аналогичным этому вопросу, но со Snakeyaml: Как я могу включить файл YAML в другой?

Например:

%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? Есть мысли, что я могу делать не так?

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:

Если вы думаете, что ваш !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.