SpringMVC-入门02

• RESTful

1 RESTful

1.1 REST概念

• REST（Representational State Transfer），表现形式状态转换

  • 传统风格资源描述形式
    http://localhost/user/getById?id=1
    http://localhost/user/saveUser
  • REST风格描述形式
    http://localhost/user/1
    http://localhost/user

• 优点：

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

• 资源的增删改查

  不同的请求方式，代表对服务器资源的不同操作

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

1.1.2 RESTful概念

• 根据REST风格对资源进行访问称为RESTful

1.1.3 注意事项

• 上述行为是约定方式，约定不是规范，可以打破，所以称REST风格，而不是REST规范

  登录虽是查询，但是不能用Get请求方式，可以用POST

• 描述模块的名称通常使用复数，也就是加s的格式描述，表示此类资源，而非单个资源，例如：users、books、accounts……

1.2 快速入门

做法：在Controller中定义方法时设定"http请求动作(请求方式)“和"设定请求参数（路径变量）”

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

    //设置当前请求方法为DELETE，表示REST风格中的删除操作
    //@PathVariable注解用于设置路径变量（路径参数），要求路径上设置对应的占位符，并且占位符名称与方法形参名称相同
    // http://localhost/users/1
    @RequestMapping(value = "/users/{id}",method = RequestMethod.DELETE)
    @ResponseBody
    public String delete(@PathVariable Integer id){
        System.out.println("user delete..." + id);
        return "{'module':'user delete'}";
    }

    //设置当前请求方法为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'}";
    }

    //设置当前请求方法为GET，表示REST风格中的查询操作
    //@PathVariable注解用于设置路径变量（路径参数），要求路径上设置对应的占位符，并且占位符名称与方法形参名称相同
    @RequestMapping(value = "/users/{id}" ,method = RequestMethod.GET)
    @ResponseBody
    public String getById(@PathVariable Integer id){
        System.out.println("user getById..."+id);
        return "{'module':'user getById'}";
    }

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

1.2.2 @PathVariable

• 名称：@PathVariable
• 类型：形参注解
• 位置：SpringMVC控制器方法形参定义前面
• 作用：绑定路径参数与处理器方法形参间的关系，要求路径参数名与形参名一一对应

1.2.3 @RequestBody、@RequestParam、@PathVariable区别和应用

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

1.3 快速开发RESTful

@RestController = @Controller + @ResponseBody

@GetMapping = @RequestMapping(method = REQUESTMETHOD.GET)

@RequestMapping可以标注在类上

• 演示代码

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

• 清爽版

  package com.itheima.controller;
  
  
  @RestController
  @RequestMapping("/books")
  public class BookController {
  
  
      @PostMapping 
      public String save(@RequestBody Book book) {
          System.out.println("book save..." + book);
          return "{'module':'book save'}";
      }
  
      // http://localhost/books/1/1
      @DeleteMapping("/{userId}/{id}") 
      public String delete(@PathVariable Integer userId, @PathVariable Integer id) {
          System.out.println("book delete..." + userId);
          System.out.println("book delete..." + id);
          return "{'module':'book delete'}";
      }
  
  
      @PutMapping 
      public String update(@RequestBody Book book) {
          System.out.println("book update..." + book);
          return "{'module':'book update'}";
      }
  
  
      @GetMapping("/{id}")
      public String getById(@PathVariable Integer id) {
          System.out.println("book getById..." + id);
          return "{'module':'book getById'}";
      }
  
  
      @GetMapping
      public String getAll() {
          System.out.println("book getAll...");
          return "{'module':'book getAll'}";
      }
  }
  

1.4 案例

1.4.1 案例效果

1.4.2 环境准备

//POJO实体类
@Data
public class Book {
    private Integer id;
    private String type;
    private String name;
    private String description;
    
}

//SpringMVC容器初始化类
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};
    }
}

//SpringMVC配置类
@Configuration
@ComponentScan({"com.itheima.controller","com.itheima.config"})
@EnableWebMvc
public class SpringMvcConfig {
}

1.4.3 代码实现

• 编写SpringMVC控制器，并通过PostMan测试接口功能

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

• POST发起请求

• 静态资源访问放行

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

• 前端页面发起异步请求

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

2. SSM整合

2.1 SSM整合流程综述

