Spring Boot 统一事务处理（拦截器）

最新推荐文章于 2024-04-29 20:54:10 发布
最新推荐文章于 2024-04-29 20:54:10 发布
阅读量1k 收藏 3
点赞数
分类专栏： java 文章标签： spring boot spring java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/m0_71777195/article/details/130822290
版权
java 专栏收录该内容
3476 篇文章 105 订阅
订阅专栏

1. 什么是拦截器？

1.1 含义

  在Spring Boot中，拦截器是一种用于拦截和处理HTTP请求的机制。它是Spring框架提供的一种中间件，用于在请求到达控制器（Controller）之前或之后执行一些共享的逻辑。

  Spring Boot的拦截器基于Spring MVC框架中的HandlerInterceptor接口实现。通过创建一个自定义的拦截器类并实现HandlerInterceptor接口，可以定义拦截器要执行的逻辑和行为。

1.2 作用

  身份验证和权限控制： 拦截器可以用于检查用户的身份验证状态和权限，并根据需要进行相关处理。例如，可以使用拦截器验证用户的登录状态，如果未登录则重定向到登录页面或返回相应的错误信息。

  异常处理和统一错误处理： 拦截器可以捕获并处理请求处理过程中发生的异常。可以根据异常类型进行适当的处理，如返回自定义错误页面或错误信息，或执行特定的错误处理逻辑。

  当然它还有其它的应用场景，这里就不一一列举了。

2. ⽤户登录权限效验

2.1 自定义拦截器

java复制代码@Component
public class LoginInterceptor implements HandlerInterceptor {

    //调用目标方法之前执行的方法
    //如果返回ture表示拦截器验证成功，执行目标方法
    //如果返回false表示拦截器验证失败，不再继续执行后续业务
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        //用户登录判断业务
        HttpSession session = request.getSession(false);

        if(session != null && session.getAttribute("session_userinfo") != null){
            //用户已登录
            return true;
        }
        response.setStatus(401);
        return false;
    }
}

  代码中的preHandle方法是拦截器的主要方法，在目标方法调用之前执行。它接收三个参数：HttpServletRequest对象表示当前的HTTP请求，HttpServletResponse对象表示当前的HTTP响应，Object handler表示被拦截的处理器（一般是Controller中的方法）。

  在preHandle方法中，首先通过request.getSession(false)获取当前请求的HttpSession对象（如果存在的话），然后判断该HttpSession对象是否为null并且是否存在名为"session_userinfo"的属性。如果这个条件成立，说明用户已经登录，可以继续执行后续的业务，于是返回true，否则验证失败，将HTTP响应的状态码设置为401，表示未授权，然后返回false，不再继续执行后续业务。

2.2 将⾃定义拦截器加⼊到系统配置

java复制代码@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/reg   (注册)
                .excludePathPatterns("/image/**")//排除 image(图像) 文件夹下的所有文件
                .excludePathPatterns("/**/*.js")//排除任意深度目录下的所有".js"文件
                .excludePathPatterns("/**/*.css");
    }
}

  在配置类中，重写了addInterceptors方法，该方法用于注册拦截器。在这里，通过调用InterceptorRegistry的addInterceptor方法来添加拦截器，并设置拦截的路径和排除的路径。

  具体地，通过调用addInterceptor(loginInterceptor)来添加LoginInterceptor拦截器。然后使用addPathPatterns方法指定需要拦截的URL路径模式，这里使用"/**"表示拦截所有的URL。使用excludePathPatterns方法来排除一些特定的URL路径，这些路径不会被拦截。

  对于"/**/*.js"，"**"：表示零个或多个路径段（目录或文件夹），可以匹配任意深度的目录结构。"/*.js"：表示以".js"结尾的文件名。

UserController：

java复制代码@RestController
@RequestMapping("/user")
public class UserController {

    @RequestMapping("/login")
    public String login(){
        return "login";
    }

    @RequestMapping("/index")
    public String index(){
        return "index";
    }

    @RequestMapping("/reg")
    public String reg(){
        return "reg";
    }
}

访问“login”：

访问“index”：

返回了401

访问“reg”：

2.3 统⼀访问前缀添加

所有请求地址添加test前缀：   在WebMvcConfigurer接口中，configurePathMatch方法用于配置路径匹配规则。

