[Java知识库]ErrorContext工作原理以及解决他的设计思路

MyBatis是非常强大，本文讲一下异常日志的输出。不知道大家有没有发现，使用 MyBatis 时定位问题非常容易，我们只需要查看一下控制台的异常日志就能一目了然地知道问题出现在了哪里。这归功于一个简单的类 ErrorContext。

ErrorContext 类说明

ErrorContext有六个存储异常信息的私有成员，如下所示：

private ErrorContext stored;
private String resource;
private String activity;
private String object;
private String message;
private String sql;
private Throwable cause;

MyBatis 异常涵盖的信息总结为：异常是由谁在做什么的时候在哪个资源文件中发生的，执行的 SQL 是哪个，以及 Java 详细的异常信息。这六个私有变量分别存储这些信息：

如：### The error occurred while setting parameters

object：存储哪个对象操作时发生异常。
如：### The error may involve defaultParameterMap

message：存储异常的概览信息。
如：### Error querying database. Cause: java.sql.SQLSyntaxErrorException: Unknown column 'id2' in 'field list'

sql：存储发生日常的 SQL 语句。
如：### SQL: select id2, name, sex, phone from author where name = ?

cause：存储详细的 Java 异常日志。
如：### Cause: java.sql.SQLSyntaxErrorException: Unknown column 'id2' in 'field list' at
org.apache.ibatis.exceptions.ExceptionFactory.wrapException(ExceptionFactory.java:30) at
org.apache.ibatis.session.defaults.DefaultSqlSession.selectList(DefaultSqlSession.java:150) at
org.apache.ibatis.session.defaults.DefaultSqlSession.selectList(DefaultSqlSession.java:141) at
org.apache.ibatis.binding.MapperMethod.executeForMany(MapperMethod.java:139) at org.apache.ibatis.binding.MapperMethod.execute(MapperMethod.java:76)

1. ErrorContext stored 存储仓库可以用来存储ErrorContext
2. String resource 如果是解析文件，比如xml,那么resource就是文件名，如果是请求网络，那就是url
3. String activity 什么行为，是update还是insert还是什么
4. String object 处理业务所需要的参数
5. String message 异常内容
6. String sql 具体的sql
7. Throwable cause 就是对应的堆栈异常信息。

其实上面的属性，不定要按他的规范去存储，只是为了看起来更方便一下，就算里面我们全部存数字都可以，只要自己看得懂。可以借鉴这种思路。

对于这六个成员变量的 “set” 方法，命名同相应成员变量，均是对成员变量做赋值操作并返回存储完相应信息后当前ErrorContext 的实例。 例如 resource 变量对应的 resource() 方法：

public ErrorContext resource(String resource) {
  this.resource = resource;
  return this;
}

这样所带来的好处是我们在给对象属性赋值的时候，可以一行就解决了，比如下面。

ErrorContext.instance()
	.resource(ms.getResource())
	.activity("executing an update")
	.object(ms.getId());

三、方法(虽然用的比较少)

将存储到仓库，然后再创建一个新的 ErrorContext.instance().store();

public ErrorContext store() {
  ErrorContext newContext = new ErrorContext();
  newContext.stored = this;
  LOCAL.set(newContext);
  return LOCAL.get();
}

召回，就是将仓库的取出来，把仓库清空。ErrorContext.instance().recall();

public ErrorContext recall() {
  if (stored != null) {
    LOCAL.set(stored);
    stored = null;//清空仓库
  }
  return LOCAL.get();
}

清空，但不是清空仓库的内容。ErrorContext.instance().reset();

public ErrorContext reset() {
  resource = null;
  activity = null;
  object = null;
  message = null;
  sql = null;
  cause = null;
  LOCAL.remove();
  return this;
}

实践，对我们在开发中如何使用呢。

比如当请求进来，且带了参数，这个时候就可以通过在当前线程把参数绑定到ErrorContext里面去，因为每个线程都有属于自己的ErrorContext。

private ResultMap resultMapElement(XNode resultMapNode, List<ResultMapping> additionalResultMappings, Class<?> enclosingType) {
    ErrorContext.instance().activity("processing " + resultMapNode.getValueBasedIdentifier());
    ........业务代码，这里记录只是为了把参数放置进去，不一定要现在把他打印出来。
}

当我们在别的地方执行出错了之后再把error打出来，像下面这种

public static RuntimeException wrapException(String message, Exception e) {
    return new PersistenceException(ErrorContext.instance().message(message).cause(e).toString(), e);
}

或者这种，不抛出运行时异常

log.info( ErrorContext.instance().toString() )

不到一定要在一个方法里面把东西塞进去，在同时打出来，只要保证是在当前一个同一个请求里面，那么无论我们在哪个类或者哪个方法打印出来，都不影响。其实众安的调用链就是通过这种方式实现的，一个线程内答应的ID都是同一个。