SSM - SpringMVC 应用

• SSM - SpringMVC 应用
• SSM整合
  • 流程分析
    • 整合配置
      • 步骤1：创建Maven的web项目
      • 步骤2:添加依赖
      • 步骤3:创建项目包结构
      • 步骤4:创建SpringConfig配置类
      • 步骤5:创建JdbcConfig配置类
      • 步骤6:创建MybatisConfig配置类
      • 步骤7:创建jdbc.properties
      • 步骤8:创建SpringMVC配置类
      • 步骤9:创建Web项目入口配置类
    • 功能模块开发
    • 单元测试
    • PostMan测试
  • 统一结果封装
    • 表现层与前端数据传输协议定义
    • 表现层与前端数据传输协议实现
      • 结果封装
  • 统一异常处理
    • 问题描述
    • 异常处理器的使用
      • 使用步骤
      • 知识点1：@RestControllerAdvice
      • 知识点2：@ExceptionHandler
    • 项目异常处理方案
      • 异常分类
      • 异常解决方案
      • 异常解决方案的具体实现
  • 前后台协议联调
    • 环境准备
  • 拦截器
    • 拦截器概念
    • 拦截器入门案例
      • 拦截器开发
    • 拦截器参数
      • 前置处理方法
      • 后置处理方法
      • 完成处理方法
    • 拦截器链配置
      • 配置多个拦截器

SSM整合

流程分析

(1) 创建工程

• 创建一个Maven的web工程
• pom.xml添加SSM需要的依赖jar包
• 编写Web项目的入口配置类，实现AbstractAnnotationConfigDispatcherServletInitializer重写以下方法
  • getRootConfigClasses() ：返回Spring的配置类->需要SpringConfig配置类
  • getServletConfigClasses() ：返回SpringMVC的配置类->需要SpringMvcConfig配置类
  • getServletMappings() : 设置SpringMVC请求拦截路径规则
  • getServletFilters() ：设置过滤器，解决POST请求中文乱码问题

(2)SSM整合[重点是各个配置的编写]

• SpringConfig
  • 标识该类为配置类 @Configuration
  • 扫描 Service 所在的包 @ComponentScan
  • 在 Service 层要管理事务 @EnableTransactionManagement
  • 读取外部的 properties配 置文件 @PropertySource
  • 整合 Mybatis 需要引入Mybatis相关配置类 @Import (两种方式：1. MybatisConfig类添加注解@Configuration；2.SpringConfig @Import({MyBatisConfig.class}))
    • 第三方数据源配置类 JdbcConfig
      • 构建 DataSource 数据源，DruidDataSouroce,需要注入数据库连接四要素， @Bean @Value
      • 构建平台事务管理器，DataSourceTransactionManager,@Bean
    • Mybatis配置类 MybatisConfig
      • 构建 SqlSessionFactoryBean 并设置别名扫描与数据源，@Bean
      • 构建 MapperScannerConfigurer 并设置DAO层的包扫描
• SpringMvcConfig
  • 标识该类为配置类 @Configuration
  • 扫描 Controller 所在的包 @ComponentScan
  • 开启 SpringMVC 注解支持 @EnableWebMvc

(3)功能模块[与具体的业务模块有关]

• 创建数据库表
• 根据数据库表创建对应的模型类
• 通过Dao层完成数据库表的增删改查(接口+自动代理)
• 编写Service层[Service接口+实现类]
  • @Service
  • @Transactional
  • 整合Junit对业务层进行单元测试
    • @RunWith
    • @ContextConfiguration
    • @Test
• 编写Controller层
  • 接收请求 @RequestMapping @GetMapping @PostMapping @PutMapping @DeleteMapping
  • 接收数据 简单、POJO、嵌套POJO、集合、数组、JSON数据类型
    • @RequestParam
    • @PathVariable
    • @RequestBody
  • 转发业务层
    • @Autowired
  • 响应结果
    • @ResponseBody

整合配置

按照上述的步骤一步步的来完成SSM的整合。

步骤1：创建Maven的web项目

可以使用Maven的骨架创建

步骤2:添加依赖

pom.xml添加SSM所需要的依赖jar包

