SpringMVC _ SSM整合、拦截器


SpringMVC _ SSM整合、拦截器

其他springMvc笔记

SpringMVC _ 起步(http://mxzfun.xyz/index.php/archives/553/
springMvc _ 请求与响应(http://mxzfun.xyz/index.php/archives/557
SpringMVC _ REST风格(http://mxzfun.xyz/index.php/archives/558
SpringMVC _ SSM整合、拦截器(http://mxzfun.xyz/index.php/archives/562/

DAY4 -- SpringMVC

P43~P58

四、SSM整合

4.1 SSM整合

4.1.1 流程分析

4.1.2 整合配置-实例

pom.xml

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

项目包结构

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

SpringConfig配置类

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

JdbcConfig配置类

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

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

}

MybatisConfig配置类

public class MyBatisConfig {
    @Bean
    public SqlSessionFactoryBean sqlSessionFactory(DataSource dataSource){
        SqlSessionFactoryBean factoryBean = new SqlSessionFactoryBean();
        factoryBean.setDataSource(dataSource);
        factoryBean.setTypeAliasesPackage("com.li.domain");
        return factoryBean;
    }
    @Bean
    public MapperScannerConfigurer mapperScannerConfigurer(){
        MapperScannerConfigurer msc = new MapperScannerConfigurer();
        msc.setBasePackage("com.li.dao");
        return msc;
    }
}

jdbc.properties

  • 在resources下提供jdbc.properties,设置数据库连接四要素。
jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/ssm_db
jdbc.username=root
jdbc.password=1234

SpringMvcConfig

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

Web项目入口配置类(ServletConfig)

  • “设置post请求中文乱码过滤器”导入的是import javax.servlet.Filter;
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请求中文乱码过滤器
    //导入import javax.servlet.Filter;
    @Override
    protected Filter[] getServletFilters() {
        CharacterEncodingFilter filter=new CharacterEncodingFilter();
        filter.setEncoding("utf-8");
        filter.setForceEncoding(true);
        return new Filter[] {filter};

    }

}

4.1.3 功能模块开发

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

创建数据库及表

-- ----------------------------
        -- Table structure for tbl_book
        -- ----------------------------
        DROP TABLE IF EXISTS `tbl_book`;
        CREATE TABLE `tbl_book`  (
        `id` int(11) NOT NULL AUTO_INCREMENT,
        `type` varchar(20) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL,
        `name` varchar(50) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL,
        `description` varchar(255) CHARACTER SET utf8 COLLATE utf8_general_ci NULL DEFAULT NULL,
        PRIMARY KEY (`id`) USING BTREE
        ) ENGINE = InnoDB AUTO_INCREMENT = 13 CHARACTER SET = utf8 COLLATE = utf8_general_ci ROW_FORMAT = Dynamic;

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

模型类(Book)

public class Book {
    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getType() {
        return type;
    }

    public void setType(String type) {
        this.type = type;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }

    private Integer id;
    private String type;
    private String name;
    private String description;
}

Dao接口(BookDao)

public interface BookDao {
    
    @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();

}

Service接口和实现类(BookService)(BookServiceImpl)

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

Contorller类(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();
    }

}

4.1.4 单元测试(JUnit)

//新建测试类
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(classes = SpringConfig.class)
public class BookServiceTest {

    //注入Service类
    @Autowired
    private BookService bookService;

    //编写测试方法
    @Test
    public void testGetById(){
        Book book =bookService.getById(1);
        System.out.println(book);
    }
}

4.1.5 Postman测试(JUnit)

新增

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

修改

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

删除

查询单个

查询所有

4.2 表现层数据封装

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

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

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

实例(设置统一数据返回结果类)

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

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

  • 项目环境基于SSM整合项目环境,可直接套用。
  • (Result类)结果类放在controller包下。

Result类

public class Result{

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


    public Object getData() {
        return data;
    }

    public void setData(Object data) {
        this.data = data;
    }

    public Integer getCode() {
        return code;
    }

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

    public String getMsg() {
        return msg;
    }

    public void setMsg(String msg) {
        this.msg = msg;
    }

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

Code类(定义返回码Code类)

  • code类中的常量设计也不是固定的,可以根据需要自行增减,例如将查询再进行细分为GET_OK、GET_ALL_OK、GET_PAGE_OK等。
//状态码
public class Code {
    //成功,尾数为1
    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;
    
    //失败。尾数为0
    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;
}

修改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);
    }
    
}

