springboot拦截response返回的JSON值 springboot拦截器修改返回值

转载

mob6454cc770d06 2024-03-04 14:20:47

前言

近期需要“搭建”基于SpringBoot框架的前后端分离项目，其中需要配置拦截器，多方查资料最终总结以下内容

拦截器配置

以下为拦截器的基本配置；

拦截的请求首先校验token信息，其中token信息放于redis中；
拦截器支持了跨域请求（处理OPTIONS请求）
拦截器中的回执信息最好根据自己的需求自定义

/**
 * @program: share
 * @description: 登录拦截器
 * @author: Mr.Jkx
 * @create: 2020-03-11 17:22
 */
@Component
public class LoginInterceptor implements HandlerInterceptor {
    @Resource
    private RedisService redisService;

    /**
     * 预处理回调方法，实现处理器的预处理
     * 返回值：true表示继续流程；false表示流程中断，不会继续调用其他的拦截器或处理器
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
            throws Exception {
        // 处理OPTIONS请求(预检请求)，具体看参阅“参考链接>>>http的协议的跨域cors 和 options请求的一些理解”
        response.setHeader("Access-Control-Allow-Origin", "*");
        response.setHeader("Access-Control-Allow-Credentials", "true");
        response.setHeader("Access-Control-Allow-Methods", "GET, HEAD, POST, PUT, PATCH, DELETE, OPTIONS");
        response.setHeader("Access-Control-Max-Age", "86400");
        response.setHeader("Access-Control-Allow-Headers", "*");
        response.setHeader("Content-Type", "text/html;charset=utf-8");
        if (request.getMethod().equals("OPTIONS")) {
            response.setStatus(HttpServletResponse.SC_OK);
            return false;
        }
        // token 信息校验
        String token = request.getHeader("token");
        if (StringUtils.isNotBlank(token)) {
            // redis校验token信息
            if (null != redisService.get(token)) {
                return true;
            } else {
                returnJson(response, "用户不存在");
            }
        } else {
            returnJson(response, "没有验证信息或已失效");
        }
        return false;
    }

    /**
     * 后处理回调方法，实现处理器（controller）的后处理，但在渲染视图之前
     * 此时我们可以通过modelAndView对模型数据进行处理或对视图进行处理
     */
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {

    }

    /**
     * 整个请求处理完毕回调方法，即在视图渲染完毕时回调，
     * 如性能监控中我们可以在此记录结束时间并输出消耗时间，
     * 还可以进行一些资源清理，类似于try-catch-finally中的finally，
     * 但仅调用处理器执行链中
     */
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {

    }

    /**
     * @Description: 拦截回执数据
     * @Author: Mr.Jkx
     * @date: 2020/3/12 13:46
     */
    private void returnJson(HttpServletResponse response, String msgData) {
        PrintWriter writer = null;
        response.setCharacterEncoding("UTF-8");
        response.setContentType("application/json; charset=utf-8");
        try {
            writer = response.getWriter();
            Msg msg = Msg.fail().add("info", msgData);
            String res = JsonUtil.toJsonString(msg);
            writer.print(res);
        } catch (IOException e) {
            e.printStackTrace();
        } finally {
            if (writer != null) {
                writer.close();
            }
        }
    }
}

addPathPatterns:拦截所有请求
excludePathPatterns：设置不拦截的请求
addResourceHandler：静态资源类型
addResourceLocations：静态资源所在目录（http://localhost:8080/xxx.html，即可访问）

@Configuration
public class InterceptorConfig extends WebMvcConfigurationSupport {
    @Autowired
    private LoginInterceptor loginInterceptor;
    @Autowired
    private ResourcesConfig resourcesConfig;

    @Override
    protected void addInterceptors(InterceptorRegistry registry) {
        // 多个拦截器组成一个拦截器链
        // addPathPatterns 用于添加拦截规则，/**表示拦截所有请求
        // excludePathPatterns 用户排除拦截
        registry.addInterceptor(loginInterceptor).addPathPatterns("/**")
                .excludePathPatterns(
                        "/**.html",
                        "/**/*.js",
                        "/**/*.jpg",
                        "/**/*.png",
                        "/**/*.gif",
                        "/**/*.css",
                        "/**/*.ts",
                        "/user/userLogin",
                        "/personage/addPersonage",
                        "/file/uploadFile",
                        "/file/uploadFileOfBatch",
                        "/file/download",
                        "/file/uploadRichTextFile");
        super.addInterceptors(registry);
    }

    /**
     * @Description: 静态资源访问设置
     * @Author: Mr.Jkx
     * @date: 2020/3/18 16:45
     * file：静态资源所在目录
     */
    @Override
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler(
                "/**.html",
                "/**/*.js",
                "/**/*.jpg",
                "/**/*.png",
                "/**/*.gif",
                "/**/*.css",
                "/**/*.ts")
                .addResourceLocations("file:" + resourcesConfig.getWebpagepath(),
                        "file:" + resourcesConfig.getReadimagepath());
    }
}