SpringBoot统一功能处理示例详解(拦截器)

 更新时间:2023年08月05日 16:09:59   作者:白杨783  
这篇文章主要介绍了SpringBoot统一功能处理(拦截器),本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下

1.用户登录权限校验

1.1自定义拦截器

写一个类去实现HandlerInterceptor接口表示当前类是一个拦截器,再重写HandlerInterceptor接口中的方法,preHandle为在方法执行前拦截,postHandle为方法执行中拦截,afterCompletion为方法执行中拦截.需要在什么时候拦截就重写什么方法

@Component
public class LoginIntercepetor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 判断用户登录
        HttpSession session = request.getSession(false);
        if(session!=null && session.getAttribute(ApplicationVariable.SESSION_USERINFO_KEY)!=null){
            // 用户已经登录
            return true;
        }
        // 当代码执行到此处说明用户未登录
        response.sendRedirect("/login.html");
        return false;
    }
}

1.2.配置拦截规则

@Configuration
public class MyConfig implements WebMvcConfigurer {
    @Autowired
    private LoginInterceptor loginInterceptor;
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(loginInterceptor)
                .addPathPatterns("/**") //拦截所有的URL
                .excludePathPatterns("/user/login") // 排除 url /user/login 不拦截
                .excludePathPatterns("/user/reg") // 排除 url /user/login 不拦截
        ;
    }
}

实现WebMvcConfigurer接口,重写WebMvcConfigurer中的addInterceptors方法,在使用 InterceptorRegistry参数 配置拦截规则

拦截器实现原理

统一异常处理

创建异常处理类

@ControllerAdvice
@ResponseBody
public class MyExceptionAdvice {
}

ControllerAdvice注解的作用:1.和Controller注解作用一样,让这个类随着Spring的启动而启动. 2.监测添加了Controller注解的类的异常 

创建异常检测的类和处理业务

@ExceptionHandler(NullPointerException.class)
public HashMap<String,Object> dpNullPointerException(NullPointerException e){
        HashMap<String,Object> result = new HashMap<>();
        result.put("code",-1);
        result.put("msg","空指针: "+e.getMessage());
        result.put("data",null);
        return result;
        }

使用@ExceptionHandler注解,括号里面写要捕获的异常,用HashMap的方式返回数据给前端,此处以捕获空指针异常为例,如果想要捕获所有的异常,可以使用所有异常的父类Exception

@ExceptionHandler(Exception.class)
    public HashMap<String,Object> doException(Exception e){
        HashMap<String,Object> result = new HashMap<>();
        result.put("code",-1);
        result.put("msg","Exception: "+e.getMessage());
        result.put("data",null);
        return result;
    }

统一数据格式返回(在返回数据之前进行数据重写)

@ControllerAdvice
public class MyResponseAdvice implements ResponseBodyAdvice {
    @Autowired
    ObjectMapper objectMapper;
    /**
     * 是否执行 beforeBodyWrite 方法,true=执行 重写返回结果,false=不执行
     *
     * @param returnType
     * @param converterType
     * @return
     */
    @Override
    public boolean supports(MethodParameter returnType, Class converterType) {
        return true;
    }
    /**
     * 在返回数据之前进行数据重写
     *
     * @param body     原始返回值
     * @param returnType
     * @param selectedContentType
     * @param selectedConverterType
     * @param request
     * @param response
     * @return
     */
    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
        //定义一个标准的返回格式
        //Hash<String,Object> code,msg,data
        if(body instanceof HashMap){
            return body;
        }
        // 重写返回结果,让其返回一个统一的数据格式
        HashMap<String,Object> result = new HashMap<>();
        result.put("code",200);
        result.put("msg","");
        result.put("data",body);
        if(body instanceof String){
            // 返回一个 String 字符串
            try {
                objectMapper.writeValueAsString(result);
            } catch (JsonProcessingException e) {
                e.printStackTrace();
            }
            return result;
        }
        return result;
    }
}