测试

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

4.3 异常处理器

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

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

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

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

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

  • 异常分类

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

  • AOP思想

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

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

4.3.2 异常处理器的使用

在controller层新建ProjectExceptionAdvice类(异常处理器类)

//@RestControllerAdvice用于标识当前类为REST风格对应的异常处理器
@RestControllerAdvice
public class ProjectExceptionAdvice {
    //除了自定义的异常处理器,保留对Exception类型的异常处理,用于处理非预期的异常
    @ExceptionHandler(Exception.class)
    public void doException(Exception ex){
        System.out.println("catch");
        //return new Result(666,null,"catchException");
    }
}
  • 确保SpringMvcConfig能够扫描到异常处理器类。

让程序抛出异常

  • 修改BookController的getById方法,添加int i = 1/0
@GetMapping("/{id}")
public Result getById(@PathVariable Integer id) {

    int i =1/0;

    Book book = bookService.getById(id);
    Integer code = book != null ? Code.GET_OK : Code.GET_ERR;
    String msg = book != null ? "" : "数据查询失败,请重试!";
    return new Result(code,book,msg);
}

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

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

测试

  • 异常已经被拦截并执行了doException方法。
  • 就算后台执行的过程中抛出异常,最终也能按照我们和前端约定好的格式返回给前端。

知识点1 —— @RestControllerAdvice

知识点2 —— @ExceptionHandler

4.3.3 项目异常处理方案

  • 业务异常(BusinessException)

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

    • 发送固定消息传递给用户,安抚用户
    • 发送特定消息给运维人员,提醒维护
    • 记录日志:发消息和记录日志对用户来说是不可见的,属于后台程序
  • 其他异常(Exception) 发送固定消息传递给用户,安抚用户

    • 发送特定消息给编程人员,提醒维护(纳入预期范围内)
    • 记录日志

异常解决方案的具体实现

思路
  • 先通过自定义异常,完成BusinessException和SystemException的定义
  • 将其他异常包装成自定义异常类型
  • 在异常处理器类中对不同的异常进行处理
自定义异常类
  • 说明:让自定义异常类继承RuntimeException的好处是,后期在抛出这两个异常的时候,就不用在 try...catch...或throws了。
  • 自定义异常类中添加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;
    }


}
//自定义异常处理器,用于封装异常信息,对异常进行分类
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;
    }

}
将其他异常包成自定义异常
  • 具体的包装方式有:

    • 方式一:try{}catch(){},在catch中重新throw我们自定义异常即可。
    • 方式二:直接throw自定义异常即可。
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);
}
  • 为了使code看着更专业些,我们在Code类中再新增需要的属性。
//状态码
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;
}
处理器类中处理自定义异常
//@RestControllerAdvice用于标识当前类为REST风格对应的异常处理器
@RestControllerAdvice
public class ProjectExceptionAdvice {
    //@ExceptionHandler用于设置当前处理器类对应的异常类型
    @ExceptionHandler(SystemException.class)
    public Result doSystemException(SystemException ex){
//记录日志
//发送消息给运维
//发送邮件给开发人员,ex对象发送给开发人员
        return new Result(ex.getCode(),null,ex.getMessage());
    }
    @ExceptionHandler(BusinessException.class)
    public Result doBusinessException(BusinessException ex){
        return new Result(ex.getCode(),null,ex.getMessage());
    }
    //除了自定义的异常处理器,保留对Exception类型的异常处理,用于处理非预期的异常
    @ExceptionHandler(Exception.class)
    public Result doOtherException(Exception ex){
//记录日志
//发送消息给运维
//发送邮件给开发人员,ex对象发送给开发人员
        return new Result(Code.SYSTEM_UNKNOW_ERR,null,"系统繁忙,请稍后再试!");
    }
}
  • 异常我们就已经处理完成了,不管后台哪一层抛出异常,都会以我们与前端约定好的方式进行返回,前端只需要把信息获取到,根据返回的正确与否来展示不同的内容即可。

总结

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

4.4 前后台协议联调

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

新建SpringMvcSupport

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

