SpringBoot内置的jackson和lombok的使用

最新推荐文章于 2024-07-18 18:46:47 发布
最新推荐文章于 2024-07-18 18:46:47 发布
阅读量1.4k 收藏 2
点赞数
分类专栏： SpringBoot java 文章标签： spring java restful
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qzw752890913/article/details/120281305
版权

文章目录

jackson的序列化和反序列化

SpringBoot内置了jackson来实现JSON的序列化和反序列化。
jackson使用ObjectMapper类将POJO对象序列化为JSON字符串，也能将JSON字符串反序列化为POJO对象。
在这里插入图片描述
下面我们来看具体的例子。

将POJO对象序列化为JSON字符串
  • com.jepcc.example.pojo.Student
package com.jepcc.example.pojo;

public class Student {
    private String id;
    private String name;
    private int age;
    private String gender;

    public String getId() {
        return id;
    }

    public void setId(String id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    public String getGender() {
        return gender;
    }

    public void setGender(String gender) {
        this.gender = gender;
    }

    @Override
    public String toString() {
        final StringBuffer sb = new StringBuffer("Student{");
        sb.append("id='").append(id).append('\'');
        sb.append(", name='").append(name).append('\'');
        sb.append(", age=").append(age);
        sb.append(", gender='").append(gender).append('\'');
        sb.append('}');
        return sb.toString();
    }
}
  • com.jepcc.example.controller.StudentController
package com.jepcc.example.controller;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.jepcc.example.pojo.Student;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/test")
public class StudentController {
    @Autowired
    private ObjectMapper mapper;

    @GetMapping("/pojo2string")
    public String test() throws JsonProcessingException {
        Student stu = new Student();
        stu.setId("1");
        stu.setName("Nicholas");
        stu.setAge(18);
        stu.setGender("male");
        String str = mapper.writeValueAsString(stu);
        return str;
    }
}
  • 调用接口/test/pojo2string，进行测试
    在这里插入图片描述
将JSON字符串转换为POJO对象

在com.jepcc.example.controller.StudentController中添加接口/test/string2pojo对应内容，如下：

package com.jepcc.example.controller;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.jepcc.example.pojo.Student;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/test")
public class StudentController {
    @Autowired
    private ObjectMapper mapper;

    @GetMapping("/pojo2string")
    public String test() throws JsonProcessingException {
        Student stu = new Student();
        stu.setId("1");
        stu.setName("Nicholas");
        stu.setAge(18);
        stu.setGender("male");
        String str = mapper.writeValueAsString(stu);
        return str;
    }

    @GetMapping("/string2pojo")
    public Student convert() throws JsonProcessingException {
        String str = "{\"id\":\"10\",\"name\":\"Lucy\",\"age\":20,\"gender\":\"female\"}";
        Student stu = mapper.readValue(str,Student.class);
        return stu;
    }
}

对接口/test/string2pojo进行测试。
在这里插入图片描述

jackson的注解

jackson包含很多注解，用于个性化序列化和反序列化操作。比如，

  • @JsonProperty(alias)，作用在属性上，为属性指定别名。
  • @JsonIgnore，作用在属性上，用此注解来忽略属性。
  • @JsonIgnoreProperties({propertyName1,propertyName2})，作用在类上，表示忽略一组属性。
  • @JsonFormat(pattern="")，用于格式化日期。比如@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")，将时间格式化为“年-月-日 时:分:秒”。

再来看个具体的例子吧。

  • com.jepcc.example.pojo.Student
package com.jepcc.example.pojo;

import com.fasterxml.jackson.annotation.JsonFormat;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonProperty;

import java.util.Date;

public class Student {
    private String id;
    private String name;
    private int age;
    
    @JsonIgnore
    private String gender;

    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss")
    @JsonProperty("bd")
    private Date birthday;

    public String getId() {
        return id;
    }

