解析springboot包裝controller返回值問題

更新時間：2021年12月22日 08:33:19 作者：hui008

這篇文章主要介紹了springboot包裝controller返回值問題，本文通過實例代碼給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值,需要的朋友可以參考下

1、springboot項目統(tǒng)一包裝返回值，通常返回結果包含code、message、data，結構如下

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
 
@Data
@NoArgsConstructor
@AllArgsConstructor
public class ResponseResult<T> {
    private int code;
    private String message;
    private T data;
 
    public ResponseResult(T data) {
        this.data = data;
        this.code = 0;
        this.message = "success";
    }
}

2、基于ControllerAdvice和HttpMessageConverter實現

定義類ResponseAdvisor實現ResponseBodyAdvice接口，重寫supports跟beforeBodyWrite方法

import org.springframework.core.MethodParameter;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;
 
@ControllerAdvice
public class ResponseAdvisor implements ResponseBodyAdvice<Object> {
    @Override
    public boolean supports(MethodParameter methodParameter, Class<? extends HttpMessageConverter<?>> aClass) {
        return true;
    }
 
    @Override
    public Object beforeBodyWrite(Object o, MethodParameter methodParameter, MediaType mediaType,
                                  Class<? extends HttpMessageConverter<?>> aClass, ServerHttpRequest serverHttpRequest,
                                  ServerHttpResponse serverHttpResponse) {
        if(o instanceof ResponseResult){
            return o;
        }
        return new ResponseResult<>(o);
    }

3、接口測試

3.1 測試返回Object類型：

@RestController
@RequestMapping("/test")
public class TestController {
 
    @GetMapping("/test")
    public Test test(){
        return new Test("test", 10);
    }
}

執(zhí)行結果如下：

3.2 測試返回String類型：

@RestController
@RequestMapping("/test")
public class TestController {
 
    @GetMapping("/test")
    public Test test(){
        return new Test("test", 10);
    }
 
    @GetMapping("/test1")
    public String test1(){
        return "test";
    }
}

執(zhí)行結果如下：

3.3 如果Controller類的返回值沒有String類型的，僅有上面這個類就夠了。如果有String類型的返回值，就有可能遇到類型不匹配的問題。HttpMessageConverter是根據Controller的原始返回值類型進行處理的，而我們在ResponseAdvisor中改變了返回值的類型。如果HttpMessageConverter處理的目標類型是Object還好說，如果是其它類型就會出現問題，其中最容易出現問題的就是String類型，因為在所有的HttpMessageConverter實例集合中，StringHttpMessageConverter要比其它的Converter排得靠前一些。我們需要嘗試將處理Object類型的HttpMessageConverter放得靠前一些，這可以在一個Configuration類中完成：

import org.springframework.context.annotation.Configuration;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;
import org.springframework.web.servlet.config.annotation.DelegatingWebMvcConfiguration;
 
import java.util.List;
 
@Configuration
public class ResponseResultConfig extends DelegatingWebMvcConfiguration {
    @Override
    protected void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        converters.add(0, new MappingJackson2HttpMessageConverter());
        super.configureMessageConverters(converters);
    }
}

3.4?重啟服務后再次測試返回String類型，返回結果如下：