SpringMVC

1. SpringMVC概述

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

• 优点

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

• 回顾下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可以处理多个请求，并对请求进行分发，执行不同的业务操作

  第二次改进：Web层优化为MVC模式

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

  • 因为是异步调用，所以后端不需要返回view视图，将其去除
  • 前端如果通过异步调用的方式进行交互，后台就需要将返回的数据转换成json格式进行返回

  第三次改进：使用异步调用，进一步优化Web层

  SpringMVC主要负责的就是

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

  第四次改进：使用SpringMVC代替Servlet

2. SpringMVC入门案例

• 步骤1:创建Maven项目
  打开IDEA,创建一个新的web项目
  

• 步骤2:补全目录结构
  

• 步骤3:导入jar包
  将pom.xml中多余的内容删除掉，再添加SpringMVC需要的依赖

  <?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>com.itheima</groupId>
    <artifactId>springmvc_01_quickstart</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>war</packaging>
  
    <dependencies>
      <dependency>
        <groupId>javax.servlet</groupId>
        <artifactId>javax.servlet-api</artifactId>
        <version>3.1.0</version>
        <scope>provided</scope>
      </dependency>
      <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-webmvc</artifactId>
        <version>5.2.10.RELEASE</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>
  
  

  说明: servlet的坐标为什么需要添加<scope>provided</scope>?

  • scope是maven中jar包依赖作用范围的描述，
  • 如果不设置默认是compile在在编译、运行、测试时均有效
  • 如果运行有效的话就会和tomcat中的servlet-api包发生冲突，导致启动报错
  • provided代表的是该包只在编译和测试的时候用，运行的时候无效直接使用tomcat中的，就避免冲突

• 步骤4:创建配置类

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

• 步骤5:创建Controller类

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

• 步骤6:使用配置类替换web.xml
  将web.xml删除，换成ServletContainersInitConfig

  public class ServletContainersInitConfig extends AbstractDispatcherServletInitializer {
      //加载springmvc配置类
      protected WebApplicationContext createServletApplicationContext() {
          //初始化WebApplicationContext对象
          AnnotationConfigWebApplicationContext ctx = new AnnotationConfigWebApplicationContext();
          //加载指定配置类
          ctx.register(SpringMvcConfig.class);
          return ctx;
      }
  
      //设置由springmvc控制器处理的请求映射路径
      protected String[] getServletMappings() {
          return new String[]{"/"};
      }
  
      //加载spring配置类
      protected WebApplicationContext createRootApplicationContext() {
          return null;
      }
  }
  

• 步骤7:配置Tomcat环境
  

• 步骤8:启动运行项目

• 步骤9:浏览器访问
  浏览器输入http://localhost/save进行访问，会报如下错误:
  
  页面报错的原因是后台没有指定返回的页面，目前只需要关注控制台看user save ...有没有被执行即可。

• 步骤10:修改Controller返回值解决上述问题
  前面我们说过现在主要的是前端发送异步请求，后台响应json数据，所以接下来我们把Controller类的save方法进行修改

  @Controller
  public class UserController {
      
      @RequestMapping("/save")
      public String save(){
          System.out.println("user save ...");
          return "{'info':'springmvc'}";
      }
  }
  
  

  再次重启tomcat服务器，然后重新通过浏览器测试访问,会发现还是会报错，这次的错是404
  出错的原因是，如果方法直接返回字符串，springmvc会把字符串当成页面的名称在项目中进行查找返回，因为不存在对应返回值名称的页面，所以会报404错误，找不到资源。

• 步骤11:设置返回数据为json

  @Controller
  public class UserController {
      
      @RequestMapping("/save")
      @ResponseBody
      public String save(){
          System.out.println("user save ...");
          return "{'info':'springmvc'}";
      }
  }
  
  

  再次重启tomcat服务器，然后重新通过浏览器测试访问，就能看到返回的结果数据
  

• 注意事项

  • SpringMVC是基于Spring的，在pom.xml只导入了spring-webmvcjar包的原因是它会自动依赖spring相关坐标
  • AbstractDispatcherServletInitializer类是SpringMVC提供的快速初始化Web3.0容器的抽象类
  • AbstractDispatcherServletInitializer提供了三个接口方法供用户实现
    • createServletApplicationContext方法，创建Servlet容器时，加载SpringMVC对应的bean并放入WebApplicationContext对象范围中，而WebApplicationContext的作用范围为ServletContext范围，即整个web容器范围
    • getServletMappings方法，设定SpringMVC对应的请求映射路径，即SpringMVC拦截哪些请求
    • createRootApplicationContext方法，如果创建Servlet容器时需要加载非SpringMVC对应的bean,使用当前方法进行，使用方式和createServletApplicationContext相同。
    • createServletApplicationContext用来加载SpringMVC环境
    • createRootApplicationContext用来加载Spring环境

