SpringMVC学习笔记 - 第二章 - SSM整合案例 - 技术整合、统一结果封装、统一异常处理、前后联调、拦截器

【前置内容】Spring 学习笔记全系列传送门：

  • Spring学习笔记 - 第一章 - IoC（控制反转）、IoC容器、Bean的实例化与生命周期、DI（依赖注入）

  • Spring学习笔记 - 第二章 - 注解开发、配置管理第三方Bean、注解管理第三方Bean、Spring 整合 MyBatis 和 Junit 案例

  • Spring学习笔记 - 第三章 - AOP与Spring事务

SpingMVC 学习笔记全系列传送门：

  • SpringMVC学习笔记 - 第一章 - 工作流程、Bean加载控制、请求与响应（参数接收与内容返回）、RESTful
  • 【本章】SpringMVC学习笔记 - 第二章 - SSM整合案例 - 技术整合、统一结果封装、统一异常处理、前后联调、拦截器
目录
  • 1、SSM整合

    • 1.1 流程分析
    • 1.2 整合配置
    • 1.3 功能模块开发
    • 1.4 单元测试
    • 1.5 PostMan 测试（细节不表）
  • 2、统一结果封装（前后端数据通信协议）

    • 2.1 表现层与前端数据传输协议定义
    • 2.2 表现层与前端数据传输协议实现

      • 2.2.1 思路分析
      • 2.2.2 结果封装
  • 3、统一异常处理

    • 3.1 问题描述
    • 3.2 异常处理器的使用

      • 3.2.1 环境准备
      • 3.2.2 使用步骤
      • 3.2.3 相关知识点

        • 3.2.3.1 @RestControllerAdvice
        • 3.2.3.2 @ExceptionHandler
    • 3.3 项目异常处理方案

      • 3.3.1 异常分类
      • 3.3.2 异常解决方案
      • 3.3.3 异常解决方案的具体实现
  • 4、前后台协议联调

    • 4.1 环境准备
    • 4.2 列表功能
    • 4.3 添加功能
    • 4.4 添加、修改、删除功能状态处理
    • 4.5 修改功能
    • 4.6 删除功能
  • 5、拦截器

    • 5.1 拦截器概念
    • 5.2 拦截器入门案例

      • 5.2.1 环境准备
      • 5.2.2 拦截器开发
      • 5.2.3 拦截器拦截规则
      • 5.2.4 简化SpringMvcSupport的编写
    • 5.3 拦截器参数

      • 5.3.1 前置处理方法
      • 5.3.2 后置处理方法
      • 5.3.3 完成处理方法
    • 5.4 拦截器链运行顺序

1、SSM整合

1.1 流程分析

1.2 整合配置

  1. 创建 Maven - web 项目

  2. 添加依赖

    <?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>priv.dandelion</groupId>
    <artifactId>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>com.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>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>
</project>

  3. 创建项目包结构

  4. SpringConfig配置类

    @Configuration
@ComponentScan({"priv.dandelion.service"})
@PropertySource("classpath:jdbc.properties")
@Import({JdbcConfig.class,MybatisConfig.class})
// 开启事务
@EnableTransactionManagement
public class SpringConfig {
}

  5. JdbcConfig配置类

    public class JdbcConfig {
    @Value("${jdbc.driver}")
    private String driver;
    @Value("${jdbc.url}")
    private String url;
    @Value("${jdbc.username}")
    private String username;
    @Value("${jdbc.password}")
    private String password;
    @Bean
    public DataSource dataSource(){
        DruidDataSource dataSource = new DruidDataSource();
        dataSource.setDriverClassName(driver);
        dataSource.setUrl(url);
        dataSource.setUsername(username);
        dataSource.setPassword(password);
        return dataSource;
    }
    // 事务控制管理器，数据源使用自动装配（由Spring管理）
    @Bean
    public PlatformTransactionManager transactionManager(DataSource dataSource){
        DataSourceTransactionManager ds = new DataSourceTransactionManager();
        ds.setDataSource(dataSource);
        return ds;
    }
}

  6. Mybatis 配置类

    public class MybatisConfig {
    @Bean
    public SqlSessionFactoryBean sqlSessionFactory(DataSource dataSource){
        SqlSessionFactoryBean factoryBean = new SqlSessionFactoryBean();
        factoryBean.setDataSource(dataSource);
        factoryBean.setTypeAliasesPackage("priv.dandelion.entity");
        return factoryBean;
    }
    @Bean
    public MapperScannerConfigurer mapperScannerConfigurer(){
        MapperScannerConfigurer msc = new MapperScannerConfigurer();
        msc.setBasePackage("priv.dandelion.dao");
        return msc;
    }
}

  7. jdbc.properties 配置文件

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

  8. SpringMvc 配置类

    @Configuration
