详解Spring MVC/Boot 统一异常处理最佳实践

$.ajax({
  type: "GET",
  url: "/user/add",
  dataType: "json",
  success: function(data){
    alert("添加成功");
  }
});

try {
  // do something
} catch (Exception e) {
  e.printStackTrace();
}

$.ajax({
  type: "GET",
  url: "/goods/add",
  dataType: "json",
  success: function(data) {
    if (data.flag) {
      alert("添加成功");
    } else {
      alert(data.message);
    }
  },
  error: function(data){
    alert("添加失败");
  }
});

@RequestMapping("/goods/add")
@ResponseBody
public Map add(Goods goods) {
  Map map = new HashMap();
  try {
    // do something
    map.put(flag, true);
  } catch (Exception e) {
    e.printStackTrace();
    map.put("flag", false);
    map.put("message", e.getMessage());
  }
  reutrn map;
}

public class ResultBean<T> {
  private int code;
  private String message;
  private Collection<T> data;

  private ResultBean() {

  }

  public static ResultBean error(int code, String message) {
    ResultBean resultBean = new ResultBean();
    resultBean.setCode(code);
    resultBean.setMessage(message);
    return resultBean;
  }

  public static ResultBean success() {
    ResultBean resultBean = new ResultBean();
    resultBean.setCode(0);
    resultBean.setMessage("success");
    return resultBean;
  }

  public static <V> ResultBean<V> success(Collection<V> data) {
    ResultBean resultBean = new ResultBean();
    resultBean.setCode(0);
    resultBean.setMessage("success");
    resultBean.setData(data);
    return resultBean;
  }

  // getter / setter 略
}

@RequestMapping("/goods/add")
@ResponseBody
public ResultBean<Goods> getAllGoods() {
  List<Goods> goods = goodsService.findAll();
  return ResultBean.success(goods);
}

@RequestMapping("/goods/update")
@ResponseBody
public ResultBean updateGoods(Goods goods) {
  goodsService.update(goods);
  return ResultBean.success();
}

{
  "code": 0,
  "message": "success",
  "data": [
    {
      "name": "商品1",
      "price": 50.00,
    },
    {
      "name": "商品2",
      "price": 99.99,
    }
  ]
}

{
  "code": -1,
  "message": "XXX 参数有问题, 请重新填写",
  "data": null
}

/**
 * 显示错误信息
 * @param result： 错误信息
 */
function showError(s) {
  alert(s);
}

/**
 * 处理 ajax 请求结果
 * @param result： ajax 返回的结果
 * @param fn： 成功的处理函数 ( 传入data: fn(result.data) )
 */
function handlerResult(result, fn) {
  // 成功执行操作，失败提示原因
  if (result.code == 0) {
    fn(result.data);
  }
  // 用户操作异常, 这里可以对 1 或 2 等错误码进行单独处理, 也可以 result.code > 0 来粗粒度的处理, 根据业务而定.
  else if (result.code == 1) {
    showError(result.message);
  }
  // 系统异常, 这里可以对 -1 或 -2 等错误码进行单独处理, 也可以 result.code > 0 来粗粒度的处理, 根据业务而定.
  else if (result.code == -1) {
    showError(result.message);
  }
  // 如果进行细粒度的状态码判断, 那么就应该重点注意这里没出现过的状态码. 这个判断仅建议在开发阶段保留用来发现未定义的状态码.
  else {
    showError("出现未定义的状态码:" + result.code);
  }
}

/**
 * 根据 id 删除商品
 */
function deleteGoods(id) {
  $.ajax({
    type: "GET",
    url: "/goods/delete",
    dataType: "json",
    success: function(result){
      handlerResult(result, deleteDone);
    }
  });
}

function deleteDone(data) {
  alert("删除成功");
}

@ControllerAdvice
@ResponseBody
public class WebExceptionHandler {

  private static final Logger log = LoggerFactory.getLogger(WebExceptionHandler.class);

  @ExceptionHandler
  public ResultBean unknownAccount(UnknownAccountException e) {
    log.error("账号不存在", e);
    return ResultBean.error(1, "账号不存在");
  }

  @ExceptionHandler
  public ResultBean incorrectCredentials(IncorrectCredentialsException e) {
    log.error("密码错误", e);
    return ResultBean.error(-2, "密码错误");
  }

  @ExceptionHandler
  public ResultBean unknownException(Exception e) {
    log.error("发生了未知异常", e);
    // 发送邮件通知技术人员.
    return ResultBean.error(-99, "系统出现错误, 请联系网站管理员!");
  }
}