步骤3:创建项目包结构

• config目录存放的是相关的配置类
• controller编写的是Controller类
• dao存放的是Dao接口，因为使用的是Mapper接口代理方式，所以没有实现类包
• service存的是Service接口，impl存放的是Service实现类
• resources:存入的是配置文件，如Jdbc.properties
• webapp:目录可以存放静态资源
• test/java:存放的是测试类

步骤4:创建SpringConfig配置类

@Configuration
@ComponentScan({"com.itheima.service"})
@PropertySource("classpath:jdbc.properties")
@Import({JdbcConfig.class,MyBatisConfig.class})
@EnableTransactionManagement
public class SpringConfig {
}

步骤5:创建JdbcConfig配置类

public class JdbcConfig {
    @Value("${jdbc.driver}")
    private String driver;
    @Value("${jdbc.url}")
    private String url;
    @Value("${jdbc.username}")
    private String username;
    @Value("${jdbc.password}")
    private String password;

    @Bean
    public DataSource dataSource(){
        DruidDataSource dataSource = new DruidDataSource();
        dataSource.setDriverClassName(driver);
        dataSource.setUrl(url);
        dataSource.setUsername(username);
        dataSource.setPassword(password);
        return dataSource;
    }

    @Bean
    public PlatformTransactionManager transactionManager(DataSource dataSource){
        DataSourceTransactionManager ds = new DataSourceTransactionManager();
        ds.setDataSource(dataSource);
        return ds;
    }
}

步骤6:创建MybatisConfig配置类

public class MyBatisConfig {
    @Bean
    public SqlSessionFactoryBean sqlSessionFactory(DataSource dataSource){
        SqlSessionFactoryBean factoryBean = new SqlSessionFactoryBean();
        factoryBean.setDataSource(dataSource);
        factoryBean.setTypeAliasesPackage("com.itheima.domain");
        return factoryBean;
    }

    @Bean
    public MapperScannerConfigurer mapperScannerConfigurer(){
        MapperScannerConfigurer msc = new MapperScannerConfigurer();
        msc.setBasePackage("com.itheima.dao");
        return msc;
    }
}

步骤7:创建jdbc.properties

在resources下提供jdbc.properties,设置数据库连接四要素

jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/ssm_db
jdbc.username=root
jdbc.password=root

步骤8:创建SpringMVC配置类

@Configuration
@ComponentScan("com.itheima.controller")
@EnableWebMvc
public class SpringMvcConfig {
}

步骤9:创建Web项目入口配置类

public class ServletConfig extends AbstractAnnotationConfigDispatcherServletInitializer {
    //加载Spring配置类
    protected Class<?>[] getRootConfigClasses() {
        return new Class[]{SpringConfig.class};
    }
    //加载SpringMVC配置类
    protected Class<?>[] getServletConfigClasses() {
        return new Class[]{SpringMvcConfig.class};
    }
    //设置SpringMVC请求地址拦截规则
    protected String[] getServletMappings() {
        return new String[]{"/"};
    }
    //设置post请求中文乱码过滤器
    @Override
    protected Filter[] getServletFilters() {
        CharacterEncodingFilter filter = new CharacterEncodingFilter();
        filter.setEncoding("utf-8");
        return new Filter[]{filter};
    }
}

功能模块开发

需求:对表tbl_book进行新增、修改、删除、根据ID查询和查询所有

1. 创建数据库及表
2. 编写模型类
3. 编写Dao接口
4. 编写Service接口和实现类
5. 编写Contorller类

先把业务层的代码使用Spring整合Junit的知识点进行单元测试:

单元测试

1. 新建测试类

2. 注入Service类

3. 编写测试方法

我们先来对查询进行单元测试。

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(classes = SpringConfig.class)
public class BookServiceTest {

    @Autowired
    private BookService bookService;

    @Test
    public void testGetById(){
        Book book = bookService.getById(1);
        System.out.println(book);
    }

    @Test
    public void testGetAll(){
        List<Book> all = bookService.getAll();
        System.out.println(all);
    }

}

PostMan测试

1. 新增

http://localhost/books

{
	"type":"类别测试数据",
    "name":"书名测试数据",
    "description":"描述测试数据"
}

