本文纲要
- 统一异常处理方案
- 异常分类与处理原则
SpringMVC异常处理器- 自定义异常与统一返回结构
- 项目异常处理实战
- 定义业务异常与系统异常
- 异常激活与包装
- 编写统一异常处理类
- 完善数据层返回值
- 前后端协议联调
- 静态资源放行
- 列表查询
- 添加功能及状态处理
- 修改功能
- 删除功能
- 项目结构一览
- 总结
统一异常处理方案
在标准 SSM 项目中,当程序出现异常时,默认会返回一大段 HTML 错误页面,前端无法解析,统一返回格式被打破。
因此需要一套机制,将所有异常统一拦截,并按照统一 JSON 格式返回给前端。
1 ) 异常出现的场景
项目中异常无处不在,可归纳为以下几类:
| 分类 | 来源 | 示例 |
|---|---|---|
| 框架内部抛出 | 框架使用不规范 | MyBatis 配置错误 |
| 数据层抛出 | SQL 错误、数据库宕机、超时 | java.sql.SQLException |
| 业务层抛出 | 业务逻辑运算错误(空指针、除零、索引越界) | NullPointerException |
| 表现层抛出 | 前端传入数据格式错误、校验失败 | 类型转换异常 |
| 工具类抛出 | 自定义工具类代码健壮性不足 | 文件读取失败 |
2 ) 异常处理的核心思想
- 异常向上抛:数据层 → 业务层 → 表现层。各层不自己处理,统一抛到表现层。
- 集中处理:在表现层使用 AOP 思想 统一拦截所有方法抛出的异常,避免在每个 Controller 方法中写大量
try-catch。 - 分类处理:不同异常返回不同消息和状态码,方便前端展示。
SpringMVC 提供了开箱即用的方案:@RestControllerAdvice + @ExceptionHandler。
项目异常处理实战
1 ) 自定义异常类
为区分业务异常、系统异常和其他未知异常,首先定义两个运行时异常类,它们都包含一个 code 编码字段,用于标识具体异常类型。
系统异常 SystemException
package com.wb.exception;
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;
}
}
业务异常 BusinessException
package com.wb.exception;
public class BusinessException extends RuntimeException {
private Integer code;
public Integer getCode() {
return code;
}
public void setCode(Integer code) {
this.code = code;
}
public BusinessException(Integer code, String message) {
super(message);
this.code = code;
}
public BusinessException(Integer code, String message, Throwable cause) {
super(message, cause);
this.code = code;
}
}
继承 RuntimeException 的目的是:抛出后不需要在方法签名中显式声明,能够自动向上层抛。
2 ) 统一返回状态码
在 Code 常量类中,不仅包含业务操作状态码,还加入了系统级异常码。
package com.wb.controller;
public class Code {
public static final Integer SAVE_OK = 20011;
public static final Integer DELETE_OK = 20021;
public static final Integer UPDATE_OK = 20031;
public static final Integer GET_OK = 20041;
public static final Integer SAVE_ERR = 20010;
public static final Integer DELETE_ERR = 20020;
public static final Integer UPDATE_ERR = 20030;
public static final Integer GET_ERR = 20040;
// 系统异常码
public static final Integer SYSTEM_ERR = 50001;
public static final Integer SYSTEMTIMEOUTERR = 50002;
public static final Integer SYSTEMUNKNOWERR = 59999;
// 业务异常码
public static final Integer BUSINESS_ERR = 60002;
}
3 ) 在 Service 层激活异常
业务层是抛出异常的主要场所,我们需要把原本可能发生的各种异常包装成自定义异常再抛出。
package com.wb.service.impl;
import com.wb.controller.Code;
import com.wb.dao.BookDao;
import com.wb.domain.Book;
import com.wb.exception.BusinessException;
import com.wb.exception.SystemException;
import com.wb.service.BookService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import java.util.List;
@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) {
// 模拟业务异常:当id为1时视为非法请求
if (id == 1) {
throw new BusinessException(Code.BUSINESS_ERR, "请不要使用你的技术挑战我的耐性!");
}
// 模拟系统异常:数据库操作可能抛出的异常,统一包装成SystemException
// try {
// int i = 1 / 0;
// } catch (Exception e) {
// throw new SystemException(Code.SYSTEMTIMEOUTERR, "服务器访问超时,请重试!", e);
// }
return bookDao.getById(id);
}
public List<Book> getAll() {
return bookDao.getAll();
}
}
包装方式:
- 业务类异常:直接判断参数或状态后
throw new BusinessException(code, message)。 - 系统类异常:使用
try-catch捕获原始异常,再throw new SystemException(code, message, e),既保留了异常链,又实现了分类。
4 ) 统一异常处理器
使用 @RestControllerAdvice 声明该类为 Rest 风格全局异常增强器,@ExceptionHandler 指定处理方法拦截的异常类型。
package com.wb.controller;
import com.wb.exception.BusinessException;
import com.wb.exception.SystemException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;
@RestControllerAdvice
public class ProjectExceptionAdvice {
@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());
}
// 兜底:处理非预期的其他异常
@ExceptionHandler(Exception.class)
public Result doOtherException(Exception ex) {
// 记录日志
// 发送消息给运维
// 发送邮件给开发人员
return new Result(Code.SYSTEMUNKNOWERR, null, "系统繁忙,请稍后再试!");
}
}
处理流程:
5 ) 统一返回类 Result
package com.wb.controller;
public class Result {
private Object data;
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;
}
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;
}
}
6 ) 改进 DAO 层返回值
为了让 Service 层能够正确判断数据操作是否成功(尤其是新增、修改、删除),需要将 DAO 方法的返回值从 void 改为 int(受影响行数)。
BookDao 接口
package com.wb.dao;
import com.wb.domain.Book;
import org.apache.ibatis.annotations.Delete;
import org.apache.ibatis.annotations.Insert;
import org.apache.ibatis.annotations.Select;
import org.apache.ibatis.annotations.Update;
import java.util.List;
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();
}
Service 层据此修改:
public boolean save(Book book) {
return bookDao.save(book) > 0;
}
至此,后台异常处理体系搭建完成。
前后端协议联调
在 springmvc11page 项目中集成了页面,并完成了列表、新增、修改、删除功能的前后端对接。
前后端交互统一采用 RESTful 风格 + JSON 格式。
1 ) 项目结构
springmvc_11_page
├─ pom.xml
├─ src/main/java/com/wb
│ ├─ config
│ │ ├─ JdbcConfig.java
│ │ ├─ MyBatisConfig.java
│ │ ├─ ServletConfig.java
│ │ ├─ SpringConfig.java
│ │ ├─ SpringMvcConfig.java
│ │ └─ SpringMvcSupport.java
│ ├─ controller
│ │ ├─ BookController.java
│ │ ├─ Code.java
│ │ ├─ ProjectExceptionAdvice.java
│ │ └─ Result.java
│ ├─ dao
│ │ └─ BookDao.java
│ ├─ domain
│ │ └─ Book.java
│ ├─ exception
│ │ ├─ BusinessException.java
│ │ └─ SystemException.java
│ └─ service
│ ├─ BookService.java
│ └─ impl
│ └─ BookServiceImpl.java
├─ src/main/resources
│ └─ jdbc.properties
└─ src/main/webapp
├─ pages/books.html
├─ css/
├─ js/
├─ plugins/
└─ WEB-INF/web.xml
2 ) 静态资源放行
SpringMVC 默认拦截所有请求,包括静态页面。需要配置资源放行。
SpringMvcSupport
package com.wb.config;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
@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 中扫描该配置类:
@Configuration
@ComponentScan({"com.wb.controller", "com.wb.config"})
@EnableWebMvc
public class SpringMvcConfig {
}
3 ) Vue 页面核心数据与方法
前端使用 Vue + ElementUI,核心变量:
dataList:列表数据formData:表单数据dialogFormVisible:新增弹层显示dialogFormVisible4Edit:编辑弹层显示
4 ) 列表功能
前端请求 :axios.get("/books")
Controller 处理:
@GetMapping
public Result getAll() {
List<Book> bookList = bookService.getAll();
Integer code = bookList != null ? Code.GETOK : Code.GETERR;
String msg = bookList != null ? "" : "数据查询失败,请重试!";
return new Result(code, bookList, msg);
}
前端接收并渲染:
getAll() {
axios.get("/books").then((res) => {
this.dataList = res.data.data;
});
}
5 ) 添加功能
添加功能需要弹窗、提交、区分成功/失败/异常状态。
弹出窗口与重置表单:
handleCreate() {
this.dialogFormVisible = true;
this.resetForm();
},
resetForm() {
this.formData = {};
}
提交流程:
handleAdd() {
axios.post("/books", this.formData).then((res) => {
console.log(res.data);
if (res.data.code == 20011) { // SAVE_OK
this.dialogFormVisible = false;
this.$message.success("添加成功");
} else if (res.data.code == 20010) { // SAVE_ERR
this.$message.error("添加失败");
} else { // 系统级错误
this.$message.error(res.data.msg);
}
}).finally(() => {
this.getAll(); // 无论成功失败,刷新列表
});
}
后台 Controller:
@PostMapping
public Result save(@RequestBody Book book) {
boolean flag = bookService.save(book);
return new Result(flag ? Code.SAVEOK : Code.SAVEERR, flag);
}
状态码判断:
20011— 添加成功,关闭弹层,提示成功,刷新列表。20010— 添加失败,不关闭弹层,提示失败。- 其他 — 服务器异常,直接显示后端返回的消息(如“系统繁忙,请稍后再试”)。
6 ) 修改功能
- 修改分两步:
- 查询数据并回显
- 提交修改
弹窗并回显:
handleUpdate(row) {
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() {
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();
});
}
Controller:
@PutMapping
public Result update(@RequestBody Book book) {
boolean flag = bookService.update(book);
return new Result(flag ? Code.UPDATEOK : Code.UPDATEERR, flag);
}
7 ) 删除功能
删除前弹出确认框,确认后发送 DELETE 请求,取消则提示。
handleDelete(row) {
this.$confirm("此操作永久删除当前数据,是否继续?", "提示", {
type: 'info'
}).then(() => {
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("取消删除操作");
});
}
Controller:
@DeleteMapping("/{id}")
public Result delete(@PathVariable Integer id) {
boolean flag = bookService.delete(id);
return new Result(flag ? Code.DELETEOK : Code.DELETEERR, flag);
}
删除确认流程:
总结
通过本次 SSM 整合实战,我们完成了两大核心能力建设:
统一异常处理
- 将异常分为业务异常、系统异常、未知异常三类。
- 自定义异常继承
RuntimeException 并携带code,便于分类。 - 使用
@RestControllerAdvice+@ExceptionHandler实现全局异常拦截。 - 所有异常最终返回统一的 Result JSON 结构,前端只需解析
code和msg。
前后端协议联调
- 配置
SpringMvcSupport放行静态资源 - 列表、新增、修改、删除全部采用 RESTful 风格
- 前端根据返回的状态码(
20011 / 20010等)进行差异化处理,并利用finally刷新数据 - 删除操作添加确认机制,提升用户体验
这套模式已成为现代 Java Web 项目的标准实践,帮助团队构建健壮、可维护的后台服务
1228



被折叠的 条评论
为什么被折叠?