1. 创建工程
2. SSM整合
   • Spring
     • SpringConfig
   • MyBatis
     • MybatisConfig
     • JdbcConfig
     • jdbc.properties
   • SpringMVC
     • ServletConfig
     • SpringMvcConfig
3. 功能模块
   • 表与实体类
   • dao（接口+自动代理）
   • service（接口+实现类）
     • 业务层接口测试（整合JUnit）
   • controller
     • 表现层接口测试（PostMan）

2.2 SSM整合配置

2.2.1 创建工程，添加依赖和插件

<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>junit</groupId>
        <artifactId>junit</artifactId>
        <version>4.12</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.48</version>
    </dependency>

    <dependency>
        <groupId>com.alibaba</groupId>
        <artifactId>druid</artifactId>
        <version>1.1.16</version>
    </dependency>

    <dependency>
      <groupId>org.projectlombok</groupId>
      <artifactId>lombok</artifactId>
      <version>1.18.20</version>
      <scope>provided</scope>
    </dependency>


    <dependency>
        <groupId>javax.servlet</groupId>
        <artifactId>javax.servlet-api</artifactId>
        <version>3.1.0</version>
        <scope>provided</scope>
    </dependency>

    <dependency>
        <groupId>com.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>

2.2.2 Spring整合Mybatis

• 创建数据库和表

-- 创建ssm_db数据库
CREATE DATABASE IF NOT EXISTS ssm_db CHARACTER SET utf8;

-- 使用ssm_db数据库
USE ssm_db;

-- 创建tbl_book表
CREATE TABLE tbl_book(
    id INT PRIMARY KEY AUTO_INCREMENT, -- 图书编号
    TYPE VARCHAR(100), -- 图书类型
    NAME VARCHAR(100), -- 图书名称
    description VARCHAR(100) -- 图书描述
);
-- 添加初始化数据
INSERT INTO tbl_book VALUES(NULL,'计算机理论','Spring实战 第5版','Spring入门经典教材，深入理解Spring原理技术内幕');
INSERT INTO tbl_book VALUES(NULL,'计算机理论','Spring 5核心原理与30个类手写实战','十年沉淀之作,手写Spring精华思想');
INSERT INTO tbl_book VALUES(NULL,'计算机理论','Spring 5设计模式','深入Spring源码剖析,Spring源码蕴含的10大设计模式');
INSERT INTO tbl_book VALUES(NULL,'市场营销','直播就该这么做:主播高效沟通实战指南','李子柒、李佳琦、薇娅成长为网红的秘密都在书中');
INSERT INTO tbl_book VALUES(NULL,'市场营销','直播销讲实战一本通','和秋叶一起学系列网络营销书籍');
INSERT INTO tbl_book VALUES(NULL,'市场营销','直播带货:淘宝、天猫直播从新手到高手','一本教你如何玩转直播的书,10堂课轻松实现带货月入3W+');

• jdbc.properties属性文件

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

• 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;
    }
	//Spring事务管理需要的平台事务管理器对象
    @Bean
    public PlatformTransactionManager transactionManager(DataSource dataSource){
        DataSourceTransactionManager ds = new DataSourceTransactionManager();
        ds.setDataSource(dataSource);
        return ds;
    }
}

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

• SpringConfig配置类

@Configuration
@ComponentScan({"com.itheima.service"})
@PropertySource("classpath:jdbc.properties")
@Import({JdbcConfig.class,MyBatisConfig.class})
@EnableTransactionManagement //开启Spring事务管理
public class SpringConfig {
}

2.2.3 Spring整合SpringMVC

• SpringMvcConfig配置类

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

• ServletConfig配置类，加载SpringMvcConfig和SpringConfig配置类

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

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

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

2.3 功能模块开发

2.3.1 数据层(BookDao)

• Book实体类

@Data
public class Book {
    private Integer id;
    private String type;
    private String name;
    private String description;
}

• BookDao接口

public interface BookDao {

    //@Insert("insert into tbl_book values(null,#{type},#{name},#{description})")
    @Insert("insert into tbl_book (type,name,description) values(#{type},#{name},#{description})")
    public int save(Book book);  //返回值表示影响的行数

    @Update("update tbl_book set type = #{type}, name = #{name}, description = #{description} where id = #{id}")
    public int update(Book book);