2. 修改

http://localhost/books

{
    "id":13,
    "type":"类别测试数据",
    "name":"书名测试数据",
    "description":"描述测试数据"
}

3. 删除

http://localhost/books/14

4. 查询单个

http://localhost/books/1

5. 查询所有

http://localhost/books

统一结果封装

表现层与前端数据传输协议定义

SSM整合以及功能模块开发完成后，对于不同的请求，会返回不同的数据类型给前端，例如:

• 在Controller层增删改返回给前端的是boolean类型数据

• 在Controller层查询单个返回给前端的是对象

• 在Controller层查询所有返回给前端的是集合对象

对于前端开发人员在解析数据的时候就比较混乱，需要后台能够返回一个统一的数据结果。

这样前端就可以按照一种固定的方式进行解析，便于前端同学的开发。

思路:

• 返回的结果数据: 创建结果模型类，封装数据到data属性中
• 返回的数据是何种操作及是否操作成功: 封装操作结果到code属性中
• 操作失败后返回的错误信息: 封装特殊消息到message(msg)属性中

根据分析，可以设置统一数据返回结果类

public class Result{
	private Object data;
	private Integer code;
	private String msg;
}

**注意:**Result类名及类中的字段并不是固定的，可以根据需要自行增减提供若干个构造方法，方便操作。

表现层与前端数据传输协议实现

结果封装

具体结果封装的步骤为:

步骤1:创建Result类

public class Result {
    //描述统一格式中的数据
    private Object data;
    //描述统一格式中的编码，用于区分操作，可以简化配置0或1表示成功失败
    private Integer code;
    //描述统一格式中的消息，可选属性
    private String msg;

    public Result() {
    }
	//构造方法是方便对象的创建
    public Result(Integer code,Object data) {
        this.data = data;
        this.code = code;
    }
	//构造方法是方便对象的创建
    public Result(Integer code, Object data, String msg) {
        this.data = data;
        this.code = code;
        this.msg = msg;
    }
	//setter...getter...省略
}

步骤2:定义返回码Code类

//状态码
public class Code {
    public static final Integer SAVE_OK = 20011;
    public static final Integer DELETE_OK = 20021;
    public static final Integer UPDATE_OK = 20031;
    public static final Integer GET_OK = 20041;

    public static final Integer SAVE_ERR = 20010;
    public static final Integer DELETE_ERR = 20020;
    public static final Integer UPDATE_ERR = 20030;
    public static final Integer GET_ERR = 20040;
}

步骤3:修改Controller类的返回值

//统一每一个控制器方法返回值
@RestController
@RequestMapping("/books")
public class BookController {

    @Autowired
    private BookService bookService;

    @PostMapping
    public Result save(@RequestBody Book book) {
        boolean flag = bookService.save(book);
        return new Result(flag ? Code.SAVE_OK:Code.SAVE_ERR,flag);
    }
...
}

步骤4:启动服务测试

至此，返回结果就已经能以一种统一的格式返回给前端。前端根据返回的结果，先从中获取code,根据code判断，如果成功则取data属性的值，如果失败，则取msg中的值做提示。

统一异常处理

问题描述

如果 Controller类 中出现异常错误，则返回给前端的结果不能按照之前的固定格式返回，导致前端解析异常。

例如：

@GetMapping("/{id}")
public Result getById(@PathVariable Integer id) {
    //手动添加一个错误信息
    if(id**1){
        int i = 1/0;
    }
    Book book = bookService.getById(id);
    Integer code = book != null ? Code.GET_OK : Code.GET_ERR;
    String msg = book != null ? "" : "数据查询失败，请重试！";
    return new Result(code,book,msg);
}

重新启动运行项目，使用PostMan发送请求，当传入的id为1，则会出现如下效果：

前端接收到这个信息后和之前我们约定的格式不一致，这个问题该如何解决?

在解决问题之前，先来看下异常的种类及出现异常的原因:

• 框架内部抛出的异常：因使用不合规导致
• 数据层抛出的异常：因外部服务器故障导致（例如：服务器访问超时）
• 业务层抛出的异常：因业务逻辑书写错误导致（例如：遍历业务书写操作，导致索引异常等）
• 表现层抛出的异常：因数据收集、校验等规则导致（例如：不匹配的数据类型间导致异常）
• 工具类抛出的异常：因工具类书写不严谨不够健壮导致（例如：必要释放的连接长期未释放等）

看完上面这些出现异常的位置，会发现开发的任何一个位置都有可能出现异常，而且这些异常是不能避免的。所以就得将异常进行处理。

思考

1. 各个层级均出现异常，异常处理代码书写在哪一层?

   所有的异常均抛出到表现层进行处理

2. 异常的种类很多，表现层如何将所有的异常都处理到呢?

   异常分类

3. 表现层处理异常，每个方法中单独书写，代码书写量巨大且意义不强，如何解决?

   AOP

对于上面这些问题及解决方案，SpringMVC已经为我们提供了一套解决方案:

• 异常处理器:

  • 集中的、统一的处理项目中出现的异常。

异常处理器的使用

使用步骤

步骤1:创建异常处理器类

//@RestControllerAdvice用于标识当前类为REST风格对应的异常处理器
@RestControllerAdvice
public class ProjectExceptionAdvice {
    //除了自定义的异常处理器，保留对Exception类型的异常处理，用于处理非预期的异常
    @ExceptionHandler(Exception.class)
    public void doException(Exception ex){
      	System.out.println("异常捕获处理")
    }
}

确保SpringMvcConfig能够扫描到异常处理器类

步骤2:让程序抛出异常

@GetMapping("/{id}")
public Result getById(@PathVariable Integer id) {
  	int i = 1/0;
    Book book = bookService.getById(id);
    Integer code = book != null ? Code.GET_OK : Code.GET_ERR;
    String msg = book != null ? "" : "数据查询失败，请重试！";
    return new Result(code,book,msg);
}

步骤3:运行程序，测试

看到输出结果中存在异常捕获处理, 说明异常已经被拦截并执行了doException方法。

异常处理器类返回结果给前端

//@RestControllerAdvice用于标识当前类为REST风格对应的异常处理器
@RestControllerAdvice
public class ProjectExceptionAdvice {
    //除了自定义的异常处理器，保留对Exception类型的异常处理，用于处理非预期的异常
    @ExceptionHandler(Exception.class)
    public Result doException(Exception ex){
      	System.out.println("异常捕获处理")
        return new Result(666,null,"异常捕获处理");
    }
}

后台执行的过程中抛出异常，通过捕获重新返回Result的方式，最终也能按照和前端约定好的格式返回。

知识点1：@RestControllerAdvice

名称	@RestControllerAdvice
类型	类注解
位置	Rest风格开发的控制器增强类定义上方
作用	为Rest风格开发的控制器类做增强

**说明:**此注解自带@ResponseBody注解与@Component注解，具备对应的功能

知识点2：@ExceptionHandler

名称	@ExceptionHandler
类型	方法注解
位置	专用于异常处理的控制器方法上方
作用	设置指定异常的处理方案，功能等同于控制器方法， 出现异常后终止原始控制器执行,并转入当前方法执行

说明：此类方法可以根据处理的异常不同，制作多个方法分别处理对应的异常

项目异常处理方案

异常分类

因为异常的种类有很多，需要对异常进行分类处理:

• 业务异常（BusinessException）

  • 规范的用户行为产生的异常
    • 用户在页面输入内容的时候未按照指定格式进行数据填写，如在年龄框输入的是字符串
  • 不规范的用户行为操作产生的异常
    • 如用户故意传递错误数据

• 系统异常（SystemException）

  • 项目运行过程中可预计但无法避免的异常
    • 比如数据库或服务器宕机

• 其他异常（Exception）

  • 编程人员未预期到的异常，如:使用文件不存在、IO错误

将异常分类以后，针对不同类型的异常，要提供具体的解决方案:

异常解决方案

• 业务异常（BusinessException）
  • 发送对应消息传递给用户，提醒规范操作
    • 常见操作：提示用户名已存在，密码格式不符合要求等
