您的位置 首页 java

JSON工具之Jackson的使用详解

智云科技发布于 2023年4月15日评论关闭阅读(124)

1、Jackson的使用

Jackson 是当前用得比较广泛的，用来序列化和反序列化 JSON 的 Java 的开源框架。Jackson 社区相对比较活跃，更新速度也比较快， 从 Github 中的统计来看，Jackson 是最流行的 json 解析器之一 。 Spring MVC 的默认 json 解析器便是 Jackson。 Jackson 优点很多。 Jackson 所依赖的 jar 包较少 ，简单易用。与其他 Java 的 json 的框架 Gson 等相比， Jackson 解析大的 json 文件速度比较快；Jackson 运行时占用内存比较低，性能比较好；Jackson 有灵活的 API，可以很容易进行扩展和定制。

1.1Jackson的常用注解

注解

说明

@JsonIgnore

使用@JsonIgnore注解JSON序列化时将忽略该字段。示例：

@JsonIgnore
private String password;

@JsonProperty

用于属性，把属性的名称序列化时转换为另外一个名称。示例：

@JsonProperty(“blog-remark”)

private String blogRemark;

@JsonFormat

用于属性或者方法，把属性的格式序列化时转换成指定的格式。示例：

@JsonFormat(timezone = “GMT+8”, pattern = “yyyy-MM-dd HH:mm:ss”)
private Date createDate;

@JsonPropertyOrder

用于类， 指定属性在序列化时 json 中的顺序 ， 示例：
@JsonPropertyOrder({ “birth_Date”, “name” })

public class Person

@JsonCreator

用于 构造方法 ，和 @JsonProperty 配合使用，适用有参数的构造方法。 示例：
@JsonCreator
public Person(@JsonProperty(“name”)String name) {…}

@JsonAnySetter

用于属性或者方法，设置未反序列化的属性名和值作为键值存储到 map 中
@JsonAnySetter

public void set(String key, Object value) {

map.put(key, value);

}

@JsonAnyGetter

用于方法 ，获取所有未序列化的属性
public Map<String, Object> any() { return map; }

1.2Jackson的简单应用

添加pom.xml配置信息： 

 <!-- Jackson依赖 -->
<dependency>
  <groupId>com.fasterxml.jackson.core</groupId>
  <artifactId>jackson-core</artifactId>
  <version>2.9.9</version>
</dependency>
<dependency>
  <groupId>com.fasterxml.jackson.core</groupId>
  <artifactId>jackson-databind</artifactId>
  <version>2.9.9</version>
</dependency>
<dependency>
  <groupId>com.fasterxml.jackson.core</groupId>
  <artifactId>jackson-annotations</artifactId>
  <version>2.9.9</version>
</dependency>

创建UserInfo（用户信息实体类），用户JSON序列化示例使用。

示例要求：

（1）使用@JsonIgnore注解， 序列化 时忽略登录密码字段。

（2）使用@JsonProperty注解，将blogRemark字段序列化时转换为blog-remark。

（3）使用@JsonFormat注解，序列化时将日期格式化。 

 package com.demo.utils.entity;

import com.fasterxml.jackson. annotation .JsonFormat;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.ObjectMapper;
import lombok.Data;

import java.util.Date;

/**
 * 用户信息实体类
 * @author luoxiang
 * @date 2022年01月13日 10:04 上午
 */@Data
public class UserInfo
{
    /**
     * 用户名称
     */    private String userName;

    /**
     * 登录密码
     * 使用@JsonIgnore注解
     *  Json 序列化时将忽略该字段
     */    @JsonIgnore
    private String password;

    /**
     * 博客地址
     */    private String blogUrl;

    /**
     * 博客信息
     * 使用@JsonProperty注解
     * 把属性的名称序列化时转换为另外一个名称
     */    @JsonProperty("blog-remark")
    private String blogRemark;

    /**
     * 创建时间
     * 使用@JsonFormat注解
     * 把属性的格式序列化时转换成指定的格式
     */    @JsonFormat(timezone = "GMT+8", pattern = "yyyy-MM-dd HH:mm:ss")
    private Date createDate;

}

1.2.1 将实体类转换为JSON 

 /**
 * 将实体类转换为JSON
 * @author luoxiang
 */@Test