• 入门案例总结

  • 一次性工作
    • 创建工程，设置服务器，加载工程
    • 导入坐标
    • 创建web容器启动类，加载SpringMVC配置，并设置SpringMVC请求拦截路径
    • SpringMVC核心配置类（设置配置类，扫描controller包，加载Controller控制器bean）
  • 多次工作
    • 定义处理请求的控制器类
    • 定义处理请求的控制器方法，并配置映射路径（@RequestMapping）与返回json数据（@ResponseBody）

• 工作流程解析
  

  • 启动服务器初始化过程

    1. 服务器启动，执行ServletContainersInitConfig类，初始化web容器
       功能类似于以前的web.xml
    2. 执行createServletApplicationContext方法，创建了WebApplicationContext对象
       该方法加载SpringMVC的配置类SpringMvcConfig来初始化SpringMVC的容器
    3. 加载SpringMvcConfig配置类
    4. 执行@ComponentScan加载对应的bean
       扫描指定包及其子包下所有类上的注解，如Controller类上的@Controller注解
    5. 加载UserController，每个@RequestMapping的名称对应一个具体的方法
       此时就建立了 /save 和 save方法的对应关系
    6. 执行getServletMappings方法，设定SpringMVC拦截请求的路径规则

  • 单次请求过程

    1. 发送请求http://localhost/save
    2. web容器发现该请求满足SpringMVC拦截规则，将请求交给SpringMVC处理
    3. 解析请求路径/save
    4. 由/save匹配执行对应的方法save(）
       • 上面的第五步已经将请求路径和方法建立了对应关系，通过/save就能找到对应的save方法
    5. 执行save()
    6. 检测到有@ResponseBody直接将save()方法的返回值作为响应体返回给请求方

• bean加载控制
  如何让Spring和SpringMVC分开加载各自的内容

  • SpringMVC加载其相关bean(表现层bean),也就是controller包下的类

  • Spring控制的bean

    • 业务bean(Service)
    • 功能bean(DataSource,SqlSessionFactoryBean,MapperScannerConfigurer等)

  • 方式一:Spring加载的bean设定扫描范围为精准范围，例如service包、dao包等

  • 方式二:Spring加载的bean设定扫描范围为com.itheima,排除掉controller包中的bean

    @Configuration
    @ComponentScan(value="com.itheima",
        excludeFilters=@ComponentScan.Filter(
        	type = FilterType.ANNOTATION,
            classes = Controller.class
        )
    )
    public class SpringConfig {
    }
    

    • excludeFilters属性：设置扫描加载bean时，排除的过滤规则

    • type属性：设置排除规则，当前使用按照bean定义时的注解类型进行排除

      • ANNOTATION：按照注解排除
      • ASSIGNABLE_TYPE:按照指定的类型过滤
      • ASPECTJ:按照Aspectj表达式排除，基本上不会用
      • REGEX:按照正则表达式排除
      • CUSTOM:按照自定义规则排除

      大家只需要知道第一种ANNOTATION即可

    • classes属性：设置排除的具体注解类，当前设置排除@Controller定义的bean

  • 方式三:不区分Spring与SpringMVC的环境，加载到同一个环境中[了解即可]

  • 有了Spring的配置类，要想在tomcat服务器启动将其加载，我们需要修改ServletContainersInitConfig

    public class ServletContainersInitConfig extends AbstractDispatcherServletInitializer {
        protected WebApplicationContext createServletApplicationContext() {
            AnnotationConfigWebApplicationContext ctx = new AnnotationConfigWebApplicationContext();
            ctx.register(SpringMvcConfig.class);
            return ctx;
        }
        protected String[] getServletMappings() {
            return new String[]{"/"};
        }
        protected WebApplicationContext createRootApplicationContext() {
          AnnotationConfigWebApplicationContext ctx = new AnnotationConfigWebApplicationContext();
            ctx.register(SpringConfig.class);
            return ctx;
        }
    }
    

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

    public class ServletContainersInitConfig extends AbstractAnnotationConfigDispatcherServletInitializer {
    
        protected Class<?>[] getRootConfigClasses() {
            return new Class[]{SpringConfig.class};
        }
    
        protected Class<?>[] getServletConfigClasses() {
            return new Class[]{SpringMvcConfig.class};
        }
    
        protected String[] getServletMappings() {
            return new String[]{"/"};
        }
    }
    

3. PostMan工具的使用

1. PostMan简介

   • PostMan是一款功能强大的网页调试与发送网页HTTP请求的Chrome插件。

   • 作用：常用于进行接口测试

   • 特征

     • 简单
     • 实用
     • 美观
     • 大方

2. PostMan使用

   • 创建WorkSpace工作空间
     
   • 发送请求
     
   • 保存当前请求
     
     注意:第一次请求需要创建一个新的目录，后面就不需要创建新目录，直接保存到已经创建好的目录即可

4. 请求与响应

1. 设置请求映射路径

   • 步骤1:修改Controller

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

     问题是解决了，但是每个方法前面都需要进行修改，写起来比较麻烦而且还有很多重复代码，如果/user后期发生变化，所有的方法都需要改，耦合度太高。

   • 步骤2:优化路径配置

     优化方案:

     @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'}";
         }
     }
     

     注意:

     • 当类上和方法上都添加了@RequestMapping注解，前端发送请求的时候，要和两个注解的value值相加匹配才能访问到。
     • @RequestMapping注解value属性前面加不加/都可以

