8. SpringBoot 与 Jackson 相关使用

冷不防 2022-09-11 14:21 154阅读 0赞

### 文章目录 ###

*  1. 为啥用Jackson？
 *  2. 格式化时间的三种方式
 *   *  2.1 使用@JsonFormat
     *  2.2 编程式
     *  2.3 配置文件修改
 *  3. 序列化与反序列化
 *   *  3.1 序列化方法 writeValueAsString
     *  3.2 反序列化方法 readValue
     *  3.3 json数组转集合
 *  4. jackson注解
 *   *  4.1 @JsonProperty 取别名
     *  4.2 @Jsonlgnore 忽略属性
     *  4.3 @JsonIgnoreProperties 忽略一组属性
     *  4.4 @JsonFormat 时间格式化
     *  4.5 @JsonNaming 命名策略

# 1. 为啥用Jackson？ #

虽然阿里巴巴的`fastjson` 号称是最快的json处理工具

但是碰到一些特殊情况不好做处理 所以改用`jackson` 毕竟还是SpringBoot自带的

ps: 可能是本人太菜 才觉得不好用。。。

用我自己的话来说 他能够对一些时间之类的字段做格式化处理，序列化与反序列化等

当然作用不仅限于此 否则本贴将毫无意义

# 2. 格式化时间的三种方式 #

先定义一个简单的`User` 类

@Data
    @Accessors(chain = true)
    public class User { 
        private String name;
        private String password;
        private Date birthday;
    }

对应的controller里 设置下`User` 重点看页面的展示效果

@RestController
    public class TestController { 
    
        @GetMapping("getuser")
        public User getUser() { 
            User user = new User();
            user.setName("bb");
            user.setPassword("123");
            user.setBirthday(new Date());
            return user;
        }
     }

访问对应的页面 可以看到如下结果  
![在这里插入图片描述][33da406e94e2455db40d2cd3aebdd40e.png]  
但这个时间日期不是我们想要的 所以得做格式化处理

其实有三种配置方式 都可以实现我们要的效果

优先级从高到低分别为

字段上加@Jsonformat > 配置格式化的ObjectMapper的Bean> 配置文件中指定

## 2.1 使用@JsonFormat ##

直接在属性上加 `@JsonFormat`

@Data
    @Accessors(chain = true)
    public class User { 
        private String name;
        private String password;
        @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
        private Date birthday;
    }

重启程序 重新访问  
![在这里插入图片描述][486d776ddc3a4eaa9329891058fb0701.png]  
看似没问题对吧？ 细心的小伙伴还会说 爆爆哥 你这么用功啊 大早上起来写博客！

过奖过奖 其实并没有 这是时区问题导致的

点开源码 截取部分 都是采用`default` 其实就是UTC 时区 所以才会比真实时间提前8个小时

给出结论

SpringBoot自带的Jackson 格式化时间 会出现时间相差8小时的问题 特别需要注意  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5py65pm655qE54iG54iG5ZOl_size_20_color_FFFFFF_t_70_g_se_x_16]

我们第一种方式比较简单 直接在属性上新增下注解即可 且优先级最高

唯一的不足是 如果有多个对象的属性包含时间那就每个都要加了

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

再次访问 发现生效了  
![在这里插入图片描述][fadbde73773e407da662b9d7f2421bcc.png]

## 2.2 编程式 ##

同时设置下时间格式化与时区即可

@Configuration
    public class JacksonConfig { 
        @Bean
        public ObjectMapper getObjectMapper() { 
            ObjectMapper objectMapper = new ObjectMapper();
            objectMapper.setDateFormat(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"));
            objectMapper.setTimeZone(TimeZone.getTimeZone("GMT+8"));
            return objectMapper;
        }
    
    }

## 2.3 配置文件修改 ##

配置文件新增（推荐使用 全局生效）

spring.jackson.date-format=yyyy-MM-dd
    spring.jackson.time-zone=GMT+8

# 3. 序列化与反序列化 #

还记得我们之前定义的`ObjectMapper` 吗 序列化与反序列化都需要靠它来实现

## 3.1 序列化方法 writeValueAsString ##

说白了就是将一个对象转化成`json` 格式

代码如下 需要注入 `ObjectMapper`

@RestController
    public class TestController {
    
        @Autowired
        private ObjectMapper objectMapper;
    
        @GetMapping("getuser2")
        public String getUser2() throws JsonProcessingException {
            User user = new User();
            user.setName("bb");
            user.setPassword("123");
            user.setBirthday(new Date());
            String str = objectMapper.writeValueAsString(user);
            return str;
        }
    
    }

访问页面 返回的是字符串格式的json串  
![在这里插入图片描述][90b57d91a9084ecca7057029a67429cb.png]

## 3.2 反序列化方法 readValue ##

我将`json`字符串复制下来 稍微改动了一下 看能否转化成功

@RestController
    public class TestController { 
    
        @Autowired
        private ObjectMapper objectMapper;
    
        @GetMapping("getuser3")
        public User getUser3() throws JsonProcessingException { 
            String str = "{\n" +
                    " \"name\": \"baobao\",\n" +
                    " \"password\": \"12138\",\n" +
                    " \"birthday\": \"2021-09-09\"\n" +
                    "}";
            User user = objectMapper.readValue(str, User.class);
            return user;
        }
    
    }

当然也是没有问题的  
![在这里插入图片描述][8d6ff94bdc2e4f55a1832d779b519513.png]

## 3.3 json数组转集合 ##

最后来一个 json 数组转化为集合形式

这个要麻烦一些 自我感觉复杂对象的转化可以不用`jackson` 不如用hutool工具来的方便

@RestController
    public class TestController { 
    
        @Autowired
        private ObjectMapper objectMapper;
    
        @GetMapping("getuserlist")
        public List<User> getuserlist() throws JsonProcessingException { 
            String str = "[\n" +
                    " {\n" +
                    " \"name\": \"bb\",\n" +
                    " \"password\": \"123\",\n" +
                    " \"birthday\": \"2021-09-17\"\n" +
                    " },\n" +
                    " {\n" +
                    " \"name\": \"bb\",\n" +
                    " \"password\": \"123\",\n" +
                    " \"birthday\": \"2021-09-17\"\n" +
                    " }\n" +
                    "]";
    
            JavaType javaType = objectMapper.getTypeFactory().constructParametricType(List.class, User.class);
            List<User> list = objectMapper.readValue(str, javaType);
            return list;
        }
    
    }

显示如下  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5py65pm655qE54iG54iG5ZOl_size_8_color_FFFFFF_t_70_g_se_x_16]