java复制代码
@Configuration
public class MyConfig implements WebMvcConfigurer {
        //统一访问前缀的添加
        @Override
        public void configurePathMatch(PathMatchConfigurer configurer) {
            configurer.addPathPrefix("test", new Predicate<Class<?>>() {
                @Override
                public boolean test(Class<?> aClass) {
                    return true;
                }
            });
        }
}

  在这个例子中，传递给addPathPrefix方法的前缀是"test"，而Predicate对象是一个匿名内部类，实现了Predicate<Class<?>>接口。Predicate接口是Java 8中引入的函数式接口，它的test方法用于判断传入的类是否符合条件。

  在这个匿名内部类中，test方法被重写为总是返回true，这意味着所有的类都符合条件，都会被添加统一访问前缀。

  因此，通过这段代码的配置，所有的请求路径都会在前面添加"test"前缀。例如，原始路径为"/example"，添加了前缀后的路径就变为"/test/example"。这样可以实现对请求路径的统一处理。

注意：如果加了前缀，拦截器的排除路径也要跟着改动：

java复制代码 //将拦截器
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(loginInterceptor)
                .addPathPatterns("/**") //拦截所有的 url
                .excludePathPatterns("/**/user/login")//排除url: /user/login (登录)
                .excludePathPatterns("/**/user/reg") //排除url: /user/reg   (注册)
                .excludePathPatterns("/**/image/**")//排除 image(图像) 文件夹下的所有文件
                .excludePathPatterns("/**/*.js")//排除任意深度目录下的所有".js"文件
                .excludePathPatterns("/**/*.css");
    }

3. 统⼀异常处理

  下面的代码在访问后会返回什么？

java复制代码@RestController
@RequestMapping("/user")
public class UserController {
    @RequestMapping("/login")
    public Integer login(){
        Object object = null;
        object.hashCode();
        return 1;
    }
}

  答案是：

  有没有一种手段可以在发生异常的时候返回有用的信息（此时的响应状态为200），而不是冰冷的报错信息呢？

  那就是统⼀异常处理：

java复制代码@ControllerAdvice
@ResponseBody
public class MyExceptionAdvice {
    @ExceptionHandler(NullPointerException.class)
    public HashMap<String,Object> doNullPointerException(NullPointerException e){
        HashMap<String,Object> result = new HashMap<>();
        result.put("code",-1);
        result.put("msg","空指针：" + e.getMessage());
        result.put("data",null);
        return result;
    }
}
  1. @ControllerAdvice注解标识该类是一个全局异常处理器，它将捕获应用程序中抛出的异常，并执行相应的处理逻辑。
  2. @ExceptionHandler(NullPointerException.class)注解指定了处理NullPointerException类型异常的方法doNullPointerException()。
  3. doNullPointerException()方法的参数是NullPointerException类型的异常对象，表示捕获到的具体异常实例。
  4. doNullPointerException()方法返回一个HashMap<String, Object>对象，用于封装异常处理结果。

  这段代码的作用是当捕获到NullPointerException异常时，执行doNullPointerException()方法，并返回一个包含异常处理结果的HashMap对象。该结果以JSON格式返回给客户端。

  当有多个异常处理器的时候，它们的处理次序：

java复制代码@ControllerAdvice
@ResponseBody
public class MyExceptionAdvice {

    //处理 NullPointerException 异常
    @ExceptionHandler(NullPointerException.class)
    public HashMap<String,Object> doNullPointerException(NullPointerException e){
        //处理
        HashMap<String,Object> result = new HashMap<>();
        result.put("code",-1);
        result.put("msg","NullPointerException：" + e.getMessage());
        result.put("data",null);
        return result;
    }
    
	//处理 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;
    }
}

java复制代码@RestController
@RequestMapping("/user")
public class UserController {
    @RequestMapping("/login")
    public Integer login(){
        Object object = null;
        object.hashCode();
        return 1;
    }
}

结论：如果能匹配就子类优先，如果没有匹配到就找父类。

4. 统一数据返回格式

4.1 为什么需要统一数据返回格式？

  1. 统一数据返回格式可以帮助前端程序员更好地接收和解析后端数据接口返回的数据，
  2. 规范性和可读性：统一数据返回格式可以定义一种统一的数据结构和字段，使得不同接口的返回数据具有一致性。这样可以提高代码的可读性和维护性，降低前后端开发人员之间的沟通成本。
  3. 统一数据维护和修改：通过统一数据返回格式，项目中的所有接口都遵循相同的数据格式，使得数据维护和修改变得更加方便和统一。如果需要修改数据返回的结构或字段，只需要在统一数据返回格式的定义处进行修改，而不需要逐个接口进行修改。
  4. 有利于制定后端技术规范标准：统一数据返回格式可以作为后端技术部门制定的一项规范标准。它可以避免出现各种奇怪的返回内容，提供统一的数据规范和结构，使得开发人员在后端开发过程中能够更好地遵循规范，提高代码质量和可维护性。

