java编辑yml_在保留注释的同时在Java中修改YAML

我们如何修改现有的YAML并在其中保留注释.

有没有Java解析器呢?

例如,如果我有以下YAML:

#This is a test YAML

name: abcd

age: 23

#Test YAML ends here.

有没有一种方法可以使用Java解析器编辑此Yaml并保留注释.

解决方法:

在撰写本文时,还没有Java的双向YAML解析器.有一个著名的SnakeYAML,它不保留注释(请参阅author’s comment here),还有一个较新的项目,名为camel,我对此一无所知.但这绝对不是往返.

从理论上讲,您可以使用SnakeYaml的Yaml.parse,然后对事件进行迭代.每个事件都有一个开始和结束标记,给出了开始和结束行&事件栏.这样就可以将事件映射回源中,并发现源中未被解析为事件的部分(可能是注释).有了此映射,您现在可以修改事件列表并将其写回.最后,您第二次读取结​​果,发现原始YAML中有注释但在修改后的YAML中没有注释的事件之间的间隔,然后重新插入这些注释,从而为您提供了最终的YAML,包括您的修改和评论.

当然,这非常复杂.我不建议您这样做,除非您a)对YAML的结构有扎实的了解或愿意学习,并且b)您的用例证明了这一工作量是合理的.

标签:snakeyaml,yaml,java

来源: https://codeday.me/bug/20191109/2011672.html

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Java本身没有直接读取YAML文件包括注释的API,但可以使用第三方库SnakeYAML实现。 以下是一个示例代码,使用SnakeYAML库读取YAML文件内容包括注释: ```java import org.yaml.snakeyaml.Yaml; import org.yaml.snakeyaml.constructor.Constructor; import org.yaml.snakeyaml.nodes.Node; import org.yaml.snakeyaml.nodes.Tag; import java.io.FileInputStream; import java.io.FileNotFoundException; import java.io.InputStream; import java.util.LinkedHashMap; import java.util.Map; public class YamlReader { public static void main(String[] args) throws FileNotFoundException { Yaml yaml = new Yaml(new CommentedConstructor()); InputStream inputStream = new FileInputStream("config.yml"); Map<String, Object> obj = yaml.load(inputStream); System.out.println(obj); } } class CommentedConstructor extends Constructor { public CommentedConstructor() { this.yamlConstructors.put(null, new CommentedConstruct()); } private class CommentedConstruct extends Constructor.ConstructYamlMap { @Override public Object construct(Node node) { Object obj = super.construct(node); if (node instanceof org.yaml.snakeyaml.nodes.MappingNode) { org.yaml.snakeyaml.nodes.MappingNode mnode = (org.yaml.snakeyaml.nodes.MappingNode) node; Map<String, Object> map = (Map<String, Object>) obj; for (org.yaml.snakeyaml.nodes.NodeTuple tuple : mnode.getValue()) { org.yaml.snakeyaml.nodes.Node keyNode = tuple.getKeyNode(); if (keyNode instanceof org.yaml.snakeyaml.nodes.ScalarNode) { org.yaml.snakeyaml.nodes.ScalarNode scalarNode = (org.yaml.snakeyaml.nodes.ScalarNode) keyNode; String key = scalarNode.getValue(); map.put(key, tuple.getValueNode().getRawValue()); // 将注释保存到map if (tuple.getValueNode().getTag().equals(Tag.COMMENT)) { map.put("#" + key, tuple.getValueNode().getValue()); } } } } return obj; } } } ``` 这里使用了CommentedConstructor继承自SnakeYAML的Constructor类,重写了构造函数,并在其对节点进行了处理。使用时只需要将YAML文件的路径修改为自己的文件路径即可。 需要注意的是,这里的注释是以键值对的方式保存在Map的,键值为"#"+原键名。因此在获取键值对时需要注意。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值