SpringMVC下异常处理思路

SpringMVC下异常处理思路

问题：
1.在做一些基础web开发的时候，为了有良好的用户体验，每一步的操作流程都要返回给用户信息，例如在添加数据或者删除数据时，需要告诉用户添加成功，或者删除成功，而在一些失败的逻辑中，也需要告诉用户失败的原因是啥，而当产生一些不可预知的异常时，我们希望返回给用户的是“系统繁忙，请稍后的重试的提示，而不是用户看不懂过的错误信息等等”
2.、service方法在执行过程出现异常在哪捕获？在service中需要都加try/catch，如果在controller也需要添加try/catch，代码冗余严重且不易维护。
解决方案：
1、在Service方法中的编码顺序是先校验判断，有问题则抛出具体的异常信息，最后执行具体的业务操作，返回成功信息。
2、在统一异常处理类中去捕获异常，无需controller捕获异常，向用户返回统一规范的响应信息。

//校验页面是否存在，已存在则抛出异常
if(cmsPage1 !=null){
//抛出异常，已存在相同的页面名称，返回前台页面重复，而非简单的操作失败信息
//...
}

异常处理流程

1、自定义异常类型。
2、自定义错误代码及错误信息。
3、对于可预知的异常由程序员在代码中主动抛出，由SpringMVC统一捕获。可预知异常是程序员在代码中手动抛出本系统定义的特定异常类型，由于是程序员抛出的异常，通常异常信息比较齐全，程序员在抛出时会指定错误代码及错误信息，获取异常信息也比较方便。
4、对于不可预知的异常（运行时异常）由SpringMVC统一捕获Exception类型的异常。不可预知异常通常是由于系统出现bug、或一些不要抗拒的错误（比如网络中断、服务器宕机等），异常类型为
RuntimeException类型（运行时异常）。
5、可预知的异常及不可预知的运行时异常最终会采用统一的信息格式（错误代码+错误信息）来表示，最终也会随请求响应给客户端。

异常抛出即处理流程

1、在controller、service、dao中程序员抛出自定义异常；springMVC框架抛出框架异常类型
2、统一由异常捕获类捕获异常，并进行处理
3、捕获到自定义异常则直接取出错误代码及错误信息，响应给用户。
4、捕获到非自定义异常类型首先从Map中找该异常类型是否对应具体的错误代码，如果有则取出错误代码和错误信息并响应给用户，如果从Map中找不到异常类型所对应的错误代码则统一为99999错误代码并响应给用户。
5、将错误代码及错误信息以Json格式响应给用户。

可预知异常处理

自定义异常类

在公共模块中自定义异常类，注意扫描该模块下的异常类

public class CustomException extends RuntimeException {
    private ResultCode resultCode;
    
    public CustomException(ResultCode resultCode) {
        super("错误代码：" + resultCode.code() + "错误信息：" + resultCode.message());
        this.resultCode = resultCode;
    }

    public ResultCode getResultCode() {
        return this.resultCode;
    }
}

定义异常抛出类

public class ExceptionCast {
    //使用此静态方法抛出异常
    public static void cast(ResultCode resultCode){
        throw new CustomException(resultCode);
    }
  }

以及异常获取类
使用 @ControllerAdvice和@ExceptionHandler注解来捕获指定类型的异常

@ControllerAdvice //控制器增强注解
public class ExceptionCatch {
    private static final Logger LOGGER = LoggerFactory.getLogger(ExceptionCatch.class);
    //使用EXCEPTIONS存放异常类型和错误代码的映射，ImmutableMap的特点的一旦创建不可改变，并且线程安全
    private static ImmutableMap<Class<? extends Throwable>, ResultCode> EXCEPTIONS;
    //使用builder来构建一个异常类型和错误代码的异常
    protected static ImmutableMap.Builder<Class<? extends Throwable>, ResultCode> builder =
            ImmutableMap.builder();

    static {
        //在这里加入一些基础的异常类型判断
        builder.put(HttpMessageNotReadableException.class, CommonCode.INVALID_PARAM);
    }

    //捕获Exception异常
    @ResponseBody
    @ExceptionHandler(Exception.class)
    public ResponseResult exception(Exception e) {
        LOGGER.error("catch exception : {}\r\nexception: ", e.getMessage(), e);
        if (EXCEPTIONS == null)//ImmutableMap未构建
            EXCEPTIONS = builder.build();//EXCEPTIONS构建成功，构建成功后map中才有数据
        final ResultCode resultCode = EXCEPTIONS.get(e.getClass());
        final ResponseResult responseResult;
        //从EXCEPTION中找到异常类所对应的错误代码，如果找到了将错误代码响应给用户，如果找不到，给用户响应99999异常
        if (resultCode != null) {
            responseResult = new ResponseResult(resultCode);
        } else {//返回99999异常
            responseResult = new ResponseResult(CommonCode.SERVER_ERROR);
        }
        return responseResult;
    }

