基本知识
- 所谓异常？
所有没有根据意愿的返回即是异常 - 为什么要统一异常处理？
让接口返回的状态一致
返回的 Json 格式约定
异常时：
{
"code": 1,
"msg": "金额必传",
"data": null
}
成功时：
{
"code" : 0,
"msg" : "成功"，
"data" :{
"id" : 20,
"bookNum" : "B",
"bookName" : "core java",
"money" : 1.2
}
}
实现异常最外层的统一格式
- 新建 Result 类
//Result 是泛型
public class Result{
//错误码
private Integer code;
//提示信息
private String msg;
//具体内容
private T data;
//
alt + insert,插入set/get 方法
}
- 新建错误处理类 util/ResultUtil
public class ResultUtil{
public static Result success(Object object){
Result result = new Result();
result.setCode(0);
result.setMsg("success");
result.setData(object);
return result;
}
//成功的话也有可能不含 object
public static Result success(){
return success(null);
}
public static Result error(Integer code, String msg){
Result result = new Result();
result.setCode(code);
result.setMsg(msg);
return result;
}
}
- 改造 BookController 相关函数
@RestController
public class BookController{
@PostMapping(value = "/books")
public Result BookAdd(@Valid BookEntity bookEntity,BingResult bingResult){
if (bingResult.hasErrors()){
return ResultUtil.error(1, bingResult.getFieldError().getDefaultMessage);
}
return ResultUtil.success(bookRepository.save(bookEntity));
}
}
用抛出异常代替重复的逻辑判断
现在有这样一个需求，如果书的价格小于100，返回“太便宜”，如果书的价格大于100，小于500，返回 “价格可以接受”。
- 首先应该把业务逻辑判断封装到 Service 层。Controller 层尽量处理与返回值相关。
// 如果没有，新建 service/bookService
@public class BookService{
@Autowired
private BookRepository bookRepository;
public void getBookMoney(Integer id) throws Exception{
BookEntity bookEntity = bookRepository.findOne(id);
Double money = bookEntity.getMoney();
if (money <= 100){
// 太便宜
throw new Exception("太便宜");
} else if(money > 100 && money < 500){
//价格可以接受
throw new Exception("价格可以接受");
}
}
}
- Service 层封装的函数要被Controller调用。如果 Service 层封装的函数返回一个String，如“太便宜”，Controller 再返回这个String。那就会破坏了异常处理最外层的统一格式；如果 Service 层返回一个标识，如“<=100”返回1，“>100&&<500”返回2，Controller 层再判断标识，这样子其实和直接在 Controller 层写业务逻辑没太大区别，代码比较冗余 。推荐的做法是，Service 层把这些信息当成异常抛出，Controller捕获这些异常
//Controller 层也先抛出异常
@GetMapping(value = "books/getBookMoney/{id}")
public void getBookMoney(@Pathvariable("id") Integer id) throws Exception{
bookService.getBookMoney(id);
}
这时候运行一下，返回值如下。我们需要把这个异常捕获，封装最外层的格式之后再返回给浏览器。
{
"timestamp": 1519598697481,
"status": 500,
"error": "Internal Server Error",
"exception": "java.lang.Exception",
"message": "太便宜",
"path": "/books/getBookMoney/1"
}
- 新建 handle/ExceptionHandle, 捕获异常。
@ControllerAdvice
public class ExceptionHandle{
//声明捕获的哪个类
@ExceptionHandler(value = Exception.class)
//因为返回给浏览器一个 json 格式，上面没有 RestController 注解
@ResponseBody
public Result handle(Exception e){
return ResultUtil.error(100, e.getMessage());
}
}
自定义 Exception
自定义 Exception, 不同的错误，状态码与返回信息都不同。
- 新建 exception / BookException
// 必须继承 RuntimeException 才能捕捉到错误
public class BookException extends RuntimeException{
private Integer code;
// 写一个构造方法
public BookException(Integer code,String msg){
// 调用父类方法
super(msg);
this.code = code;
}
public Integer getCode(){
return code;
}
public void setCode(Integer code){
this.code = code;
}
}
- 将 BookService 中原来使用 Exception 的代码替换为自定义异常 BookException.
public void getBookMoney(Integer id) throws Exception{
BookEntity bookEntity = bookRepository.findOne(id);
Double money = bookEntity.getMoney();
if (money <= 100){
throw new BookException(100, "too cheap");
} else if(money > 100 && money <= 500){
throw new BookException(101, "this price is suitable");
}
}
通过日志记录未知错误的具体原因
在 ExceptionHandle 中，如果不是自定义的错误，则会返回“Unkonwn Error”，这对 debug 不友好，需要通过记日志来记录错误的堆栈信息。修改 ExceptionHandle
@ControllerAdvice
public class ExceptionHandle{
private final static Logger logger = LoggerFactory.getLogger(ExceptionHandle.class);
//声明捕获哪个类
@ExceptionHandler(value = Exception.class)
@ResponseBody
public Result handle(Exception e){
if (e instanceof BookException){
BookException bookExcetion = (bookException) e;
} else {
logger.error("[System Error] {}", e);
return ResultUtil.error(-1, "Unknowm Errror");
}
}
}
通过枚举类集中管理异常
- 创建 enumes / ResultEnum
public enum ResultEnum {
// 以后可以把异常集中在这
UNKONWN_ERROR(-1, "UnKnown Error"),
SUCCESS(100, "success"),
CHEAP(100, "it's too cheap"),
SUITABLE(101, "it is suitable");
}
private Integer code;
private String msg;
//构造方法
ResultEnum(Integer code, String msg){
this.code = code;
this.msg = msg;
}
alt + insert ，添加 set/get。
- 修改 BookException 类的构造方法
public BookException(ResultEnum resultEnum){
super(resultEnum.getMsg);
this.code = resultEnum.getCode();
}
- 修改 BookService 中相关的调用。
public void getBookMoney(Ingeter id) throws Exception{
BookEntity bookEntity = bookRepositoty.getMoney(id);
Double money = bookEntity.getMoney();
if (money <= 100){
throw new BookException(ResultEnum.CHEAP);
} else if (money > 100 && money <= 500){
throw new BookExceptiono(ResultEnum.SUITABLE);
}
}