2. 请求参数

   • GET发送参数
     发送请求与参数:

     http://localhost/commonParam?name=itcast&age=15
     

     
     接收参数：

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

     Tomcat8.5以后的版本已经处理了中文乱码的问题

   • POST发送参数
     
     接收参数：

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

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

   • POST请求中文乱码

     解决方案:配置过滤器

     public class ServletContainersInitConfig extends AbstractAnnotationConfigDispatcherServletInitializer {
         protected Class<?>[] getRootConfigClasses() {
             return new Class[0];
         }
     
         protected Class<?>[] getServletConfigClasses() {
             return new Class[]{SpringMvcConfig.class};
         }
     
         protected String[] getServletMappings() {
             return new String[]{"/"};
         }
     
         //乱码处理
         @Override
         protected Filter[] getServletFilters() {
             CharacterEncodingFilter filter = new CharacterEncodingFilter();
             filter.setEncoding("UTF-8");
             return new Filter[]{filter};
         }
     }
     

     CharacterEncodingFilter是在spring-web包中，所以用之前需要导入对应的jar包

3. 五种类型参数传递

   • 普通参数：url地址传参，地址参数名与形参变量名相同，定义形参即可接收参数
     如果形参与地址参数名不一致，使用@RequestParam注解

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

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

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

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

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

   • 集合类型参数：使用@RequestParam注解

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

     • 集合保存普通参数：请求参数名与形参集合对象名相同且请求参数为多个，@RequestParam绑定参数关系
     • 对于简单数据类型使用数组会比集合更简单些

4. JSON数据传输参数
   SpringMVC接收JSON数据的实现步骤为:
   (1)导入jackson包
   (2)使用PostMan发送JSON数据
   (3)开启SpringMVC注解驱动，在配置类上添加@EnableWebMvc注解
   (4)Controller方法的参数前添加@RequestBody注解

   • JSON普通数组

     • 步骤1:pom.xml添加依赖

       SpringMVC默认使用的是jackson来处理json的转换，所以需要在pom.xml添加jackson依赖

       <dependency>
           <groupId>com.fasterxml.jackson.core</groupId>
           <artifactId>jackson-databind</artifactId>
           <version>2.9.0</version>
       </dependency>
       

     • 步骤2:PostMan发送JSON数据
       

     • 步骤3:开启SpringMVC注解支持@EnableWebMvc
       在SpringMVC的配置类中开启SpringMVC的注解支持，这里面就包含了将JSON转换成对象的功能。

       @Configuration
       @ComponentScan("com.itheima.controller")
       //开启json数据类型自动转换
       @EnableWebMvc
       public class SpringMvcConfig {
       }
       

     • 步骤4:参数前添加@RequestBody

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

   • JSON对象数据
     
     后端接收数据：

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

   • 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'}";
     }
     

   • @RequestBody与@RequestParam区别

     • 区别

       • @RequestParam用于接收url地址传参，表单传参【application/x-www-form-urlencoded】
       • @RequestBody用于接收json数据【application/json】

     • 应用

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

5. 日期类型参数传递
   SpringMVC默认支持的字符串转日期的格式为yyyy/MM/dd
   要传递其他格式需要使用@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'}";
   }
   

   

