SpringMVC总结

springMVC

SpringMVC是隶属于Spring框架的一部分，主要是用来进行Web开发，是对Servlet进行了封装。

对于SpringMVC我们主要学习如下内容:

• SpringMVC简介

• 请求与响应

• REST风格

• SSM整合(注解版)

• 拦截器

SpringMVC是处理Web层/表现层的框架，所以其主要的作用就是用来接收前端发过来的请求和数据然后经过处理并将处理的结果响应给前端，所以如何处理请求和响应是SpringMVC中非常重要的一块内容。

REST是一种软件架构风格，可以降低开发的复杂性，提高系统的可伸缩性，后期的应用也是非常广泛。

SSM整合是把咱们所学习的SpringMVC+Spring+Mybatis整合在一起来完成业务开发，是对我们所学习这三个框架的一个综合应用。

对于SpringMVC的学习，最终要达成的目标:

1. 掌握基于SpringMVC获取请求参数和响应json数据操作
2. 熟练应用基于REST风格的请求路径设置与参数传递
3. 能够根据实际业务建立前后端开发通信协议并进行实现
4. 基于SSM整合技术开发任意业务模块功能

1. SpringMVC概述

学习SpringMVC我们先来回顾下现在web程序是如何做的，咱们现在web程序大都基于三层架构来实现。

三层架构:

• 浏览器发送一个请求给后端服务器，后端服务器现在是使用Servlet来接收请求和数据

• 如果所有的处理都交给Servlet来处理的话，所有的东西都耦合在一起，对后期的维护和扩展极为不利

• 将后端服务器Servlet拆分成三层，分别是web、service和dao

• • web层主要由servlet来处理，负责页面请求和数据的收集以及响应结果给前端
• • service层主要负责业务逻辑的处理
• • dao层主要负责数据的增删改查操作

• servlet处理请求和数据的时候，存在的问题是一个servlet只能处理一个请求

• 针对web层进行了优化，采用了MVC设计模式，将其设计为controller、view和Model

• • controller负责请求和数据的接收，接收后将其转发给service进行业务处理
• • service根据需要会调用dao对数据进行增删改查
• • dao把数据处理完后将结果交给service,service再交给controller
• • controller根据需求组装成Model和View,Model和View组合起来生成页面转发给前端浏览器
• • 这样做的好处就是controller可以处理多个请求，并对请求进行分发，执行不同的业务操作。

随着互联网的发展，上面的模式因为是同步调用，性能慢慢的跟不是需求，所以异步调用慢慢的走到了前台，是现在比较流行的一种处理方式。

• 因为是异步调用，所以后端不需要返回view视图，将其去除

• 前端如果通过异步调用的方式进行交互，后台就需要将返回的数据转换成json格式进行返回

• SpringMVC主要负责的就是

• • controller如何接收请求和数据
• • 如何将请求和数据转发给业务层
• • 如何将响应数据转换成json发回到前端

介绍了这么多，对SpringMVC进行一个定义

• SpringMVC是一种基于java实现MVC模型的轻量级Web框架

• 优点

• • 使用简单、开发便捷(相比于Servlet)
• • 灵活性强

这里所说的优点，就需要我们在使用的过程中慢慢体会。

2.SpringMVC入门案例

2.1 SpringMVC实现流程：

SpringMVC的具体实现流程：

1.创建web工程(Maven结构)

2.设置tomcat服务器，加载web工程(tomcat插件)

3.导入坐标(SpringMVC+Servlet)

4.定义处理请求的功能类(UserController)

@Controller
public class UserController {
    
    @RequestMapping("/save")
    @ResponseBody
    public void save(){
        System.out.println("user save ...");
    }
}

5.设置SpringMVC的配置类

@Configuration
@***ponentScan("***.itheima.controller")
public class SpringMv***onfig {
}

6.将SpringMVC设定加载到Tomcat容器中,设置请求映射(配置映射关系)

public class ServletContainersInitConfig extends AbstractDispatcherServletInitializer {
    //加载springmvc配置类
    protected WebApplicationContext createServletApplicationContext() {
        //初始化WebApplicationContext对象
        AnnotationConfigWebApplicationContext ctx = new AnnotationConfigWebApplicationContext();
        //加载指定配置类
        ctx.register(SpringMv***onfig.class);
        return ctx;
    }

    //设置由springmvc控制器处理的请求映射路径
    protected String[] getServletMappings() {
        return new String[]{"/"};
    }

    //加载spring配置类
    protected WebApplicationContext createRootApplicationContext() {
        return null;
    }
}

对于上述的配置方式，Spring还提供了一种更简单的配置方式，可以不用再去创建AnnotationConfigWebApplicationContext对象，不用手动register对应的配置类，如何实现?

public class ServletContainersInitConfig extends AbstractAnnotationConfigDispatcherServletInitializer {

    protected Class<?>[] getRootConfigClasses() {
        return new Class[]{SpringConfig.class};
    }

    protected Class<?>[] getServletConfigClasses() {
        return new Class[]{SpringMv***onfig.class};
    }

    protected String[] getServletMappings() {
        return new String[]{"/"};
    }
}

知识点1：@Controller

知识点2：@RequestMapping

知识点3：@ResponseBody

2.2 入门案例总结

• 一次性工作

• • 创建工程，设置服务器，加载工程
• • 导入坐标
• • 创建web容器启动类，加载SpringMVC配置，并设置SpringMVC请求拦截路径
• • SpringMVC核心配置类（设置配置类，扫描controller包，加载Controller控制器bean）

• 多次工作

• • 定义处理请求的控制器类
• • 定义处理请求的控制器方法，并配置映射路径（@RequestMapping）与返回json数据（@ResponseBody）

2.3 工作流程解析

