怎么从拦截器中获取json数据

从拦截器中获取JSON数据的实用指南

在Java Web开发中，拦截器（Interceptor）是处理请求和响应的重要组件，常用于日志记录、权限验证、数据转换等场景，当需要从拦截器中获取请求数据（特别是JSON格式）时，开发者常常会遇到一些技术难题，本文将详细介绍几种在拦截器中获取JSON数据的方法及注意事项。

准备工作

在开始之前,我们需要明确几个前提条件：

1. 项目使用了支持JSON的框架（如Spring Boot、Jackson、Gson等）
2. 请求头中包含Content-Type: application/json
3. 请求体是有效的JSON数据

获取JSON数据的几种方法

通过HttpServletRequest获取请求体

在Spring MVC中，可以通过HttpServletRequest对象获取请求体内容：

public class MyInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 获取请求输入流
        ServletInputStream inputStream = request.getInputStream();
        // 使用BufferedReader读取请求体
        BufferedReader reader = new BufferedReader(new InputStreamReader(inputStream, StandardCharsets.UTF_8));
        StringBuilder stringBuilder = new StringBuilder();
        String line;
        while ((line = reader.readLine()) != null) {
            stringBuilder.append(line);
        }
        String jsonBody = stringBuilder.toString();
        // 解析JSON数据
        ObjectMapper objectMapper = new ObjectMapper();
        try {
            JsonNode jsonNode = objectMapper.readTree(jsonBody);
            // 处理JSON数据...
        } catch (JsonProcessingException e) {
            e.printStackTrace();
        }
        return true;
    }
}

使用Spring的ContentCachingRequestWrapper

对于需要多次读取请求体的场景,可以使用Spring提供的ContentCachingRequestWrapper：

@Configuration
public class WebConfig implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new MyInterceptor())
                .addPathPatterns("/**");
    }
    @Bean
    public FilterRegistrationBean<OncePerRequestFilter> contentCachingFilter() {
        FilterRegistrationBean<OncePerRequestFilter> registrationBean = new FilterRegistrationBean<>();
        registrationBean.setFilter(new OncePerRequestFilter() {
            @Override
            protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) 
                throws ServletException, IOException {
                ContentCachingRequestWrapper cachingRequest = new ContentCachingRequestWrapper(request);
                filterChain.doFilter(cachingRequest, response);
            }
        });
        registrationBean.addUrlPatterns("/*");
        return registrationBean;
    }
}
public class MyInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        if (request instanceof ContentCachingRequestWrapper) {
            ContentCachingRequestWrapper cachingRequest = (ContentCachingRequestWrapper) request;
            byte[] requestBody = cachingRequest.getContentAsByteArray();
            if (requestBody.length > 0) {
                String jsonBody = new String(requestBody, StandardCharsets.UTF_8);
                // 解析JSON数据...
                ObjectMapper objectMapper = new ObjectMapper();
                JsonNode jsonNode = objectMapper.readTree(jsonBody);
                // 处理JSON数据...
            }
        }
        return true;
    }
}

通过@RequestBody注解（不推荐在拦截器中直接使用）

虽然@RequestBody注解在Controller方法中很方便，但在拦截器中不能直接使用，因为注解是由框架在Controller方法调用时处理的，如果需要在拦截器中获取这些数据，可以考虑以下替代方案：

// 在Controller方法中获取数据后存入ModelAndView或Request域
@PostMapping("/api/data")
public ModelAndView handleRequest(@RequestBody MyData data, ModelAndView mav) {
    mav.addObject("requestData", data);
    mav.setViewName("viewName");
    return mav;
}
// 然后在拦截器中从ModelAndView或Request域获取
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
    if (modelAndView != null) {
        MyData data = (MyData) modelAndView.getModel().get("requestData");
        // 处理数据...
    }
}

注意事项

1. 请求体只能读取一次：默认情况下，Servlet请求体只能被读取一次，如果需要在多个地方访问，必须使用ContentCachingRequestWrapper。

2. 性能考虑：读取和解析JSON数据会带来一定的性能开销，特别是在高并发场景下，应谨慎处理。

3. 异常处理：确保正确处理JSON解析可能抛出的异常，避免因格式错误导致请求处理失败。

4. 编码问题：始终指定正确的字符编码（如UTF-8），避免中文等特殊字符出现乱码。

5. 安全性：不要在日志中直接记录敏感的JSON数据，应进行脱敏处理。

最佳实践建议

1. 职责分离：拦截器应尽量保持轻量级，复杂的JSON解析逻辑建议放在专门的Service或工具类中。

2. 缓存复用：如果多个拦截器都需要访问JSON数据，考虑在第一个拦截器中解析后存入请求属性，供后续拦截器使用。

3. 框架集成：充分利用Spring框架提供的工具类和机制，如ContentCachingRequestWrapper和ObjectMapper的配置。

4. 测试覆盖：为拦截器中的JSON处理逻辑编写充分的单元测试，确保各种边界情况都能正确处理。

从拦截器中获取JSON数据是Web开发中的常见需求,通过合理选择和使用HttpServletRequest、ContentCachingRequestWrapper等工具，可以有效地实现这一功能，在实际开发中，应根据具体场景选择最适合的方法，并注意性能、安全和异常处理等方面的问题，希望本文的介绍能够帮助开发者更好地理解和应用相关技术。