SpringBoot整合Json

一、SpringBoot中返回Json数据

1、RestController注解

在前后端分离模式中，我们都是通过json格式来传输数据的，在Springboot中，使用RestController就可以转为json格式。

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Controller
@ResponseBody
public @interface RestController {
    @AliasFor(
        annotation = Controller.class
    )
    String value() default "";
}

可以看到@RestController是包含了@ResponseBody和@Controller注解，@ResponseBody注解解析为json。Spring Boot 中默认使用的 Json 解析技术框架是 jackson。我们点开 pom.xml 中的 spring-boot-starter-web 依赖，可以看到一个 spring-boot-starter-json 依赖：

    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-json</artifactId>
      <version>2.5.1</version>
      <scope>compile</scope>
    </dependency>

spring-boot-starter-json又有如下依赖

 <dependency>
      <groupId>com.fasterxml.jackson.core</groupId>
      <artifactId>jackson-databind</artifactId>
      <version>2.12.3</version>
      <scope>compile</scope>
    </dependency>
    <dependency>
      <groupId>com.fasterxml.jackson.datatype</groupId>
      <artifactId>jackson-datatype-jdk8</artifactId>
      <version>2.12.3</version>
      <scope>compile</scope>
    </dependency>
    <dependency>
      <groupId>com.fasterxml.jackson.datatype</groupId>
      <artifactId>jackson-datatype-jsr310</artifactId>
      <version>2.12.3</version>
      <scope>compile</scope>
    </dependency>

2、json对null值的处理

在项目中，我们难免会遇到null值，我们希望null转为""这种空字符串。
编写配置类

@Configuration
public class JacksonConfig {

    @Bean
    @Primary //多个实现类时，优先考虑
    @ConditionalOnMissingBean(ObjectMapper.class)//判断当前需要注入Spring容器中的bean的实现类是否已经含有，有的话不注入，没有就注入
    public ObjectMapper jacksonObjectMapper(Jackson2ObjectMapperBuilder builder) {
        ObjectMapper objectMapper = builder.createXmlMapper(false).build();
        objectMapper.getSerializerProvider().setNullValueSerializer(new JsonSerializer<Object>() {
            @Override
            public void serialize(Object o, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {
                jsonGenerator.writeString("");
            }
        });
        return objectMapper;
    }
}

编写测试类

    @RequestMapping("/testNull")
    public Map<String,String> testNull() {
        HashMap<String, String> map = new HashMap<>();
        map.put("name",null);
        map.put("sex","man");
        return map;
    }

结果如下

{
  "sex": "man",
  "name": ""
}

3、fastjson对null值的处理

import com.alibaba.fastjson.serializer.SerializerFeature;
import com.alibaba.fastjson.support.config.FastJsonConfig;
import com.alibaba.fastjson.support.spring.FastJsonHttpMessageConverter;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.MediaType;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;

import java.nio.charset.Charset;
import java.util.ArrayList;
import java.util.List;

@Configuration
public class fastJsonConfig extends WebMvcConfigurationSupport {

    /**
     * 使用阿里 FastJson 作为JSON MessageConverter
     * @param converters
     */
    @Override
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        FastJsonHttpMessageConverter converter = new FastJsonHttpMessageConverter();
        FastJsonConfig config = new FastJsonConfig();
        config.setSerializerFeatures(
                // 保留map空的字段
                SerializerFeature.WriteMapNullValue,
                // 将String类型的null转成""
                SerializerFeature.WriteNullStringAsEmpty,
                // 将Number类型的null转成0
                SerializerFeature.WriteNullNumberAsZero,
                // 将List类型的null转成[]
                SerializerFeature.WriteNullListAsEmpty,
                // 将Boolean类型的null转成false
                SerializerFeature.WriteNullBooleanAsFalse,
                // 避免循环引用
                SerializerFeature.DisableCircularReferenceDetect);

        converter.setFastJsonConfig(config);
        converter.setDefaultCharset(Charset.forName("UTF-8"));
        List<MediaType> mediaTypeList = new ArrayList<>();
        // 解决中文乱码问题，相当于在Controller上的@RequestMapping中加了个属性produces = "application/json"
        mediaTypeList.add(MediaType.APPLICATION_JSON);
        converter.setSupportedMediaTypes(mediaTypeList);
        converters.add(converter);
    }
}

4、定义统一的返回值类型

在前后端分离过程中，我们需要返回固定的格式内容，返回的状态码，提示信息，返回的数据等。
封装一个响应类

public class JsonResult {

    private Object data;
    private String msg;
    private String code;

    public Object getData() {
        return data;
    }

    public void setData(Object data) {
        this.data = data;
    }

    public String getMsg() {
        return msg;
    }

    public void setMsg(String msg) {
        this.msg = msg;
    }

    public String getCode() {
        return code;
    }

    public void setCode(String code) {
        this.code = code;
    }


    public JsonResult(Object data, String msg, String code) {
        this.data = data;
        this.msg = msg;
        this.code = code;
    }

    public static JsonResult error(Object data, String msg) {
        return new JsonResult(data,msg,ResultEnum.ERROR.getCode());
    }
    public static JsonResult error(Object data) {
        return new JsonResult(data,ResultEnum.ERROR.getMsg(),"500");
    }
    public static JsonResult error(Object data,String msg,String code){
        return new JsonResult(data,msg,code);
    }

    public static JsonResult success(Object data, String msg) {
        return new JsonResult(data,msg,ResultEnum.SUCCESS.getCode());
    }
    public static JsonResult success(Object data) {
        return new JsonResult(data,ResultEnum.SUCCESS.getMsg(),"500");
    }
    public static JsonResult success(Object data,String msg,String code){
        return new JsonResult(data,msg,code);
    }

}

注意，必须要get方法，不然请求报错406。

    @GetMapping("/test1")
    public JsonResult testNull() {
        JsonResult jsonResult = new JsonResult("hi", "成功", "12");
        System.out.println(jsonResult);
        return jsonResult;
    }

这种返回的是一个对象，会被json转为字符串。也可以直接返回类型设为String类型，需要使用writeValueAsString方法。

    @GetMapping("/test2")
    public String testOutput() throws JsonProcessingException {
        JsonResult success = JsonResult.success("数据", "成功");
        ObjectMapper objectMapper = new ObjectMapper();
        String s = objectMapper.writeValueAsString(success);
        return s;
    }

结果为

{"data":"数据","msg":"成功","code":"200"}