• 系统异常（SystemException）
  • 发送固定消息传递给用户，安抚用户
    • 系统繁忙，请稍后再试
    • 系统正在维护升级，请稍后再试
    • 系统出问题，请联系系统管理员等
  • 发送特定消息给运维人员，提醒维护
    • 可以发送短信、邮箱或者是公司内部通信软件
  • 记录日志
    • 发消息和记录日志对用户来说是不可见的，属于后台程序
• 其他异常（Exception）
  • 发送固定消息传递给用户，安抚用户
  • 发送特定消息给编程人员，提醒维护（纳入预期范围内）
    • 一般是程序没有考虑全，比如未做非空校验等
  • 记录日志

异常解决方案的具体实现

思路:

1.先通过自定义异常，完成BusinessException和SystemException的定义

2.将其他异常包装成自定义异常类型

3.在异常处理器类中对不同的异常进行处理

步骤1:自定义异常类

//自定义异常处理器，用于封装异常信息，对异常进行分类
public class SystemException extends RuntimeException{
}

//自定义异常处理器，用于封装异常信息，对异常进行分类
public class BusinessException extends RuntimeException{
}

说明:

• 让自定义异常类继承RuntimeException的好处是，后期在抛出这两个异常的时候，就不用在try...catch...或throws了
• 自定义异常类中添加code属性的原因是为了更好的区分异常是来自哪个业务的

步骤2:将其他异常包成自定义异常

public Book getById(Integer id) {
    //模拟业务异常，包装成自定义异常
    if(id == 1){
        throw new BusinessException(Code.BUSINESS_ERR,"请不要使用你的技术挑战我的耐性!");
    }
    //模拟系统异常，将可能出现的异常进行包装，转换成自定义异常
    try{
        int i = 1/0;
    }catch (Exception e){
        throw new SystemException(Code.SYSTEM_TIMEOUT_ERR,"服务器访问超时，请重试!",e);
    }
    return bookDao.getById(id);
}

具体的包装方式有：

• 方式一: try{}catch(){}在catch中重新throw自定义异常即可。
• 方式二: 直接throw自定义异常即可

上面为了使code看着更专业些，我们在Code类中再新增需要的属性

//状态码
public class Code {
    public static final Integer SAVE_OK = 20011;
    public static final Integer DELETE_OK = 20021;
    public static final Integer UPDATE_OK = 20031;
    public static final Integer GET_OK = 20041;

    public static final Integer SAVE_ERR = 20010;
    public static final Integer DELETE_ERR = 20020;
    public static final Integer UPDATE_ERR = 20030;
    public static final Integer GET_ERR = 20040;
    public static final Integer SYSTEM_ERR = 50001;
    public static final Integer SYSTEM_TIMEOUT_ERR = 50002;
    public static final Integer SYSTEM_UNKNOW_ERR = 59999;

    public static final Integer BUSINESS_ERR = 60002;
}

步骤3:处理器类中处理自定义异常

//@RestControllerAdvice用于标识当前类为REST风格对应的异常处理器
@RestControllerAdvice
public class ProjectExceptionAdvice {
    //@ExceptionHandler用于设置当前处理器类对应的异常类型
    @ExceptionHandler(SystemException.class)
    public Result doSystemException(SystemException ex){
        //记录日志
        //发送消息给运维
        //发送邮件给开发人员,ex对象发送给开发人员
        return new Result(ex.getCode(),null,ex.getMessage());
    }

    @ExceptionHandler(BusinessException.class)
    public Result doBusinessException(BusinessException ex){
        return new Result(ex.getCode(),null,ex.getMessage());
    }

    //除了自定义的异常处理器，保留对Exception类型的异常处理，用于处理非预期的异常
    @ExceptionHandler(Exception.class)
    public Result doOtherException(Exception ex){
        //记录日志
        //发送消息给运维
        //发送邮件给开发人员,ex对象发送给开发人员
        return new Result(Code.SYSTEM_UNKNOW_ERR,null,"系统繁忙，请稍后再试！");
    }
}

步骤4:运行程序

根据ID查询，

如果传入的参数为1，会报BusinessException

如果传入的是其他参数，会报SystemException

不管后台哪一层抛出异常，都会以与前端约定好的方式进行返回，前端只需要把信息获取到，根据返回的正确与否来展示不同的内容即可。

