前言
为了巩固所学的知识，作者尝试着开始发布一些学习笔记类的博客，方便日后回顾。当然，如果能帮到一些萌新进行新技术的学习那也是极好的。作者菜菜一枚，文章中如果有记录错误，欢迎读者朋友们批评指正。
（博客的参考源码可以在我主页的资源里找到，如果在学习的过程中有什么疑问欢迎大家在评论区向我提出）
1. 本文建立在SSM整合快速入门案例(一)的基础上进行编写，该博客可以在我的ssm专栏里找到
一、表现层与前端数据传输协议定义
1. 情景引入
后端返回的数据格式不统一，不利于前端访问数据，需要统一格式
2. 解决方案
前端接收数据格式-创建结果模型类，封装数据到data属性中
3. 不足与改进1.0
- 在ssm快速入门的基础案例中我们发现增删改查返回到前端页面的结果都是true,不利于区分
- 因此我们在结果模型类data中添加一个code属性，代表具体的查询结果（示例中用200X代表操作种类，用0和1代表操作是否成功）
4. 不足与改进2.0
- 当查询空时数据data返回null，页面渲染空数据，此时展示什么给用户看呢？
- 因此我们在结果模型类中添加一个message属性用于解决该类问题
5. 表现层数据封装
- 设置统一数据返回结果类
- Result类中的字段并不是固定的，可以根据需要自行增减，提供若干个构造方法，方便操作
二、表现层与前端数据传输协议实现
结果模型类属于表现层，故将其定义在controller包下
1. 在controller包中创建编辑结果模型类Result，并定义几个构造方法模拟需求
public class Result { //此处省略gerter、setter方法 //描述统一格式中的数据 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; }
2. 在controller包中创建定义状态码类Code
Code类的常量设计也不是固定的，可以根据需要自行增减，例如将查询再进行细分为GET OK，GET ALL OK，GET PAGE OK
//状态码 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. 修改优化BookController
- 所有方法都返回Result类型
- return语句中进行操作成功与否判断并返回状态码和数据（增删改查返回数据的结构有所差别，对应了结果模型类中不同的构造方法）
//统一每一个控制器方法返回值 @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. 测试示例
三、异常处理器
1. 情景导入
程序在开发中不可避免的会遇到异常现象，无法正常返回数到表现层，影响了业务的正常运行和用户体验，因此我们需要对其进行处理
2. 异常的分类
- 框架内部抛出的异常: 因使用不合规导致(比如mybatis配置中写错相关信息)
- 数据层抛出的异常: 因外部服务器故障导致 (例如: 服务器访问超时、sql语句书写错误)
- 业务层抛出的异常:因业务逻辑书写错误导致(例如: 遍历业务书写操作，导致索引异常等
- 表现层抛出的异常:因数据收集、校验等规则导致 (例如: 不匹配的数据类型间导致异常)
- 工具类抛出的异常: 因工具类书写不严谨不够健壮导致(例如:必要释放的连接长期未释放等)
3. 异常处理器
- 各个层级均出现异常，异常处理代码书写在哪一层
所有的异常全部抛到表现层进行分类处理
- 表现层处理异常，每个方法中单独书写，代码书写量巨大且意义不强，如何解决
采用AOP思想，当程序出异常时都到AOP思想定义的方法中去处理
- 是否自己单独写AOP
其实spring提供了基于AOP思想的异常处理器来集中统一解决异常，一般格式如下：
- 名称: @RestControllerAdvice
类型:类注解
位置: Rest风格开发的控制器增强类定义上方
作用:用于标识当前类为REST风格对应的异常处理器，为Rest风格开发的控制器类做增强，
说明:此注解自带@ResponseBody注解与@Component注解，具备对应的功能- 名称: @ExceptionHandler
类型:方法注解
位置:专用于异常处理的控制器方法上方
作用:设置指定异常的处理方案，功能等同于控制器方法，出现异常后终止原始控制器执行，并转入当前方法执行
说明：此类方法可以根据处理的异常不同，制作多个方法分别处理对应的异常- 示例：
四、项目异常处理
1. 项目异常分类
- 业务异常 (BusinessException)
规范的用户行为产生的异常和不规范的用户行为操作产生的异常- 系统异常 (SystemException)
项目运行过程中可预计且无法避免的异常其他异常- 其他异常 (Exception)
编程人员未预期到的异常
2. 项目异常处理方案
- 业务异常 (BusinessException
发送对应消息传递给用户，提醒规范操作.- 系统异常 (SystemException)
发送固定消息传递给用户，安抚用户;
发送特定消息给运维人员，提醒维护;
记录日志.- 其他异常 (Exception)
发送固定消息传递给用户，安抚用户;
发送特定消息给编程人员，提醒维护 (纳入预期范围内);
记录日志.
3. 定义异常类
- 创建exception包，创建定义系统异常类SystemException
//自定义异常处理器，用于封装异常信息，对异常进行分类 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; } }
- 创建定义异常类SystemException
//自定义异常处理器，用于封装异常信息，对异常进行分类 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. 在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;
5. 在业务层实现类BookServiceImpl中模拟异常
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); }
6. 在Controller包中创建编写项目异常处理类ProjectExceptionAdvice
//1.@RestControllerAdvice用于标识当前类为REST风格对应的异常处理器 @RestControllerAdvice public class ProjectExceptionAdvice { //2.@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,"系统繁忙，请稍后再试！"); } }
7. 模拟异常访问与文件结构示例
8. 小结：项目异常案例处步骤
- 自定义项目系统级异常
- 自定义项目业务级异常
- 自定义异常编码
- 触发自定义异常
- 拦截并处理异常
- 异常处理器效果对比