# 4. jackson注解 #

重头戏来了 最重要的注解

## 4.1 @JsonProperty 取别名 ##

可以给对应的json的key取别名

@Data
    @Accessors(chain = true)
    public class User { 
        @JsonProperty("姓名")
        private String name;
        private String password;
        private Date birthday;
    }

![在这里插入图片描述][1c5bc9a502d94d308e74cf8c40eb949a.png]

## 4.2 @Jsonlgnore 忽略属性 ##

对于一些我们不需要在前端展示的属性 可以使用该注解

@Data
    @Accessors(chain = true)
    public class User { 
        @JsonProperty("姓名")
        private String name;
        @JsonIgnore
        private String password;
        private Date birthday;
    }

![在这里插入图片描述][14cd89efb30944059c70d486a99ffe8a.png]

## 4.3 @JsonIgnoreProperties 忽略一组属性 ##

需要用在类上

@Data
    @Accessors(chain = true)
    @JsonIgnoreProperties({ "password","birthday"})
    public class User { 
        @JsonProperty("姓名")
        private String name;
        private String password;
        private Date birthday;
    }

![在这里插入图片描述][de3e34473cfa4082bd540b44ac74b11c.png]

## 4.4 @JsonFormat 时间格式化 ##

略 之前已经详细说明了

## 4.5 @JsonNaming 命名策略 ##

指定首字母大写

@Data
    @Accessors(chain = true)
    //首字母大写的策略
    @JsonNaming(PropertyNamingStrategy.UpperCamelCaseStrategy.class)
    public class User { 
        @JsonProperty("姓名")
        private String name;
        private String password;
        private Date birthday;
        private String className;
    }

![在这里插入图片描述][732ff98f304046fe9288dd31087dbc62.png]

其实内部还有些属性 没有讲到 大家用到的时候可以研究一下

> 死亡是唯一一座永远亮着的灯塔，不管你向哪里航行，最终都得转向它指引的方向。  
> 一切都会逝去，只有死神永生。

[33da406e94e2455db40d2cd3aebdd40e.png]: /images/20220828/5b3b391b2b1a4f0cb4dadb6979bc52a8.png
[486d776ddc3a4eaa9329891058fb0701.png]: /images/20220828/4fe2b77e8fd043b89dc78f856ca9a1b3.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5py65pm655qE54iG54iG5ZOl_size_20_color_FFFFFF_t_70_g_se_x_16]: /images/20220828/5ba4364329694fa3b1a061f23b2ce51c.png
[fadbde73773e407da662b9d7f2421bcc.png]: /images/20220828/38033fb06a404066b68447f472fe1088.png
[90b57d91a9084ecca7057029a67429cb.png]: /images/20220828/d66c929fa0084fce9c8b7ff2bca9638c.png
[8d6ff94bdc2e4f55a1832d779b519513.png]: /images/20220828/71f07f71a00b4b8bbb51373d6710dc99.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5py65pm655qE54iG54iG5ZOl_size_8_color_FFFFFF_t_70_g_se_x_16]: /images/20220828/554e4ab7ce1d489bbc01183773f4e679.png
[1c5bc9a502d94d308e74cf8c40eb949a.png]: /images/20220828/68051aeece2a48c9b5be00eb0bc16c39.png
[14cd89efb30944059c70d486a99ffe8a.png]: /images/20220828/bae0de0babcf47869de602e248486e31.png
[de3e34473cfa4082bd540b44ac74b11c.png]: /images/20220828/cd7c03dcb1c5490f8e8450932f6f212e.png
[732ff98f304046fe9288dd31087dbc62.png]: /images/20220828/dcce4b1b2b554b57b3999d4aef65f823.png