为了更好的使用SpringMVC,我们将SpringMVC的使用过程总共分两个阶段来分析，分别是启动服务器初始化过程和单次请求过程

2.3.1 启动服务器初始化过程

1. 服务器启动，执行ServletContainersInitConfig类，初始化web容器

• • 功能类似于以前的web.xml

2. 执行createServletApplicationContext方法，创建了WebApplicationContext对象

• • 该方法加载SpringMVC的配置类SpringMv***onfig来初始化SpringMVC的容器

3. 加载SpringMv***onfig配置类
   

4. 执行@***ponentScan加载对应的bean

• • 扫描指定包及其子包下所有类上的注解，如Controller类上的@Controller注解

5. 加载UserController，每个@RequestMapping的名称对应一个具体的方法
   

• • 此时就建立了 /save 和 save方法的对应关系

6. 执行getServletMappings方法，设定SpringMVC拦截请求的路径规则
   

• • /代表所拦截请求的路径规则，只有被拦截后才能交给SpringMVC来处理请求

2.3.2 单次请求过程

1. 发送请求http://localhost/save

2. web容器发现该请求满足SpringMVC拦截规则，将请求交给SpringMVC处理

3. 解析请求路径/save

4. 由/save匹配执行对应的方法save(）

• • 上面的第五步已经将请求路径和方法建立了对应关系，通过/save就能找到对应的save方法

5. 执行save()

6. 检测到有@ResponseBody直接将save()方法的返回值作为响应体返回给请求方

3. 请求与响应

SpringMVC是web层的框架，主要的作用是接收请求、接收数据、响应结果，所以这一章节是学习SpringMVC的重点内容，我们主要会讲解四部分内容:

• 请求映射路径

• 请求参数

• 日期类型参数传递

• 响应json数据

3.1 设置请求映射路径

@Controller
@RequestMapping("/user")
public class UserController {

    @RequestMapping("/save")
    @ResponseBody
    public String save(){
        System.out.println("user save ...");
        return "{'module':'user save'}";
    }
    
    @RequestMapping("/delete")
    @ResponseBody
    public String save(){
        System.out.println("user delete ...");
        return "{'module':'user delete'}";
    }
}

@Controller
@RequestMapping("/book")
public class BookController {

    @RequestMapping("/save")
    @ResponseBody
    public String save(){
        System.out.println("book save ...");
        return "{'module':'book save'}";
    }
}

3.2 请求参数

GET发送参数及中文乱码

发送请求与参数:

接收参数：

@Controller
public class UserController {

    @RequestMapping("/***monParam")
    @ResponseBody
    public String ***monParam(String name,int age){
        System.out.println("普通参数传递 name ==> "+name);
        System.out.println("普通参数传递 age ==> "+age);
        return "{'module':'***monParam'}";
    }
}

中文乱码解决方案：

修改pom.xml

<build>
    <plugins>
      <plugin>
        <groupId>org.apache.tomcat.maven</groupId>
        <artifactId>tomcat7-maven-plugin</artifactId>
        <version>2.1</version>
        <configuration>
          <port>80</port><!--tomcat端口号-->
          <path>/</path> <!--虚拟目录-->
          <uriEncoding>UTF-8</uriEncoding><!--访问路径编解码字符集-->
        </configuration>
      </plugin>
    </plugins>
  </build>

POST发送参数及中文乱码

发送请求与参数:

接收参数：

和GET一致，不用做任何修改

@Controller
public class UserController {

    @RequestMapping("/***monParam")
    @ResponseBody
    public String ***monParam(String name,int age){
        System.out.println("普通参数传递 name ==> "+name);
        System.out.println("普通参数传递 age ==> "+age);
        return "{'module':'***monParam'}";
    }
}

中文乱码解决方案：

配置过滤器（在web容器配置类中）

public class ServletContainersInitConfig extends AbstractAnnotationConfigDispatcherServletInitializer {
    protected Class<?>[] getRootConfigClasses() {
        return new Class[0];
    }

    protected Class<?>[] getServletConfigClasses() {
        return new Class[]{SpringMv***onfig.class};
    }

    protected String[] getServletMappings() {
        return new String[]{"/"};
    }

    //乱码处理
    @Override
    protected Filter[] getServletFilters() {
        CharacterEncodingFilter filter = new CharacterEncodingFilter();
        filter.setEncoding("UTF-8");
        return new Filter[]{filter};
    }
}

3.3 五种类型参数传递

常见的参数种类有:

• 普通参数

• POJO类型参数

• 嵌套POJO类型参数

• 数组类型参数

• 集合类型参数

3.3.1 普通参数

如果形参与地址参数名不一致该如何解决？

解决方案:使用@RequestParam注解

@RequestMapping("/***monParamDifferentName")
    @ResponseBody
    public String ***monParamDifferentName(@RequestParam("name") String userName , int age){
        System.out.println("普通参数传递 userName ==> "+userName);
        System.out.println("普通参数传递 age ==> "+age);
        return "{'module':'***mon param different name'}";
    }

注意:写上@RequestParam注解框架就不需要自己去解析注入，能提升框架处理性能

3.3.2 POJO数据类型

简单数据类型一般处理的是参数个数比较少的请求，如果参数比较多，那么后台接收参数的时候就比较复杂，这个时候我们可以考虑使用POJO数据类型。

• POJO参数：请求参数名与形参对象属性名相同，定义POJO类型形参即可接收参数

此时需要使用前面准备好的POJO类，先来看下User

public class User {
    private String name;
    private int age;
    //setter...getter...略
}

发送请求和参数:

后台接收参数:

//POJO参数：请求参数与形参对象中的属性对应即可完成参数传递
@RequestMapping("/pojoParam")
@ResponseBody
public String pojoParam(User user){
    System.out.println("pojo参数传递 user ==> "+user);
    return "{'module':'pojo param'}";
}

注意:

• POJO参数接收，前端GET和POST发送请求数据的方式不变。
• 请求参数key的名称要和POJO中属性的名称一致，否则无法封装。

3.3.3 嵌套POJO类型参数

如果POJO对象中嵌套了其他的POJO类，如

public class Address {
    private String province;
    private String city;
    //setter...getter...略
}
public class User {
    private String name;
    private int age;
    private Address address;
    //setter...getter...略
}

• 嵌套POJO参数：请求参数名与形参对象属性名相同，按照对象层次结构关系即可接收嵌套POJO属性参数

发送请求和参数:

后台接收参数:

//POJO参数：请求参数与形参对象中的属性对应即可完成参数传递
@RequestMapping("/pojoParam")
@ResponseBody
public String pojoParam(User user){
    System.out.println("pojo参数传递 user ==> "+user);
    return "{'module':'pojo param'}";
}

注意:

请求参数key的名称要和POJO中属性的名称一致，否则无法封装

3.3.4 数组类型参数

• 数组参数：请求参数名与形参对象属性名相同且请求参数为多个，定义数组类型即可接收参数

发送请求和参数:

后台接收参数:

  //数组参数：同名请求参数可以直接映射到对应名称的形参数组对象中
    @RequestMapping("/arrayParam")
    @ResponseBody
    public String arrayParam(String[] likes){
        System.out.println("数组参数传递 likes ==> "+ Arrays.toString(likes));
        return "{'module':'array param'}";
    }

3.3.5 集合类型参数

发送请求和参数:

后端接收参数：

使用@RequestParam注解

//集合参数：同名请求参数可以使用@RequestParam注解映射到对应名称的集合对象中作为数据
@RequestMapping("/listParam")
@ResponseBody
public String listParam(@RequestParam List<String> likes){
    System.out.println("集合参数传递 likes ==> "+ likes);
    return "{'module':'list param'}";
}

如果不加@RequestParam运行会报错，

错误的原因是:SpringMVC将List看做是一个POJO对象来处理，将其创建一个对象并准备把前端的数据封装到对象中，但是List是一个接口无法创建对象，所以报错。

• 集合保存普通参数：请求参数名与形参集合对象名相同且请求参数为多个，@RequestParam绑定参数关系

• 对于简单数据类型使用数组会比集合更简单些。

知识点1：@RequestParam

3.4 JSON数据传输参数

现在比较流行的开发方式为异步调用。前后台以异步方式进行交换，传输的数据使用的是JSON,

对于JSON数据类型，我们常见的有三种:

• json普通数组（[“value1”,“value2”,“value3”,…]）

• json对象（{key1:value1,key2:value2,…}）

• json对象数组（[{key1:value1,…},{key2:value2,…}]）

对于上述数据，前端如何发送，后端如何接收?

3.4.1 JSON普通数组

步骤：

1. 添加jackson依赖（用来处理json的转换）

2. postman发送JSON数据

3. 开启SpringMVC注解支持@EnableWebMvc,其中一个功能就是支持将JSON转换成对象

@Configuration
@***ponentScan("***.itheima.controller")
//开启json数据类型自动转换
@EnableWebMvc
public class SpringMv***onfig {
}

4. 参数前添加@RequsetBody

//使用@RequestBody注解将外部传递的json数组数据映射到形参的集合对象中作为数据
@RequestMapping("/listParamForJson")
@ResponseBody
public String listParamForJson(@RequestBody List<String> likes){
    System.out.println("list ***mon(json)参数传递 list ==> "+likes);
    return "{'module':'list ***mon for json param'}";
}

3.4.2 JSON对象数据

请求和数据的发送:

后端接收数据：

@RequestMapping("/pojoParamForJson")
@ResponseBody
public String pojoParamForJson(@RequestBody User user){
    System.out.println("pojo(json)参数传递 user ==> "+user);
    return "{'module':'pojo for json param'}";
}

3.4.3 JSON对象数组

请求和数据的发送:

后端接收数据:

@RequestMapping("/listPojoParamForJson")
@ResponseBody
public String listPojoParamForJson(@RequestBody List<User> list){
    System.out.println("list pojo(json)参数传递 list ==> "+list);
    return "{'module':'list pojo for json param'}";
}

小结

SpringMVC接收JSON数据的实现步骤为:

(1)导入jackson包

(2)使用PostMan发送JSON数据

(3)开启SpringMVC注解驱动，在配置类上添加@EnableWebMvc注解

(4)Controller方法的参数前添加@RequestBody注解

知识点1：@EnableWebMvc

知识点2：@RequestBody

@RequestBody与@RequestParam区别

• 区别

• • @RequestParam用于接收url地址传参，表单传参【application/x-www-form-urlencoded】(主要是针对形参名与请求参数名不一致，以及传递集合的情况)
• • @RequestBody用于接收json数据【application/json】

• 应用

• • 后期开发中，发送json格式数据为主，@RequestBody应用较广
• • 如果发送非json格式数据，选用@RequestParam接收请求参数

3.5 日期类型参数传递

对于日期的格式有N多中输入方式，比如:

• 2088-08-18

• 2088/08/18

• 08/18/2088

• …

前端发送请求和参数：

后端接收日期类型的参数：

使用@DateTimeFormat

@RequestMapping("/dataParam")
@ResponseBody
public String dataParam(Date date,
                        @DateTimeFormat(pattern="yyyy-MM-dd") Date date1,
                        @DateTimeFormat(pattern="yyyy/MM/dd HH:mm:ss") Date date2)
    System.out.println("参数传递 date ==> "+date);
	System.out.println("参数传递 date1(yyyy-MM-dd) ==> "+date1);
	System.out.println("参数传递 date2(yyyy/MM/dd HH:mm:ss) ==> "+date2);
    return "{'module':'data param'}";
}