在SpringMvcConfig中扫描SpringMvcSupport

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

4.4.2 列表功能

需求

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

4.4.3 添加功能

需求

handleCreate打开新增面板

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

handleAdd方法发送异步请求并携带数据

handleAdd () {
//发送ajax请求
    // this.formData是表单中的数据,最后是一个json数据
    axios.post("/books",this.formData).then((res)=>{
        this.dialogFormVisible = false;
        this.getAll();
    });
}

4.4.4 添加功能状态处理

需求

修改前端页面

//添加
handleAdd() {
    //发送ajax请求
    //this.formData是表单中的数据,最后是一个json数据
    axios.post("/books", this.formData).then((res) => {
        //如果操作成功,关闭弹层,显示数据
        if (res.data.code == 20011) {
            this.dialogFormVisible = false;
            this.$message.success("添加成功");
        } else if (res.data.code == 20010) {
            this.$message.success("添加失败");
        } else {
            this.$message.success(res.data.msg);
        }
    }).finally(() => {
        this.getAll();
    })
},

后台返回操作结果,将Dao层的增删改方法返回值从void改成int

public interface BookDao {
    
    @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();

}

在BookServiceImpl中,增删改方法根据DAO的返回值来决定返回true/false

@Service
public class BookServiceImpl implements BookService {
    @Autowired
    private BookDao bookDao;
    public boolean save(Book book) {
        return bookDao.save(book) > 0;
    }
    public boolean update(Book book) {
        return bookDao.update(book) > 0;
    }
    public boolean delete(Integer id) {
        return bookDao.delete(id) > 0;
    }
    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);
    }
    public List<Book> getAll() {
        return bookDao.getAll();
    }
}

新增成功后,再次点击新增按钮会发现之前的数据还存在,这个时候就需要在新增的时候将表单内容清空

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

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

4.4.5 修改功能

需求

修改handleUpdate方法

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

修改handleEdit方法

//编辑
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();
    });

},

4.4.6 删除功能

需求

修改handleDelete方法

// 删除
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("取消删除操作");
    });
}

五、拦截器

5.1 拦截器概念

  • 拦截器(Interceptor)是一种动态拦截方法调用的机制
  • 作用:

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

拦截器与过滤器区别

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

5.2 入门案例

5.2.1 环境准备

pom.xml

<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>
  <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>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-compiler-plugin</artifactId>
        <configuration>
          <source>8</source>
          <target>8</target>
        </configuration>
      </plugin>
    </plugins>
  </build>

对应的配置类(ServletContainersInitConfig)

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

模型类Book

public class Book {
    private String name;
    private double price;
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public double getPrice() {
        return price;
    }
    public void setPrice(double price) {
        this.price = price;
    }
    @Override
    public String toString() {
        return "Book{" +
                "书名='" + name + '\'' +
                ", 价格=" + price +
                '}';
    }
}

Controller(BookController)

@RestController
@RequestMapping("/books")
public class BookController {
    @PostMapping
    public String save(@RequestBody Book book){
        System.out.println("book save..." + book);
        return "{'module':'book save'}";
    }
    @DeleteMapping("/{id}")
    public String delete(@PathVariable Integer id){
        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'}";
    }
}

5.2.2 拦截器开发

创建拦截器类(ProjectInterceptor)

  • 让类实现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...");
    }
}

配置拦截器类(SpringMvcSupport)

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

SpringMVC添加SpringMvcSupport包扫描(SpringMvcConfig)

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

修改拦截器拦截规则

