使用 @ControllerAdvice 和 實現ResponseBodyAdvice接口， 攔截Controller方法默認返回參數，統一處理返回值/響應體

1、Controller代碼
以下是Controller方法源碼：

@RestController @RequestMapping("/manage/user") public class TestController {private Logger logger = LoggerFactory.getLogger(TestController.class);/*** 通過會員id獲取會員信息及詳情** @param id 會員id* @return app msg*/@GetMapping("/edit/{id}")public AppMessage edit(@PathVariable Integer id) {if (null == id) {return AppMessage.error(-3, "會員ID不能為空");}// 查詢會員對象User user = userService.queryById(id);if (user == null) {return AppMessage.error(-3, "根據會員ID未查詢到對應會員");}return AppMessage.success(user);}}

2、攔截處理器
下面已經封裝好了一個攔截處理類以供參考：

package com.yclimb.test;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.ControllerAdvice; import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;/*** 攔截Controller方法默認返回參數，統一處理返回值/響應體*/ @ControllerAdvice public class TestResponseBodyAdvice implements ResponseBodyAdvice {@Overridepublic Object beforeBodyWrite(Object o, MethodParameter methodParameter, MediaType mediaType, Class aClass, ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse) {System.out.println("TestResponseBodyAdvice==>beforeBodyWrite:" + o.toString() + ","+ methodParameter);return o;}@Overridepublic boolean supports(MethodParameter methodParameter, Class aClass) {return true;} }

ResponseBodyAdvice

方法講解

• supports對你需要進行攔截的response進行判斷篩選，返回true則進行攔截反之放行，
• beforeBodyWrite對supports進行攔截的response進行處理，封裝你需要的類型參數，加密等等。

個人理解：

ResponseBodyAdvice 接口是在 Controller 執行 return 之后，在 response 返回給客戶端之前，執行的對 response 的一些處理，可以實現對 response 數據的一些統一封裝或者加密等操作。

該接口一共有兩個方法：

（1）supports —— 判斷是否要執行beforeBodyWrite方法，true為執行，false不執行 —— 通過supports方法，我們可以選擇哪些類或哪些方法要對response進行處理，其余的則不處理。

（2）beforeBodyWrite —— 對 response 處理的具體執行方法。

package com.abc.demo;import com.github.pagehelper.Page; import com.abc.pojo.bean.ResponseResult; import org.springframework.core.MethodParameter; import org.springframework.http.MediaType; 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.bind.annotation.ExceptionHandler; import org.springframework.web.bind.annotation.ResponseBody; import org.springframework.web.bind.annotation.RestController; import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse;@ControllerAdvice public class ControllerAdviceHandler implements ResponseBodyAdvice<Object> {@ResponseBody@ExceptionHandler(value = Throwable.class)public ResponseResult catchAllError(HttpServletRequest request, HttpServletResponse response, Throwable error) {return ResponseResult.exception(error);}@Overridepublic boolean supports(MethodParameter method, Class<? extends HttpMessageConverter<?>> clazz) {return method.getContainingClass().getPackage().getName().startsWith("com.abc") &&(method.getContainingClass().getAnnotation(RestController.class) != null ||(method.getMethod() != null && method.getMethod().getAnnotation(ResponseBody.class) != null));}@Overridepublic Object beforeBodyWrite(Object result, MethodParameter methodParameter, MediaType mediaType,Class<? extends HttpMessageConverter<?>> aClass,ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse) {return result instanceof ResponseResult ? result :result instanceof Page ? ResponseResult.page((Page<?>) result) :ResponseResult.successData(result);} }

實例

有一個Controller類，返回參數為OutputObject，我們通過ResponseBodyAdvice，對該類的所有方法返回的OutputObject中的部分數據進行統一加密處理。

// 對響應報文統一處理，對bean內容進行加密 @Component //聲明該類要處理的包路徑 @ControllerAdvice("com.cmos.edcreg.web.controller") public class ResponseAdvice implements ResponseBodyAdvice {private final Logger logger = LoggerFactory.getLogger(ResponseAdvice.class);// 對response處理的具體方法@Overridepublic Object beforeBodyWrite(Object arg0, MethodParameter arg1,MediaType arg2, Class arg3, ServerHttpRequest arg4,ServerHttpResponse arg5) {OutputObject out = new OutputObject();try {//arg0轉換為OutputObject類型ObjectMapper objectMapper=new ObjectMapper();out = objectMapper.readValue(org.json.JSONObject.valueToString(arg0), OutputObject.class);//獲取加密密鑰String oldEncryptKey = out.getBean().get("oldEncryptKey");//獲取加密字符串DesSpecial des = new DesSpecial();String encryptData = des.strEnc(JSON.toJSONString(out.getBean()), oldEncryptKey, null, null);//封裝數據（清除原來數據，放入加密數據）out.getBean().clear();out.getBean().put("data", encryptData);return out;} catch (Exception e) {logger.error("返回報文處理出錯", e);out.setReturnCode(ReturnInfoEnums.PROCESS_ERROR.getCode());out.setReturnMessage(ReturnInfoEnums.PROCESS_ERROR.getMessage());return out;}}/* 選擇哪些類，或哪些方法需要走beforeBodyWrite* 從arg0中可以獲取方法名和類名* arg0.getMethod().getDeclaringClass().getName()為獲取方法名*/@Overridepublic boolean supports(MethodParameter arg0, Class arg1) {return "com.cmos.edcreg.web.controller.GdH5AppointmentActiveVideoNewController".equals(arg0.getMethod().getDeclaringClass().getName());} }

在spring項目開發過程中的應用場景

對controller層返回值進行修改增強處理。比如返回值5，需要封裝成：{“code”:“0”,“data”:5,“msg”:“success”} 格式返回前端

1、controller層業務代碼

@RestController //此注解包含@ResponseBody注解 @RequestMapping("/mp") public class ResponseBodyAdviceController {@RequestMapping(value = "/hello", method = RequestMethod.GET)public int hello() {return 5;} }

2、實現ResponseBodyAdvice接口的切面類

/** *此注解針對controller層的類做增強功能，即對加了@RestController注解的類進行處理 */ @ControllerAdvice(annotations = RestController.class) public class RestResultWrapper implements ResponseBodyAdvice<Object> {@Overridepublic boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {return true;}@Overridepublic Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request,ServerHttpResponse response) {//定義一個統一的返回類RestResult responseResult = new RestResult( "0", body, "success");//如果handler處理類的返回類型是String（即控制層的返回值類型），為了保證一致性，這里需要將ResponseResult轉回去if(body instanceof String) {return JSON.toJSONString(responseResult);}//封裝后的數據返回到前端頁面return JSONObject.toJSON(responseResult); } }

3、返回公共類的創建

// 統一返回Rest風格的數據結構 public class RestResult<T> implements Serializable {private String code = "2000";// 成功時返回的數據，失敗時返回具體的異常信息private T data;// 請求失敗返回的提示信息，給前端進行頁面展示的信息private String message ; public RestResult() {}@Overridepublic String toString() {return "RestResult{" +"code='" + code + '\'' +", data=" + data +", message=" + message +'}';}public RestResult(String code, T data, String message) {this.code = code;this.data = data;this.message = message;} }

總結

以上是生活随笔為你收集整理的使用 @ControllerAdvice 和 实现ResponseBodyAdvice接口， 拦截Controller方法默认返回参数，统一处理返回值/响应体的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。