知识点1：@DateTimeFormat

3.6 响应

对于响应，主要就包含两部分内容：

• 响应页面

• 响应数据

• • 文本数据
• • json数据

3.6.1 响应页面[了解]

@Controller
public class UserController {
    
    @RequestMapping("/toJumpPage")
    //注意
    //1.此处不能添加@ResponseBody,如果加了该注入，会直接将page.jsp当字符串返回前端
    //2.方法需要返回String
    public String toJumpPage(){
        System.out.println("跳转页面");
        //此处应该是转发操作
        return "page.jsp";
    }
    
}

3.6.2 返回文本数据[了解]

@Controller
public class UserController {
    
   	@RequestMapping("/toText")
	//注意此处该注解就不能省略，如果省略了,会把response text当前页面名称去查找，如果没有回报404错误
    @ResponseBody
    public String toText(){
        System.out.println("返回纯文本数据");
        return "response text";
    }
    
}

3.6.3 响应JSON数据

响应POJO对象

@Controller
public class UserController {
    
    @RequestMapping("/toJsonPOJO")
    @ResponseBody
    public User toJsonPOJO(){
        System.out.println("返回json对象数据");
        User user = new User();
        user.setName("itcast");
        user.setAge(15);
        return user;
    }
    
}

返回值为实体类对象，设置返回值为实体类类型，即可实现返回对应对象的json数据，需要依赖==@ResponseBody注解和@EnableWebMvc==注解

