首页 > 编程语言 >【Java对象转换】003- Java 对象与 Yaml 互转

【Java对象转换】003- Java 对象与 Yaml 互转

时间：2023-02-22 21:08:46浏览次数：72  
标签：map Java java 003 yaml 互转 import com


【Java对象转换】003- Java 对象与 Yaml 互转

文章目录

  • ​​【Java对象转换】003- Java 对象与 Yaml 互转​​
  • ​​一、Java 对象与 Yaml 概述​​
  • ​​1、Java 对象​​
  • ​​2、Yaml​​
  • ​​二、Java 对象与 Yaml 互转​​
  • ​​1、使用 jackson dataformat yaml​​
  • ​​第一步：在 pom.xml下引入依赖​​
  • ​​第二步：写个工具类​​
  • ​​第三步：代码演示​​
  • ​​第四步：运行结果​​
  • ​​2、使用 com.esotericsoftware.yamlbeans​​
  • ​​第一步：在 pom.xml下引入依赖​​
  • ​​第二步：写个工具类​​
  • ​​第三步：写一个实体类​​
  • ​​第四步：代码测试​​
  • ​​第五步：运行结果​​
  • ​​3、使用 org.jyaml​​
  • ​​概述​​
  • ​​参考文章​​
  • ​​参考网站​​
  • ​​4、使用 SnakeYaml​​
  • ​​第一步：在 pom.xml 下引入依赖​​
  • ​​第二步：写一个工具类​​
  • ​​第三步：写一个实体类​​
  • ​​第四步：代码测试​​
  • ​​第五步：运行结果​​

一、Java 对象与 Yaml 概述

1、Java 对象

  • Java对象是数据和处理可用数据的过程的组合；
  • 对象既有状态又有行为 。 在Java中，使用关键字“ new”创建对象；
  • 对象是从称为类的模板创建的；
  • 对象是类的实例。

2、Yaml

可参考本人其他文章：《【Spring Boot】003-yaml语法》 二、yaml语法

二、Java 对象与 Yaml 互转

1、使用 jackson dataformat yaml

jackson dataformat yaml，是用来读取yaml文件，并且反序列化到对象中的一个模块。

此处使用 2.13.2 会报错：java.lang.NoSuchMethodError: ‘com.fasterxml.jackson.core.io.ContentReference com.fasterxml.jackson.dataformat.yaml.YAMLFactory._createContentReference(java.lang.Object)’

第一步：在 pom.xml下引入依赖

<dependency>
    <groupId>com.fasterxml.jackson.dataformat</groupId>
    <artifactId>jackson-dataformat-yaml</artifactId>
    <version>2.12.4</version>
</dependency>

第二步：写个工具类

package com.zibo.api.util;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
import com.fasterxml.jackson.dataformat.yaml.YAMLGenerator;
import com.fasterxml.jackson.dataformat.yaml.YAMLMapper;

import java.io.IOException;
import java.io.StringWriter;

/**
 * 对象与yaml字符串互转工具：测试完成，时间：2021年08月06日 14时08分18秒
 */
public class YamlUtil {
    /**
     * 将yaml字符串转成类对象
     * @param yamlStr 字符串
     * @param clazz 目标类
     * @param <T> 泛型
     * @return 目标类
     */
    public static <T> T toObject(String yamlStr, Class<T> clazz){
        ObjectMapper mapper = new ObjectMapper(new YAMLFactory());
        mapper.findAndRegisterModules();
        try {
            return mapper.readValue(yamlStr, clazz);
        } catch (JsonProcessingException e) {
            e.printStackTrace();
        }
        return null;
    }