@ComponentScan("priv.dandelion.controller")
@EnableWebMvc
public class SpringMvcConfig {
}

  9. web 项目入口配置类

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

1.3 功能模块开发

  1. SQL

    create database ssm_db character set utf8;
use ssm_db;
create table tbl_book(
  id int primary key auto_increment,
  type varchar(20),
  name varchar(50),
  description varchar(255)
)
insert  into `tbl_book`(`id`,`type`,`name`,`description`) values (1,'计算机理论','Spring实战 第五版','Spring入门经典教程，深入理解Spring原理技术内幕'),(2,'计算机理论','Spring 5核心原理与30个类手写实践','十年沉淀之作，手写Spring精华思想'),(3,'计算机理论','Spring 5设计模式','深入Spring源码刨析Spring源码中蕴含的10大设计模式'),(4,'计算机理论','Spring MVC+Mybatis开发从入门到项目实战','全方位解析面向Web应用的轻量级框架，带你成为Spring MVC开发高手'),(5,'计算机理论','轻量级Java Web企业应用实战','源码级刨析Spring框架，适合已掌握Java基础的读者'),(6,'计算机理论','Java核心技术 卷Ⅰ 基础知识(原书第11版)','Core Java第11版，Jolt大奖获奖作品，针对Java SE9、10、11全面更新'),(7,'计算机理论','深入理解Java虚拟机','5个纬度全面刨析JVM,大厂面试知识点全覆盖'),(8,'计算机理论','Java编程思想(第4版)','Java学习必读经典，殿堂级著作！赢得了全球程序员的广泛赞誉'),(9,'计算机理论','零基础学Java(全彩版)','零基础自学编程的入门图书，由浅入深，详解Java语言的编程思想和核心技术'),(10,'市场营销','直播就这么做:主播高效沟通实战指南','李子柒、李佳奇、薇娅成长为网红的秘密都在书中'),(11,'市场营销','直播销讲实战一本通','和秋叶一起学系列网络营销书籍'),(12,'市场营销','直播带货:淘宝、天猫直播从新手到高手','一本教你如何玩转直播的书，10堂课轻松实现带货月入3W+');

  2. 实体类

    public class Book {
    private Integer id;
    private String type;
    private String name;
    private String description;
    //getter...setter...toString省略
}

  3. Dao 接口

    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 void save(Book book);
    @Update("update tbl_book set type = #{type}, name = #{name}, description = #{description} where id = #{id}")
    public void update(Book book);
    @Delete("delete from tbl_book where id = #{id}")
    public void 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();
}

  4. Service

    • 接口

      // 声明该类需要被事务管理
@Transactional
public interface BookService {
    public boolean save(Book book);
    public boolean update(Book book);
    public boolean delete(Integer id);
    public Book getById(Integer id);
    public List<Book> getAll();
}

    • 实现类

      @Service
public class BookServiceImpl implements BookService {
    @Autowired
    private BookDao bookDao;
    @Override
    public boolean save(Book book) {
        bookDao.save(book);
        return true;
    }
    @Override
    public boolean update(Book book) {
        bookDao.update(book);
        return true;
    }
    @Override
    public boolean delete(Integer id) {
        bookDao.delete(id);
        return true;
    }
    @Override
    public Book getById(Integer id) {
        return bookDao.getById(id);
    }
    @Override
    public List<Book> getAll() {
        return bookDao.getAll();
    }
}

  5. Controller

    package priv.dandelion.service.impl;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import priv.dandelion.dao.BookDao;
import priv.dandelion.entity.Book;
import priv.dandelion.service.BookService;
import java.util.List;
@Service
public class BookServiceImpl implements BookService {
    @Autowired
    private BookDao bookDao;
    @Override
    public boolean save(Book book) {
        bookDao.save(book);
        return true;
    }
    @Override
    public boolean update(Book book) {
        bookDao.update(book);
        return true;
    }
    @Override
    public boolean delete(Integer id) {
        bookDao.delete(id);
        return true;
    }
    @Override
    public Book getById(Integer id) {
        return bookDao.getById(id);
    }
    @Override
    public List<Book> getAll() {
        return bookDao.getAll();
    }
}