响应POJO集合对象

@Controller
public class UserController {
    
    @RequestMapping("/toJsonList")
    @ResponseBody
    public List<User> toJsonList(){
        System.out.println("返回json集合数据");
        User user1 = new User();
        user1.setName("传智播客");
        user1.setAge(15);

        User user2 = new User();
        user2.setName("黑马程序员");
        user2.setAge(12);

        List<User> userList = new ArrayList<User>();
        userList.add(user1);
        userList.add(user2);

        return userList;
    }
    
}

知识点1：@ResponseBody

• 当方法上有@ReponseBody注解后

• • 方法的返回值为字符串，会将其作为文本内容直接响应给前端
• • 方法的返回值为对象，会将对象转换成JSON响应给前端

4.Rest风格

对于Rest风格，我们需要学习的内容包括:

• REST简介

• REST入门案例

• REST快速开发

• 案例:基于RESTful页面数据交互

4.1REST简介

• REST（Representational State Transfer），表现形式状态转换,它是一种软件架构风格
  当我们想表示一个网络资源的时候，可以使用两种方式:

• • 传统风格资源描述形式
• • • http://localhost/user/getById?id=1 查询id为1的用户信息
• • • http://localhost/user/saveUser 保存用户信息
• • REST风格描述形式
• • • http://localhost/user/1
• • • http://localhost/user

REST的优点有:

• 隐藏资源的访问行为，无法通过地址得知对资源是何种操作

• 书写简化

但是一个相同的url地址即可以是新增也可以是修改或者查询，那么到底我们该如何区分该请求到底是什么操作呢?

• 按照REST风格访问资源时使用行为动作区分对资源进行了何种操作

• • http://localhost/users 查询全部用户信息 GET（查询）
• • http://localhost/users/1 查询指定用户信息 GET（查询）
• • http://localhost/users 添加用户信息 POST（新增/保存）
• • http://localhost/users 修改用户信息 PUT（修改/更新）
• • http://localhost/users/1 删除用户信息 DELETE（删除）

PS:根据REST风格对资源（后台服务）进行访问称为RESTful。

4.2 RestFul入门案例

1.创建web的maven项目，导入坐标

2.创建servlet，springmvc配置类

3.编写pojo类Book

4.编写BookController控制器类

部分代码如下：

save方法：

@RequestMapping(value = "/users",method = RequestMethod.POST)
    @ResponseBody
    public String save(@RequestBody Book book){
        System.out.println("book save..." + book);
        return "{'module':'book save'}";
    }

delete方法：
后端获取参数，需要做如下修改:
● 修改@RequestMapping的value属性，将其中修改为/users/{id}，目的是和路径匹配
● 在方法的形参前添加@PathVariable注解

@Controller
public class UserController {
    //设置当前请求方法为DELETE，表示REST风格中的删除操作
	@RequestMapping(value = "/users/{id}/{name}",method = RequestMethod.DELETE)
    @ResponseBody
    public String delete(@PathVariable Integer id,@PathVariable String name) {
        System.out.println("user delete..." + id+","+name);
        return "{'module':'user delete'}";
    }
}

小结

RESTful入门案例，我们需要学习的内容如下:

(1)设定Http请求动作(动词)

@RequestMapping(value=“”,method = RequestMethod.POST|GET|PUT|DELETE)

(2)设定请求参数(路径变量)

@RequestMapping(value=“/users/{id}”,method = RequestMethod.DELETE)

@ReponseBody

public String delete(@PathVariable Integer id){

}

知识点1：@PathVariable

接收参数的注解@RequestBody、@RequestParam、@PathVariable

关于接收参数，我们学过三个注解@RequestBody、@RequestParam、@PathVariable,这三个注解之间的区别和应用分别是什么?

• 区别

• • @RequestParam用于接收url地址传参或表单传参
• • @RequestBody用于接收json数据（请求体）
• • @PathVariable用于接收路径参数，使用 {参数名称} 描述路径参数

• 应用

