java实现Yaml转Json示例详解
作者：Allein 发布时间：2023-12-06 22:58:34
标签：java,Yaml,转,Json
缘起
年前，因为项目需要进行配置的优化和架构的升级，领导给我来了个任务，让我去进行技术调研
需要将配置中心的yaml配置文件里面的配置转为Json的形式，以便后面可以通过写配置文件的方式，让数据源变的可拔插
调研过程
本着有轮子就直接用，绝不自己造轮子的态度，我成功找到了 snakeyaml 这个依赖
<dependency>
<groupId>org.yaml</groupId>
<artifactId>snakeyaml</artifactId>
<version>1.30</version>
</dependency>
1.0 入口点
Yaml yaml = new Yaml();
注意📢：此实现并不是一个线程安全的
1.1 基本用法
yml 文件：
common.cloud:
discovery: consul
config: consul
Java 代码：
@Test
public void YAMLToJSON01() {
Yaml yaml = new Yaml();
InputStream resourceAsStream = this.getClass().getClassLoader().getResourceAsStream("yamlToJson.yml");
// 解析唯一的 yaml 文档转为 Java 对象
Map<String, Object> load = yaml.load(resourceAsStream);
JSONObject jsonObject = JSONObject.parseObject(load);
System.out.println(jsonObject.toString());
}
结果
{"common.cloud":{"discovery":"consul","config":"consul"}}
1.2 自定义类型解析
yml 文件：
cloud:
discovery: consul
config: consul
extension:
- data: application-oracle-public.yml
refresh: true
Java 代码：
首先是创建对应的实体类
@Data
public class Cloud {
private Contact cloud;
private List<Contact02> extension;
}
@Data
public class Contact {
private String discovery;
private String config;
}
@Data
public class Contact02 {
private String data;
private String refresh;
}
@Test
public void YAMLToJSON02() {
Yaml yaml = new Yaml(new Constructor(Cloud.class));
InputStream resourceAsStream = this.getClass()
.getClassLoader()
.getResourceAsStream("yamlToJson.yml");
// 解析 yaml 文档转为 Cloud 对象
Cloud cloud = yaml.load(resourceAsStream);
JSONObject jsonObject = JSONObject.parseObject(JSONObject.toJSONString(cloud));
System.out.println(jsonObject.toString());
}
结果
{"cloud":{"discovery":"consul","config":"consul"},"extension":[{"data":"application-oracle-public.yml","refresh":"true"}]}
1.3 实战
1.3.1 从本地读配置文件
在项目中，假如领导只需要 spring.cloud.nacos 这一块的配置内容，但我们把整个配置文件的内容全部取出来了，那肯定是不符合领导需求的
于是就有了接下来的一些代码，一些关键的注释也标注在了代码中
yml 文件:
spring.cloud.nacos:
discovery:
server-addr: xxx
config:
server-addr: xxx
file-extension: yml
extension-configs:
- data-id: application-oracle-public.yml
refresh: true
eureka:
instance:
preferIpAddress: true
instanceId: ${spring.application.name}-${spring.cloud.client.ip-address}-${server.port}
client:
serviceUrl:
defaultZone: http://xxx/eureka/
Java 代码:
@Test
public void YAMLToJSON01() {
Yaml yaml = new Yaml();
InputStream resourceAsStream = this.getClass().getClassLoader().getResourceAsStream("bootstrap.yml");
// 解析 yaml 文档转为 Map
Map<String, Object> load = yaml.load(resourceAsStream);
HashMap<String, Object> objectObjectHashMap = new HashMap<>();
// 通过 key 取到对应的 value 然后放到新的 Map 中
objectObjectHashMap.put("spring.cloud.nacos", load.get("spring.cloud.nacos"));
JSONObject jsonObject = JSONObject.parseObject(JSONObject.toJSONString(objectObjectHashMap));
System.out.println(jsonObject.toString());
}
结果
{"spring.cloud.nacos":{"discovery":{"server-addr":"xxx"},"config":{"file-extension":"yml","server-addr":"xxx","extension-configs":[{"refresh":true,"data-id":"application-oracle-public.yml"}]}}}
下面的代码是使用静态内部类的方式去保证线程的安全
public class YamlToJsonUtil implements Serializable {
private final static String BOOTSTRAP = "bootstrap-test.yml";
private final Yaml yaml = new Yaml(new SafeConstructor());
/**
* Yaml to json.
*
* @param key the key
* @return the json object
*/
public JSONObject YamlToJson(String key) {
YamlToJsonUtil instance = YamlToJsonInner.instance;
Yaml yaml = instance.getYaml();
InputStream resourceAsStream = null;
try {
resourceAsStream = this.getClass().getClassLoader().getResourceAsStream(BOOTSTRAP);
} catch (Exception e) {
throw new RuntimeException(e);
}
Map<String, Object> load = null;
Map<String, Object> result = new HashMap<>();
load = yaml.load(resourceAsStream);
result.put(key, load.get(key));
return JSONObject.parseObject(JSONObject.toJSONString(result));
}
private YamlToJsonUtil() {
}
/**
* Gets instance.
*
* @return the instance
*/
public static YamlToJsonUtil getInstance() {
return YamlToJsonInner.instance;
}
private static class YamlToJsonInner {
private static final YamlToJsonUtil instance = new YamlToJsonUtil();
}
/**
* Gets yaml.
*
* @return the yaml
*/
public Yaml getYaml() {
return yaml;
}
}
@Test
public void YAMLToJSON03() {
String key = "spring.cloud.nacos";
YamlToJsonUtil yamlToJsonUtil = YamlToJsonUtil.getInstance();
JSONObject jsonObject = yamlToJsonUtil.YamlToJson(key);
System.out.println(jsonObject);
}
到了这一步领导的需求基本已经完成了一大半，接下来只需要再从配置中心中将这些配置取出来就可以摸鱼下班了
那么问题来了：该如何从配置中心中找到那一份配置文件呢？
就在这时，我想起来了 Spring 里面的 org.springframework.core.env.PropertySource 这个类。 org.springframework.core.env.PropertySource 这一个类顾名思义就是属性源的意思,再具体一点就是对获取键值对资源的抽象类。我们可以从org.springframework.core.env.AbstractEnvironment#getPropertySources 这个方法中得到配置中心里面的配置以及环境配置，再通过过滤即可得到我们想到的数据
(ps:上面提到的这个类以及对应的方法大家可以自行百度，因为篇幅等原因就不在这里详解了)
1.3.2 从配置中心读配置文件
接下来直接看代码：
public Map<String, Object> getPropertyMap(Environment environment) {
// 得到当前环境中所有的属性集合
List<?> propertySourceCollection = ((StandardEnvironment) environment)
.getPropertySources().stream()
.map(PropertySource::getSource)
.collect(Collectors.toList());
List<LinkedHashMap<String, Object>> list = new ArrayList<>();
for (Object source : propertySourceCollection) {
// 判断属性类型是否为 LinkedHashMap
if (source instanceof LinkedHashMap) {
list.add((LinkedHashMap<String, Object>) source);
}
}
// 将集合中多个 LinkedHashMap 合并为一个 Map
return list.stream()
.flatMap(map -> map.entrySet().stream())
.collect(Collectors.toMap(
Map.Entry::getKey,
Map.Entry::getValue,
(value1, value2) -> value1));
}
经过测试，上面的代码可以将配置中心中的所有配置都存储在一个 Map<String, Object> 中。
但是由于 yaml.load() 并没有入参为 Map<String, Object> 的重载方法，所以我们还得引入这个依赖
<dependency>
<groupId>pl.jalokim.propertiestojson</groupId>
<artifactId>java-properties-to-json</artifactId>
<version>5.1.0</version>
</dependency>
这个依赖里面的方法可以将 Map 转为 properties，再转为 json，刚好满足我们的需求。
Map<String, Object> propertyMap = getPropertyMap(environment);
// 将 Map 转为 Json
String json = new PropertiesToJsonConverter().convertFromValuesAsObjectMap(propertyMap);
直接上整个从配置中心读yaml配置文件里面的配置转为Json的全部代码
线程安全单例：
/**
* The type Yaml to json util.
*/
public class YamlToJsonForCloudUtil implements Serializable {
private final Yaml yaml = new Yaml(new SafeConstructor());
/**
* Yaml to json.
*
* @param key the key of the configuration file in Consul or Nacos
* @return the json object
*/
public JSONObject YamlToJson(String key) {
YamlToJsonForCloudUtil instance = YamlToJsonInner.instance;
Environment environment = instance.getEnvironment();
if (environment == null) {
throw new RuntimeException("Environment 为空！");
}
Map<String, Object> propertyMap = getPropertyMap(environment);
// 将 Map 转为 Json
String json = new PropertiesToJsonConverter().convertFromValuesAsObjectMap(propertyMap);
Yaml yaml = instance.getYaml();
Map<String, Object> load = null;
Map<String, Object> result = new HashMap<>();
// 解析 String 中唯一的 YAML 文档并转为 Map
load = yaml.load(json);
result.put(key, load.get(key));
return JSONObject.parseObject(JSONObject.toJSONString(result));
}
/**
* Gets property map.
*
* @param environment the environment
* @return the property map
*/
public Map<String, Object > getPropertyMap(Environment environment) {
// 得到当前环境中所有的属性集合
List<?> propertySourceCollection = ((StandardEnvironment) environment)
.getPropertySources().stream()
.map(PropertySource::getSource)
.collect(Collectors.toList());
List<LinkedHashMap<String, Object>> list = new ArrayList<>();
for (Object source : propertySourceCollection) {
// 判断属性类型是否为 LinkedHashMap
if (source instanceof LinkedHashMap) {
list.add((LinkedHashMap<String, Object>) source);
}
}
// 将集合中多个 LinkedHashMap 合并为一个 Map
return list.stream()
.flatMap(map -> map.entrySet().stream())
.collect(Collectors.toMap(
Map.Entry::getKey,
Map.Entry::getValue,
(value1, value2) -> value1));
}
private YamlToJsonForCloudUtil() {
}
/**
* Gets instance.
*
* @return the instance
*/
public static YamlToJsonForCloudUtil getInstance() {
return YamlToJsonInner.instance;
}
private static class YamlToJsonInner {
private static final YamlToJsonForCloudUtil instance = new YamlToJsonForCloudUtil();
}
/**
* Gets yaml.
*
* @return the yaml
*/
public Yaml getYaml() {
return yaml;
}
/**
* Gets environment.
*
* @return the environment
*/
public Environment getEnvironment() {
return SpringContextUtil.getBean(Environment.class);
}
}
工具类：
@Component
public class SpringContextUtil implements ApplicationContextAware {
private static ApplicationContext applicationContext;
/**
* 实现ApplicationContextAware接口的回调方法，设置上下文环境
*/
@Override
public void setApplicationContext(@NotNull ApplicationContext applicationContext){
SpringContextUtil.applicationContext = applicationContext;
}
/**
* 获得spring上下文
* @return ApplicationContext spring上下文
*/
public static ApplicationContext getApplicationContext(){
return applicationContext;
}
/**
* 获取bean
* @param name service注解方式name为小驼峰格式
* @return Object bean的实例对象
*/
public static Object getBean(String name) throws BeansException {
return getApplicationContext().getBean(name);
}
public static <T> T getBean(Class<T> className) {
return getApplicationContext().getBean(className);
}
/**
* 通过接口类型，返回所有实现了这个接口的实现类
*
* @param clazz
* @param <T>
* @return
*/
public static <T> Map<String, T> getBeansOfType(Class<T> clazz) {
return getApplicationContext().getBeansOfType(clazz);
}
}
测试：
@Test
public void YamlToJsonEnvironment() {
YamlToJsonForCloudUtil yamlToJsonUtil = YamlToJsonForCloudUtil.getInstance();
JSONObject dom = yamlToJsonUtil.YamlToJson("dom");
System.out.println(JSONObject.toJSONString(dom));
}
来源：https://juejin.cn/post/7198791684459642940
0
投稿猜你喜欢
- REmote DIctionary Server(Redis) 是一个由Salvatore Sanfilippo写的key-value存储系
- 本文实例讲述了C#执行外部命令的方法。分享给大家供大家参考。具体实现方法如下：///<summary>///executes a
前言在开发中我们经常要使用图片或者drawable文件夹下的xml,来实现一些效果，Drawable的用法都和xml相关，我们可以使用sha- 我们来讲一下自定义组合控件，相信大家也接触过自定义组合控件吧，话不多说，直接干（哈~哈~）：大家看到这个觉得这不是很简单的吗，这不就是写个布
- 项目中为了实现账号多设备登录的监听 一个账号在别的设备登录时在该设备上需要弹出对话框提示 故而用到全局对话框方案一、1、在开发中有时会用到全
- 1.狂妄的WPF相对传统的Windows图形编程，需要做很多复杂的工作，引用许多不同的API。例如：WinForm（带控件表单）、GDI+（
- C#中的很多关键词用法比较容易混淆，var和dynamic就是其中一组，他们都可以申明动态类型的变量，但是本质上他们还是有不少区别的。var
- 你要学会：流的概念处理字节流的类处理字符流的类Java标准输入输出文件管理类Java语言的输入输出类库1.流的概念流是指计算机各部件之间的数
- ActivityManager.RunningAppProcessInfo类与获取正在运行的应用程序每一个应用程序都会运行在它独立的进程里，
- 定义工具类-创建对应的日志对象定义枚举类-存储定义的日志文件名称logback.xml里配置对应的日志名称和日志等级1、工具类 Logger
- 本文实例为大家分享了Android Webview使用小结，供大家参考，具体内容如下#采用重载URL的方式实现Java与Js交互在Andro
- 1，IDEA中Lombok作用数据库: 库 表 字段 对应的值 user表(id,name,age)实体对象pojo: 用来封装数据库中的数
- 两种android图片裁剪方式，供大家参考，具体内容如下一、相机拍完照之后利用系统自带裁剪工具进行截取public static void
- Fragment的主要意义就是提供与Activity绑定的生命周期回调。Fragment不一定要向Activity的视图层级中添加View.
- 1.ArrayList 是基数组结构的，需要连续的内存空间从构造函数可以看出，ArrayList内部用一个Object数组来保存数据。对于无
- Apache 和 Tomcat 都是web网络服务器，两者既有联系又有区别，在进行HTML、PHP、JSP、P
- 这篇文章主要介绍了mybatis使用pagehelper插件过程详解,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习
- 前言项目流程图如下：这里我们通过：163邮箱来实现激活码发送qq邮箱来进行接收学习之前需要掌握的知识springboot的基本使用方法mys
- 类的初始化顺序在Java中，类里面可能包含：静态变量，静态初始化块，成员变量，初始化块，构造函数。在类之间可能存在着继承关系，那么当我们实例
- 本文实例为大家分享了java实现顺时针打印矩阵的具体代码，供大家参考，具体内容如下题目：输入一个矩阵，按照从外向里以顺时针的顺序依次打印出每