4.2 统一数据返回格式案例

  假设这里我们以{"msg": *,"code": *,"data": *}这种形式来作为标准返回格式。使用 @ControllerAdvice 注解结合 ResponseBodyAdvice 接口可以实现统一的数据返回格式。

java复制代码@ControllerAdvice
public class ResponseAdvice implements ResponseBodyAdvice {

    /**
     * @return 如果为 true，就执行 beforeBodyWrite
     */
    @Override
    public boolean supports(MethodParameter returnType, Class converterType){
        return true;
    }

    /**
     * 返回数据之前进行数据重写
     * @param body 原始返回值
     * @return
     */
    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType,
                                  MediaType selectedContentType, Class selectedConverterType,
                                  ServerHttpRequest request, ServerHttpResponse response) {

		// 在返回数据之前进行处理，可以修改、包装响应体，添加额外信息等
        // 这里可以对返回的数据进行统一的格式处理
        if(body instanceof HashMap){
            // 如果已经是统一响应格式，则直接返回
            return body;
        }
        // 如果不是统一响应格式，则进行包装
        HashMap<String,Object> result = new HashMap<>();
        result.put("code",200);
        result.put("data",body);
        result.put("msg","");
        return result;
    }
}

java复制代码@RestController
@RequestMapping("/user")
public class UserController {
    @RequestMapping("/login")
    public HashMap<String,Object> login(){
        HashMap<String,Object> hashMap = new HashMap<>();
        hashMap.put("code",200);
        hashMap.put("data",1);
        hashMap.put("msg","");
        return hashMap;
    }
    @RequestMapping("/reg")
    public Integer reg(){
        return 10;
    }
}

4.3 返回值为 String 的情况

  假如我要对下面的代码进行格式统一处理：

java复制代码@RequestMapping("/hi")
public String hi(){
    return "Hello World";
}

  可以发现报错了，为什么没有成功呢？

返回执行流程：

  1. 方法返回的是 String
  2. 统一数据返回之前处理：将 String 装入 HashMap 中。
  3. 将 HashMap 转换为 application/json 字符串给前端。

  问题就出在第三步，在进行转换 application/json 的时候，会先判断原 Body 的类型，如果是 String 类型，将会启用 StringHttpMessageConverter 进行类型转换，如果不是 String 类型，就用HttpMessageConverter来进行转换。

  在 Spring MVC 中，HttpMessageConverter 负责处理请求和响应的消息体，将请求的数据转换为方法参数的类型，以及将方法返回值转换为响应的数据格式。StringHttpMessageConverter 特别用于处理字符串类型的数据。

  StringHttpMessageConverter只能把String转换为其他类型，例如将字符串作为响应的内容返回给客户端。而代码中是把 HashMap 转换为 application/json字符串。所以报错了。

  解决方法：

  • 直接对 String 做特殊处理：直接把 HashMap 转为 json 字符串再发送给前端。
java复制代码@ControllerAdvice
public class ResponseAdvice implements ResponseBodyAdvice {

    @Autowired
    private ObjectMapper objectMapper;

    .......
        略
    .......
        
    //重写返回结果
    HashMap<String,Object> result = new HashMap<>();
    result.put("code",200);
    result.put("data",body);
    result.put("msg","");
    if(body instanceof String){
        //将 HashMap 转换为 json 字符串
        return objectMapper.writeValueAsString(request);
    }

    .......
        略
    .......
}
  • 删除 StringHttpMessageConverter
