SpringBoot中的默认JSON转换器及其Gson自定义

默认转换器

JSON是目前主流的前后端数据传输方式。创建一个Spring Boot项目后，添加web依赖后，依赖中默认加入了jackson-databind作为JSON处理器，此时不需要添加额外的JSON处理器就能返回一段JSON。

• 下面是一个示例。

Book实体类

@Data
public class Book {
    private String name;
    private String author;
    @JsonIgnore
    private Float price;
    @JsonFormat(pattern="yyyy-MM-dd")
    private Date publicationDate;
}

创建BookController，返回Book对象

@Controller
public class BookController {
    @GetMapping("/book")
    @ResponseBody
    public Book book(){
        Book book = new Book();
        book.setAuthor("罗贯中");
        book.setName("三国演义");
        book.setPrice(30f);
        book.setPublicationDate(new Date());
        return book;
    }
}

• BookController的另一种写法

@RestController
public class BookController {
    @GetMapping("/book")
    public Book book(){
        Book book = new Book();
        book.setAuthor("罗贯中");
        book.setName("三国演义");
        book.setPrice(30f);
        book.setPublicationDate(new Date());
        return book;
    }
}

• 两者区别在于采用@RestController组合注解代替@Controller和@ResponseBody

自定义转换器Gson

• Gson 是 Google 提供的用来在 Java 对象和 JSON 数据之间进行映射的 Java 类库。可以将一个 JSON字符串转成一个 Java 对象，或者反过来。
• 使用Gson需要先去除默认的jackson-databind，然后再加入Gson依赖。具体如下：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <exclusions>
        <exclusion>
            <groupId>com.fasterxml.jackson.core</groupId>
            <artifactId>jackson-databind</artifactId>
        </exclusion>
    </exclusions>
</dependency>
<dependency>
    <groupId>com.google.code.gson</groupId>
    <artifactId>gson</artifactId>
</dependency>

Book实体类

@Data
@AllArgsConstructor
@NoArgsConstructor
public class Book {
    private String name;
    private String author;
    protected Float price;
    private Date publicationDate;
}

创建BookController，返回Book对象

@RestController
public class BookController {
    @GetMapping("/book")
    public Book book(){
        Book book = new Book();
        book.setAuthor("罗贯中");
        book.setName("三国演义");
        book.setPrice(30f);
        book.setPublicationDate(new Date());
        return book;
    }
}

创建Gson的配置类，注入Bean

@Configuration
public class GsonConfig {
    @Bean
    //自己提供一个GsonHttpMessageConverter的实例
    GsonHttpMessageConverter gsonHttpMessageConverter(){
        GsonHttpMessageConverter converter = new GsonHttpMessageConverter();
        GsonBuilder builder = new GsonBuilder();
        //设置Gson解析时日期的格式
        builder.setDateFormat("yyyy-MM-dd");
        //设置Gson解析时修饰符为protected的字段被过滤掉
        builder.excludeFieldsWithModifiers(Modifier.PROTECTED);
        //创建Gson对象放入GsonHttpMessageConverter的实例中并返回converter
        Gson gson = builder.create();
        converter.setGson(gson);
        return converter;
    }
}

上述使用默认JSON解析器jackson-databind和使用Gson达到的效果一样，即返回的json数据是一样的。