使用ResponseBodyAdvice接口,重写supports和beforeBodyWrite方法,这种方式如果原方法返回的是字符串,不进行特殊处理会报错(执行流程:

1.方法返回的是 String

2.统一数据返回之前处理 把String 转换成 HashMap

3.将 HashMap 转换成 application/json 字符串给前端(接口)),在第三步的时候会判断原 body 类型,根据类型选择不同的 消息转换器 去转换,如果是String 类型会使用StringHttpMessageConverter进行类型转换,如果非String 类型,会使用 HttpMessageConverter 进行类型转换.但是事实上StringHttpMessageConverter 消息转换器不能把HashMap转换为json格式的字符串,因此会报错.   我们可以在统一数据重写时,单独处理String类型,让其返回一个 String 字符串,而非HashMap

到此这篇关于SpringBoot统一功能处理(拦截器)的文章就介绍到这了,更多相关SpringBoot统一功能处理内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 解决RestTemplate 请求url中包含百分号 会被转义成25的问题

    解决RestTemplate 请求url中包含百分号 会被转义成25的问题

    这篇文章主要介绍了解决RestTemplate 请求url中包含百分号 会被转义成25的问题,具有很好的参考价值,希望对大家有所帮助。
    2021-10-10
  • Java 过滤器实现敏感词汇过滤功能

    Java 过滤器实现敏感词汇过滤功能

    通过使用 Java 过滤器,我们可以轻松地实现敏感词汇过滤的功能,以保护用户免受不良内容的侵害,让我们通过一个简单的示例来演示我们的敏感词汇过滤器是如何工作的,感兴趣的朋友一起看看吧
    2024-01-01
  • java多线程复制文件的实例代码

    java多线程复制文件的实例代码

    java多线程复制文件的实例代码,需要的朋友可以参考一下
    2013-03-03
  • java大数乘法的简单实现 浮点数乘法运算

    java大数乘法的简单实现 浮点数乘法运算

    大数乘法可以进行任意大小和精度的整数和浮点数的乘法运算, 精确度很高, 可以用作经融等领域的计算,这个是我看了一些资料, 然后自己整理实现的,简单测试了一下
    2014-01-01
  • Java集合的Collection接口和List接口详解

    Java集合的Collection接口和List接口详解

    这篇文章主要为大家详细介绍了Java集合的Collection接口和List接口,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下,希望能够给你带来帮助
    2022-03-03
  • Java快速实现PDF转图片功能实例代码

    Java快速实现PDF转图片功能实例代码

    PDFBox是一个开源Java类库,用于读取和创建PDF文档,它支持文本提取、表单处理、文档加密解密、合并分割、内容覆盖追加、文档打印和转换等功能,文中通过代码介绍的非常详细,需要的朋友可以参考下
    2024-09-09
  • Java编程Commons lang组件简介

    Java编程Commons lang组件简介

    这篇文章主要介绍了Java编程Commons lang组件的相关内容,十分具有参考意义,需要的朋友可以了解下。
    2017-09-09
  • java应用开发之JVM运行时内存分析

    java应用开发之JVM运行时内存分析

    这篇文章主要介绍了java应用开发之JVM运行时内存,文中附含图文示例内容分析非常简要,有需要的朋友可以借鉴参考下,希望能够有所帮助
    2021-09-09
  • Java中Servlet的生命周期详解

    Java中Servlet的生命周期详解

    这篇文章主要介绍了Java中Servlet的生命周期详解,文章围绕主题展开详细的内容介绍,具有一定的参考价值,需要的小伙伴可以参考一下
    2022-08-08
  • Spring Boot中使用Redis做缓存的方法实例

    Spring Boot中使用Redis做缓存的方法实例

    这篇文章主要给大家介绍了关于Spring Boot中使用Redis做缓存的相关资料,文中介绍的非常详细,对大家具有一定的参考学习价值,需要的朋友们下面来一起看看吧。
    2017-06-06

最新评论