Mybatis源码中获取到的错误日志灵感
无意中读到Mybatis中的源码中的ErrorContext感觉这个设计很不错，这样可以在异常的时候直接进行打印出来我们需要的业务参数。原来解决线上问题的时候经常发现，抛出了一个异常，比如说是一个空指针异常，但是却不知道上层传过来的参数是什么样子的，然后再一点点的找日志，真是痛苦不堪。
Mybatis中ErrorContext的良好设计解决了这一点（本人也是一个小白，自我感觉）
自己尝试
读到Mybatis好的地方就要自己进行尝试一下。手撸一个简单版的ErrorContext（可以解决大部分需求了）
上码：
首先我们需要一个ErrorContext,ErrorContext由以下几个地方组成
- 线程本地变量，因为每次执行都是以线程为单位，所以使用线程本地变量来进行存储异常信息
- 相关的message（业务信息，例如Id等你想在抛出异常的时候看到的内容）、class、method和Cause（引发异常的原因）
import java.util.Objects;
/**
* 跟踪工具类
*
* @author gongyan
* @date 2018/4/14
*/
public class ErrorContext {
private static final String LINE_SEPARATOR = System.getProperty("line.separator", "\n");
/**
* 错误信息跟踪本地方法
*/
private static final ThreadLocal<ErrorContext> errorTrace = new ThreadLocal<ErrorContext>();
private String message;
private String clazz;
private String method;
private Throwable cause;
/**
* 获取errorContext的实例
*
* @return errorContext的实例
*/
public static ErrorContext getInstance() {
ErrorContext errorContext = errorTrace.get();
if (Objects.isNull(errorContext)) {
errorContext = new ErrorContext();
errorTrace.set(errorContext);
}
return errorContext;
}
/**
* 设置错误信息
*
* @param message 错误信息
* @return this
*/
public ErrorContext setMessage(String message) {
this.message = message;
return this;
}
/**
* 设置发生错误的class文件
*
* @param clazz
* @return this
*/
public ErrorContext setClass(String clazz) {
this.clazz = clazz;
return this;
}
/**
* 设置方法名称
*
* @param method 方法名称
* @return this
*/
public ErrorContext setMethod(String method) {
this.method = method;
return this;
}
/**
* 设置异常信息
*
* @param cause
* @return this
*/
public ErrorContext setCause(Throwable cause) {
this.cause = cause;
return this;
}
/**
* 清理对象
*/
public ErrorContext clear() {
/** errorTrace remove */
errorTrace.remove();
/** 信息内容清空 */
this.message = null;
this.method = null;
this.clazz = null;
this.cause = null;
return this;
}
}
以上就是全部的操作代码了，但是需要在抛出异常的时候进行展示，这个时候就需要我们再重写一下toString方法
@Override
public String toString() {
StringBuilder description = new StringBuilder();
if (Objects.nonNull(message)) {
description.append(LINE_SEPARATOR);
description.append("### ");
description.append(this.message);
}
if (Objects.nonNull(clazz)) {
description.append(LINE_SEPARATOR);
description.append("### happen error may at: ");
description.append(this.clazz);
}
if (Objects.nonNull(method)) {
description.append(LINE_SEPARATOR);
description.append("### happen method may at: ");
description.append(this.method);
}
if (Objects.nonNull(cause)) {
description.append(LINE_SEPARATOR);
description.append("### Cause: ");
description.append(this.cause.toString());
}
return description.toString();
}
异常处理工厂
我们的ErrorContext是与异常绑定进行输出的，这就意味着我们需要对抛出的异常进行包装，包装中放入我们的异常ErrorContext。
异常处理工厂：
/**
* 异常处理工厂
* @author gongyan
* @date 2018/4/14
*/
public class ExceptionFactory {
/**
* 包装异常获取异常信息
* @param e
* @return
*/
public static RuntimeException wrapException(Throwable e) {
return new RuntimeException(ErrorContext.getInstance().setCause(e).toString(), e);
}
}
试试效果
写完异常处理工厂和异常上下文，我们需要动手试一试啦，我们写一个业务实现类来模拟异常进行使用
import com.wsqandgy.utils.ErrorContext;
import com.wsqandgy.utils.ExceptionFactory;
/**
* @author gongyan
* @date 2018/4/14
*/
public class DemoService {
public void doSomeBusiness(Integer id) {
/** 入口信息 */
ErrorContext.getInstance().setClass(this.getClass().getName()).setMethod("doSomeBusiness").setMessage("准备查询数据" + id);
try {
/** 模拟异常 */
Object o = doQuery(id);
o.toString();
} catch (Throwable e) {
throw ExceptionFactory.wrapException(e);
} finally {
ErrorContext.getInstance().clear();
}
}
private Object doQuery(Integer id) {
return null;
}
}
入口类：
/**
* 操作入口
* @author gongyan
* @date 2018/4/14
*/
public class App {
public static void main(String[] args) {
DemoService demoService = new DemoService();
demoService.doSomeBusiness(10);
}
}
获取到异常：
Exception in thread "main" java.lang.RuntimeException:
### 准备查询数据10
### happen error may at: com.wsqandgy.DemoService
### happen method may at: doSomeBusiness
at com.wsqandgy.utils.ExceptionFactory.wrapException(ExceptionFactory.java:16)
at com.wsqandgy.DemoService.doSomeBusiness(DemoService.java:25)
at com.wsqandgy.App.main(App.java:10)
Caused by: java.lang.NullPointerException
at com.wsqandgy.DemoService.doSomeBusiness(DemoService.java:22)
... 1 more
从异常异常信息中我们可以看到，伴随着空指针异常，我们打印出来了相关的业务信息。这样以后在查日志的时候就不回太头疼啦。
线程切换支持上下文
很多时候我们做业务逻辑都是使用线程的方式去执行的，如果使用了ErrorContext，因为ErrorContext是线程绑定的，在使用其他线程去操作的时候必然会切换线程，这就会导致错误信息丢失。
例如我们将在本线程执行的业务方法，改为线程中执行
doSomeBusiness:
public void doSomeBusiness(Integer id) {
/** 入口信息 */
ErrorContext.getInstance().setClass(this.getClass().getName()).setMethod("doSomeBusiness").setMessage("准备查询数据" + id);
try {
/** 查询信息 */
Object result = doQuery(id);
/** 使用线程去执行一定的业务逻辑*/
new Thread(new ServiceRunnable(result)).start();
} catch (Throwable e) {
throw ExceptionFactory.wrapException(e);
} finally {
ErrorContext.getInstance().clear();
}
}
ServiceRunnable:
import com.wsqandgy.utils.ExceptionFactory;
/**
* 业务运行类
* @author gongyan
* @date 2018/4/14
*/
public class ServiceRunnable implements Runnable {
private Object[] params;
public ServiceRunnable(Object...params){
this.params = params;
}
@Override
public void run() {
try {
doQuery();
} catch (Throwable e){
throw ExceptionFactory.wrapException(e);
}
}
private void doQuery() {
/** 模拟异常 */
System.out.println(1 / 0);
}
}
返回的结果：
Exception in thread "Thread-0" java.lang.RuntimeException:
### Cause: java.lang.ArithmeticException: / by zero
at com.wsqandgy.utils.ExceptionFactory.wrapException(ExceptionFactory.java:16)
at com.wsqandgy.ServiceRunnable.run(ServiceRunnable.java:23)
at java.lang.Thread.run(Thread.java:748)
Caused by: java.lang.ArithmeticException: / by zero
at com.wsqandgy.ServiceRunnable.doQuery(ServiceRunnable.java:28)
at com.wsqandgy.ServiceRunnable.run(ServiceRunnable.java:21)
... 1 more
可以看到我们之前设置的 ErrorContext.getInstance().setClass(this.getClass().getName()).setMethod("doSomeBusiness").setMessage("准备查询数据" + id);这句话没有在线程中进行打印，这样就丢失了相关的错误信息
解决线程上下文切换中
解决上下文切换主要是包装线程类，提供一个新的ErrorTraceRunnable类进行封装线程接口。
ErrorTraceRunnable:
import com.wsqandgy.utils.ErrorContext;
import java.util.Objects;
/**
* 错误追踪运行类
*
* @author gongyan
* @date 2018/4/14
*/
public class ErrorTraceRunnable implements Runnable {
private final Runnable runnable;
private final ErrorContext errorContext;
public ErrorTraceRunnable(Runnable runnable) {
/** 完成线程切换 */
this.errorContext = ErrorContext.getInstance().deepCopy();
this.runnable = runnable;
}
@Override
public void run() {
if (Objects.nonNull(errorContext)) {
ErrorContext.getInstance().setErrorContext(errorContext);
}
runnable.run();
}
}
ErrorContext增加deepCopy方法：
/**
* 设置errorContext
* @param errorContext
*/
public void setErrorContext(ErrorContext errorContext){
errorTrace.set(errorContext);
}
/**
* 拷贝相关的内容
* @return
*/
public ErrorContext deepCopy() {
try {
return (ErrorContext) this.clone();
} catch (CloneNotSupportedException e) {
return new ErrorContext().setCause(e);
}
}
@Override
protected Object clone() throws CloneNotSupportedException {
ErrorContext errorContext = new ErrorContext();
errorContext.setCause(this.cause).setMethod(this.method).setMessage(this.message).setClass(this.clazz);
return errorContext;
}
运行线程的方式从:
new Thread(new ServiceRunnable(result)).start();
改变为：
new Thread(new ErrorTraceRunnable(new ServiceRunnable(result))).start();
运行结果：
Exception in thread "Thread-0" java.lang.RuntimeException:
### 准备查询数据10
### happen error may at: com.wsqandgy.DemoService
### happen method may at: doSomeBusiness
### Cause: java.lang.ArithmeticException: / by zero
at com.wsqandgy.utils.ExceptionFactory.wrapException(ExceptionFactory.java:16)
at com.wsqandgy.ServiceRunnable.run(ServiceRunnable.java:23)
at com.wsqandgy.ErrorTraceRunnable.run(ErrorTraceRunnable.java:30)
at java.lang.Thread.run(Thread.java:748)
Caused by: java.lang.ArithmeticException: / by zero
at com.wsqandgy.ServiceRunnable.doQuery(ServiceRunnable.java:28)
at com.wsqandgy.ServiceRunnable.run(ServiceRunnable.java:21)
... 2 more
我们可以看到线程中也可以获取到上下文的错误信息了，可以在线程中获取上下文的错误信息进行打印了