    public void setId(String id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    public String getGender() {
        return gender;
    }

    public void setGender(String gender) {
        this.gender = gender;
    }

    public Date getBirthday() {
        return birthday;
    }

    public void setBirthday(Date birthday) {
        this.birthday = birthday;
    }

    @Override
    public String toString() {
        final StringBuffer sb = new StringBuffer("Student{");
        sb.append("id='").append(id).append('\'');
        sb.append(", name='").append(name).append('\'');
        sb.append(", age=").append(age);
        sb.append(", gender='").append(gender).append('\'');
        sb.append(", birthday=").append(birthday);
        sb.append('}');
        return sb.toString();
    }
}
  • com.jepcc.example.controller.StudentController
package com.jepcc.example.controller;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.jepcc.example.pojo.Student;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.Date;

@RestController
@RequestMapping("/test")
public class StudentController {
    @Autowired
    private ObjectMapper mapper;

    @GetMapping("/pojo2string")
    public String test() throws JsonProcessingException {
        Student stu = new Student();
        stu.setId("1");
        stu.setName("Nicholas");
        stu.setAge(18);
        stu.setGender("male");
        stu.setBirthday(new Date());
        String str = mapper.writeValueAsString(stu);
        return str;
    }

    @GetMapping("/string2pojo")
    public Student convert() throws JsonProcessingException {
        String str = "{\"id\":\"10\",\"name\":\"Lucy\",\"age\":20,\"gender\":\"female\",\"bd\":"+new Date().getTime()+"}";
        Student stu = mapper.readValue(str,Student.class);
        return stu;
    }

}
  • 对接口：/test/pojo2string和/test/string2pojo 分别进行测试。
GET http://localhost:8000/test/pojo2string
Content-Type: application/json
###


GET http://localhost:8000/test/string2pojo
Content-Type: application/json
###

在这里插入图片描述

自定义ObjectMapper

如果很多类中都定义了Date类的属性，则需要在每个类中添加JsonFormat(pattern="")来实现时间格式化，这样就会变得很麻烦，代码也会显得很臃肿。因此，可以自定义一个ObjectMapper，用于修饰Date类型的属性。

  • com.jepcc.example.pojo.Student
package com.jepcc.example.pojo;

import java.util.Date;

public class Student {
    private String id;
    private String name;
    private int age;
    private String gender;
    private Date birthday;

    public String getId() {
        return id;
    }

    public void setId(String id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    public String getGender() {
        return gender;
    }

    public void setGender(String gender) {
        this.gender = gender;
    }

    public Date getBirthday() {
        return birthday;
    }

    public void setBirthday(Date birthday) {
        this.birthday = birthday;
    }

    @Override
    public String toString() {
        final StringBuffer sb = new StringBuffer("Student{");
        sb.append("id='").append(id).append('\'');
        sb.append(", name='").append(name).append('\'');
        sb.append(", age=").append(age);
        sb.append(", gender='").append(gender).append('\'');
        sb.append(", birthday=").append(birthday);
        sb.append('}');
        return sb.toString();
    }
}
  • com.jepcc.example.config.ObjectMapperConfig
    注意两点：
    1）添加注解@Configuration，标识ObjectMapperConfig为一个配置类
    2）添加注解@Bean，将自定义的ObjectMapper注入SpringBoot的IOC容器。
package com.jepcc.example.config;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import java.text.SimpleDateFormat;

@Configuration
public class ObjectMapperConfig {
    @Bean
    public ObjectMapper getObjectMapper(){
        ObjectMapper objectMapper = new ObjectMapper();
        objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
        objectMapper.setDateFormat(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"));
        return objectMapper;
    }
}
  • com.jepcc.example.controller.StudentController
    注意一点：将自定义的ObjectMapper通过注解@Autowired引入并使用。
package com.jepcc.example.controller;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.jepcc.example.pojo.Student;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.Date;

@RestController
@RequestMapping("/test")
public class StudentController {
    @Autowired
    private ObjectMapper mapper;

    @GetMapping("/pojo2string")
    public String test() throws JsonProcessingException {
        Student stu = new Student();
        stu.setId("1");
        stu.setName("Nicholas");
        stu.setAge(18);
        stu.setGender("male");
        stu.setBirthday(new Date());
        String str = mapper.writeValueAsString(stu);
        return str;
    }

