SpringBoot学习（六）使用拦截器

1.环境

    Idea2018.2.X + jdk1.8 + maven3.3.9+ springboot2.0.5

2.项目结构

    

3.步骤

    3.1创建springboot项目(省略)附pom.xml

<?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>cn.gobon</groupId>
    <artifactId>springboot-interceptor</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>

    <name>springboot-interceptor</name>
    <description>Demo project for Spring Boot</description>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.5.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>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>


</project>

    3.2User实体类

package cn.gobon.model;

/**
 * @Auther: ${JianxiongYi}
 * @Date: 2018/9/23 18:32
 * @Description: 用户实体类
 */
public class User {
    private String username;
    private int age;
    private String sex;

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    public String getSex() {
        return sex;
    }

    public void setSex(String sex) {
        this.sex = sex;
    }
}

    3.3拦截器

        创建拦截器，实现HandlerInterceptor 接口，实现三个方法preHandle（请求前经过的方法），postHandle（请求controller时经过的方法），afterCompletion（返回经过拦截器的方法）。

package cn.gobon.interceptor;

import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 * @Auther: ${JianxiongYi}
 * @Date: 2018/9/23 18:08
 * @Description: 拦截器
 */
public class LoginInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("进入拦截器。。。。。");
        //返回false,就是拦截该请求
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("请求...controller");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("返回经过拦截器。。。");
    }
}

    3.4创建controller

package cn.gobon.controller;

import cn.gobon.model.User;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.servlet.ModelAndView;

/**
 * @Auther: ${JianxiongYi}
 * @Date: 2018/9/23 18:28
 * @Description:
 */
@RestController
public class UserController {

    @RequestMapping("/springboot/hello")
    public String hello(){
        return "hello";
    }

    @RequestMapping("/springboot/getUser")
    public User getUser() {
        User user = new User();
        user.setUsername("zhangsan");
        user.setAge(17);
        user.setSex("男");
        return user;
    }

    @RequestMapping("/springboot")
    public ModelAndView getModel(){
        ModelAndView mv = new ModelAndView();
        User user = new User();
        user.setUsername("张三丰");
        user.setAge(17);
        user.setSex("男");
        mv.addObject("user",user);
        return mv;
    }

}

    3.5创建配置类

        配置类实现WebMvcConfigurer ,需要注意的是在springboot2.0之前,实现的WebMvcConfigurerAdapter接口,从springboot2.0开始,该接口已经过时,推荐使用WebMvcConfigurer         ,WebMvcConfigurationSupport,具体的差异这里不做介绍。

package cn.gobon.config;

import cn.gobon.interceptor.LoginInterceptor;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

/**
 * @Auther: ${JianxiongYi}
 * @Date: 2018/9/23 18:16
 * @Description: 配置类
 */
@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        //拦截的请求路径
        String[] addInterceptors = {
            "/springboot/**"
        };
        //排除拦截的路径
        String[] excludePathPatterns = {
            "/springboot/getUser"
        };
        //注册拦截器,可以注册多个拦截器
        registry.addInterceptor(new LoginInterceptor()).addPathPatterns(addInterceptors).excludePathPatterns(excludePathPatterns);
    }
}

 

4.测试

    请求 http://localhost:8080/springboot/hello,经过拦截器。

    请求http://localhost:8080/springboot/getUser，没有经过拦截器。

 

    本人实力有限,若有错误,欢迎指点!

转载于:https://my.oschina.net/u/3794524/blog/2208003