java复制代码@Configuration
public class MyConfig implements WebMvcConfigurer {
    /**
     * 移除 StringHttpMessageConverter
     *
     * @param converters
     */
    @Override
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        converters.removeIf(converter -> converter instanceof StringHttpMessageConverter);
    }
}
肥肥技术宅
关注
  • 0
    点赞
  • 踩
  • 3
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
Spring Boot 2.X、Spring Cloud、Spring Cloud Alibaba、Dubbo、分布式.zip
10-14
在带你快速学会 SpringMVC API 接口的编写的同时，我还想告诉你还有全局返回、全局异常、拦截器、跨域处理等等功能。 在带你快速学会 MQ 消息的发送与消费的同时，我还想告诉你 MQ 还有集群消费、广播消费、顺序消息...
SpringBoot 全局异常拦截器
Java笔记虾
12-18 2305
点击关注公众号，利用碎片时间学习通常jsr303参数校验，由于返回的数据提示很不友好(bindException)，需要定义全局异常拦截器，将信息友好的显示给用户本文以处理登录为例定义全局...
在springboot中使用拦截器
进击的豌豆的博客
06-30 8512
目前有一个需求，是在现有项目中集成一个简单的登录功能，想到了使用过滤器和拦截器实现，这篇文章介绍如何使用spring的拦截器。拦截器是在面向切面编程中应用的，就是在你的service或者一个方法前调用一个方法，或者在方法后调用一个方法。是基于JAVA的反射机制。过滤前->拦截前->Action处理->拦截后->过滤后 1）预处理preHandle()方法2）后处理postHandle()方法3）返回处理afterCompletion()方法注：一般使用preHandle这个拦截器进行预处理，对url进行请求
SpringBoot 拦截器与统一功能处理
2401_83384536的博客
03-11 897
Spring AOP是一个基于面向切面编程的框架，用于将横切性关注点（如日志记录、事务管理）与业务逻辑分离，通过代理对象将这些关注点织入到目标对象的方法执行前后、抛出异常或返回结果时等特定位置执行，从而提高程序的可复用性、可维护性和灵活性。但使用原生Spring AOP实现统一的拦截是非常繁琐、困难的。而在本节，我们将使用一种简单的方式进行统一功能处理，这也是AOP的一次实战，具体如下：统一用户登录权限验证统一数据格式返回统一异常处理。
springboot异常处理和拦截器
Lovely-Zhang-1026的博客
03-31 1040
自定义异常 继承Exception package com.zhf.demoboot3_31.exception; public class MyException extends Exception{ private String code; private String msg; public MyException() { } public String getCode() { return code; } publ
全面了解SpringBoot拦截器
万猫学社
06-28 1万+
拦截器（Interceptor）是一种特殊的组件，它可以在请求处理的过程中对请求和响应进行拦截和处理。拦截器可以在请求到达目标处理器之前、处理器处理请求之后以及视图渲染之前执行特定的操作。拦截器的主要目的是在不修改原有代码的情况下，实现对请求和响应的统一处理。本文详细介绍了SpringBoot中的拦截器，包括拦截器的概念、作用、实现方式、执行顺序、生命周期以及高级应用。我们还探讨了拦截器的性能优化策略和常见问题。希望本文能帮助您更好地理解和使用SpringBoot中的拦截器。
Springboot——拦截器
热门推荐
weixin_51351637的博客
11-27 3万+
假设controller层抛了异常，在这里是可以拿到异常对象的，但是我们有异常处理机制，所以这里就没有那么大的需求了。封装了SpringMVC进行页面跳转的相关数据，但是我们现在都是反JSON，一般不会这么搞了。是一种动态拦截方法调用的机制，在SpringMVC中动态拦截控制器方法的执行。通过这个ex可以拿到原始的程序执行过程中出现的异常的。那当我们配置了两个拦截器以后，会有一个执行顺序。Object handler 是什么参数。request：请求对象。response：响应对象。
【SpringBoot】SpringBoot拦截器
weixin_45618869的博客
07-12 2290
Spring Boot中的拦截器是一种用于在处理请求之前或之后执行特定操作的组件。拦截器通常用于实现对请求进行预处理、日志记录、权限验证等功能。在Spring Boot中，可以使用接口来定义自己的拦截器，并通过配置进行注册和使用。创建一个实现了接口的拦截器类，实现其中的方法，例如preHandle用于在请求处理之前执行操作，postHandle用于在请求处理之后执行操作，用于在视图渲染之后执行操作。在Spring Boot的配置类中，通过继承并重写方法来注册拦截器。
SpringBoot自定义异常拦截器
墨初
12-08 745
SpringBoot自定义异常拦截器
Spring Boot拦截器
2301_78930824的博客
07-03 853
本文介绍了Spring Boot拦截器的作用和原理，并给出了一个简单的示例来演示如何通过拦截器实现请求日志的记录。拦截器是开发中一个非常有用的工具，可以帮助开发人员处理请求、记录日志、鉴权和处理异常。请求日志记录：拦截器可以记录请求的信息，如请求方法、路径、请求参数等。现在，我们的拦截器已经注册到了Spring Boot应用程序中，接下来我们可以在控制器类中使用它。在上面的代码中，我们在preHandle方法中记录了请求的方法和路径，并使用SLF4J日志框架打印到日志中。
Spring Boot 拦截器实现：登录验证 & 统一异常处理 & 返回数据规范化
m0_65190367的博客
07-26 3124
创建一个普通类，实现 HandlerInterceptor 接口，重写 preHandle 方法，由于拦截器非常常用，所以Spring boot 内置了拦截器的依赖；preHandle方法：在请求到达Controller之前调用。在拦截器链中的每个拦截器的preHandle方法都会被依次调用。如果某个拦截器的preHandle方法返回false，则后续的拦截器的preHandle方法和Controller方法都不会被执行，请求将被拦截下来。
Spring Boot知识点复习
12-20
知识点复习：  1、IoC的具体应用  装配Bean的注解：  @Service ... 6、拦截器  7、登录认证  JWT 8、应用程序打包部署  操作系统：Linux/Unix  前后端分离部署：    Webserver App server  
基于 Spring Boot 2.X 版本的深度入门教程
04-05
快速学会 SpringMVC API 接口的编写的同时，我还想告诉你还有全局返回、全局异常、拦截器、跨域处理等等功能。快速学会 MQ 消息的发送与消费的同时，我还想告诉你 MQ 还有集群消费、广播消费、顺序消息、定时消息、...
【SpringBoot】Spring Boot 2小时入门基础教程
06-09
第二章：servlet、过滤器、监听器、拦截器配置及使用场景 第三章：讲解日志、静态资源、启动加载数据处理方式 第四章：数据库配置，jdbctemplate、mybatis、事务原理及实现 第五章：服务发布部署
spring boot 代码示例
02-23
包含druid数据源, druid的sql监控, druid过滤, mybatis xml配置, mybatis分页插件, logback日志配置, springboot多环境配置, 发送邮件, AOP拦截, 过滤器 spring拦截器, 全局异常, 统一响应, 自定义事务, 动态数据源...
实现spring boot 应用开机自启动之systemd service
04-23 414
centos下实现java 应用为systemd service运行，主要目的是显现开机自启动，并可以支持stop、restart功能。
快速构建Spring boot项目
Fxdll的博客
04-22 507
2、运行4、开发环境热部署查看目前已有的依赖。
Spring Boot分段处理List集合多线程批量插入数据
涛哥是个大帅比
04-22 498
Spring Boot分段处理List集合多线程批量插入数据
# 使用 spring boot 时，@Autowired 注解 自动装配注入时，变量报红解决方法：
最新发布
段子手168的博客
04-29 109
# 使用 spring boot 时，@Autowired 注解 自动装配注入时，变量报红解决方法：
Spring Boot 事物原理
09-11
Spring Boot的事务原理是基于Spring框架中的事务管理机制。在Spring Boot中，使用注解@Transactional来标识一个方法或类需要进行事务管理。当调用被标记为@Transactional的方法时，Spring会自动为该方法开启一个新的事务。如果方法执行成功，则事务会被提交，如果方法执行出现异常，则事务会回滚。 具体来说，Spring Boot的事务原理可以分为以下几个步骤： 1. 配置事务管理器：在Spring Boot中，需要配置事务管理器来管理事务。可以通过在配置文件中添加@EnableTransactionManagement注解来启用事务管理。 2. 标记事务注解：使用@Transactional注解来标记需要进行事务管理的方法或类。当方法被调用时，Spring会自动根据注解的设置来开启、提交或回滚事务。 3. 事务切面的生成：Spring会根据@Transactional注解生成事务切面，这个切面会在方法调用前后进行拦截，并在合适的时机开启、提交或回滚事务。 4. 事务的隔离级别和传播行为：可以通过设置@Transactional注解的参数来指定事务的隔离级别和传播行为。隔离级别定义了事务之间的隔离程度，传播行为定义了事务在方法调用链中的传播方式。 总之，Spring Boot的事务原理是基于Spring框架中的事务管理机制，在使用注解@Transactional标记方法或类时，Spring会根据注解的设置来进行事务的管理和控制。这样可以简化事务管理的过程，提高开发效率。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值