Springboot拦截器如何获取@RequestBody参数

下面是关于Spring Boot拦截器如何获取@RequestBody参数的攻略。

什么是拦截器

拦截器是Spring框架中的一个组件，它是在请求到达Controller之前或离开Controller之后执行的代码块。拦截器主要用于对请求进行预处理和后处理，在预处理中可以实现一些安全性检查和参数校验等操作，而后处理中可以对响应结果进行处理。

如何获取@RequestBody参数

在Spring Boot框架中，要在拦截器中获取@RequestBody参数，需要进行如下步骤：

1. 实现HandlerInterceptor接口。

public class MyInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        return true;
    }
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
    }
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
    }
}

1. 重写preHandle方法，在该方法中获取HttpServletRequest对象，并通过该对象获取@RequestBody参数。

@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
    String jsonStr = IOUtils.toString(request.getReader());
    return true;
}

1. 需要注意，在获取@RequestBody参数之前，需要先判断请求的Content-Type是否为application/json。

@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
    if (request.getContentType() != null && request.getContentType().contains("application/json")) {
        String jsonStr = IOUtils.toString(request.getReader());
    }
    return true;
}

示例一

例如，下面是一个Controller类：

@RestController
@RequestMapping("/api")
public class MyController {
    @PostMapping("/")
    public String demo(@RequestBody Map<String, Object> data) {
        return "hello";
    }
}

拦截器类：

public class MyInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        if (request.getContentType() != null && request.getContentType().contains("application/json")) {
            String jsonStr = IOUtils.toString(request.getReader());
            System.out.println("请求参数为：" + jsonStr);
        }
        return true;
    }
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
    }
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
    }
}

注册拦截器：

@Configuration
public class MyConfig implements WebMvcConfigurer {
    @Autowired
    private MyInterceptor myInterceptor;
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(myInterceptor).addPathPatterns("/api/*");
    }
}

请求参数为：

{
    "username": "Tom",
    "password": "123456"
}

控制台输出：

请求参数为：{"username":"Tom","password":"123456"}

示例二

如果是基于Spring Boot自带的WebMvcConfigurationSupport拦截器，可以直接获取到处理@RequestBody注解的附加信息，也就是要转换的数据类型。

public class MyInterceptor extends HandlerInterceptorAdapter {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        HandlerMethod handlerMethod = (HandlerMethod)handler;
        MethodParameter[] methodParameters = handlerMethod.getMethodParameters();
        for (MethodParameter methodParameter : methodParameters) {
            if (methodParameter.getParameterAnnotation(RequestBody.class) != null) {
                JavaType javaType = TypeFactory.defaultInstance().constructType(methodParameter.getGenericParameterType());
                System.out.println("请求参数类型为：" + javaType.getRawClass().getName());
            }
        }
        return true;
    }
}

那么在示例一中，如果接口方法的入参类型变为：

public String demo(@RequestBody User user) {
    return "hello";
}

那么在拦截器中就可以直接获取到User类对象，并可以获取到它的属性值。