    @Delete("delete from tbl_book where id = #{id}")
    public int delete(Integer id);

    @Select("select * from tbl_book where id = #{id}")
    public Book getById(Integer id);

    @Select("select * from tbl_book")
    public List<Book> getAll();
}

2.3.2 业务层开发(BookService/BookServiceImpl)

• BookService接口

@Transactional //表示所有方法进行事务管理，使用默认的事务属性
public interface BookService {

    /**
     * 保存
     * @param book
     * @return
     */
    public boolean save(Book book);

    /**
     * 修改
     * @param book
     * @return
     */
    public boolean update(Book book);

    /**
     * 按id删除
     * @param id
     * @return
     */
    public boolean delete(Integer id);

    /**
     * 按id查询
     * @param id
     * @return
     */
    public Book getById(Integer id);

    /**
     * 查询全部
     * @return
     */
    public List<Book> getAll();
}

• BookServiceImpl实现类

@Service
public class BookServiceImpl implements BookService {
    @Autowired
    private BookDao bookDao;

    public boolean save(Book book) {
        bookDao.save(book);
        return true;
    }

    public boolean update(Book book) {
        bookDao.update(book);
        return true;
    }

    public boolean delete(Integer id) {
        bookDao.delete(id);
        return true;
    }

    public Book getById(Integer id) {
        return bookDao.getById(id);
    }

    public List<Book> getAll() {
        return bookDao.getAll();
    }
}

2.3 表现层开发(BookController)

@RestController
@RequestMapping("/books")
public class BookController {

    @Autowired
    private BookService bookService;

    @PostMapping
    public boolean save(@RequestBody Book book) {
        return bookService.save(book);
    }

    @PutMapping
    public boolean update(@RequestBody Book book) {
        return bookService.update(book);
    }

    @DeleteMapping("/{id}")
    public boolean delete(@PathVariable Integer id) {
        return bookService.delete(id);
    }

    @GetMapping("/{id}")
    public Book getById(@PathVariable Integer id) {
        return bookService.getById(id);
    }

    @GetMapping
    public List<Book> getAll() {
        return bookService.getAll();
    }
}

3 接口测试

3.1 Spring整合Junit测试业务层方法

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

3.2 postman测试表现层接口

• 测试保存图书

3. 表现层响应数据封装

3.1 响应数据存在的问题问题

问题：我们表现层增删改方法返回true或者false表示是否成功，getById()方法返回一个json对象，getAll()方法返回一个json对象数组，这里就出现了三种格式的响应结果，极其不利于前端解析。

解决：我们需要统一响应结果的格式

3.2 定义Result类封装响应结果

3.2.1 Result类封装响应结果

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

注意事项：

Result类中的字段并不是固定的，可以根据需要自行增减

3.2.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.3 表现层代码优化

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

4. 异常处理

理解即可。

4.1 常见异常

• 程序开发过程中不可避免的会遇到异常现象，我们不能让用户看到这样的页面数据

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

4.2 异常处理器

4.2.1 编写异常处理器

• 异常处理代码

  package com.itheima.web;
  
  @RestControllerAdvice  //用于标识当前类为REST风格对应的异常处理器
  public class ProjectExceptionAdvice {
  
      //统一处理所有的Exception异常
      @ExceptionHandler(Exception.class)
      public Result doOtherException(Exception ex){
          return new Result(666,null);
      }
  }
  

• 使用异常处理器之后的效果

4.2.2 @RestControllerAdvice

• 名称：@RestControllerAdvice

• 类型：类注解

• 位置：Rest风格开发的控制器增强类定义上方

• 作用：为Rest风格开发的控制器类做增强

• 说明：

  @RestControllerAdvice = @ControllerAdvice + @ResponseBody

  ​ =@Component + Advice + @ResponseBody

4.2.3 @ExceptionHandler

• 名称：@ExceptionHandler
• 类型：方法注解
• 位置：专用于异常处理的控制器方法上方
• 作用：相当于一个Handler，某个类型的异常出现后，会自动执行该注解标注的方法。
• 说明：应编写多个标注有该注解的方法，分别处理对应的异常，并返回和Handler类似的格式到前端

4.3 项目中异常分类

• 业务异常（BusinessException）
  • 规范的用户行为产生的异常
  • 不规范的用户行为操作产生的异常
