当前位置：主页 > java教程 > springboot自定义拦截器

springboot自定义拦截器简单使用及举例

发布：2023-04-20 18:05:02 59

给大家整理了相关的编程文章，网友任英华根据主题投稿了本篇教程内容，涉及到springboot自定义拦截器、springboot拦截所有请求、springboot、拦截器、springboot自定义拦截器相关内容，已被632网友关注，涉猎到的知识点内容可以在下方电子书获得。

springboot自定义拦截器

1. 自定义拦截器

在springboot中，使用自定义拦截器，只需要将类实现HandlerIntercepter接口(与原生的filter也基本差不多)。

HandlerIntercepeter源码：

package org.springframework.web.servlet;

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

import org.springframework.lang.Nullable;
import org.springframework.web.method.HandlerMethod;

public interface HandlerInterceptor {

	default boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
			throws Exception {

		return true;
	}
	
	default void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
			@Nullable ModelAndView modelAndView) throws Exception {
	}

	default void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler,
			@Nullable Exception ex) throws Exception {
	}

}

preHandle()：当某个 url 已经匹配到对应的 Controller 中的某个方法，且在这个方法执行之前 去执行。返回 true 则放行，返回 false 则不会向后执行。

postHandle()：当某个 url 已经匹配到对应的 Controller 中的某个方法，且在执行完了该方法，但是在 DispatcherServlet视图渲染之前。所以在这个方法中有个 ModelAndView 参数，可以在此做一些修改动作。

afterCompletion()：在整个请求处理完成后（包括视图渲染）执行，这时做一些资源的清理工作，这个方法只有在 preHandle(……) 被成功执行后并且返回 true才会被执行。

2. 拦截器登录验证的小demo

只有当用户正确登录以后，才允许用户去访问网站的其他页面和资源，即初始时拦截掉所有请求，除了登录页面的请求，登录成功以后放行访问其他页面。

目录结构如下：

2.1 配置pom.xml

配置pom.xml

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

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <excludes>
                        <exclude> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId>
                        </exclude>
                    </excludes>
                </configuration>
            </plugin>
        </plugins>
    </build>

2.2 创建User的bean组件

使用lombok，来快速生成有参无参构造器，以及get ,set方法和toString()方法

package com.robin.boot.bean;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.ToString;

@ToString
@NoArgsConstructor
@AllArgsConstructor
@Data
public class User {
    private String userName;
    private String password;
}

2.3 创建需要的表单页面以及登录成功的页面

index.html:

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>登录页面</title>
</head>
<body>
    <h3 th:text="${msg}">title</h3>
    <form action="/login" method="post">
        <input type="text" name="userName"><br>
        <input type="password" name="password"><br>
        <input type="submit" value="登录">
    </form>
</body>
</html>

show.html:

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>显示页面</title>
</head>
<body>
    <h3 th:text="${msg}">title</h3>
    账号:<p th:text="${loginUser.userName}">账号xxx</p>
    密码:<p th:text="${loginUser.password}">密码xxx</p>
</body>
</html>

2.4 编写controller映射关系

package com.robin.boot.controller;

import com.robin.boot.bean.User;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;

@Controller
public class LoginController {

    @PostMapping("/login")
    public String login(User user, Model model){
        System.out.println(user);
        if ("robin".equals(user.getUserName())&&"123456".equals(user.getPassword())){
            model.addAttribute("loginUser",user);
            return "show";
        }else{
            model.addAttribute("msg","登录失败,请检查账号密码信息..");
            return "index";
        }
    }
}

2.5 自定义拦截器类，实现intercepetor接口

package com.robin.boot.interceptor;

import lombok.extern.slf4j.Slf4j;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

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


@Slf4j
public class LoginInterceptor implements HandlerInterceptor {

    // 目标方法执行之前
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 拦截请求输出
        String requestURI = request.getRequestURI();
        log.info("拦截了请求{}",requestURI);

        // 登录检查逻辑，是否登录，登录成功以后放行资源，未登录则拦截资源
        HttpSession session = request.getSession();
        Object loginUser = session.getAttribute("loginUser");

