使用SnakeYaml解析YAML为Java对象时出现异常，求排查原因

核心问题：自定义YAML标签!include未被解析库识别 #

你的YAML中使用了自定义标签!include引入外部YAML文件，但Java主流YAML解析库（如SnakeYAML、Jackson YAML模块）默认不支持这类自定义标签，会直接抛出解析异常。此外，路径中的反斜杠\在YAML中属于转义字符，可能导致路径解析错误，也是潜在问题点。

排查与解决步骤 #

1. 修复路径格式问题 #

YAML中路径应使用正斜杠/，或者将反斜杠转义为\\，避免转义字符干扰：

beforeSuiteActions:
- !include /commonSteps/getConfig.yaml
- !include /commonSteps/adminLogin.yaml
- !include /commonSteps/login.yaml
- !include /commonSteps/getDeviceDomain.yaml
- !include /commonSteps/getLinearChannels.yaml
- !include /commonSteps/getAssetList.yaml

2. 针对SnakeYAML的解决方案 #

如果使用SnakeYAML，需要自定义Constructor来处理!include标签，实现外部文件加载逻辑：

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.Tag;
import java.io.FileReader;
import java.io.IOException;
import java.util.List;

public class IncludeConstructor extends Constructor {
    public IncludeConstructor() {
        this.yamlConstructors.put(new Tag("!include"), new ConstructInclude());
    }

    private class ConstructInclude extends AbstractConstruct {
        @Override
        public Object construct(Node node) {
            String path = (String) constructScalar(node);
            try {
                Yaml yaml = new Yaml(new Constructor());
                return yaml.load(new FileReader(path));
            } catch (IOException e) {
                throw new RuntimeException("Failed to include YAML file: " + path, e);
            }
        }
    }

    // 使用示例
    public static void main(String[] args) throws IOException {
        Yaml yaml = new Yaml(new IncludeConstructor());
        TestConfig config = yaml.loadAs(new FileReader("your-config.yaml"), TestConfig.class);
    }
}

// 对应的Java实体类
class TestConfig {
    private List<Object> beforeSuiteActions;
    // getter、setter
}

3. 针对Jackson YAML模块的解决方案 #

如果使用Jackson处理YAML，需要自定义JsonDeserializer并绑定到字段：

import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.JsonDeserializer;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.dataformat.yaml.YAMLMapper;
import java.io.File;
import java.io.IOException;
import java.util.List;

public class YamlIncludeDeserializer extends JsonDeserializer<Object> {
    private static final YAMLMapper mapper = new YAMLMapper();

    @Override
    public Object deserialize(JsonParser p, DeserializationContext ctxt) throws IOException {
        String path = p.getValueAsString();
        return mapper.readValue(new File(path), Object.class);
    }
}

// 实体类定义
class TestConfig {
    @JsonDeserialize(contentUsing = YamlIncludeDeserializer.class)
    private List<Object> beforeSuiteActions;
    // getter、setter
}

// 使用示例
public class Main {
    public static void main(String[] args) throws IOException {
        YAMLMapper mapper = new YAMLMapper();
        TestConfig config = mapper.readValue(new File("your-config.yaml"), TestConfig.class);
    }
}

额外注意事项 #

• 确保引入的外部YAML文件路径正确，可使用绝对路径或相对于当前工作目录的相对路径。
• 如果外部YAML文件的结构需要匹配特定Java类，需调整解析逻辑，将加载的内容转换为对应类型，而非泛用的Object。

内容的提问来源于stack exchange，提问作者Harish Algat