小结

以后项目中的异常处理方式为:

前后台协议联调

环境准备

• 创建一个Web的Maven项目
• pom.xml添加SSM整合所需jar包
• 创建对应的配置类
• 编写Controller、Service接口、Service实现类、Dao接口和模型类
• resources下提供jdbc.properties配置文件

内容参考前面的项目或者直接使用前面的项目进行本节内容的学习。

最终创建好的项目结构如下:

1. 将资料\SSM功能页面下面的静态资源拷贝到webapp下。

2. 因为添加了静态资源，SpringMVC会拦截，所有需要在SpringConfig的配置类中将静态资源进行放行。

• 新建SpringMvcSupport

  @Configuration
  public class SpringMvcSupport extends WebMvcConfigurationSupport {
      @Override
      protected void addResourceHandlers(ResourceHandlerRegistry registry) {
          registry.addResourceHandler("/pages/**").addResourceLocations("/pages/");
          registry.addResourceHandler("/css/**").addResourceLocations("/css/");
          registry.addResourceHandler("/js/**").addResourceLocations("/js/");
          registry.addResourceHandler("/plugins/**").addResourceLocations("/plugins/");
      }
  }
  

• 在SpringMvcConfig中扫描SpringMvcSupport

  @Configuration
  @ComponentScan({"com.itheima.controller","com.itheima.config"})
  @EnableWebMvc
  public class SpringMvcConfig {
  }
  

将所有的列表查询、新增、修改、删除等功能一个个来实现下，具体实现参见 springmvc_11_page。

拦截器

学习如下内容:

• 拦截器概念
• 入门案例
• 拦截器参数
• 拦截器工作流程分析

拦截器概念

讲解拦截器的概念之前，先看一张图:

(1)浏览器发送一个请求会先到Tomcat的web服务器

(2)Tomcat服务器接收到请求以后，会去判断请求的是静态资源还是动态资源

(3)如果是静态资源，会直接到Tomcat的项目部署目录下去直接访问

(4)如果是动态资源，就需要交给项目的后台代码进行处理

(5)在找到具体的方法之前，我们可以去配置过滤器(可以配置多个)，按照顺序进行执行

(6)然后进入到到中央处理器(SpringMVC中的内容)，SpringMVC会根据配置的规则进行拦截

(7)如果满足规则，则进行处理，找到其对应的controller类中的方法进行执行,完成后返回结果

(8)如果不满足规则，则不进行处理

(9)这个时候，如果我们需要在每个Controller方法执行的前后添加业务，具体该如何来实现?

这个就是拦截器要做的事。

• 拦截器（Interceptor）是一种动态拦截方法调用的机制，在SpringMVC中动态拦截控制器方法的执行
• 作用:
  • 在指定的方法调用前后执行预先设定的代码
  • 阻止原始方法的执行
  • 总结：拦截器就是用来做增强

看完以后，大家会发现

• 拦截器和过滤器在作用和执行顺序上也很相似

思考:拦截器和过滤器之间的区别是什么?

• 归属不同：Filter属于Servlet技术，Interceptor属于SpringMVC技术
• 拦截内容不同：Filter对所有访问进行增强，Interceptor仅针对SpringMVC的访问进行增强

拦截器入门案例

拦截器开发

步骤1:创建拦截器类

让类实现HandlerInterceptor接口，重写接口中的三个方法。

@Component
//定义拦截器类，实现HandlerInterceptor接口
//注意当前类必须受Spring容器控制
public class ProjectInterceptor implements HandlerInterceptor {
    @Override
    //原始方法调用前执行的内容
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("preHandle...");
        return true;
    }

    @Override
    //原始方法调用后执行的内容
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("postHandle...");
    }

    @Override
    //原始方法调用完成后执行的内容
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("afterCompletion...");
    }
}

**注意:**拦截器类要被SpringMVC容器扫描到。

步骤2:配置拦截器类

@Configuration
public class SpringMvcSupport extends WebMvcConfigurationSupport {
    @Autowired
    private ProjectInterceptor projectInterceptor;

