前言
公司老项目的优化,真的是任重而道远。
最近发现老代码动不动就try、catch,然后catch里面就打印个日志。
公司日志系统很垃圾,查看的方式很low,这种打印,和没打印差别不大;
Exception和RuntimeException区别?
长篇大论就不说了,简单明了的讲:
Exception
: 需要手动捕获异常或者向外抛出。
RuntimeException
:这种异常我们不需要处理,完全由虚拟机接管。
也就是说,RuntimeException异常交给jvm处理,会导致线程就此终止。我们一般可以用在参数的校验上,如果校验不通过,那么就没有必要往下执行了。
而Exception
,可以手动捕获,也就是即使抛了异常,线程也可以继续运行下去。
业务代码的设计
针对RuntimeException异常进行设计:
首先我们需要设计一个顶层接口,记录业务上错误的状态码和异常信息。
package com.sgy.common.data;
/**
* 错误码
*/
public interface Error {
/**
* 获取错误码
*
* @return
*/
int getCode();
/**
* 获取错误消息内容
*
* @return
*/
String getMessage();
}
然后针对,API的接口,业务场景:
假设异常类的设计是单独抽取到一个公共的项目中,那么下面这段代码
ApiError类
将需要放到业务项目中去。
package com.sgy.common.data;
import lombok.Getter;
@Getter
public enum ApiError implements Error {
EEE(11, "系统异常");
ReturnCode(int code, String message) {
this.code = code;
this.message = message;
}
private int code;
private String message;
}
ApiException 接口异常
package com.sgy.common.exceptions;
import com.sgy.common.data.ApiError;
import lombok.Getter;
/**
* 接入层异常,包括参数检验异常、授权异常等。
*/
public class ApiException extends RuntimeException {
@Getter
private int code;
public ApiException(ApiError error) {
super(error.getMessage());
this.code = error.getCode();
}
public ApiException(ApiError error, Throwable cause) {
super(cause);
this.code = error.getCode();
}
public ApiException(ApiError error, String message) {
super(message);
this.code = error.getCode();
}
public ApiException(ApiError error, String message, Throwable cause) {
super(message, cause);
this.code = error.getCode();
}
}
使用
//业务项目里的代码:
Optional.ofNullable(id).orElseThrow(() -> new ApiException(ApiError.EEE));
总结
也就是我们需要两个东西:
① 设计一个顶层接口Error
,里面抽象两个方法,获取业务错误编码getCode
、业务错误信息getMessage
。
② 编写业务异常类实现RuntimeException
; 如:ApiException extends RuntimeException
。
③ 业务上使用,继承Error
接口,然后里面填写具体的业务错误状态信息。
其实在第三步,有些公司的做法,不会像上面枚举那样去做,而是使用接口
这面这个类,也是打包在单独的项目里,而不是让业务项目代码去实现Error
package com.sgy.common.data;
import lombok.Getter;
/**
* 接入层错误
*/
@Getter
public class ApiError implements Error {
private int code;
private String message;
public ApiError(int code, String message) {
if (code < 1 || code > 999) {
throw new IllegalArgumentException(String.format("ApiError 错误码[%d]超出范围(1~99)", code));
}
this.code = code;
this.message = message;
}
public static ApiError with(int code, String message) {
return new ApiError(code, message);
}
}
使用:
package com.misssad.common;
import com.sgy.common.data.ApiError;
/**
* 定义 API 错误,主要是参数错误、鉴权错误等,大部分时候用 ApiErrors 定义的几个就够了。
*/
@SuppressWarnings("checkstyle:interfaceistype")
public interface SgyApiErrors {
// 自定义 API 错误码
//ApiError XXX_ERROR = ApiError.with(10, "XXXX");
/**
* 耗材套餐名称为空
*/
ApiError NAME_IS_NULL = ApiError.with(1, "名称为空");
}
对于Exception
的设计也是类似的。只不过,Exception
需要我们手动捕获,或者向上跑。
这种在实际业务的项目中,个人认为应该少用,业务代码就是要你自己来处理问题题。
只有工具类,框架类的代码,这些场景才用的比较多。