1.4 单元测试

  1. 新建测试类

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

  2. 注入 Service 类，编写测试方法

    @RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(classes = SpringConfig.class)
public class BookServiceTest {
    @Autowired
    private BookService bookService;
    @Test
    public void testGetById() {
        Book byId = bookService.getById(1);
        System.out.println(byId);
    }
    @Test
    public void testGetAll() {
        List<Book> all = bookService.getAll();
        System.out.println(all);
    }
}

1.5 PostMan 测试（细节不表）

2、统一结果封装（前后端数据通信协议）

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

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

2.2.1 思路分析

2.2.2 结果封装

  1. 创建 Result 类

    public class Result{
	private Object data;
	private Integer code;
	private String msg;
    // 构造、getter、setter略...
}

  2. 定义返回码 Code 类

    public class Code {
    public static final Integer SAVE_OK = 20011;
    public static final Integer DELETE_OK = 20021;
    public static final Integer UPDATE_OK = 20031;
    public static final Integer GET_OK = 20041;
    public static final Integer SAVE_ERR = 20010;
    public static final Integer DELETE_ERR = 20020;
    public static final Integer UPDATE_ERR = 20030;
    public static final Integer GET_ERR = 20040;
}

  3. 修改 Conteoller 类的返回值

    @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> all = bookService.getAll();
        Integer code = all != null ? Code.GET_OK : Code.GET_ERR;
        String msg = all != null ? "" : "数据查询失败，请重试";
        return new Result(code, all, msg);
    }
}

3、统一异常处理

3.1 问题描述

当出现异常时，响应500等错误代码，返回错误页面，前端获取到有效信息，无法处理

3.2 异常处理器的使用

为实现统一的异常处理，Spring提供了异常处理器

3.2.1 环境准备

3.2.2 使用步骤

  1. 创建异常处理器类

    // 声明这个类用于Rest风格对应的统一异常处理器类
@RestControllerAdvice
public class ProjectExceptionAdvice {
    // 拦截异常
    @ExceptionHandler(Exception.class)
    public void doException(Exception ex) {
        System.out.println("捕获异常");
    }
}

  2. 异常处理器类返回结果到前端

    // 声明这个类用于Rest风格对应的统一异常处理
@RestControllerAdvice
public class ProjectExceptionAdvice {
    // 拦截异常
    @ExceptionHandler(Exception.class)
    // 修改返回值类型，向前端返回异常信息
    public Result doException(Exception ex) {
        String msg = "异常捕获";
        System.out.println(msg);
        return new Result(00000, null, msg);
    }
}

3.2.3 相关知识点

3.2.3.1 @RestControllerAdvice
名称 @RestControllerAdvice
类型 类注解
位置 Rest风格开发的控制器增强类定义上方
作用 为Rest风格开发的控制器类做增强
说明 此注解自带@ResponseBody注解与@Component注解，具备对应的功能
3.2.3.2 @ExceptionHandler
名称 @ExceptionHandler
类型 方法注解
位置 专用于异常处理的控制器方法上方
作用 设置指定异常的处理方案，功能等同于控制器方法，
出现异常后终止原始控制器执行,并转入当前方法执行
说明 此类方法可以根据处理的异常不同，制作多个方法分别处理对应的异常

3.3 项目异常处理方案

3.3.1 异常分类

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

3.3.2 异常解决方案

3.3.3 异常解决方案的具体实现

  1. 自定义异常类

    • 系统异常（SystemException）

      // 继承RuntimeException，可以不做处理自动上抛
public class SystemException extends RuntimeException{
    private Integer 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 Integer getCode() {
        return code;
    }
    public void setCode(Integer code) {
        this.code = code;
    }
}

    • 业务异常（BusinessException）

      public class BusinessException extends RuntimeException{
    private Integer 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;
    }
    public Integer getCode() {
        return code;
    }
    public void setCode(Integer code) {
        this.code = code;
    }
}

  2. 将其他异常包成自定义异常（本案例在Service中进行）

    @Override
public Book getById(Integer id) {
    // 将可能出现的异常进行包装，转换成自定义异常
    if (id <= 0) {
        throw new BusinessException(Code.BUSINESS_ERR, "数据不合法");
    }
    // 将可能出现的异常进行包装，转换成自定义异常
    try{
        int i = 1/0;
        return bookDao.getById(id);
    }catch (ArithmeticException ae){
        throw new SystemException(Code.SYSTEM_TIMEOUT_ERR, "服务器访问超时");
    }
}

  3. 处理器类中处理自定义异常

    • 原先的public Result doException(Exception ex){}仍然保留，用于处理其他异常

    • 此处为了方便新增了错误代码

      public static final Integer SYSTEM_ERR = 50001;
