Spring REST 异常处理之本地处理

前面的几篇博客详细地介绍了spring中非REST的异常处理，而本文则粗略介绍spring中使用REST方式处理异常的第一种情况-----本地REST异常处理。

• 代码

/**
 * 异常处理的几个关键类 | 见 spring framework 文档 22.11 节
 *
 * {@link HandlerExceptionResolver}
 *
 * {@link AbstractHandlerExceptionResolver}
 *
 * {@link DefaultErrorAttributes}
 *
 * {@link DefaultHandlerExceptionResolver}
 *
 * {@link SimpleMappingExceptionResolver}
 */
@Controller
@RequestMapping(value = {"/rest/exception/local"})
public class RestExceptionHandlerController {

    /**
     * 测试方法之一，直接抛出异常
     */
    @RequestMapping("/dataIntegrityViolation")
    public void throwDataIntegrityViolationException() {
        throw new DataIntegrityViolationException("ID 重复");
    }

    /**
     * 如果 {@link ExceptionHandler} 注解中没有指定需要处理的异常
     * 
     * 则处理该方法参数中指定的异常
     * 
     * @param ex 该异常处理方法要默认要处理的异常类型
     * 
     * @return REST 方式的响应体
     */
    @ExceptionHandler(value = {DataIntegrityViolationException.class})
    public ResponseEntity<String> handleDataIntegrityViolationException(
            DataIntegrityViolationException ex) {
        return new ResponseEntity<>(ex.getLocalizedMessage(), HttpStatus.BAD_REQUEST);
    }

    /**
     * 测试方法之二，直接抛出异常
     */
    @RequestMapping("/databaseError")
    public String throwSqlException() throws SQLException {
        throw new SQLException("SQL 异常");
    }

    /**
     * 如果 {@link ExceptionHandler} 注解中没有指定需要处理的异常
     *
     * 则处理该方法参数中指定的异常
     *
     * @param ex 该异常处理方法要默认要处理的异常类型
     *
     * @return REST 方式的响应体
     */
    @ExceptionHandler(value = {SQLException.class})
    @ResponseBody
    public String handleSqlException(SQLException ex) {
        return "{ message : " + ex.getMessage() + " }";
    }
}

• 查看验证（乱码问题不是本文要关注的）
  
  

从代码中可以看出，我们使用了2种方式来处理REST类型的本地异常：一种是通过将异常处理方法的返回值设置为ResponseEntity类型；一种是使用@ResponseBody注解标注异常处理方法。

需要注意的是，上面的例子只是介绍一个思路，介绍的非常简单，在实际应用中，我们可以实现复杂的异常处理逻辑，返回内容更加丰富的异常对象。

• 参考

1. Spring 异常处理之HTTP状态码
2. Spring 异常处理之本地处理
3. Spring 异常处理之全局处理
4. Spring REST 异常处理之本地处理
5. Spring REST 异常处理之全局处理