    @GetMapping("/string2pojo")
    public Student convert() throws JsonProcessingException {
        String str = "{\"id\":\"10\",\"name\":\"Lucy\",\"age\":20,\"gender\":\"female\",\"birthday\":"+new Date().getTime()+"}";
        Student stu = mapper.readValue(str,Student.class);
        return stu;
    }
}
  • 调用接口进行测试验证
GET http://localhost:8000/test/pojo2string
Content-Type: application/json
###


GET http://localhost:8000/test/string2pojo
Content-Type: application/json
###

在这里插入图片描述

使用lombok
  • com.jepcc.example.pojo.Student
package com.jepcc.example.pojo;

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

import java.util.Date;
@Data
@NoArgsConstructor
@AllArgsConstructor
@Builder
public class Student {
    private String id;
    private String name;
    private int age;
    private String gender;
    private Date birthday;
}
  • com.jepcc.example.controller.StudentController
package com.jepcc.example.controller;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.jepcc.example.pojo.Student;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.Date;

@RestController
@RequestMapping("/test")
public class StudentController {
    @Autowired
    private ObjectMapper mapper;

    @GetMapping("/pojo2string")
    public String test() throws JsonProcessingException {
        Student stu = Student.builder()
                .id("1")
                .name("Nicholas")
                .age(18)
                .gender("male")
                .birthday(new Date())
                .build();
        String str = mapper.writeValueAsString(stu);
        return str;
    }

