SnakeYAML为例

Question

我试图用SnakeYAML读取和解析YAML文件，并将其转换为我的Java应用程序的配置POJO：

// Groovy pseudo-code
class MyAppConfig {
    List<Widget> widgets
    String uuid
    boolean isActive

    // Ex: MyAppConfig cfg = new MyAppConfig('/opt/myapp/config.yaml')
    MyAppConfig(String configFileUri) {
        this(loadMap(configFileUri))
    }

    private static HashMap<String,HashMap<String,String>> loadConfig(String configFileUri) {
        Yaml yaml = new Yaml();
        HashMap<String,HashMap<String,String>> values
        try {
            File configFile = Paths.get(ClassLoader.getSystemResource(configUri).toURI()).toFile();
            values = (HashMap<String,HashMap<String,String>>)yaml.load(new FileInputStream(configFile));
        } catch(FileNotFoundException | URISyntaxException ex) {
            throw new MyAppException(ex.getMessage(), ex);
        }

        values
    }

    MyAppConfig(HashMap<String,HashMap<String,String>> yamlMap) {
        super()

        // Here I want to extract keys from 'yamlMap' and use their values
        // to populate MyAppConfig's properties (widgets, uuid, isActive, etc.).
    }
}

例YAML：

widgets:
  - widget1
    name: blah
    age: 3000
    isSilly: true
  - widget2
    name: blah meh
    age: 13939
    isSilly: false
uuid: 1938484
isActive: false

由于SnakeYAML似乎只给我一个HashMap<String,<HashMap<String,String>>来表示我的配置数据，所以我们似乎只能有两个SnakeYAML支持的嵌套映射属性(外部映射和类型为<String,String>的内部映射).

1. 但是，如果widgets包含一个列表/序列(例如，fizzes)，其中包含一个列表(例如，buzzes )，其中包含另一个列表，等等，该怎么办？这仅仅是SnakeYAML的一个限制，还是我使用该API的错误？
2. 要从这个映射中提取值，我需要迭代它的键/值，并且(似乎)需要应用我自己的自定义验证。SnakeYAML是否提供了任何用于进行此提取+验证的API？例如，与其手工滚动自己的代码来检查uuid是否是在映射中定义的属性，不如我可以执行类似yaml.extract('uuid')等的操作，然后再对uuid (和任何其他属性)进行验证。
3. YAML本身包含了许多强大的概念，例如锚和引用。SnakeYAML处理这些概念吗？如果最终用户在配置文件中使用它们，该如何检测/验证/执行它们呢？！？SnakeYAML是否为此提供了一个API？

Answer 1

你的意思是这样：

@Grab('org.yaml:snakeyaml:1.17')
import org.yaml.snakeyaml.*
import org.yaml.snakeyaml.constructor.*
import groovy.transform.*

String exampleYaml = '''widgets:
                       |  - name: blah
                       |    age: 3000
                       |    silly: true
                       |  - name: blah meh
                       |    age: 13939
                       |    silly: false
                       |uuid: 1938484
                       |isActive: false'''.stripMargin()

@ToString(includeNames=true)
class Widget {
    String name
    Integer age
    boolean silly
}

@ToString(includeNames=true)
class MyConfig {
    List<Widget> widgets
    String uuid
    boolean isActive

    static MyConfig fromYaml(yaml) {
        Constructor c = new Constructor(MyConfig)
        TypeDescription t = new TypeDescription(MyConfig)
        t.putListPropertyType('widgts', Widget)
        c.addTypeDescription(t);

        new Yaml(c).load(yaml)
    }
}

println MyConfig.fromYaml(exampleYaml)

显然，这是一个要在Groovy控制台中运行的脚本，您不需要@Grab行，因为您可能已经在类路径中有了库;-)