• • 后期开发中，发送请求参数超过1个时，以json格式为主，@RequestBody应用较广
• • 如果发送非json格式数据，选用@RequestParam接收请求参数
• • 采用RESTful进行开发，当参数数量较少时，例如1个，可以采用@PathVariable接收请求路径变量，通常用于传递id值

4.3RestFul快速开发

知识点1：@RestController

知识点2：@GetMapping @PostMapping @PutMapping @DeleteMapping

4.4RestFul实例

后端：

编写Controller类并使用RESTful进行配置:

@RestController
@RequestMapping("/books")
public class BookController {
    @PostMapping
    public String save(@RequestBody Book book){
        System.out.println("book save ==> "+ book);
        return "{'module':'book save su***ess'}";
    }

    @GetMapping
    public List<Book> getAll(){
        System.out.println("book getAll is running ...");
        List<Book> bookList = new ArrayList<Book>();

        Book book1 = new Book();
        book1.setType("计算机");
        book1.setName("SpringMVC入门教程");
        book1.setDescription("小试牛刀");
        bookList.add(book1);

        Book book2 = new Book();
        book2.setType("计算机");
        book2.setName("SpringMVC实战教程");
        book2.setDescription("一代宗师");
        bookList.add(book2);

        Book book3 = new Book();
        book3.setType("计算机丛书");
        book3.setName("SpringMVC实战教程进阶");
        book3.setDescription("一代宗师呕心创作");
        bookList.add(book3);

        return bookList;
    }
}

前端：

想要访问静态资源时，由于SpringMVC拦截静态资源，导致无法访问：

(1)出现错误的原因?

SpringMVC拦截了静态资源，根据/pages/books.html去controller找对应的方法，找不到所以会报404的错误。

(2)SpringMVC为什么会拦截静态资源呢?

(3)解决方案?

• SpringMVC需要将静态资源进行放行。

@Configuration
public class SpringMvcSupport extends WebMv***onfigurationSupport {
    //设置静态资源访问过滤，当前类需要设置为配置类，并被扫描加载
    @Override
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        //当访问/pages/????时候，从/pages目录下查找内容
        registry.addResourceHandler("/pages/**").addResourceLocations("/pages/");
        registry.addResourceHandler("/js/**").addResourceLocations("/js/");
        registry.addResourceHandler("/css/**").addResourceLocations("/css/");
        registry.addResourceHandler("/plugins/**").addResourceLocations("/plugins/");
    }
}

• 该配置类是在config目录下，SpringMVC扫描的是controller包，所以该配置类还未生效，要想生效需要将SpringMv***onfig配置类进行修改

@Configuration
@***ponentScan({"***.itheima.controller","***.itheima.config"})
@EnableWebMvc
public class SpringMv***onfig {
}

或者

@Configuration
@***ponentScan("***.itheima")
@EnableWebMvc
public class SpringMv***onfig {
}

最后由html文件发送ajax异步请求调用controller的各个方法即可

                //添加
                saveBook () {
                    axios.post("/books",this.formData).then((res)=>{

                    });
                },

                //主页列表查询
                getAll() {
                    axios.get("/books").then((res)=>{
                        this.dataList = res.data;
                    });
                }

5.SSM整合

前面我们已经把Mybatis、Spring和SpringMVC三个框架进行了学习，今天主要的内容就是把这三个框架整合在一起完成我们的业务功能开发，具体如何来整合，我们一步步来学习。

流程分析:

5.1 创建工程

• 创建一个Maven的web工程

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

  <?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>***.itheima</groupId>
    <artifactId>springmvc_08_ssm</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>war</packaging>
  
    <dependencies>
      <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-webmvc</artifactId>
        <version>5.2.10.RELEASE</version>
      </dependency>
  
      <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-jdbc</artifactId>
        <version>5.2.10.RELEASE</version>
      </dependency>
  
      <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-test</artifactId>
        <version>5.2.10.RELEASE</version>
      </dependency>
  
      <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis</artifactId>
        <version>3.5.6</version>
      </dependency>
  
      <dependency>
        <groupId>org.mybatis</groupId>
        <artifactId>mybatis-spring</artifactId>
        <version>1.3.0</version>
      </dependency>
  
      <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>5.1.47</version>
      </dependency>
  
      <dependency>
        <groupId>***.alibaba</groupId>
        <artifactId>druid</artifactId>
        <version>1.1.16</version>
      </dependency>
  
      <dependency>
        <groupId>junit</groupId>
        <artifactId>junit</artifactId>
        <version>4.12</version>
        <scope>test</scope>
      </dependency>
  
      <dependency>
        <groupId>javax.servlet</groupId>
        <artifactId>javax.servlet-api</artifactId>
        <version>3.1.0</version>
        <scope>provided</scope>
      </dependency>
  
      <dependency>
        <groupId>***.fasterxml.jackson.core</groupId>
        <artifactId>jackson-databind</artifactId>
        <version>2.9.0</version>
      </dependency>
    </dependencies>
  
    <build>
      <plugins>
        <plugin>
          <groupId>org.apache.tomcat.maven</groupId>
          <artifactId>tomcat7-maven-plugin</artifactId>
          <version>2.1</version>
          <configuration>
            <port>80</port>
            <path>/</path>
          </configuration>
        </plugin>
      </plugins>
    </build>
  </project>
  

• 编写Web项目的入口配置类ServletConfig，实现AbstractAnnotationConfigDispatcherServletInitializer重写以下方法

• • getRootConfigClasses() ：返回Spring的配置类->需要SpringConfig配置类
• • getServletConfigClasses() ：返回SpringMVC的配置类->需要SpringMv***onfig配置类
• • getServletMappings() : 设置SpringMVC请求拦截路径规则
• • getServletFilters() ：设置过滤器，解决POST请求中文乱码问题

5.2 SSM整合[重点是各个配置的编写]

