详解java如何实现将数据导出为yaml

 更新时间:2023年11月22日 09:53:08   作者:棒棒糖_  
这篇文章主要为大家详细介绍了java如何利用snakeyaml和freemarker实现将数据导出为yaml文件,文中的示例代码讲解详细,有需要的小伙伴可以参考一下

需求描述

需求:根据用户在web界面勾选的配置生成一份如下格式文档,保留注释。

# 我是注释
VERSION: '1.0'

# 我是注释
FILE_NAME: foo

# 我是注释
UNWIND:
  COUNT: 3
  UNWIND_CHECK: true
  
# 我是注释
FLAGS:
  FLAG1: true
  FLAG2: false
  FLAG3: true
  FLAG4: true
  
 # 我是注释
 DEFINES:
  - DEFINE1
  - DEFINE2
  - DEFINE3

技术调研

这里直接给结论,关于下面提及的技术在网上资料很多,我也会把我参考的资料贴在文章尾部。

简单介绍一下这里提及的两个技术:

  • snakeyaml: 支持javabean转为yaml文件,也支持读取yaml文件为javabean对象。类似fastjson可以实现javabean与json相互转化。
  • freemark:比较成熟的template engine之一。

1.采用snakeyaml

优点:生成yaml文件简单,有相应的api可直接调用。只要把封装数据传给snakeyaml即可

缺点:

  • 和需求文档中的变量顺序不一致,生成的按照字母顺序排序;注释不好处理 。
  • java对象属性名需要和yaml中的一致。但是yaml中采用大写加下划线的风格、java中变量名采用驼峰命名风格。(初步尝试了做变量风格转换,要继承snakeyaml的一些类重写部分函数,比较复杂。而且后面要读取yaml文档时,又要做一次逆向风格替换。)

2.采用freemarker

优点:

  • 以按照需求文档中的配置项顺序生成yaml文件
  • 变量名风格可以不一致

缺点:

  • 需要自己写yaml语法规则
  • 如果变量名风格不一致,在读取yaml文件时会增加复杂度

3.snakeyaml + freemarker

优点:

  • 可以按照需求文档中的配置项顺序生成yaml文件
  • 生成yaml文件逻辑较为简单

缺点:

  • 需求文档中使用块序列风格,这种方式将以流序列风格生成文档
  • 如果变量名风格不一致,在读取yaml文件时会增加复杂度

调研反馈

和产品沟通后,第三种方式提到的两个缺点不是问题。

结论:1.读取yaml文件功能不需要开发(是我多虑了,哈哈);2.块序列风格转为流序列风格。

理论落地

snakeyaml + freemarker的实现思路是:根据需求中的yaml文件提取出一个模板,然后通过数据填充的方式,给模板填充使用snakeyaml预处理过的数据,如此即可生成一份令产品满意的yaml文档。

step 1:提取freemark模板

# 我是注释
VERSION: ${dumpHelper.settingBO.version!}

# 我是注释
FILE_NAME: ${dumpHelper.settingBO.fileName!}

# 我是注释
UNWIND: ${dumpHelper.getUnwind()!}

# 我是注释
FLAGS: ${dumpHelper.getFlags()!}

# 我是注释
DEFINES: ${dumpHelper.getDefines()!}

step 2: 编写生成yaml文件工具类

public class YamlGeneratorUtil {
    private static final Configuration freemarkerConfig;

    static {
        // 初始化Freemarker配置
        freemarkerConfig = new Configuration(Configuration.VERSION_2_3_0);
        freemarkerConfig.setClassForTemplateLoading(YamlGeneratorUtil.class, "/templates/");
    }