    /**
     * 将类对象转yaml字符串
     * @param object 对象
     * @return yaml字符串
     */
    public static String toYaml(Object object){
        ObjectMapper mapper = new ObjectMapper(new YAMLFactory());
        mapper.findAndRegisterModules();
        mapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);
        mapper = new ObjectMapper(new YAMLFactory().disable(YAMLGenerator.Feature.WRITE_DOC_START_MARKER));
        StringWriter stringWriter = new StringWriter();
        try {
            mapper.writeValue(stringWriter, object);
            return stringWriter.toString();
        } catch (IOException e) {
            e.printStackTrace();
        }
        return null;
    }

    /**
     * （此方法非必要）
     * json 2 yaml
     * @param jsonStr json
     * @return yaml
     * @throws JsonProcessingException Exception
     */
    public static String json2Yaml(String jsonStr) throws JsonProcessingException {
        JsonNode jsonNode = new ObjectMapper().readTree(jsonStr);
        return new YAMLMapper().writeValueAsString(jsonNode);
    }
}

第三步：代码演示

在测试类进行简单演示！

package com.zibo.api;

import com.zibo.api.util.YamlUtil;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;

import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * @author zibo
 * @date 2022/3/28 0028 20:35
 */
@SpringBootTest
public class MyYamlTest {
    @Test
    public void transform() {
        // 1、准备 Java 对象
        Map<String, String> map = new HashMap<>();
        map.put("k1", "v1");
        map.put("k2", "v2");
        map.put("k3", "v3");
        Cat cat = new Cat("喵喵", 2, Arrays.asList("捉老鼠", "吃鱼"), map);
        // 2、Java 对象转 yaml 字符串
        String toYaml = YamlUtil.toYaml(cat);
        System.out.println(toYaml);
        // 3、yaml 字符串转 Java 对象
        Cat toObject = YamlUtil.toObject(toYaml, Cat.class);
        System.out.println(toObject);
    }
}

@Data
@NoArgsConstructor
@AllArgsConstructor
class Cat {
    private String name;
    private Integer age;
    private List<String> hobbies;
    private Map<String, String> map;
}

第四步：运行结果

name: "喵喵"
age: 2
hobbies:
- "捉老鼠"
- "吃鱼"
map:
  k1: "v1"
  k2: "v2"
  k3: "v3"

Cat(name=喵喵, age=2, hobbies=[捉老鼠, 吃鱼], map={k1=v1, k2=v2, k3=v3})

2、使用 com.esotericsoftware.yamlbeans

第一步：在 pom.xml下引入依赖

<dependency>
    <groupId>com.esotericsoftware.yamlbeans</groupId>
    <artifactId>yamlbeans</artifactId>
    <version>1.15</version>
</dependency>

下面的和这个好像是同一个，引入效果似乎一样，具体需探索！

<!--yaml-->
<dependency>
    <groupId>com.github.sanjusoftware</groupId>
    <artifactId>yamlbeans</artifactId>
    <version>1.11</version>
</dependency>

第二步：写个工具类

package com.zibo.api.utils;

import com.esotericsoftware.yamlbeans.YamlException;
import com.esotericsoftware.yamlbeans.YamlReader;
import com.esotericsoftware.yamlbeans.YamlWriter;

import java.io.FileNotFoundException;
import java.io.FileReader;
import java.io.FileWriter;
import java.io.IOException;

/**
 * @author zibo
 * @date 2022/3/28 0028 22:18
 */
public class YamlUtil {
    private YamlUtil() {}