• SpringConfig

• • 标识该类为配置类 @Configuration
• • 扫描Service所在的包 @***ponentScan
• • 在Service层要管理事务 @EnableTransactionManagement
• • 读取外部的properties配置文件 @PropertySource

• • 整合Mybatis需要引入Mybatis相关配置类 @Import

• • • 第三方数据源配置类 Jdb***onfig
• • • • 构建DataSource数据源，DruidDataSouroce,需要注入数据库连接四要素， @Bean @Value

• • • • 构建平台事务管理器，DataSourceTransactionManager,@Bean

• • • Mybatis配置类 MybatisConfig
• • • • 构建SqlSessionFactoryBean并设置别名扫描与数据源，@Bean

• • • • 构建MapperScannerConfigurer并设置DAO层的包扫描 ，创建mapper接口的自动代理对象，@Bean

• SpringMv***onfig

• • 标识该类为配置类 @Configuration
• • 扫描Controller所在的包 @***ponentScan
• • 开启SpringMVC注解支持 @EnableWebMvc ,开启如转换json数据等多种辅助功能

5.3 功能模块[与具体的业务模块有关]

• 创建数据库表

• 根据数据库表创建对应的模型类pojo

• 通过Dao层完成数据库表的增删改查(接口+自动代理)

• 编写Service层[Service接口+实现类]

• • @Service
• • @Transactional

• ​

• • 整合Junit对业务层进行单元测试
• • • @RunWith
• • • @ContextConfiguration
• • • @Test

• 编写Controller层

• • 接收请求 @RequestMapping @GetMapping @PostMapping @PutMapping @DeleteMapping
• • 接收数据 简单、POJO、嵌套POJO、集合、数组、JSON数据类型
• • • @RequestParam
• • • @PathVariable
• • • @RequestBody
• • 转发业务层
• • • @Autowired
• • 响应结果
• • • @ResponseBody

PS：SSM整合完之后就可以进行junit测试service类以及postman测试controller类

6.统一结果封装

SSM整合以及功能模块开发完成后，接下来，我们在上述案例的基础上分析下有哪些问题需要我们去解决下。首先第一个问题是:

随着业务的增长，我们需要返回的数据类型会越来越多。对于前端开发人员在解析数据的时候就比较凌乱了，所以对于前端来说，如果后台能够返回一个统一的数据结果，前端在解析的时候就可以按照一种方式进行解析。开发就会变得更加简单。

所以我们就想能不能将返回结果的数据进行统一，具体如何来做，大体的思路为:

• 为了封装返回的结果数据:创建结果模型类，封装数据到data属性中

• 为了封装返回的数据是何种操作及是否操作成功:封装操作结果到code属性中

• 操作失败后为了封装返回的错误信息:封装特殊消息到message(msg)属性中

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

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...省略
}

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

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;
}

**注意:**code类中的常量设计也不是固定的，可以根据需要自行增减，例如将查询再进行细分为GET_OK,GET_ALL_OK,GET_PAGE_OK等。

3.修改Controller类的返回值为Result

//统一每一个控制器方法返回值
@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);
    }

    @PutMapping
    public Result update(@RequestBody Book book) {
        boolean flag = bookService.update(book);
        return new Result(flag ? Code.UPDATE_OK:Code.UPDATE_ERR,flag);
    }

    @DeleteMapping("/{id}")
    public Result delete(@PathVariable Integer id) {
        boolean flag = bookService.delete(id);
        return new Result(flag ? Code.DELETE_OK:Code.DELETE_ERR,flag);
    }

    @GetMapping("/{id}")
    public Result getById(@PathVariable Integer id) {
        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);
    }

    @GetMapping
    public Result getAll() {
        List<Book> bookList = bookService.getAll();
        Integer code = bookList != null ? Code.GET_OK : Code.GET_ERR;
        String msg = bookList != null ? "" : "数据查询失败，请重试！";
        return new Result(code,bookList,msg);
    }
}

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

7.统一异常处理

先来看下异常的种类及出现异常的原因:

• 框架内部抛出的异常：因使用不合规导致

• 数据层抛出的异常：因外部服务器故障导致（例如：服务器访问超时）

• 业务层抛出的异常：因业务逻辑书写错误导致（例如：遍历业务书写操作，导致索引异常等）

• 表现层抛出的异常：因数据收集、校验等规则导致（例如：不匹配的数据类型间导致异常）

• 工具类抛出的异常：因工具类书写不严谨不够健壮导致（例如：必要释放的连接长期未释放等）

思考

1. 各个层级均出现异常，异常处理代码书写在哪一层?
   所有的异常均抛出到表现层进行处理

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

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

7.1异常处理器

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

• 异常处理器:

• • 集中的、统一的处理项目中出现的异常，并返回数据给前端

知识点1：@RestControllerAdvice

知识点2：@ExceptionHandler

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

7.2项目异常处理方案

7.2.1异常分类

异常处理器我们已经能够使用了，那么在咱们的项目中该如何来处理异常呢?

因为异常的种类有很多，如果每一个异常都对应一个@ExceptionHandler，那得写多少个方法来处理各自的异常，所以我们在处理异常之前，需要对异常进行一个分类:

• 业务异常（BusinessException）

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

• 系统异常（SystemException）

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

• 其他异常（Exception）

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

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

7.2.2异常解决方案

• 业务异常（BusinessException）

• • 发送对应消息传递给用户，提醒规范操作
• • • 大家常见的就是提示用户名已存在或密码格式不正确等

• 系统异常（SystemException）