public void entityToJson() throws  Exception  {
    //用户信息实体类
    UserInfo userInfo = new UserInfo();
    userInfo.setUserName("uncle_xiang的博客");
    userInfo.setPassword("123456");
    userInfo.setBlogUrl("#34;);
    userInfo.setBlogRemark("您好，欢迎访问 uncle_xiang的博客");
    userInfo.setCreateDate(new Date());

    //将参数转换成JSON对象
    ObjectMapper mapper = new ObjectMapper();
     String  json = mapper.writeValueAsString(userInfo);

    //打印结果
    System.out.println(json);
}

执行结果：

1.2.2 将JSON转换为实体类 

 /**
 * 将JSON转换为实体类
 * @author luoxiang
 */@Test
public void jsonToEntity() throws Exception {
    //JSON内容
    String json = "{"userName":"uncle_xiang的博客","blogUrl":"#34;,"createDate":"2022-01-13 10:07:55","blog-remark":"您好，欢迎访问 uncle_xiang的博客"}";

    //将JSON转换为实体类
    ObjectMapper mapper = new ObjectMapper();
    UserInfo  userInfo = mapper.readValue(json, UserInfo.class);

    //打印结果
    System.out.println("用户名称：" + userInfo.getUserName());
    System.out.println("登录密码：" + userInfo.getPassword());
    System.out.println("博客地址：" + userInfo.getBlogUrl());
    System.out.println("博客信息：" + userInfo.getBlogRemark());
    System.out.println("创建时间：" + userInfo.getCreateDate());
}

执行结果：

2、创建工具类

在项目中创建Jackson工具类（JacksonUtil.java） 

 package com.demo.utils.json;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.JavaType;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.io.IOException;
import java.util.List;
import java.util.Map;
import java.util.Set;

/**
 * Jackson工具类
 * @author luoxiang
 * @date 2022年01月13日 10:13 上午
 */public class JacksonUtil {

    private  static  ObjectMapper mapper = new ObjectMapper();

    /**
     * 将对象转换成JSON数据
     * @author luoxiang
     * @date 2022/1/13 10:15 上午
     * @param data   data对象
     * @return java.lang.String  JSON数据
     */    public static String getBeanToJson(Object data){
        try {
            return mapper.writeValueAsString(data);
        } catch (JsonProcessingException e) {
            e.printStackTrace();
        }
        return null;
    }

    /**
     * 将JSON数据转换成对象
     * @author luoxiang
     * @date 2022/1/13 10:17 上午
     * @param jsonData  JSON数据
     * @param beanType  对象类型
     * @return T 对象
     */    public static <T> T getJsonToBean(String jsonData,Class<T> beanType){
        try {
            return mapper.readValue(jsonData, beanType);
        } catch (IOException e) {
            e.printStackTrace();
        }
        return null;
    }

    /**
     * 将JSON数据转换成列表
     * @author luoxiang
     * @date 2022/1/13 10:21 上午
     * @param jsonData JSON对象
     * @param beanType 对象类型
     * @return java.util.List<T> 列表
     */    public static <T> List<T> getJsonToList(String jsonData, Class<T> beanType){
        try {
            JavaType javaType = mapper.getTypeFactory().constructParametricType(List.class, beanType);
            return mapper.readValue(jsonData, javaType);
        } catch (IOException e) {
            e.printStackTrace();
        }
        return null;
    }

    /**
     * 将JSON数据转换成Set集合
     * @param jsonData JSON数据
     * @param elementType  元素类型
     * @param <E>
     * @return Set集合
     */    public static <E> Set<E> getJsonToSet(String jsonData, Class<E> elementType){
        try {
            JavaType javaType = mapper.getTypeFactory().constructCollectionType(Set.class, elementType);
            return mapper.readValue(jsonData,javaType);
        } catch (IOException e) {
            e.printStackTrace();
        }
        return null;
    }

    /**
     * 将JSON数据转换成Map集合
     * @author luoxiang
     * @date 2022/1/13 10:28 上午
     * @param jsonData JSON数据
     * @param keyType  键类型
     * @param valueType 值类型
     * @return java.util.Map<K,V> Map集合
     */    public static <K,V> Map<K,V> getJsonToMap(String jsonData, Class<K> keyType, Class<V> valueType){
        try {
            JavaType javaType = mapper.getTypeFactory().constructMapType(Map.class, keyType, valueType);
            return mapper.readValue(jsonData,javaType);
        } catch (IOException e) {
            e.printStackTrace();
        }
        return null;
    }
}

1.1将JSON数据转换成set集合。 

 /**
 * 将JSON数据转换成Set集合
 * @author luoxiang
 */@Test
public void setTest(){
    Set<String> userSet = new HashSet<>();
    userSet.add("uncle_xiang的博客");
    userSet.add("您好，欢迎访问 uncle_xiang的博客");
    userSet.add("#34;);

    //将Set转化为JSON数据
    String json = JacksonUtil.getBeanToJson(userSet);
    System.out.println(json + "n");

    //将JSON数据转换成Set集合
    Set<String> jsonToSet = JacksonUtil.getJsonToSet(json,String.class);
    for(String item : jsonToSet) {
        System.out.println(item);
    }
}

执行结果：

2.2将JSON数据转换成Map集合。 

 /**
 * 将JSON数据转换成Map集合
 * @author luoxiang
 */@Test
public void mapTest() {
    Map<String, String> userMap = new HashMap<>();
    userMap.put("userName", "uncle_xiang的博客");
    userMap.put("blogUrl", "#34;);
    userMap.put("blogRemark", "您好，欢迎访问 uncle_xiang的博客");

    //将map转化为JSON数据
    String json = JacksonUtil.getBeanToJson(userMap);

    //将JSON数据转换成Map集合
    Map<String, String> jsonToMap = JacksonUtil.getJsonToMap(json, String.class, String.class);
    System.out.println("用户名称：" + jsonToMap.get("userName"));
    System.out.println("博客地址：" + jsonToMap.get("blogUrl"));
    System.out.println("博客备注：" + jsonToMap.get("blogRemark"));
}

执行结果：

标签:
打赏 点赞(2)

文章来源：智云一二三科技

文章标题：JSON工具之Jackson的使用详解

文章地址：https://www.zhihuclub.com/190550.shtml

关于作者: 智云科技

相关文章

热门文章

1分享新浪图床上传接口源码

点赞(929)阅读(61,042)

2PHP简单实现路由Route功能

点赞(1.14K)阅读(35,958)

3Tideways、xhprof 和 xhgui 打造 PHP 非侵入式监控平台

点赞(357)阅读(4,285)

4centos系统如何查看是否安装了mysql

点赞(530)阅读(3,781)

5curl 工具简述

点赞(503)阅读(2,973)
网站地图