public static final Integer SYSTEM_TIMEOUT_ERR = 50002;
public static final Integer SYSTEM_UNKNOWN_ERR = 59999;
public static final Integer BUSINESS_ERR = 60001;

    // 声明这个类用于Rest风格对应的统一异常处理
@RestControllerAdvice
public class ProjectExceptionAdvice {
    // 拦截异常
    @ExceptionHandler(SystemException.class)
    public Result doException(SystemException ex) {
        // 记录日志
        // 发送消息给运维
        // 邮件发送ex的对象给开发
        // 返回消息内容
        return new Result(ex.getCode(), null, ex.getMessage());
    }
    // 拦截异常
    @ExceptionHandler(BusinessException.class)
    public Result doException(BusinessException ex) {
        // 记录日志
        // 发送邮件给开发
        // 返回消息内容
        return new Result(ex.getCode(), null, ex.getMessage());
    }
    // 仍然保留，用于处理其他异常
    @ExceptionHandler(Exception.class)
    // 修改返回值类型，向前端返回异常信息
    public Result doException(Exception ex) {
        // 记录日志
        // 发送消息给运维
        // 邮件发送ex的对象给开发
        // 返回消息内容
        return new Result(Code.SYSTEM_UNKNOWN_ERR, null, "系统繁忙请稍后再试");
    }
}

4、前后台协议联调

4.1 环境准备

4.2 列表功能

4.3 添加功能

4.4 添加、修改、删除功能状态处理

4.5 修改功能

4.6 删除功能

// 删除
handleDelete(row) {
    // 弹出提示框
    this.$confirm("此操作将永久删除数据，请确认","注意",{
        type:'info'
    }).then(()=>{
        // 确认删除
        // 发送Ajax请求
        axios.delete("/books/" + row.id).then((res)=>{
            if (res.data.code == 20021) {
                this.$message.success("删除成功");
            } else {
                this.$message.error("删除失败");
            }
        }).finally(()=>{
            // 重新显示数据
            this.getAll();
        });
    }).catch(()=>{
        // 取消删除
        this.$message.info("删除已取消");
    });
}

5、拦截器

5.1 拦截器概念

5.2 拦截器入门案例

5.2.1 环境准备

5.2.2 拦截器开发

  1. 创建拦截器类

    • 拦截器一般写在 controller 包下，一般只给 controller 用
    • 拦截器也可以写在其他位置，但是要保证 SpringMVC 配置类的包扫描可以扫描到 
    package priv.dandelion.controller.interceptor;
// import ...
@Component
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");
    }
}

  2. 配置拦截器类

    • 此处写在了 SpringMvcSupport 中，注意配置类注解
    • 要保证 SpringMVC 配置类的包扫描可以扫描到
    @Configuration
public class SpringMvcSupport extends WebMvcConfigurationSupport {
    @Autowired
    private ProjectInterceptor projectInterceptor;
    // 配置拦截器
    @Override
    protected void addInterceptors(InterceptorRegistry registry) {
        // 使用到的两个参数均为可变参数，可以直接写多个，addResourceHandlers()中相同，不再赘述
        // registry.addInterceptor(projectInterceptor).addPathPatterns("/books", "/books/*");
        // 也可以采用这种形式，拦截/books,/books/*，/books/*/*...
        registry.addInterceptor(projectInterceptor).addPathPatterns("/books/**");
    }
    @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.3 拦截器拦截规则

5.2.4 简化SpringMvcSupport的编写

  • 可以直接在 SpringMvcConfig 中继承 WebMvcConfigurer 接口，覆写相应方法，效果相同
  • 相比 SpringMvcSupport 具有一定侵入性
@Configuration
@ComponentScan("priv.dandelion.controller")
@EnableWebMvc
public class SpringMvcConfig implements WebMvcConfigurer {
    @Autowired
    private ProjectInterceptor projectInterceptor;
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(projectInterceptor).addPathPatterns("/books/**");
    }
    @Override
    public 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.3 拦截器参数

拦截器代码见 5.2.2

5.3.1 前置处理方法

5.3.2 后置处理方法

5.3.3 完成处理方法

5.4 拦截器链运行顺序

标签 , ,

发表回复