    @GetMapping("/string2pojo")
    public Student convert() throws JsonProcessingException {
        String str = "{\"id\":\"10\",\"name\":\"Lucy\",\"age\":20,\"gender\":\"female\",\"birthday\":"+new Date().getTime()+"}";
        Student stu = mapper.readValue(str,Student.class);
        return stu;
    }
}
  • com.jepcc.example.config.ObjectMapperConfig
package com.jepcc.example.config;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import java.text.SimpleDateFormat;

@Configuration
public class ObjectMapperConfig {
    @Bean
    public ObjectMapper getObjectMapper(){
        ObjectMapper objectMapper = new ObjectMapper();
        objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
        objectMapper.setDateFormat(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"));
        return objectMapper;
    }
}
  • 调用接口进行测试和验证
GET http://localhost:8000/test/pojo2string
Content-Type: application/json
###


GET http://localhost:8000/test/string2pojo
Content-Type: application/json
###

在这里插入图片描述

lombok注解之@Data

注解@Data作用在类上，会为类的所有属性自动生成setter/getter、equals、hasCode、toString方法。更多可以访问这里和这里。

lombok注解之@Builder

@Builder在创建对象时具有链式赋值的特点。更多可以访问这里。

参考文章

SpringBoot基础篇(一)默认转换工具Jackson
Lombok官网
reducing boilerplate code with project lombok
Lombok注解系列文章总览
Lombok介绍、使用方法和总结
06. 《Lombok 实战 —— @Builder》

richest_qi
关注
  • 0
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
SpringBoot系列-- SpringBoot中使用lombok简化开发
Gang-bb的博客
01-29 1973
目录1. 项目环境2.添加依赖和安装插件3. 实体类常用注解总结3.1 @Setter、@Getter3.1.1 注解在属性上3.1.2 注解在类上3.1.3 注解对静态属性和final类型属性3.2 @NoArgsConstructor3.3 @AllArgsConstructor3.4 @RequiredArgsConstructor3.5 @ToString3.6 @EqualsAndHashCode3.7 @Data(常用)3.8 @Builder3.9 @Value3.10 @NonNull4.
【SpringBoot-3】Lombok使用详解
云深不知处
03-31 5372
Lombok使用详解Lombok简介Lombok安装Lombak使用@Data@Setter&@Getter@Builder@NonNull@Log4j@AllArgsConstructor@NoArgsConstructor@EqualsAndHashCode@RequiredArgsConstructor@Cleanup@ToString@Value@SneakyThrows@Sync...
SpringBoot使用Jackson
weixin_71454352的博客
07-05 1282
SpringBoot使用Jackson
五、spring boot教程--集成lombok
pin621的博客
02-16 257
spring boot教程--集成lombok一、lombok简介二、IntelliJ IDEA安装lombok插件三、lombok使用方法1.然后引入lombok的jar包2.常用注解3.在实体类中使用lombok注解 一、lombok简介 Lombok是一个可以通过简单的注解形式来帮助我们简化消除一些必须有但显得很臃肿的Java代码的工具，通过使用对应的注解，可以在编译源码的时候生成对应的方法...
SpringBoot框架学习笔记（三）：Lombok 和 Spring Initailizr
最新发布
2301_76144723的博客
07-18 911
（1）Lombok 作用简化JavaBean开发，可以使用Lombok的注解让代码更加简洁Java项目中，很多没有技术含量又必须存在的代码：POJO的getter/setter/toString；异常处理；I/O流的关闭操作等等，这些代码既没有技术含量，又影响着代码的美观，Lombok应运而生（2）SpringBoot 和 IDEA 官方支持IDEA 2020已经内置了Lombok插件SpringBoot 2.1.x之后的版本也在Starter中内置了Lombok依赖。
SpringBoot基础篇(一)默认转换工具Jackson
热门推荐
u013089490的博客
10-31 2万+
Spring Boot 内置了jackson来完成JSON的序列化和反序列化操作。Jackson使用ObjectMapper类将POJO对象序列化成JSON字符串，也能将JSON字符串反序列化成POJO对象。 JackSon支持三种层次的序列化和反序列化方式： 采用JsonParser来解析JSON，解析结果是一串Tokens，采用JsonGenerator来生成JSON，这是最底层的方式。 ...
SpringBoot使用LomBok的示例代码
08-27
SpringBoot 使用 LomBok 的示例代码 在本文中，我们将详细介绍如何使用 LomBok 在 SpringBoot 项目中，以简化代码编写过程。LomBok 是一个 Java 库，可以帮助开发者消除重复的代码，例如 setter、getter、构造函数...
详解SpringBoot优雅编码之Lombok加持
08-27
详解SpringBoot优雅编码之Lombok加持 Lombok是一款功能强大且广泛使用的Java库，旨在简化Java开发过程，提高代码质量和开发效率。下面我们将详细介绍Lombok的使用方法和优雅编码技巧。 Lombok的优点： 1. 简化...
SpringBoot配置lombok与logback过程解析
08-19
SpringBoot配置lombok与logback过程解析 Lombok是一款Java库，主要用来消除Java中的getter和setter方法的编写。它可以在编译时自动生成getter和setter方法，从而简化Java开发者的工作。 在SpringBoot项目中，...
Springboot 集成 lombok.jar过程解析
08-25
Springboot 集成 lombok.jar 过程解析 Spring Boot 是一个高效的开发框架，而 Lombok 则是一套代码模板解决方案，它可以极大地提升开发的效率。Lombok 的主要目的是解决在实体 Bean 中大量的 Getter/Setter 方法，...
springboot3.2.4+lombok+log4j2+swagger集成demo
04-12
初学者的福音，最近一直在折腾springboot版本的问题，发现在集成三方库时v2和v3版本完全不兼容。平滑升级相当困难，在用springboot3做新项目时也遇到了很多官方文档不详细的原因，所以特整理了一个干净版本的开发...
springboot
qq_37709028的博客
10-22 1062
一、springboot 1.介绍： springboot是一个工具集,将许多的常用的框架封装在了一起，比如spring 、springmvc 、data-jpa，springboot将这些常用的框架整合到了一起，并提供了许多的自动配置类，实现敏捷开发。 2.特点： SpringBoot项目不需要模板化的配置。 SpringBoot中整合第三方框架时，只需要导入相应的starter依赖包，就自动整合了。 SpringBoot默认只有一个.properties的配置文件，不推荐使用xml，后期会采用.
@JsonFormat与@DateTimeFormat注解的使用
Evan's Blog ٩(๑❛ᴗ❛๑)۶
01-12 1739
最近做开源项目，持久层使用了Spring Data JPA。前面一篇文章介绍过@CreatedDate和@LastModifiedDate的使用，有兴趣的可以先去看下那篇文章。通过前面的注解实现了自动插入时间，这里获取显示时间却又出了问题。所以特此来介绍下这两个注解。 一、@JsonFormat 注：这个注解来自jackson。使用前需要导入Jackson依赖，但是如果你使用的是spring...
【LocalDateTime与Spring Mvc、Lombok、Jackson的坑】
zhengyong14350的博客
05-12 555
LocalDateTime与Spring Mvc、Lombok、Jackson的坑LocalDateTime在Spring boot 项目中格式化的问题Lombok的@Data + @Builder注解同时使用时的坑Jackson 默认不支持 LocalDateTimeLocalDateTime 格式化必须要有时分秒！ LocalDateTime在Spring boot 项目中格式化的问题 Lombok的@Data + @Builder注解同时使用时的坑 如下接收参数实体类 @Data @EqualsA
Fastxml 简单常用注解学习笔记
hashcon
05-14 7258
Fastxml 简单常用注解学习笔记@JsonNaming@JsonIgnoreProperties@JsonIgnore@JsonFormat@JsonDeserialize@JsonSerialize@JsonProperty如下User类package com.usoft; import com.fasterxml.jackson.annotation.JsonFormat; import
springmvc/springboot 序列化枚举类/枚举转json、转json忽略字段、fastjon/jackson指定字段名称/自定义字段名称
wangjun5159的专栏
12-18 4797
springmvc中 比如一个枚举类 public enum MyEnum{ INSTANCE1("code1"，“name1”), INSTANCE2("code1"，“name1”), ; private String code; private String name; } springmvc默认使用jackson，序列化的结果是 [{0:"INSTANCE1"},{1:"INSTANCE2"}] 期望序列化后结果 [{"code":"code1","name":"
springboot集成jackson详解
qq_28754027的博客
04-04 4741
Spring Boot 默认使用 Jackson 作为 JSON 解析器Jackson 是一个流行的 Java 序列化和反序列化库，它能够将 Java 对象转换为 JSON 数据，也可以将 JSON 数据转换为 Java 对象。
Java开发工具lombok的使用详解
qq_36906588的博客
12-08 705
lombok的安装及使用
Jackson学习笔记
SIMBA1949的博客
09-17 584
Jackson学习笔记 前言 jackson-databind 依赖 jackson-core 和 jackson-annotations ，所以只需要依赖 jackson-databind 即可 版本说明 jackson-databind=2.11.2 相关链接： jackson-databind maven 地址：https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jackson-databind jackson githu
springboot使用lombok
07-27
在Spring Boot中使用Lombok非常简单。Lombok是一个Java库，可以通过注解来自动生成Java类的getter、setter、构造函数等常见的代码。 首先，在你的项目的pom.xml文件中添加Lombok的依赖： ```xml <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>1.18.20</version> <scope>provided</scope> </dependency> ``` 然后，在你的Java类中使用Lombok的注解来简化代码。例如，如果你想要自动生成getter和setter方法，只需在类上添加`@Getter`和`@Setter`注解： ```java import lombok.Getter; import lombok.Setter; @Getter @Setter public class MyClass { private String name; private int age; } ``` 这样，Lombok会在编译时自动生成`getName()`、`setName()`、`getAge()`和`setAge()`方法。 除了`@Getter`和`@Setter`，Lombok还提供了其他一些有用的注解，如`@NoArgsConstructor`生成无参构造函数，`@AllArgsConstructor`生成全参构造函数，以及`@Data`生成所有常见方法（getter、setter、toString、equals等）。你可以根据需要选择使用这些注解。 需要注意的是，你的IDE可能需要安装Lombok插件才能正确识别和处理Lombok注解。确保你的IDE已经安装了Lombok插件，以避免出现编译错误。 希望这些信息对你有所帮助！如果你有任何其他问题，请随时提问。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值