spring如何自己写一个拦截器 • Worktile社区

fiy

Worktile&PingCode市场小伙伴

自己编写一个拦截器通常需要以下步骤：

创建拦截器类：首先，需要创建一个类来实现HandlerInterceptor接口，该接口定义了拦截器的相关方法。可以自定义拦截器类的命名，如MyInterceptor。
实现拦截器方法：在拦截器类中，需要重写HandlerInterceptor接口中的三个方法：preHandle、postHandle和afterCompletion。

preHandle方法：在请求处理之前被调用，可以进行相关的权限验证或其他的前置处理操作。该方法返回一个布尔值，用于判断是否继续处理请求。
postHandle方法：在请求处理之后被调用，可以进行一些后置处理操作，比如添加数据到视图等。
afterCompletion方法：在请求完成之后被调用，可以用于清理资源或进行其他的收尾工作。

注册拦截器：将自定义的拦截器注册到Spring框架中，以便让Spring知道要使用该拦截器。

在Spring配置文件中添加mvc:interceptors标签，并在该标签内部添加标签，指定要注册的拦截器类。

配置拦截器的拦截路径：在注册拦截器的标签中，可以使用标签配置拦截器要拦截的路径。
编写业务逻辑代码：根据需要，在拦截器的preHandle、postHandle和afterCompletion方法中编写相关的业务逻辑代码。

需要注意的是，拦截器只能拦截Controller层中的请求，无法拦截静态资源文件。

通过以上步骤，就可以自己编写一个拦截器并将其应用到Spring框架中了。可以根据具体需求，自定义拦截器的功能，比如验证用户登录状态、记录请求日志等。

1年前 0条评论

不及物动词

这个人很懒，什么都没有留下～

Spring框架为开发者提供了强大的拦截器功能，使用拦截器可以在请求处理的不同阶段进行自定义的处理操作。下面是自己编写一个拦截器的步骤：

创建一个类，并实现HandlerInterceptor接口。

public class MyInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        //在请求处理之前进行预处理
        return true;  // 返回true表示继续向下执行，返回false表示中断请求
    }

    @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 {
        //在整个请求结束之后进行清理操作
    }
}

配置拦截器

在Spring的配置文件中，配置拦截器的Bean，并通过mvc:interceptors标签注册拦截器。

<mvc:interceptors>
    <bean class="com.example.MyInterceptor"/>
</mvc:interceptors>

拦截器的使用

在需要拦截的Controller方法上使用注解@Interceptor来指定需要使用的拦截器。

@Controller
public class MyController {
    @RequestMapping("/hello")
    @Interceptor(MyInterceptor.class)  //使用自定义的拦截器
    public ModelAndView hello() {
        ModelAndView modelAndView = new ModelAndView("hello");
        return modelAndView;
    }
}

配置Spring配置文件

在Spring的配置文件中配置拦截器的扫描路径和拦截器映射。例如：

<mvc:interceptors>
    <mvc:interceptor>
        <mvc:mapping path="/*"/>
        <bean class="com.example.MyInterceptor"/>
    </mvc:interceptor>
</mvc:interceptors>

测试拦截器

启动应用程序，访问拦截器配置的路径，可以看到自定义的拦截器将会被执行。

以上是自己编写一个拦截器的基本步骤。在实际的开发中，我们还可以通过拦截器来处理异常、实现权限控制、实现日志记录等功能。

1年前 0条评论

worktile

Worktile官方账号

Spring框架提供了一个非常灵活的拦截器机制，可以帮助我们在应用程序中进行统一的处理逻辑。自己编写一个拦截器只需实现Spring提供的HandlerInterceptor接口并完成相应的配置即可。下面将详细介绍如何在Spring中自己编写一个拦截器。

创建一个拦截器类
首先，我们需要创建一个拦截器类来实现HandlerInterceptor接口。该接口定义了三个方法，分别在请求处理之前、请求处理之后和请求完成之后进行调用。

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

public class MyInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
            throws Exception {
        // 在请求处理之前进行调用，返回true才会继续向下执行，返回false取消当前请求
        // 可以在这里进行权限验证、日志记录等操作
        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 {
        // 在请求完成后进行调用，可以在这里进行一些资源清理操作等
    }
}

配置拦截器
下一步是配置拦截器，使之生效。在Spring中，可以使用WebMvcConfigurer接口来进行配置。我们可以创建一个配置类并实现该接口，在配置类中注册我们的拦截器。

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
public class WebConfig implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 注册拦截器并设置拦截路径
        registry.addInterceptor(new MyInterceptor()).addPathPatterns("/**");
    }
}

在上述配置中，我们使用addInterceptor方法注册了我们的拦截器，并通过addPathPatterns方法设置了需要拦截的请求路径。上述示例中，使用"/**"表示拦截所有的请求路径。

配置拦截器优先级（可选）
如果应用程序中有多个拦截器，可以通过设置拦截器的优先级来控制它们的执行顺序。优先级较高的拦截器先执行，优先级较低的拦截器后执行。

@Configuration
public class WebConfig implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 注册拦截器并设置拦截路径和优先级
        registry.addInterceptor(new MyInterceptor()).addPathPatterns("/**").order(1);
        registry.addInterceptor(new AnotherInterceptor()).addPathPatterns("/**").order(2);
    }
}

上述示例中，我们使用order方法来设置拦截器的优先级。在这里，MyInterceptor拦截器的优先级为1，AnotherInterceptor拦截器的优先级为2。

常见用例
自己编写的拦截器可以用于许多不同的用例，如权限验证、日志记录、请求参数验证等。以下是一些常见的用例示例：

权限验证：在preHandle方法中进行用户身份验证，如果验证失败，则返回false取消当前请求。
日志记录：在postHandle方法中记录请求的URL、输入参数、返回结果等相关信息。
请求参数验证：在preHandle方法中对请求参数进行合法性验证，如果验证失败，则返回false取消当前请求并返回错误信息。

需要注意的是，拦截器只能在Spring MVC的请求处理链中使用。如果需要拦截其他类型的请求（如静态资源请求），可以考虑使用Spring Boot中的拦截器Servlet Filter。

以上就是自己编写一个拦截器的基本步骤。通过自己编写拦截器，我们可以在应用程序中实现一些通用的处理逻辑，从而提高代码的重用性和可维护性。

1年前 0条评论