• 系统异常（SystemException）
  • 项目运行过程中可预计且无法避免的异常
  • eg：外键约束删除失败、唯一约束添加失败
• 其他异常（Exception）
  • 编程人员未预期到的异常

4.4 项目异常处理方案

• 业务异常（BusinessException）
  • 发送对应消息传递给用户，提醒规范操作
• 系统异常（SystemException）
  • 发送固定消息传递给用户，安抚用户
  • 发送特定消息给运维人员，提醒维护
  • 记录日志
• 其他异常（Exception）
  • 发送固定消息传递给用户，安抚用户
  • 发送特定消息给编程人员，提醒维护（纳入预期范围内）
  • 记录日志

4.5 项目异常处理代码实现

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

4.5.2 自定义异常编码（持续补充）

public class Code {

	//之前其他状态码省略没写，以下是新补充的状态码，可以根据需要自己补充
    
    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;
    
}

4.5.3 触发自定义异常

@Service
public class BookServiceImpl implements BookService {
    @Autowired
    private BookDao bookDao;

	//在getById演示触发异常，其他方法省略没有写进来
    public Book getById(Integer id) {
        //模拟业务异常，包装成自定义异常
        if(id <0){
            throw new BusinessException(Code.BUSINESS_ERR,"请不要使用你的技术挑战我的耐性!");
        }
    }
}

4.5.4 在异常通知类中拦截并处理异常

@RestControllerAdvice //用于标识当前类为REST风格对应的异常处理器
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.5.6 测试

在postman中发送请求访问getById方法，传递参数-1，得到以下结果：

5. SSM整合中前台页面开发

5.1 放行静态资源

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

5.2 查询所有功能

• 前端代码

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

5.3 添加功能

• 前端代码

//弹出添加窗口
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.success("添加成功");
        }else if(res.data.code == 20010){
            this.$message.error("添加失败");
        }else{
            this.$message.error(res.data.msg);
        }
    }).finally(()=>{
        this.getAll();
    });
},

• 后台代码改进

@Service
public class BookServiceImpl implements BookService {
    @Autowired
    private BookDao bookDao;
	//增删改的方法判断了影响的行数是否大于0，而不是固定返回true
    public boolean save(Book book) {
        return bookDao.save(book) > 0;
    }
	//增删改的方法判断了影响的行数是否大于0，而不是固定返回true
    public boolean update(Book book) {
        return bookDao.update(book) > 0;
    }
	//增删改的方法判断了影响的行数是否大于0，而不是固定返回true
    public boolean delete(Integer id) {
        return bookDao.delete(id) > 0;
    }

    public Book getById(Integer id) {
        if(id < 0){
            throw new BusinessException(Code.BUSINESS_ERR,"请不要使用你的技术挑战我的耐性!");
            return bookDao.getById(id);
        }
    }
    public List<Book> getAll() {
        return bookDao.getAll();
    }
}

5.4 修改功能

• 显示弹出框查询图书信息

//弹出编辑窗口
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.success("修改成功");
        }else if(res.data.code == 20030){
            this.$message.error("修改失败");
        }else{
            this.$message.error(res.data.msg);
        }
    }).finally(()=>{
        this.getAll();
    });
}

5.5 删除功能

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

6. 拦截器

6.1 概念

拦截器（Interceptor）：一种动态拦截方法调用并完成方法增强的机制

作用：

1. 在指定的方法调用前、后执行预先设定好的代码
2. 阻止原始方法的执行
3. 总结：增强

原理：AOP（动态代理）

拦截器链：多个拦截器按照一定的顺序，对原始被调用功能进行增强。类比于FilterChain

6.2 过滤器VS拦截器

项目	Filter过滤器	intercept拦截器
规范	servlet规范的一部分，任何Web框架都可用	SpringMVC定义的规范，限SpringMVC使用
依赖容器	tomcat等web容器	Spring（MVC）容器
粒度	类级别，基于回调访问servlet前后进行拦截	方法级别，基于AOP在方法执行前后拦截增强

6.3 快速入门

也就是：自定义拦截器开发步骤