    //捕获CustomException异常
    @ExceptionHandler(CustomException.class)
    @ResponseBody
    public ResponseResult customException(CustomException e) {
        LOGGER.error("catch exception:{}\r\nexception ", e.getMessage(), e);
        ResultCode resultCode = e.getResultCode();
        ResponseResult responseResult = new ResponseResult(resultCode);
        return responseResult;
    }
}

定义错误代码，每个使用异常操作都用异常代码去标识

@ToString
public enum CmsCode implements ResultCode {
    CMS_ADDPAGE_EXISTSNAME(false, 24001, "页面名称已存在！"),
    CMS_GENERATEHTML_DATAURLISNULL(false, 24002, "从页面信息中找不到获取数据的url！"),
    CMS_GENERATEHTML_DATAISNULL(false, 24003, "根据页面的数据url获取不到数据！"),
    CMS_GENERATEHTML_TEMPLATEISNULL(false, 24004, "页面模板为空！"),
    CMS_GENERATEHTML_HTMLISNULL(false, 24005, "生成的静态html为空！"),
    CMS_GENERATEHTML_SAVEHTMLERROR(false, 24005, "保存静态html出错！"),
    CMS_COURSE_PERVIEWISNULL(false, 24007, "预览页面为空！");
    //操作代码
    boolean success;
    //操作代码
    int code;
    //提示信息
    String message;

    private CmsCode(boolean success, int code, String message) {
        this.success = success;
        this.code = code;
        this.message = message;
    }

    @Override
    public boolean success() {
        return success;
    }

    @Override
    public int code() {
        return code;
    }

    @Override
    public String message() {
        return message;
    }
}

抛出异常，在controller、service、 dao中都可以抛出异常，通过异常抛出类中的静态方法抛出异常

	if (byPageNameAndPageAliaseAndSiteId != null) {//校验页面是否已经存在，不为空则表示已经存在
            
            ExceptionCast.cast(CmsCode.CMS_ADDPAGE_EXISTSNAME);//抛出异常
        }

前端获取后端返回的json信息，如下

{"success":false,"code":24001,"message":"页面名称已存在！"}

在将返回的message信息前台展示给用户即可

不可预知异常处理

如上代码所示，在异常获取类中添加对Exception的获取，对于一些常见的不可预知的异常，解决方案是

1、我们在map中配置异常类如：HttpMessageNotReadableException和错误代码。
2、在异常捕获类中对Exception异常进行捕获，并从map中获取异常类型对应的错误代码，如果存在错误代码则返
回此错误，否则统一返回99999错误。
具体的开发实现如下：
1、在通用错误代码类CommCode中配置非法参数异常

INVALID_PARAM(false,10003,"非法参数！"),

2、在异常捕获类中配置 HttpMessageNotReadableException 为非法参数异常。
异常捕获类代码如下：（同上异常获取代码）

 private static final Logger LOGGER = LoggerFactory.getLogger(ExceptionCatch.class);
    //使用EXCEPTIONS存放异常类型和错误代码的映射，ImmutableMap的特点的一旦创建不可改变，并且线程安全
    private static ImmutableMap<Class<? extends Throwable>, ResultCode> EXCEPTIONS;
    //使用builder来构建一个异常类型和错误代码的异常
    protected static ImmutableMap.Builder<Class<? extends Throwable>, ResultCode> builder =
            ImmutableMap.builder();

    static {
        //在这里加入一些基础的异常类型判断
        builder.put(HttpMessageNotReadableException.class, CommonCode.INVALID_PARAM);
    }

    //捕获Exception异常
    @ResponseBody
    @ExceptionHandler(Exception.class)
    public ResponseResult exception(Exception e) {
        LOGGER.error("catch exception : {}\r\nexception: ", e.getMessage(), e);
        if (EXCEPTIONS == null)//ImmutableMap未构建
            EXCEPTIONS = builder.build();//EXCEPTIONS构建成功，构建成功后map中才有数据
        final ResultCode resultCode = EXCEPTIONS.get(e.getClass());
        final ResponseResult responseResult;
        //从EXCEPTION中找到异常类所对应的错误代码，如果找到了将错误代码响应给用户，如果找不到，给用户响应99999异常
        if (resultCode != null) {
            responseResult = new ResponseResult(resultCode);
        } else {//返回99999异常
            responseResult = new ResponseResult(CommonCode.SERVER_ERROR);
        }
        return responseResult;
    }

当产生一些不可预知的异常时就会返回前台99999异常

{"success":false,"code":99999,"message":"抱歉，系统繁忙，请稍后重试！"}