• • 发送固定消息传递给用户，安抚用户
• • • 系统繁忙，请稍后再试
• • • 系统正在维护升级，请稍后再试
• • • 系统出问题，请联系系统管理员等
• • 发送特定消息给运维人员，提醒维护
• • • 可以发送短信、邮箱或者是公司内部通信软件
• • 记录日志
• • • 发消息和记录日志对用户来说是不可见的，属于后台程序

• 其他异常（Exception）

• • 发送固定消息传递给用户，安抚用户
• • 发送特定消息给编程人员，提醒维护（纳入预期范围内）
• • • 一般是程序没有考虑全，比如未做非空校验等
• • 记录日志

7.2.3异常解决方案的具体表现

步骤1:自定义异常类

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

    public Integer getCode() {
        return code;
    }

    public void setCode(Integer code) {
        this.code = code;
    }

    public SystemException(Integer code, String message) {
        super(message);
        this.code = code;
    }

    public SystemException(Integer code, String message, Throwable cause) {
        super(message, cause);
        this.code = code;
    }

}

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

    public Integer getCode() {
        return code;
    }

    public void setCode(Integer code) {
        this.code = code;
    }

    public BusinessException(Integer code, String message) {
        super(message);
        this.code = code;
    }

    public BusinessException(Integer code, String message, Throwable cause) {
        super(message, cause);
        this.code = code;
    }

}

说明:

• 让自定义异常类继承RuntimeException的好处是，后期在抛出这两个异常的时候，就不用在try…catch…或throws了

• 自定义异常类中添加code属性的原因是为了更好的区分异常是来自哪个业务的

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

假如在BookServiceImpl的getById方法抛异常了，该如何来包装呢?

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,"系统繁忙，请稍后再试！");
    }
}

8.前后台协议协调

项目结构：

<!DOCTYPE html>

<html>

    <head>

        <!-- 页面meta -->

        <meta charset="utf-8">

        <meta http-equiv="X-UA-***patible" content="IE=edge">

        <title>SpringMVC案例</title>

        <meta content="width=device-width,initial-scale=1,maximum-scale=1,user-scalable=no" name="viewport">

        <!-- 引入样式 -->

        <link rel="stylesheet" href="../plugins/elementui/index.css">

        <link rel="stylesheet" href="../plugins/font-awesome/css/font-awesome.min.css">

        <link rel="stylesheet" href="../css/style.css">

    </head>

    <body class="hold-transition">

        <div id="app">

            <div class="content-header">

                <h1>图书管理</h1>

            </div>

            <div class="app-container">

                <div class="box">

                    <div class="filter-container">

                        <el-input placeholder="图书名称" v-model="pagination.queryString" style="width: 200px;" class="filter-item"></el-input>

                        <el-button @click="getAll()" class="dalfBut">查询</el-button>

                        <el-button type="primary" class="butT" @click="handleCreate()">新建</el-button>

                    </div>

                    <el-table size="small" current-row-key="id" :data="dataList" stripe highlight-current-row>

                        <el-table-column type="index" align="center" label="序号"></el-table-column>

                        <el-table-column prop="type" label="图书类别" align="center"></el-table-column>

                        <el-table-column prop="name" label="图书名称" align="center"></el-table-column>

                        <el-table-column prop="description" label="描述" align="center"></el-table-column>

                        <el-table-column label="操作" align="center">

                            <template slot-scope="scope">

                                <el-button type="primary" size="mini" @click="handleUpdate(scope.row)">编辑</el-button>

                                <el-button type="danger" size="mini" @click="handleDelete(scope.row)">删除</el-button>

                            </template>

                        </el-table-column>

                    </el-table>

                    <!-- 新增标签弹层 -->

                    <div class="add-form">

                        <el-dialog title="新增图书" :visible.sync="dialogFormVisible">

                            <el-form ref="dataAddForm" :model="formData" :rules="rules" label-position="right" label-width="100px">

                                <el-row>

                                    <el-col :span="12">

                                        <el-form-item label="图书类别" prop="type">

                                            <el-input v-model="formData.type"/>

                                        </el-form-item>

                                    </el-col>

                                    <el-col :span="12">

                                        <el-form-item label="图书名称" prop="name">

                                            <el-input v-model="formData.name"/>

                                        </el-form-item>

                                    </el-col>

                                </el-row>


                                <el-row>

                                    <el-col :span="24">

                                        <el-form-item label="描述">

                                            <el-input v-model="formData.description" type="textarea"></el-input>

                                        </el-form-item>

                                    </el-col>

                                </el-row>

                            </el-form>

                            <div slot="footer" class="dialog-footer">

                                <el-button @click="dialogFormVisible = false">取消</el-button>

                                <el-button type="primary" @click="handleAdd()">确定</el-button>

                            </div>

                        </el-dialog>

                    </div>

                    <!-- 编辑标签弹层 -->

                    <div class="add-form">

                        <el-dialog title="编辑检查项" :visible.sync="dialogFormVisible4Edit">

                            <el-form ref="dataEditForm" :model="formData" :rules="rules" label-position="right" label-width="100px">

                                <el-row>

                                    <el-col :span="12">

                                        <el-form-item label="图书类别" prop="type">

                                            <el-input v-model="formData.type"/>

                                        </el-form-item>

                                    </el-col>

                                    <el-col :span="12">

                                        <el-form-item label="图书名称" prop="name">

                                            <el-input v-model="formData.name"/>

                                        </el-form-item>

                                    </el-col>

                                </el-row>

                                <el-row>

                                    <el-col :span="24">

                                        <el-form-item label="描述">

                                            <el-input v-model="formData.description" type="textarea"></el-input>

                                        </el-form-item>

                                    </el-col>

                                </el-row>

                            </el-form>

                            <div slot="footer" class="dialog-footer">

                                <el-button @click="dialogFormVisible4Edit = false">取消</el-button>

                                <el-button type="primary" @click="handleEdit()">确定</el-button>

                            </div>

                        </el-dialog>

                    </div>

                </div>

            </div>

        </div>

    </body>

    <!-- 引入组件库 --> 

    <script src="../js/vue.js"></script>

    <script src="../plugins/elementui/index.js"></script>

    <script type="text/javascript" src="../js/jquery.min.js"></script>

    <script src="../js/axios-0.18.0.js"></script>
    
    <!-- 重点！！！！！！-->

    <script>
        var vue = new Vue({

            el: '#app',
            data:{
                pagination: {},
				dataList: [],//当前页要展示的列表数据
                formData: {},//表单数据
                dialogFormVisible: false,//控制表单是否可见
                dialogFormVisible4Edit:false,//编辑表单是否可见
                rules: {//校验规则
                    type: [{ required: true, message: '图书类别为必填项', trigger: 'blur' }],
                    name: [{ required: true, message: '图书名称为必填项', trigger: 'blur' }]
                }
            },

            //钩子函数，VUE对象初始化完成后自动执行
            created() {
                this.getAll();
            },

            methods: {
                //列表
                getAll() {
                    //发送ajax请求
                    axios.get("/books").then((res)=>{
                        this.dataList = res.data.data;
                    });

                },

                //弹出添加窗口
                handleCreate() {
                    this.dialogFormVisible = true;
                    this.resetForm();
                },

                //重置表单
                resetForm() {
                    this.formData = {};
                },

                //添加
                handleAdd () {
                    //发送ajax请求
                    axios.post("/books",this.formData).then((res)=>{
                        console.log(res.data);
                        //如果操作成功，关闭弹层，显示数据
                        if(res.data.code == 20011){
                            this.dialogFormVisible = false;
                            this.$message.su***ess("添加成功");
                        }else if(res.data.code == 20010){
                            this.$message.error("添加失败");
                        }else{
                            //服务器异常等
                            this.$message.error(res.data.msg);
                        }
                    }).finally(()=>{
                        this.getAll();
                    });

                },

                //弹出编辑窗口
                handleUpdate(row) {
                    // console.log(row);   //row.id 查询条件
                    //查询数据，根据id查询
                    axios.get("/books/"+row.id).then((res)=>{
                        // console.log(res.data.data);
                        if(res.data.code == 20041){
                            //展示弹层，加载数据
                            this.formData = res.data.data;
                            this.dialogFormVisible4Edit = true;
                        }else{
                            this.$message.error(res.data.msg);
                        }
                    });
                },

                //编辑
                handleEdit() {
                    //发送ajax请求

                    axios.put("/books",this.formData).then((res)=>{
                        //如果操作成功，关闭弹层，显示数据
                        if(res.data.code == 20031){
                            this.dialogFormVisible4Edit = false;
                            this.$message.su***ess("修改成功");
                        }else if(res.data.code == 20030){
                            this.$message.error("修改失败");
                        }else{
                            this.$message.error(res.data.msg);
                        }
                    }).finally(()=>{
                        this.getAll();
                    });
                },

                // 删除
                handleDelete(row) {
                    //1.弹出提示框
                    this.$confirm("此操作永久删除当前数据，是否继续？","提示",{
                        type:'info'
                    }).then(()=>{
                        //2.做删除业务
                        axios.delete("/books/"+row.id).then((res)=>{
                            if(res.data.code == 20021){
                                this.$message.su***ess("删除成功");
                            }else{
                                this.$message.error("删除失败");
                            }
                        }).finally(()=>{
                            this.getAll();
                        });
                    }).catch(()=>{
                        //3.取消删除
                        this.$message.info("取消删除操作");
                    });
                }
            }
        })

    </script>