    /**
     * 根据模板生成单个yaml配置文件
     * @param templateName 模板名称
     * @param outputFileName 生成的文件名
     * @param settingDumpHelper 配置转储辅助类
     */
    public static void generate(String templateName, String outputFileName, SettingDumpHelper settingDumpHelper) {
        try (FileWriter fileWriter = new FileWriter(outputFileName)) {
            Template template = freemarkerConfig.getTemplate(templateName);
            Map<String, Object> dataModel = new HashMap<>();
            dataModel.put("dumpHelper", freemarkerConfig.getObjectWrapper().wrap(settingDumpHelper));
            String config = FreeMarkerTemplateUtils.processTemplateIntoString(template, dataModel);
            fileWriter.write(config);
            System.out.println(config);
        } catch (IOException | TemplateException e) {
            throw new BusinessException(ErrorEnum.build(ErrorEnum.INTERNAL_SERVER_ERROR, "生成yaml文件失败:" + e.toString()));
        }
    }
}

step 3:编写SettingDumpHelper转储辅助类

由于业务特殊,源码就不贴了。这个类具体怎么写根据大家自己的业务逻辑,它的作用是利用snakeyaml对数据进行预处理,把数据转换成yaml的流序列格式。

//示例:
DumperOptions dumperOptions = new DumperOptions();
// 指定流序列格式
dumperOptions.setDefaultFlowStyle(DumperOptions.FlowStyle.FLOW);
Yaml settingDumper = new Yaml(dumperOptions);
// 把数据转换成yaml的流序列格式。
public String getFlags() {
       return settingDumper.dump(settingBO.getFlags());
}

step 4:利用工具类生成yaml文件

YamlGeneratorUtil.generate("config.ftl", your_output_file, your_dump_helper);

到此这篇关于详解java如何实现将数据导出为yaml的文章就介绍到这了,更多相关java数据导出为yaml内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Java实现京东联盟API数据获取功能

    Java实现京东联盟API数据获取功能

    这篇文章介绍了Java获取京东联盟API数据的方法,文中通过示例代码介绍的非常详细。对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2022-07-07
  • JAVA中的基本数据类型

    JAVA中的基本数据类型

    本文主要介绍了JAVA中的基本数据类型。具有很好的参考价值,下面跟着小编一起来看下吧
    2017-02-02
  • 详解SpringBoot如何优雅的处理免登录接口

    详解SpringBoot如何优雅的处理免登录接口

    在项目开发过程中,会有很多API接口不需要登录就能直接访问,比如公开数据查询之类的,常规处理方法基本是 使用拦截器或过滤器,拦截需要认证的请求路径,本文介绍一个更优雅的方法自定义注解的方式,文中通过代码示例介绍的非常详细,需要的朋友可以参考下
    2024-01-01
  • Java数据结构之简单的连接点(link)实现方法示例

    Java数据结构之简单的连接点(link)实现方法示例

    这篇文章主要介绍了Java数据结构之简单的连接点(link)实现方法,涉及java指针指向节点的相关使用技巧,需要的朋友可以参考下
    2017-10-10
  • 利用stream sorted进行降序排序

    利用stream sorted进行降序排序

    这篇文章主要介绍了利用stream sorted进行降序排序,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2021-03-03
  • AQS同步组件CyclicBarrier循环屏障用例剖析

    AQS同步组件CyclicBarrier循环屏障用例剖析

    这篇文章主要为大家介绍了AQS同步组件CyclicBarrier循环屏障用例剖析,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-08-08
  • 分享JVM 的四种引用方式

    分享JVM 的四种引用方式

    这篇文章主要介绍了分享JVM 的四种引用方式,文章围绕主题展开详细的内容介绍,具有一定的参考价值,需要的小伙伴可以参考一下
    2022-07-07
  • java程序运行时内存分配详解

    java程序运行时内存分配详解

    这篇文章主要介绍了java程序运行时内存分配详解 ,需要的朋友可以参考下
    2016-07-07
  • Mybatis批量插入index out of range错误的解决(较偏的错误)

    Mybatis批量插入index out of range错误的解决(较偏的错误)

    这篇文章主要介绍了Mybatis批量插入index out of range错误的解决(较偏的错误),具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-12-12
  • springboot中shiro使用自定义注解屏蔽接口鉴权实现

    springboot中shiro使用自定义注解屏蔽接口鉴权实现

    本文主要介绍了springboot中shiro使用自定义注解屏蔽接口鉴权实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2022-07-07

最新评论