SpringBoot统一全局响应(5)

一、基础响应

 前后端分离一定会设计到数据传输。因此，每个项目必定都有一个基础的响应类。

定义两个基础的构造函数，再定义两个通过枚举的构造函数。

package com.hanzhenya.learnspringboot.util;

import java.util.List;

/**
 * @Description: 结果处理
 * @author: 韩振亚
 * @date: 2021年03月29日 13:43
 */
public class ResultInfo<T> {
    private Integer status;
    private String message;
    private T response;

    public ResultInfo() {
    }
    public ResultInfo(Integer status, String message, T response) {
        this.status = status;
        this.message = message;
        this.response = response;
    }

    public Integer getStatus() {
        return status;
    }

    public void setStatus(Integer status) {
        this.status = status;
    }

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }

    public T getResponse() {
        return response;
    }

    public void setResponse(T response) {
        this.response = response;
    }

    public ResultInfo success(Integer status, String message, T response) {
       return new ResultInfo(status, message,response);
    }
}

响应码枚举类，封装一些常用的响应码与响应信息。

package com.hanzhenya.learnspringboot.util;

import lombok.Getter;

/**
 * @Description: TODO
 * @author: 韩振亚
 * @date: 2021年03月31日 11:47
 */
@Getter
public enum  StatusCodeEnum {
    SUCCESS(200, "SUCCESS"), ERROR(500, "Business Exception"), INVALID(-1, "Illegal Argument");

    private int code;

    private String message;

    StatusCodeEnum(int code, String message) {
        this.code = code;
        this.message = message;
    }

}

二、统一响应模板

如果某个方法返回的是一个字符串，那么这不符合前端接收的规则。后端应该对这些单个返回的数据进行处理。

比如数据从 "我是数据" 这种格式 ，修改为 { code : 200 ， message : SUCCESS ，response: 我是数据 }。

用到了AOP的思想。在返回给前端之前，用切面对返回值做一次数据处理。

SpringBoot对切面的支持真的非常的友好。我们这个需求只需要实现一个叫做ResponseBodyAdvice的接口。

Advice结尾就知道是一个AOP的通知。@ResponseBody注解的功能就是将返回数据映射成JSON格式。而我们就在他映射之前，修改掉返回数据。

package com.hanzhenya.learnspringboot.advice;

import com.hanzhenya.learnspringboot.util.ResultInfo;
import com.hanzhenya.learnspringboot.util.StatusCodeEnum;
import org.springframework.core.MethodParameter;
import org.springframework.http.MediaType;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;

/**
 * @Description: TODO
 * @author: 韩振亚
 * @date: 2021年03月31日 11:44
 */
@RestControllerAdvice
public class ResponseAdvice implements ResponseBodyAdvice {

    @Override
    public boolean supports(MethodParameter methodParameter, Class aClass) {
        return true;
    }

    @Override
    public Object beforeBodyWrite(Object o, MethodParameter methodParameter, MediaType mediaType, Class aClass, ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse) {
        if (isResponseType(o)) {
            return o;
        }

        return new ResultInfo<>(StatusCodeEnum.SUCCESS.getCode(), StatusCodeEnum.SUCCESS.getMessage(), o);
    }

    private boolean isResponseType(Object data) {
        return data instanceof ResultInfo;
    }

}

为系统添加一个配置，否则上述切面无法正常工作。

package com.hanzhenya.learnspringboot.config;

import com.alibaba.fastjson.support.spring.FastJsonHttpMessageConverter;
import org.springframework.boot.autoconfigure.http.HttpMessageConverters;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

/**
 * @Description: TODO
 * @author: 韩振亚
 * @date: 2021年03月31日 13:39
 */

@Configuration
public class CustomWebConfigure implements WebMvcConfigurer {
    @Bean
    public HttpMessageConverters customConverters() {
        return new HttpMessageConverters(new FastJsonHttpMessageConverter());
    }
}

pom.xml添加依赖

 <!-- fast json-->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.54</version>
        </dependency>

乱码的问题解决：在application.yml中加入下面的参数

spring:
  http:
    encoding:
      charset: UTF-8
      force: true
      enabled: true
  messages:
    encoding: UTF-8
  banner:
    charset: UTF-8