1. 实现拦截器接口HandlerInteceptor，非强制实现三个default方法

   @Component //注意当前类必须受Spring容器控制
   public class MyInterceptor implements HandlerInterceptor {
       //处理器运行之前执行
       @Override
       public boolean preHandle(HttpServletRequest request,
                                HttpServletResponse response,
                                Object handler) throws Exception {
           System.out.println("前置运行----a1");
           // 这里先返回true，否则目标Handler方法，以及后面的两个实现方法将无法执行
           return true;
       }
   
       //处理器运行之后执行
       @Override
       public void postHandle(HttpServletRequest request,
                              HttpServletResponse response,
                              Object handler,
                              ModelAndView modelAndView) throws Exception {
           System.out.println("后置运行----b1");
       }
   
       @Override
       public void afterCompletion(HttpServletRequest request,
                                   HttpServletResponse response,
                                   Object handler,
                                   Exception ex) throws Exception {
           System.out.println("完成运行----c1");
       }
   }
   

2. 配置加载拦截器

   @Configuration
   public class SpringMvcSupport extends WebMvcConfigurationSupport {
       @Autowired
       private ProjectInterceptor projectInterceptor;
   
       @Override
       protected void addInterceptors(InterceptorRegistry registry) {
           //配置拦截器
           registry.addInterceptor(projectInterceptor)
               .addPathPatterns("/books","/books/*");
       }
   }
   

   简化写法

   @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/*");
       }
   }
   

6.4 单个拦截器执行流程

6.5 拦截参数

6.5.1 前置处理

//原始方法调用前执行的内容
//返回值类型可以拦截控制的执行，true放行，false终止
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
    System.out.println("preHandle..."+contentType);
    return true;
}

• 参数

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

• 返回值
  返回值为false，被拦截的处理器将不执行。

6.5.2 后置处理

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

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

注意：如果处理器方法出现异常了，该方法不会执行

6.5.3 完成后处理

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

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

注意：无论处理器方法内部是否出现异常，该方法都会执行。

6.6 拦截器链配置

6.6.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");
    }
}

• 配置第二个拦截器

@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/*");
    }
}

6.6.2 多个连接器工作流程分析

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

相关注解

@PathVariable

• 名称：@PathVariable
• 类型：形参注解
• 位置：SpringMVC控制器方法形参定义前面
• 作用：绑定路径参数与处理器方法形参间的关系，要求路径参数名与形参名一一对应

@RestControllerAdvice

• 名称：@RestControllerAdvice

• 类型：类注解

• 位置：Rest风格开发的控制器增强类定义上方

• 作用：为Rest风格开发的控制器类做增强

• 说明：

  @RestControllerAdvice = @ControllerAdvice + @ResponseBody

  ​ =@Component + 通知类 + @ResponseBody

@ExceptionHandler

• 名称：@ExceptionHandler
• 类型：方法注解
• 位置：专用于异常处理的控制器方法上方
• 作用：设置指定异常的处理方案，功能等同于控制器方法，出现异常后终止原始控制器执行，并转入当前方法执行
• 说明：此类方法可以根据处理的异常不同，制作多个方法分别处理对应的异常

放行静态资源

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

rceptor(projectInterceptor2)
.addPathPatterns(“/books”,“/books/*”);
}
}

#### 6.6.2 多个连接器工作流程分析

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

[外链图片转存中...(img-fwocW91m-1654140777627)]















## 相关注解

### `@PathVariable`

- 名称：`@PathVariable`
- 类型：形参注解
- 位置：`SpringMVC`控制器方法形参定义前面
- 作用：绑定路径参数与处理器方法形参间的关系，要求路径参数名与形参名一一对应

[外链图片转存中...(img-ZtBGdyyz-1654140777627)]





### @`RestControllerAdvice`

- 名称：@RestControllerAdvice

- 类型：==类注解==

- 位置：Rest风格开发的控制器增强类定义上方

- 作用：为Rest风格开发的控制器类做增强

- 说明：

  @`RestControllerAdvice` = @`ControllerAdvice` + @`ResponseBody`

  ​																=@`Component` +  通知类 + @`ResponseBody`

  



### @`ExceptionHandler`

- 名称：@ExceptionHandler
- 类型：==方法注解==
- 位置：专用于异常处理的控制器方法上方
- 作用：设置指定异常的处理方案，功能等同于控制器方法，出现异常后终止原始控制器执行，并转入当前方法执行
- 说明：此类方法可以根据处理的异常不同，制作多个方法分别处理对应的异常



## ==放行静态资源==

```java
@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/");
    }
}