@Configuration
public class SpringMvcSupport extends WebMvcConfigurationSupport {
    @Autowired
    private ProjectInterceptor projectInterceptor;
    @Override
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/pages/**").addResourceLocations("/pages/");
    }
    @Override
    protected void addInterceptors(InterceptorRegistry registry) {
//配置拦截器
        registry.addInterceptor(projectInterceptor).addPathPatterns("/books","/books/*" );
}
}
  • 这个时候,如果再次访问http://localhost/books/100,拦截器就会被执行。
  • 拦截器中的preHandler方法,如果返回true,则代表放行,会执行原始 Controller类中要请求的方法。
  • 如果返回false,则代表拦截,后面的就不会再执行了。

简化SpringMvcSupport的编写(SpringMvcConfig)

@Configuration
@ComponentScan({"com.li.controller"})
@EnableWebMvc
//实现WebMvcConfigurer接口可以简化开发,但具有一定的侵入性
public class SpringMvcConfig implements WebMvcConfigurer {
    @Autowired
    private ProjectInterceptor projectInterceptor;
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
//配置多拦截器
        registry.addInterceptor(projectInterceptor).addPathPatterns("/books","/books/*");
}
}

5.2.3 拦截器的执行流程

  • 当有拦截器后,请求会先进入preHandle方法;
  • 如果方法返回true,则放行继续执行后面的handle[controller的方法]和后面的方法;
  • 如果返回false,则直接跳过后面方法的执行。

5.3 拦截器参数

5.3.1 前置处理方法

原始方法之前运行preHandle

//原始方法调用前执行的内容
    public boolean preHandle(HttpServletRequest request, HttpServletResponse
            response, Object handler) throws Exception {
        System.out.println("preHandle...");
        return true;
    }
  • request:请求对象
  • response:响应对象
  • handler:被调用的处理器对象,本质上是一个方法对象,对反射中的Method对象进行了再包装。
  • 返回值为false,被拦截的处理器将不执行。

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

5.3.2 后置处理方法(使用率不高)

  • 原始方法运行后运行,如果原始方法被拦截,则不执行。
    @Override
//原始方法调用后执行的内容
    public void postHandle(HttpServletRequest request, HttpServletResponse
            response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("postHandle...");
    }
  • 前三个参数和上面的是一致的。
  • modelAndView:如果处理器执行完成具有返回结果,可以读取到对应数据与页面信息,并进行调整。
  • 因为现在都是返回json数据,所以该参数的使用率不高。

5.3.3 完成处理方法

  • 拦截器最后执行的方法,无论原始方法是否执行。
    @Override
//原始方法调用完成后执行的内容
    public void afterCompletion(HttpServletRequest request,
                                HttpServletResponse response, Object handler, Exception ex) throws Exception
    {
        System.out.println("afterCompletion...");
    }
}
  • 前三个参数与上面的是一致的。
  • ex:如果处理器执行过程中出现异常对象,可以针对异常情况进行单独处理。
  • 因为我们现在已经有全局异常处理器类,所以该参数的使用率也不高。
  • 这三个方法中,最常用的是preHandle,在这个方法中可以通过返回值来决定是否要进行放行;
  • 我们可以把业务逻辑放在该方法中,如果满足业务则返回true放行,不满足则返回false拦截。

5.4 拦截器工作流程分析(拦截器链配置)

5.4.1 配置多个拦截器

  • 之前我们在项目中只添加了一个拦截器,如果有多个,该如何配置?配置多个后,执行顺序是什么?

(1)创建拦截器类

  • 实现接口,并重写接口中的方法
ProjectInterceptor2
@Component
public class ProjectInterceptor2 implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse
            response, Object handler) throws Exception {
        System.out.println("preHandle...222");
        return false;
    }
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse
            response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("postHandle...222");
    }
    @Override
    public void afterCompletion(HttpServletRequest request,
                                HttpServletResponse response, Object handler, Exception ex) throws Exception
    {
        System.out.println("afterCompletion...222");
    }
}

(2)配置拦截器类(SpringMvcConfig)

@Configuration
@ComponentScan({"com.li.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/*");

}
}

5.4.2 拦截器执行的顺序是和配置顺序有关。

  • 先进后出。
  • 当配置多个拦截器时,形成拦截器链。
  • 拦截器链的运行顺序参照拦截器添加顺序为准。
  • 当拦截器中出现对原始处理器的拦截,后面的拦截器均终止运行。
  • 当拦截器运行中断,仅运行配置在前面的拦截器的afterCompletion操作。
  • preHandle:与配置顺序相同,必定运行。
  • postHandle:与配置顺序相反,可能不运行。
  • afterCompletion:与配置顺序相反,可能不运行。
  • 把握住一个原则即可:以最终的运行结果为准

声明:三二一的一的二|版权所有,违者必究|如未注明,均为原创|本网站采用BY-NC-SA协议进行授权

转载:转载请注明原文链接 - SpringMVC _ SSM整合、拦截器


三二一的一的二