第六章：如何在SpringBoot项目中使用拦截器

拦截器对使用SpringMvc、Struts的开发人员来说特别熟悉，因为你只要想去做好一个项目必然会用到它。拦截器在我们平时的项目中用处有很多，如：日志记录（我们后续章节会讲到）、用户登录状态拦截、安全拦截等等。而SpringBoot内部集成的是SpringMVC控制框架，所以使用起来跟SpringMVC没有区别，只是在配置上有点不同。废话不多说，我们开始我们本章的内容！

本章目标

学习使用SpringBoot中是如何配置拦截器，使用拦截器来完成简单的用户登录状态判定。

构建项目

我们创建一个名字叫做Chapter6的SpringBoot项目，添加如下maven依赖：Web、MySQL、JPA、Druid等。复制上一章配置文件application.yml到本章对应目录下，具体项目结构如下图1所示：

图1

我们的application.yml文件内容需要修改添加JSP的支持，另外如果你下载后放到你本地的项目时，需要将数据库的地址以及用户名，密码修改成对应自己的配置信息。添加JSP路径配置支持如下图2所示：

图2

InteiiJ IDEA工具为我们创建的SpringBoot项目是不存在webapp、WEB-INF结构目录的，我们需要自行添加，如下图3所示：

图3

可以看到上述图3我们对应的创建了jsp目录，接下来我们分别创建名字叫做，index.jsp，login.jsp的JSP页面文件，index.jsp内填写“你已成功访问到主页面！”，login.jsp创建一个登录表单，输入一个用户名、密码字段，具体内容如下图4、图5所示：

图4

图5

配置控制器

上述JSP文件已经创建完成，下面我们需要让SpringBoot内置SpringMVC控制器转发到对应的JSP页面，我们创建名叫LoginController的类文件，并且加入登录用户的方法，如下图6所示：

图6

下面我们配置用户从数据库中读取，因为之前的表没有“密码”字段我们下图在之前的表内添加一个密码字段如下图7所示：

图7

表结构已经修改，我们根据表结构创建对应的实体，根据实体类直接创建SpringDataJPA的管理接口，SpringDataJPA的具体讲解我留到下面的章节给大家好好的梳理梳理，本章先使用最简单的部分查询功能。我下面直接贴对应的实体类代码以及JPA代码，如下图8、图9所示：

图8

图9

用户的实体以及JPA配置完成后我们再次打开LoginController，将UserJPA使用SpringBean的形式注入，然后完成简单的登录逻辑，如下图10所示：

图10

上图10可以看到我们使用SpringDataJPA从数据库中查询指定用户，然后再比对密码是否符合，我再次修改LoginController在登录成功的地方，添加将用户写入session中。如下图11所示：

图11

到现在我们还没有编写有关拦截器的相关内容，上述都是地基，我们接下来开始盖楼。

创建拦截器

在创建拦截器之前我们需要添加初始化登录页面的转发配置，我们创建IndexController添加初始化登录、首页页面转发配置，如下图12所示：

图12

完成上述操作后，创建一个名叫做SessionInterceptor的拦截器实体类，实现SpringMVC内部接口HandlerInterceptor，并且添加如果没有session状态直接跳转到/user/login_view地址也就是我们对应的login.jsp页面，拦截器配置如下图13所示：

图13

接下来我们需要将SessionInterceptor拦截器添加到SpringBoot的配置中，让SpringBoot项目有这么一个拦截器存在，我们新创建一个SessionConfiguration，将拦截器的配置以及拦截路径配置好，如下图14所示：

图14

好了，我们的所有工作都已经做好，下面我们来初尝试运行项目，看看有没有什么问题

初尝试运行

我们观察InteiilJ IDEA工具的控制台的日志如下图15所示，证明你的项目启动没有问题，那么我们先来访问首页地址尝试登录地址：127.0.0.1:8080/user/index，我们发现了一个意向不到的结果，如下图15所示：

图15

为什么会出现这个问题呢？我们已经排除了/user/login以及/user/login_view请求地址为什么还会出现这个问题呢？遇到这个问题我们可以去SessionInterceptor内打印request.getRequestURI()看看输出的地址，如下图16所示：

图16

我们发现不仅仅有/user/login_view，还存在一个/error页面，为什么出现这个呢？这时才恍然大悟，我们在pom.xml配置文件中并没有配置JSP的支持，我们打开pom.xml配置文件将jsp以及servlet的依赖添加进去，如下图17所示：

图17

完成依赖添加后，重启项目，再次访问127.0.0.1:8080/user/index，现在显示是没有问题了，我们没有登录直接访问index.jsp，当然会被拦截器拦截，拦截后直接跳转到登录页面（login.jsp），如下图18所示效果：

图18

我们现在输入数据库内存在的用户名：admin，密码：123456的测试用户进行登录，效果如下图19所示：

图19

显示我们已经登录成功，也就是说我们的登录用户消息已经存放到session内，那么我们来访问127.0.0.1:8080/user/index地址进行验证，如下图20所示：

图20

可以看到图20效果，我们可以访问到了index.jsp页面的内容了，我们的拦截器完美的完成的拦截使命。

总结

上述内容是本章的全部讲解内容，本章主要内容讲解SpringBoot项目是如果配置拦截器，并且实现简单的用户登录状态验证拦截实例。

本章代码已经上传到码云：

SpringBoot配套源码地址：https://gitee.com/hengboy/spring-boot-chapter

SpringCloud配套源码地址：https://gitee.com/hengboy/spring-cloud-chapter

SpringBoot相关系列文章请访问：目录：SpringBoot学习目录

QueryDSL相关系列文章请访问：QueryDSL通用查询框架学习目录

SpringDataJPA相关系列文章请访问：目录：SpringDataJPA学习目录

SpringBoot相关文章请访问：目录：SpringBoot学习目录，感谢阅读！