异常处理-异常处理的问题分析

1-异常处理-异常处理的问题分析

参考文档:

https://blog.csdn.net/kinginblue/article/details/70186586

自定义异常:

1:
10001 非法参数
10002 参数缺失

2:
2001 数据库异常
2003 网络异常

从添加页面的service方法中找问题：

//添加页面
public CmsPageResult add(CmsPage cmsPage){
	//校验页面是否存在，根据页面名称、站点Id、页面webpath查询
	CmsPage cmsPage1 = cmsPageRepository.findByPageNameAndSiteIdAndPageWebPath(cmsPage.getPageName(), cmsPage.getSiteId(), cmsPage.getPageWebPath());
    
    if(cmsPage1==null){
        cmsPage.setPageId(null);//添加页面主键由spring data 自动生成
        cmsPageRepository.save(cmsPage);
        //返回结果
        CmsPageResult cmsPageResult = new CmsPageResult(CommonCode.SUCCESS,cmsPage);
        return cmsPageResult;
    }
    return new CmsPageResult(CommonCode.FAIL,null);
}

问题：

1、上边的代码只要操作不成功仅向用户返回“错误代码：11111，失败信息：操作失败”，无法区别具体的错误信
息。
2、service方法在执行过程出现异常在哪捕获？在service中需要都加try/catch，如果在controller也需要添加
try/catch，代码冗余严重且不易维护。

解决方案：

1、在Service方法中的编码顺序是先校验判断，有问题则抛出具体的异常信息，最后执行具体的业务操作，返回成
功信息。
2、在统一异常处理类中去捕获异常，无需controller捕获异常，向用户返回统一规范的响应信息。

//添加页面
public CmsPageResult add(CmsPage cmsPage){
    //校验cmsPage是否为空
    if(cmsPage == null){
    	//抛出异常，非法请求
    	//...
    }
    //根据页面名称查询（页面名称已在mongodb创建了唯一索引）
    CmsPage cmsPage1 =
    cmsPageRepository.findByPageNameAndSiteIdAndPageWebPath(cmsPage.getPageName(),
    cmsPage.getSiteId(), cmsPage.getPageWebPath());
    
    //校验页面是否存在，已存在则抛出异常
    if(cmsPage1 !=null){
    	//抛出异常，已存在相同的页面名称
    	//...
    }
    
    cmsPage.setPageId(null);//添加页面主键由spring data 自动生成
    CmsPage save = cmsPageRepository.save(cmsPage);
    //返回结果
    CmsPageResult cmsPageResult = new CmsPageResult(CommonCode.SUCCESS,save);
    return cmsPageResult;
}

2-异常处理-异常处理流程

系统对异常的处理使用统一的异常处理流程：

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

异常抛出及处理流程：

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

3-异常处理-可预知异常处理-自定义异常类型和抛出类

CustomException.java

/**
 * 自定义异常类
 */
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;
    }
}

ExceptionCast.java

public class ExceptionCast {

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

ExceptionCatch.java

/**
 * 统一异常捕获类
 *
 * 在spring 3.2中，新增了@ControllerAdvice 注解，
 * 可以用于定义@ExceptionHandler、@InitBinder、@ModelAttribute，并应用到所有@RequestMapping中。
 */
@ControllerAdvice // 控制器增强
public class ExceptionCatch {

    private static final Logger LOGGER = LoggerFactory.getLogger(ExceptionCatch.class);

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

4-异常处理-可预知异常处理-异常处理测试

PageService.java

在add()的代码中加入异常处理：

//校验cmsPage是否为空
if(cmsPage1 != null){
	//抛出异常，非法请求
	ExceptionCast.cast(CmsCode.CMS_ADDPAGE_EXISTSNAME);
}

CmsCode.java

@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;
    }
}

ManageCmsApplication.java

在核心启动类上加入包扫描，去扫描common项目的包

@SpringBootApplication
@EntityScan("com.yunke.framework.domain.cms")//扫描实体类
@ComponentScan(basePackages={"com.yunke.api"})//扫描接口
@ComponentScan(basePackages={"com.yunke.framework"})//扫描common包下的类
@ComponentScan(basePackages={"com.yunke.manage_cms"})//扫描本项目下的所有类
public class ManageCmsApplication {
    public static void main(String[] args) {
        SpringApplication.run(ManageCmsApplication.class,args);
    }
}

测试

当出现重复页面的时候,无法进行保存,错误提示也是我们自己定义的了.

5-异常处理-不可预知异常处理

ExceptionCatch.java

//使用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\n exception: ",e.getMessage(), e);
    if(EXCEPTIONS == null) {
        EXCEPTIONS = builder.build(); // EXCEPTIONS构建完毕
    }
    // 从EXCEPTIONS中寻找异常类型对应的错误代码，如果找到了将错误代码响应给用户，如果找不到就返回给用户9999
    final ResultCode resultCode = EXCEPTIONS.get(e.getClass());

    if (resultCode != null) {
        return new ResponseResult(resultCode);
    } else {
        return new ResponseResult(CommonCode.SERVER_ERROR);
    }
}		

CommonCode.java

@ToString
public enum CommonCode implements ResultCode{

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

测试效果