        if (loginUser!=null){
            // 登录成功放行资源
            return true;
        }else{
            // 提示错误信息
            request.setAttribute("msg","请先登录！");
            // 请求转发
            request.getRequestDispatcher("/").forward(request,response);
            // 未登录拦截资源
            return false;
        }


    }

    // 目标方法执行完毕
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
          log.info("postHandle执行{}",modelAndView);
    }

    // 页面渲染以后
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        log.info("afterCompletion执行异常{}",ex);
    }
}

2.6注册添加拦截器，自定义springboot配置类

通过addInterceptors(InterceptorRegistry registry)方法，使用registry.addInterceptor()将自定义拦截器注册。

并且通过InterceptorRegistration.addPathPatterns()方法添加拦截的请求，InterceptorRegistration.excludePathPatterns()方法放行请求。

package com.robin.boot.config;

import com.robin.boot.interceptor.LoginInterceptor;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

// 自定义springboot配置类
@Configuration
public class MyWebConfig implements WebMvcConfigurer {

    // 添加注册拦截器
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LoginInterceptor())
                .addPathPatterns("/**") // 拦截所有请求
                .excludePathPatterns("/","/login"); // 放行 / 和 /login请求,
        // 因为例子写的比较简单
        // .excludePathPatterns("/","/login","/css/**","/js/**","/fonts/**","/images/**"); 平常可以写这样
    }
}

2.7 运行测试

访问首页：

输入错误的账号信息：

直接通过地址栏访问show.html,http://localhost:8080/show.html,拦截器发送提示信息并请求转发到index.html,因为是请求转发，所有地址栏不会发生改变。

输入正确的账号信息，成功访问：

总结

到此这篇关于springboot自定义拦截器简单使用及举例的文章就介绍到这了,更多相关springboot自定义拦截器内容请搜索码农之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持码农之家！

参考资料

相关文章

  • springboot整合xxl-job实现分布式定时任务的过程

    springboot整合xxl-job实现分布式定时任务的过程

    发布：2023-01-03

    为网友们分享了关于springboot的教程，XXL-JOB是一个分布式任务调度平台，其核心设计目标是开发迅速、学习简单、轻量级、易扩展，这篇文章主要介绍了springboot整合xxl-job分布式定时任务,需要的朋友可以参考下

  • SpringBoot前后端json数据交互的全过程记录

    SpringBoot前后端json数据交互的全过程记录

    发布：2022-09-23

    给网友朋友们带来一篇关于SpringBoot的教程，现在大多数互联网项目都是采用前后端分离的方式开发,下面这篇文章主要给大家介绍了关于SpringBoot前后端json数据交互的相关资料,文中通过实例代码介绍的非常详细,需要的朋友可以参考下

  • springboot通过cors协议解决跨域问题方法

    发布：2019-06-07

    这篇文章主要介绍了springboot中通过cors协议解决跨域问题,cors是一个w3c标准，它允许浏览器（目前ie8以下还不能被支持）像我们不同源的服务器发出xmlHttpRequest请求，我们可以继续使用ajax进行请

  • SpringBoot系列教程JPA基础环境搭建的步骤

    发布：2019-07-25

    这篇文章主要介绍了SpringBoot系列教程JPA之基础环境搭建的方法,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习

  • SpringBoot实现埋点监控

    发布：2023-03-03

    本文主要介绍了SpringBoot实现埋点监控，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧

  • springboot在idea下debug调试热部署问题

    发布：2023-04-12

    这篇文章主要介绍了springboot在idea下debug调试热部署问题，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教

  • SpringBoot项目集成日志的方法步骤

    发布：2019-06-18

    这篇文章主要介绍了SpringBoot项目集成日志的实现方法,小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧

  • SpringBoot Bean花式注解方法示例上篇

    发布：2023-04-07

    这篇文章主要介绍了SpringBoot Bean花式注解方法，很多时候我们需要根据不同的条件在容器中加载不同的Bean，或者根据不同的条件来选择是否在容器中加载某个Bean

网友讨论

最新更新
最近更新
热门资源