6. 响应

   • 响应页面[了解]
     设置返回页面

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

   • 响应数据

     • 文本数据[了解]

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

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

   • @ResponseBody
     • 该注解可以写在类上或者方法上
     • 写在类上就是该类下的所有方法都有@ReponseBody功能
     • 当方法上有@ReponseBody注解后
       • 方法的返回值为字符串，会将其作为文本内容直接响应给前端
       • 方法的返回值为对象，会将对象转换成JSON响应给前端

5. Rest风格

1. REST简介

   • 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的优点有:
     • 隐藏资源的访问行为，无法通过地址得知对资源是何种操作
     • 书写简化
   • 按照REST风格访问资源时使用行为动作区分对资源进行了何种操作
     • http://localhost/users 查询全部用户信息 GET（查询）
     • http://localhost/users/1 查询指定用户信息 GET（查询）
     • http://localhost/users 添加用户信息 POST（新增/保存）
     • http://localhost/users 修改用户信息 PUT（修改/更新）
     • http://localhost/users/1 删除用户信息 DELETE（删除）
   • 上述行为是约定方式，约定不是规范，可以打破，所以称REST风格，而不是REST规范
   • 在进行开发的过程中，大多是都是遵从REST风格来访问我们的后台服务
   • 根据REST风格对资源进行访问称为RESTful

2. RESTful入门案例
   修改RESTful风格

   • 新增

     @Controller
     public class UserController {
     	//设置当前请求方法为POST，表示REST风格中的添加操作
         @RequestMapping(value = "/users",method = RequestMethod.POST)
         @ResponseBody
         public String save() {
             System.out.println("user save...");
             return "{'module':'user save'}";
         }
     }
     

     • 将请求路径更改为/users

       • 访问该方法使用 POST: http://localhost/users

     • 使用method属性限定该方法的访问方式为POST

       • 如果发送的不是POST请求，比如发送GET请求，则会报错

   • 删除

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

     

   • 修改

     @Controller
     public class UserController {
         //设置当前请求方法为PUT，表示REST风格中的修改操作
         @RequestMapping(value = "/users",method = RequestMethod.PUT)
         @ResponseBody
         public String update(@RequestBody User user) {
             System.out.println("user update..." + user);
             return "{'module':'user update'}";
         }
     }
     

   • 根据ID查询

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

   • 查询所有

     @Controller
     public class UserController {
         //设置当前请求方法为GET，表示REST风格中的查询操作
         @RequestMapping(value = "/users" ,method = RequestMethod.GET)
         @ResponseBody
         public String getAll() {
             System.out.println("user getAll...");
             return "{'module':'user getAll'}";
         }
     }
     

   • 注解@RequestBody、@RequestParam、@PathVariable

     • 区别
       • @RequestParam用于接收url地址传参或表单传参
       • @RequestBody用于接收json数据
       • @PathVariable用于接收路径参数，使用{参数名称}描述路径参数
     • 应用
       • 后期开发中，发送请求参数超过1个时，以json格式为主，@RequestBody应用较广
       • 如果发送非json格式数据，选用@RequestParam接收请求参数
       • 采用RESTful进行开发，当参数数量较少时，例如1个，可以采用@PathVariable接收请求路径变量，通常用于传递id值

3. RESTful快速开发
   
   问题1：每个方法的@RequestMapping注解中都定义了访问路径/books，重复性太高。

   将@RequestMapping提到类上面，用来定义所有方法共同的访问路径。
   

   问题2：每个方法的@RequestMapping注解中都要使用method属性定义请求方式，重复性太高。

   使用@GetMapping  @PostMapping  @PutMapping  @DeleteMapping代替
   

   问题3：每个方法响应json都需要加上@ResponseBody注解，重复性太高。

   1.将ResponseBody提到类上面，让所有的方法都有@ResponseBody的功能
   2.使用@RestController注解替换@Controller与@ResponseBody注解，简化书写
   

   @RestController //@Controller + ReponseBody
   @RequestMapping("/books")
   public class BookController {
       
   	//@RequestMapping(method = RequestMethod.POST)
       @PostMapping
       public String save(@RequestBody Book book){
           System.out.println("book save..." + book);
           return "{'module':'book save'}";
       }
   
       //@RequestMapping(value = "/{id}",method = RequestMethod.DELETE)
       @DeleteMapping("/{id}")
       public String delete(@PathVariable Integer id){
           System.out.println("book delete..." + id);
           return "{'module':'book delete'}";
       }
   
       //@RequestMapping(method = RequestMethod.PUT)
       @PutMapping
       public String update(@RequestBody Book book){
           System.out.println("book update..." + book);
           return "{'module':'book update'}";
       }
   
       //@RequestMapping(value = "/{id}",method = RequestMethod.GET)
       @GetMapping("/{id}")
       public String getById(@PathVariable Integer id){
           System.out.println("book getById..." + id);
           return "{'module':'book getById'}";
       }
   
       //@RequestMapping(method = RequestMethod.GET)
       @GetMapping
       public String getAll(){
           System.out.println("book getAll...");
           return "{'module':'book getAll'}";
       }
       
   }
   