</html>

9.拦截器interceptor

浏览器访问资源路径流程:

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

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

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

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

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

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

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

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

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

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

9.1 拦截器概念

• 拦截器（Interceptor）是一种动态拦截方法调用的机制，在SpringMVC中动态拦截控制器方法的执行

• 作用:

• • 在指定的方法调用前后执行预先设定的代码
• • 阻止原始方法的执行
• • 总结：拦截器就是用来做增强(底层就是AOP)

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

• 归属不同：Filter属于Servlet技术，Interceptor属于SpringMVC技术

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

9.2 拦截器入门案例

项目结构：

1.创建拦截器类

@***ponent
//定义拦截器类，实现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 after***pletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("after***pletion...");
    }
}

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

2.配置拦截器类

@Configuration
public class SpringMvcSupport extends WebMv***onfigurationSupport {
    @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/*" );
    }
}

**注意：**此处也可以简化SpringMvcSupport的编写，直接让SpringMv***onfig实现WebMv***onfigurer接口即可,此后就不用再写SpringMvcSupport类了

@Configuration
@***ponentScan({"***.itheima.controller"})
@EnableWebMvc
//实现WebMv***onfigurer接口可以简化开发，但具有一定的侵入性
public class SpringMv***onfig implements WebMv***onfigurer {
    @Autowired
    private ProjectInterceptor projectInterceptor;

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

拦截器执行流程

ps：handle[controller的方法]

9.3 拦截器参数

preHandle

原始方法之前运行

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;
}

• request:请求对象

• response:响应对象

• handler:被调用的处理器对象，本质上是一个方法对象[HandleMethod]，对反射中的Method对象进行了再包装

postHandle

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

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

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

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

因为咱们现在都是返回json数据，所以该参数的使用率不高。

after***pletion

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

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

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

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

因为我们现在已经有全局异常处理器类，所以该参数的使用率也不高。

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

9.4 拦截器链配置

preHandle：与配置顺序相同，必定运行

postHandle:与配置顺序相反，可能不运行

after***pletion:与配置顺序相反，可能不运行。

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