    @Override
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/pages/**").addResourceLocations("/pages/");
    }

    @Override
    protected void addInterceptors(InterceptorRegistry registry) {
        //配置拦截器
        registry.addInterceptor(projectInterceptor).addPathPatterns("/books","/books/*" );
    }
}

步骤3:SpringMVC添加SpringMvcSupport包扫描

@Configuration
@ComponentScan({"com.itheima.controller","com.itheima.config"})
@EnableWebMvc
public class SpringMvcConfig{
   
}

步骤4:运行程序测试

使用PostMan发送http://localhost/books

注意：拦截器中的preHandler方法，如果返回true,则代表放行，会执行原始Controller类中要请求的方法，如果返回false，则代表拦截，后面的就不会再执行了。

拦截器的执行流程:

当有拦截器后，请求会先进入preHandle方法，

• 如果方法返回true，则放行继续执行后面的handle[controller的方法]和后面的方法
• 如果返回false，则直接跳过后面方法的执行。

拦截器参数

前置处理方法

原始方法之前运行preHandle

public boolean preHandle(HttpServletRequest request,
                         HttpServletResponse response,
                         Object handler) throws Exception {
    System.out.println("preHandle");
    return true;
}

• request:请求对象
• response:响应对象
• handler:被调用的处理器对象，本质上是一个方法对象，对反射中的Method对象进行了再包装

使用request对象可以获取请求数据中的内容，如获取请求头的Content-Type

public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
    String contentType = request.getHeader("Content-Type");
    System.out.println("preHandle..."+contentType);
    return true;
}

使用handler参数，可以获取方法的相关信息

public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
    HandlerMethod hm = (HandlerMethod)handler;
    String methodName = hm.getMethod().getName();//可以获取方法的名称
    System.out.println("preHandle..."+methodName);
    return true;
}

后置处理方法

原始方法运行后运行，如果原始方法被拦截，则不执行

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

前三个参数和上面的是一致的。

modelAndView:如果处理器执行完成具有返回结果，可以读取到对应数据与页面信息，并进行调整。

完成处理方法

拦截器最后执行的方法，无论原始方法是否执行

public void afterCompletion(HttpServletRequest request,
                            HttpServletResponse response,
                            Object handler,
                            Exception ex) throws Exception {
    System.out.println("afterCompletion");
}

前三个参数与上面的是一致的。

ex:如果处理器执行过程中出现异常对象，可以针对异常情况进行单独处理。

这三个方法中，最常用的是preHandle,在这个方法中可以通过返回值来决定是否要进行放行。可以把业务逻辑放在该方法中，如果满足业务则返回true放行，不满足则返回false拦截。

拦截器链配置

配置多个拦截器

步骤1:创建拦截器类

实现接口，并重写接口中的方法

@Component
public class ProjectInterceptor2 implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("preHandle...222");
        return false;
    }

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

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("afterCompletion...222");
    }
}

步骤2:配置拦截器类

@Configuration
@ComponentScan({"com.itheima.controller"})
@EnableWebMvc
//实现WebMvcConfigurer接口可以简化开发，但具有一定的侵入性
public class SpringMvcConfig implements WebMvcConfigurer {
    @Autowired
    private ProjectInterceptor projectInterceptor;
    @Autowired
    private ProjectInterceptor2 projectInterceptor2;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        //配置多拦截器
        registry.addInterceptor(projectInterceptor).addPathPatterns("/books","/books/*");
        registry.addInterceptor(projectInterceptor2).addPathPatterns("/books","/books/*");
    }
}

步骤3:运行程序，观察顺序

拦截器执行的顺序是和配置顺序有关，先进后出。

• 当配置多个拦截器时，形成拦截器链
• 拦截器链的运行顺序参照拦截器添加顺序为准
• 当拦截器中出现对原始处理器的拦截，后面的拦截器均终止运行
• 当拦截器运行中断，仅运行配置在前面的拦截器的afterCompletion操作

• preHandle：与配置顺序相同，必定运行
• postHandle:与配置顺序相反，可能不运行
• afterCompletion:与配置顺序相反，可能不运行。

这个顺序不太好记，最终只需要把握住一个原则即可:以最终的运行结果为准