4. RESTful案例
   需求一:图片列表查询，从后台返回数据，将数据展示在页面上
   
   需求二:新增图片，将新增图书的数据传递到后台，并在控制台打印
   

   • 编写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 success'}";
         }
     
      	@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需要将静态资源进行放行

     @Configuration
     public class SpringMvcSupport extends WebMvcConfigurationSupport {
         //设置静态资源访问过滤，当前类需要设置为配置类，并被扫描加载
         @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包，所以该配置类还未生效，要想生效需要将SpringMvcConfig配置类进行修改

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

   • 修改books.html页面

      <script>
             var vue = new Vue({
     
                 el: '#app',
     
                 data:{
     				dataList: [],//当前页要展示的分页列表数据
                     formData: {},//表单数据
                     dialogFormVisible: false,//增加表单是否可见
                     dialogFormVisible4Edit:false,//编辑表单是否可见
                     pagination: {},//分页模型数据，暂时弃用
                 },
     
                 //钩子函数，VUE对象初始化完成后自动执行
                 created() {
                     this.getAll();
                 },
     
                 methods: {
                     // 重置表单
                     resetForm() {
                         //清空输入框
                         this.formData = {};
                     },
     
                     // 弹出添加窗口
                     openSave() {
                         this.dialogFormVisible = true;
                         this.resetForm();
                     },
     
                     //添加
                     saveBook () {
                         axios.post("/books",this.formData).then((res)=>{
     
                         });
                     },
     
                     //主页列表查询
                     getAll() {
                         axios.get("/books").then((res)=>{
                             this.dataList = res.data;
                         });
                     },
     
                 }
             })
         </script>
     

6. SSM整合

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

1. 流程分析
   (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
       • 第三方数据源配置类 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

2. 整合配置
   略

7. 统一结果封装

对于前端来说，如果后台能够返回一个统一的数据结果，前端在解析的时候就可以按照一种方式进行解析。开发就会变得更加简单
封装大体的思路为:

• 为了封装返回的结果数据:创建结果模型类，封装数据到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;
  }
  
  

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

• 步骤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);
      }
  
      @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);
      }
  }
  

8. 统一异常处理

异常的种类及出现异常的原因:

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

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

思考

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

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

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

   异常分类

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

   AOP

SpringMVC已经为我们提供了一套解决方案：
异常处理器: 集中的、统一的处理项目中出现的异常

• 异常处理器的使用
  创建异常处理器类

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

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

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

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

项目异常处理方案

1. 异常分类

• 业务异常（BusinessException）
  • 规范的用户行为产生的异常
    用户在页面输入内容的时候未按照指定格式进行数据填写
  • 不规范的用户行为操作产生的异常
    如用户故意传递错误数据
• 系统异常（SystemException）
  项目运行过程中可预计但无法避免的异常，比如数据库或服务器宕机
• 其他异常（Exception）
  编程人员未预期到的异常，如:用到的文件不存在

2. 异常解决方案

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

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

9. 拦截器

1. 拦截器概念
   

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

• 作用:

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

• 拦截器和过滤器之间的区别

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

2. 拦截器入门案例

• 步骤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容器扫描到。
拦截器中的preHandler方法，如果返回true,则代表放行，会执行原始Controller类中要请求的方法，如果返回false，则代表拦截，后面的就不会再执行了

• 步骤2:配置拦截器类

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

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

• 简化SpringMvcSupport的编写

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

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

3. 拦截器参数

前置处理方法

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:如果处理器执行完成具有返回结果，可以读取到对应数据与页面信息，并进行调整
现在都是返回json数据，所以该参数的使用率不高。

完成处理方法

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

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

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

已经有全局异常处理器类，所以该参数的使用率也不高

4. 拦截器链配置

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