    /**
     * 将 Java 对象写到 yaml 文件
     *
     * @param object   对象
     * @param yamlPath 文件路径
     */
    public static void writeYaml(Object object, String yamlPath) {
        try {
            YamlWriter writer = new YamlWriter(new FileWriter(yamlPath));
            writer.write(object);
            writer.close();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    /**
     * 从 yaml 文件读取转到 Java 对象
     * @param yamlPath 文件路径
     * @param clazz    目标类.class
     * @param <T>      目标类
     * @return 目标类对象
     */
    public static <T> T readYaml(String yamlPath, Class<T> clazz) {
        try {
            YamlReader reader = new YamlReader(new FileReader(yamlPath));
            try {
                return reader.read(clazz);
            } catch (YamlException e) {
                e.printStackTrace();
            }
        } catch (FileNotFoundException e) {
            e.printStackTrace();
        }
        return null;
    }

}

第三步：写一个实体类

这个实体类的构造函数需要使用 public 修饰，我刚开始在测试类里面写的实体类无法使用！

package com.zibo.api.entity;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.util.List;
import java.util.Map;

@Data
@NoArgsConstructor
@AllArgsConstructor
public class Cat {
    private String name;
    private Integer age;
    private List<String> list;
    private Map<String, String> map;
}

第四步：代码测试

package com.zibo.api;

import com.zibo.api.entity.Cat;
import com.zibo.api.utils.YamlUtil;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;

import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/**
 * @author zibo
 * @date 2022/3/28 0028 22:58
 */
@SpringBootTest
public class YamlTest {
    @Test
    public void transform() {
        String path = "test.yaml";
        // 1、准备 Java 对象
        Map<String, String> map = new HashMap<>();
        map.put("k1", "v1");
        map.put("k2", "v2");
        map.put("k3", "v3");
        Cat cat = new Cat("喵喵", 2, Arrays.asList("捉老鼠", "吃鱼"), map);
        // 2、Java 对象写到 yaml 文件
        YamlUtil.writeYaml(cat, path);
        // 3、读取 yaml 文件转成 Java 字符串
        System.out.println(YamlUtil.readYaml(path, Cat.class));
    }
}

第五步：运行结果

test.yaml 文件

注意这里的中文转成了 Unicode 编码！

!com.zibo.api.entity.Cat
name: "\u55b5\u55b5"
age: 2
list: !java.util.Arrays$ArrayList
- "\u6349\u8001\u9f20"
- "\u5403\u9c7c"
map: 
   k1: v1
   k2: v2
   k3: v3

控制台输出

Cat(name=喵喵, age=2, list=[捉老鼠, 吃鱼], map={k1=v1, k2=v2, k3=v3})

3、使用 org.jyaml

概述

此框架不再更新，基本可以满足使用，有一点瑕疵！

参考文章

《java-yml工具类JYaml用法》

《Yaml介绍及JYaml将数据写入yaml文件》

《JYaml——>Yaml的Java实现》

参考网站

​​http://jyaml.sourceforge.net/tutorial.html​​

4、使用 SnakeYaml

第一步：在 pom.xml 下引入依赖

<dependency>
    <groupId>org.yaml</groupId>
    <artifactId>snakeyaml</artifactId>
    <version>1.30</version>
</dependency>

第二步：写一个工具类

package com.zibo.api.utils;

import org.yaml.snakeyaml.Yaml;

import java.io.StringWriter;

/**
 * @author zibo
 * @date 2022/3/28 0028 22:18
 */
public class YamlUtil2 {
    private YamlUtil2() {
    }

    /**
     * Java 对象转 yaml 字符串
     * @param object 对象
     * @return 字符串
     */
    public static String toYaml(Object object) {
        Yaml yaml = new Yaml();
        StringWriter sw = new StringWriter();
        yaml.dump(object, sw);
        return sw.toString();
    }

    /**
     * 从 yaml 文件读取转到 Java 对象
     * @param yamlStr yaml 字符串
     * @param clazz   目标类.class
     * @param <T>     目标类
     * @return 目标类对象
     */
    public static <T> T toObject(String yamlStr, Class<T> clazz) {
        Yaml yaml = new Yaml();
        return yaml.loadAs(yamlStr, clazz);
    }

}

第三步：写一个实体类

package com.zibo.api.entity;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.util.List;
import java.util.Map;

@Data
@NoArgsConstructor
@AllArgsConstructor
public class Cat {
    private String name;
    private Integer age;
    private List<String> list;
    private Map<String, String> map;
}

第四步：代码测试

package com.zibo.api;

import com.zibo.api.entity.Cat;
import com.zibo.api.utils.YamlUtil2;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;

import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/**
 * @author zibo
 * @date 2022/3/28 0028 22:58
 */
@SpringBootTest
public class YamlTest {
    @Test
    public void transform() {
        // 1、准备 Java 对象
        Map<String, String> map = new HashMap<>();
        map.put("k1", "v1");
        map.put("k2", "v2");
        map.put("k3", "v3");
        Cat cat = new Cat("喵喵", 2, Arrays.asList("捉老鼠", "吃鱼"), map);
        // 2、Java 对象转 yaml 字符串
        String yaml = YamlUtil2.toYaml(cat);
        System.out.println(yaml);
        // 3、读取 yaml 文件转成 Java 字符串
        System.out.println(YamlUtil2.toObject(yaml, Cat.class));
    }
}

第五步：运行结果

!!com.zibo.api.entity.Cat
age: 2
list: [捉老鼠, 吃鱼]
map: {k1: v1, k2: v2, k3: v3}
name: 喵喵

Cat(name=喵喵, age=2, list=[捉老鼠, 吃鱼], map={k1=v1, k2=v2, k3=v3})


标签：map,Java,java,003,yaml,互转,import,com
From： https://blog.51cto.com/u_13272819/6079415

相关文章

  • Java 扫描枚举类并获取属性
    Java扫描枚举类并获取属性文章目录​​Java扫描枚举类并获取属性​​​​第一步：在pom.xml下导入hutool和commons-lang3​​​​第二步：写一个接口以规范枚举的属性​......
  • 【Java对象转换】002- Java 对象与 Map 互转
    文章目录​​【Java对象转换】002-Java对象与Map互转​​​​一、Java对象与Map概述​​​​1、Java对象​​​​2、Map​​​​二、Java对象与Map互转​​​​1......
  • Java 截取字符串 split 方法与 substring 方法简单比较
    Java截取字符串split方法与substring方法简单比较文章目录​​Java截取字符串`split`方法与`substring`方法简单比较​​​​0、结论​​​​1、截取目标​​​​......
  • 【TypeScript 4.5】003-第 3 章 常用类型
    【TypeScript4.5】003-第3章常用类型文章目录​​【TypeScript4.5】003-第3章常用类型​​​​一、基元类型string、number和boolean​​​​1、基本含义​​​......
  • 【Java对象转换】001- Java 对象与 JSON 互转
    文章目录​​【Java对象转换】001-Java对象与JSON互转​​​​一、Java对象与JSON概述​​​​1、Java对象​​​​2、JSON​​​​二、JSON解析及与Java对象互转......
  • 【JavaScript】JS引擎中执行上下文如何顺序执行代码
    首先我们知道JavaScript引擎包括一个调用栈和堆，调用栈是代码实际执行的地方，使用执行上下文(执行环境)来完成；堆是非结构化的内存池，存储了应用程序所需要的所有对象。执行上......
  • java环境搭建
    百度下载jdk8（8u181）先登录甲骨文再下载，安装后要记得安装目录在我的电脑，属性，高级设置，环境变量里新建JAVA_HOME环境名，地址是安装目录找到Path在里面添加%JAVA_HOME%/bin和......
  • Java帝国的诞生
    Java帝国的诞生C&C++1972年C诞生贴近硬件，运行极快，效率极高。操作系统，编译器，数据库，网络系统等指针和内存管理1982年C++诞生面向对象兼容C图形领域、游戏等1995年J......
  • Java数据类型，变量命名的标准 （AJCG），分支和循环，文档注释的要求
    Java数据类型，变量，分支和循环Java中的八大基本数据类型数据类型占用字节数数据范围byte1B-128~127short2B-32768~32767int4B-2^31~2^31-1......
  • Java多线程技能-方法介绍
    java多线程技能技术点：线程的启动如何使线程暂停如何使线程停止线程的优先级线程安全相关的问题方法currentThread()currentThread()方法可返回代码段正在被哪......

赞助商

阅读排行

网站主页关于我们联系我们网站地图

本网站内容转载自其他媒体，侵权联系[admin##ips99.com]。

Copyright © 2020-2023 IPS99 版权所有 IPS99