Spring Boot 中如何使用拦截器（十五）

最新推荐文章于 2023-03-15 17:52:42 发布

weixin_34174322

最新推荐文章于 2023-03-15 17:52:42 发布

阅读量165

点赞数

文章标签： python java

原文链接：https://my.oschina.net/wangxincj/blog/1862880

版权

2019独角兽企业重金招聘Python工程师标准>>>

关于拦截器，大家一定都不陌生，spring boot 中是如何使用拦截器的呢？今天就举个例子，来给大家说明一下，废话不多说，开始撸代码！！！

1、创建一个新的spring boot项目，并引入相应的jar，pom文件如下：

<?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>

	<groupId>com.quick</groupId>
	<artifactId>quick-intercprot</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<packaging>jar</packaging>

	<name>quick-intercprot</name>
	<description>Demo project for Spring Boot</description>

	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>2.0.3.RELEASE</version>
		<relativePath/> <!-- lookup parent from repository -->
	</parent>
	<properties>
		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
		<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
		<java.version>1.8</java.version>
	</properties>
	<dependencies>
		<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-thymeleaf</artifactId>
		</dependency>
	</dependencies>
	<build>
		<plugins>
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
			</plugin>
		</plugins>
	</build>
</project>

2、编写HandlerInterceptor

public class TestInterceptor extends HandlerInterceptorAdapter{
	private static final String username="wang";
	private static final String pwd="123";
	@Override
	public boolean preHandle(HttpServletRequest request,
							 HttpServletResponse response, Object handler) throws Exception {
		System.out.println("preHandle start...");
		String usernameParam = request.getParameter("username");
		String pwdParam = request.getParameter("pwd");
		if(!StringUtils.isEmpty(usernameParam)&&!StringUtils.isEmpty(pwdParam)){
			if(username.equals(usernameParam)&&pwdParam.equals(pwd)){
				System.out.println("TRUE");
				return Boolean.TRUE;
			}else {
				System.out.println("FALSE");
				response.sendRedirect(request.getContextPath()+"/index/errorIndex");
				return Boolean.FALSE;
			}
		}else {
			return Boolean.TRUE;
		}
	}
}

我们创建一个名为`TestInterceptor`的拦截器并继承`HandlerInterceptorAdapter`，实现`HandlerInterceptorAdapter`抽象类中的`preHandle`方法。此处我们模拟一个登陆请求的拦截，当账号密码正确时拦截器返回`true`并跳转到相应的页面，如果账号密码错误，重定向到一个错误页面。

3、编写拦截器配置

@Configuration
public class InterceptorConfig extends WebMvcConfigurationSupport {
	@Override
	protected void addInterceptors(InterceptorRegistry registry) {
		registry.addInterceptor(new TestInterceptor()).addPathPatterns("/test/**");
		super.addInterceptors(registry);
	}
}

由于我使用的springboot是`2.0.3.RELEASE`，2.0以后的版本需要继承`WebMvcConfigurationSupport` ，如果你使用的是2.0以下的版本请继承`WebMvcConfigurerAdapter`，此处做了一个请求的拦截，只有`/test/**`的请求才会被拦截到。

4、编写测试Controller，此处我们需要写三个Controller

此方法为模拟的登陆请求的方法

@RestController
@RequestMapping("/test")
public class TestController {
	@RequestMapping("/t")
	public String test(String username,String pwd){
		return "success";
	}
}

此方法主要是为了模拟拦截器是否能够拦截特定的请求路径，故将请求写为`/test2/**`

@RestController
@RequestMapping("/test2")
public class Test2Controller {
	@RequestMapping("/t")
	public String test(String param){
		return "success";
	}
}

此方法主要是为了当账号密码错误时跳转错误页面

@Controller
@RequestMapping("/index")
public class IndexController {
	@RequestMapping("/errorIndex")
	public String index(){
		return "errorIndex";
	}
}

5、编写错误页面`errorIndex.html`

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<h1>login error,账号或者密码错误</h1>
</body>
</html>