springboot实现拦截器

本文介绍如何创建SpringBoot项目,包括配置文件、依赖项及版本控制。同时,详细解析了自定义拦截器的实现,展示了两个具体示例,并通过配置使其生效。最后,演示了一个简单的控制器用于测试拦截器功能。

1、创建springboot项目

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.1.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.example</groupId>
    <artifactId>demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>
    <name>demo</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>


        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
        </dependency>
        <dependency>
            <groupId>net.sf.json-lib</groupId>
            <artifactId>json-lib</artifactId>
            <version>2.4</version>
            <classifier>jdk15</classifier>
        </dependency>
    </dependencies>


</project>

 

2、自定义拦截器:

package com.example.demo.intercepter;

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

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
@Component
public class AIntercepter implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("A-----------A");
        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 {

    }
}
package com.example.demo.intercepter;

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

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
@Component
public class MyIntercepter implements HandlerInterceptor {
    /**
     * 进入handler之前
     * @param request
     * @param response
     * @param handler
     * @return
     * @throws Exception
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("进入handler之前");
        return true;
    }

    /**
     * 进入handler之后,返回model之前
     * @param request
     * @param response
     * @param handler
     * @param modelAndView
     * @throws Exception
     */
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {

    }

    /**
     * 返回model之后
     * @param request
     * @param response
     * @param handler
     * @param ex
     * @throws Exception
     */
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {

    }
}

3、配置:

package com.example.demo.config;

import com.example.demo.intercepter.AIntercepter;
import com.example.demo.intercepter.MyIntercepter;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.SpringBootConfiguration;
import org.springframework.boot.autoconfigure.web.servlet.WebMvcAutoConfiguration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
@SpringBootConfiguration
public class MySpringMVCConfig extends WebMvcConfigurerAdapter {
    @Autowired
    private MyIntercepter myIntercepter;
    @Autowired
    private AIntercepter aIntercepter;
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(myIntercepter).addPathPatterns("/**");
        registry.addInterceptor(aIntercepter).addPathPatterns("/**");
    }
}

4、目标:
 

package com.example.demo.controller;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class SampleController {
    @RequestMapping("/home")
    public String home() {
        return "Hello World!";
    }
}

 

在Spring Boot应用中实现和配置拦截器,通常需要以下几个步骤:创建拦截器类、注册拦截器以及定义拦截规则。 ### 创建拦截器类 首先,需要实现一个拦截器类,该类通常实现`HandlerInterceptor`接口,并重写其中的方法。这些方法包括: - `preHandle`:在目标方法执行前调用,如果返回`false`,则中断请求。 - `postHandle`:在目标方法执行后,视图渲染前调用。 - `afterCompletion`:在整个请求完成后调用,无论是否发生异常。 下面是一个简单的拦截器示例,它在请求到达控制器之前打印请求的URL: ```java import org.springframework.web.servlet.HandlerInterceptor; import javax.servlet.http.HttpServletRequest; import HttpServletResponse; public class MyInterceptor implements HandlerInterceptor { @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { System.out.println("请求地址: " + request.getRequestURL()); return true; // 如果返回false,则中断请求 } @Override public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception { // 在这里可以修改modelAndView } @Override public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { // 在这里可以进行资源清理工作 } } ``` ### 注册拦截器 创建了拦截器类之后,你需要创建一个配置类来注册这个拦截器。这个配置类需要实现`WebMvcConfigurer`接口,并重写`addInterceptors`方法。在这个方法中,你可以指定拦截器应该拦截哪些路径,以及哪些路径应该被排除。 下面是一个配置类的示例: ```java 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 MvcConfig implements WebMvcConfigurer { private final MyInterceptor myInterceptor; public MvcConfig(MyInterceptor myInterceptor) { this.myInterceptor = myInterceptor; } @Override public void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(myInterceptor) .addPathPatterns("/**") // 拦截所有请求 .excludePathPatterns("/public/**", "/error"); // 排除一些不需要拦截的请求 } } ``` 在这个例子中,我们使用了构造器注入来注入`MyInterceptor`实例。然后,通过`addInterceptors`方法将拦截器添加到`InterceptorRegistry`中,并定义了拦截所有请求的模式,但排除了`/public/**`和`/error`路径。 ### 定义拦截规则 在上面的配置中,`.addPathPatterns("/**")`定义了拦截所有请求的规则,而`.excludePathPatterns("/public/**", "/error")`则定义了不被拦截的特定路径。你可以根据实际需求调整这些规则。 ### 注意事项 - **职责单一**:每个拦截器应该只关注一个功能点。 - **性能考虑**:避免在拦截器中执行耗时操作。 - **合理排序**:如果存在多个拦截器,应合理安排它们的顺序。 - **异常处理**:注意拦截器中的异常处理逻辑。 - **避免循环**:确保拦截器逻辑不会导致循环重定向。 以上就是在Spring Boot中实现和配置拦截器的基本步骤。当然,你可以根据具体的业务需求来扩展拦截器的功能,比如进行权限校验、日志记录或性能监控等[^3]。
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值