ResponseBodyAdvice 返回数据处理

光辉灿烂@

已于 2022-09-19 16:44:41 修改

阅读量585

点赞数

CC 4.0 BY-SA版权

分类专栏： Java 文章标签： spring java mvc

于 2022-09-19 15:59:18 首次发布

本文链接：https://blog.youkuaiyun.com/u012406790/article/details/126782139

Java 专栏收录该内容

27 篇文章

订阅专栏

本文介绍了如何在Spring MVC中实现ResponseBodyAdvice，用于自定义响应数据的编码处理。通过创建EncodeResponseBodyAdvice类并实现接口，然后添加ResponseAnnotation注解以指定需要拦截的接口，或者根据URL进行拦截。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

一、自定义EncodeResponseBodyAdvice实现ResponseBodyAdvice

package com.onway.interceptor;

import com.alibaba.fastjson.JSONObject;
import com.onway.leaguer.center.server.common.annotation.ResponseAnnotation;
import com.onway.leaguer.center.server.common.utils.AESUtil;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.core.MethodParameter;
import org.springframework.core.annotation.AnnotationUtils;
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;

import java.lang.reflect.AnnotatedElement;

/**
 * 描述：
 *
 */

@ControllerAdvice(basePackages = "com.onway.leaguer.center.server.controller")
@Slf4j
public class EncodeResponseBodyAdvice implements ResponseBodyAdvice {
    
    @Override
    public boolean supports(MethodParameter methodParameter, Class aClass) {
        //默认false
        boolean isIntercept = false;

        //第一种：通过注解拦截，拦截@ResponseAnnotation接口
        AnnotatedElement annotatedElement = methodParameter.getAnnotatedElement();
        ResponseAnnotation responseAnnotation = AnnotationUtils.findAnnotation(annotatedElement, ResponseAnnotation.class);
        if (responseAnnotation != null) {
            isIntercept = true;
        }

        //第二种：通过方法名称拦截，拦截指定方法
        Method method = methodParameter.getMethod();
        if ("saveOrder".equals(method.getName())) {
            isIntercept = true;
        }

        return isIntercept;
    }

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

        //对返回数据加密
        return AESUtil.dataEncrypt(JSONObject.toJSONString(body));
    }

}

二、添加ResponseAnnotation

import java.lang.annotation.*;

/**
 * 描述：
 *
 */
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ResponseAnnotation {

}

三、需要拦截的接口，添加@ResponseAnnotation注解


import com.onway.dayu.api.Ret;
import com.onway.dayu.api.RetUtil;
import com.onway.leaguer.center.server.common.annotation.ResponseAnnotation;
import com.onway.leaguer.center.server.controller.vo.TakeOutCallbackReqVO;
import com.onway.leaguer.center.server.service.CallbackService;
import com.onway.leaguer.center.server.thirdparty.tcsl.connection.TcslException;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

import javax.annotation.Resource;
import javax.validation.Valid;

/**
 * 描述：订单接口模块
 *
 */
@Slf4j
@Api(value = "OrderController", tags = {"订单接口模块"})
@RestController
@RequestMapping("/api/")
public class OrderController {

    @Resource
    private OrderService orderService;

    @ResponseAnnotation
    @ApiOperation(value = "修改订单状态")
    @PostMapping("/order/status/update")
    public Ret updateOrderStatus(@Valid @RequestBody OrderReqVO reqVO) {
        orderService.updateOrderStatus(reqVO);
        return RetUtil.success();
    }

}

第三种、通过url拦截


import com.alibaba.fastjson.JSONObject;
import com.onway.leaguer.center.server.common.annotation.ResponseAnnotation;
import com.onway.leaguer.center.server.common.utils.AESUtil;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.core.MethodParameter;
import org.springframework.core.annotation.AnnotationUtils;
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;

import java.lang.reflect.AnnotatedElement;

/**
 * 描述：
 *
 */

@ControllerAdvice(basePackages = "com.onway.leaguer.center.server.controller")
@Slf4j
public class EncodeResponseBodyAdvice implements ResponseBodyAdvice {
    
    @Override
    public boolean supports(MethodParameter methodParameter, Class aClass) {
        return true;
    }

    @Override
    public Object beforeBodyWrite(Object body, MethodParameter methodParameter, MediaType mediaType, Class aClass, ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse) {
        //需要拦截的url信息，建议放到配置里面
        String urlStr = "/api/center/balance/card/available/list";
        //获取请求的url路径
        String path = serverHttpRequest.getURI().getPath();
        //对拦截数据处理
        if (path.equals(urlStr)) {
            return AESUtil.dataEncrypt(JSONObject.toJSONString(body));
        }

        return body;
    }

}