1. 整體了解一下
引用一段話:
無論在開發(fā)測試環(huán)境中,還是在線上生產(chǎn)環(huán)境中总放,日志在整個系統(tǒng)中的地位都是非常重要的。良好的日志功能可以幫助開發(fā)人員和測試人員快速定位 Bug 代碼墩弯,也可以幫助運維人員快速定位性能瓶頸等問題兰英。目前的 Java 世界中存在很多優(yōu)秀的日志框架,例如 Log4j蜗搔、 Log4j2劲藐、Slf4j 等。
mybatis這么優(yōu)秀的框架, 肯定也會提供比較比較詳細(xì)的日志輸出信息, 其主要的功能由日志模塊提供, mybatis日志模塊主要做兩件事.
- 集成常用的第三方日志框架
- 用jdk代理的實現(xiàn)來打印sql執(zhí)行的日志
那現(xiàn)在就讓我們來啃一下日志模塊相關(guān)的源碼, 首選我們看一下logging包的結(jié)構(gòu)
通過看包的結(jié)構(gòu), 我們發(fā)現(xiàn), 大部分的代碼主要對我們常用的日志框架做適配集成, 如我們最常用的slf4j, log4j和log4j2, 而jdbc包主要提供處理sql執(zhí)行時的日志打印.
然后我們大概看下這些類的關(guān)系:
2. LogFactory類
org.apache.ibatis.logging.LogFactory
, Log的工廠類
2.1 類的構(gòu)造方法
//支持標(biāo)記的日志實現(xiàn)將使用的標(biāo)記
public static final String MARKER = "MYBATIS";
//日志實現(xiàn)的構(gòu)造器, 用于創(chuàng)建Log接口的對象
private static Constructor<? extends Log> logConstructor;
static {
//逐個嘗試, 看那個日志實現(xiàn)能初始化logConstructor的就直接選那個
//初始化的時候會判斷非空, 如果已經(jīng)初始化了是不會重復(fù)初始化的
tryImplementation(LogFactory::useSlf4jLogging);
tryImplementation(LogFactory::useCommonsLogging);
tryImplementation(LogFactory::useLog4J2Logging);
tryImplementation(LogFactory::useLog4JLogging);
tryImplementation(LogFactory::useJdkLogging);
tryImplementation(LogFactory::useNoLogging);
}
private LogFactory() {
// disable construction
}
靜態(tài)代碼塊會從上往下嘗試將logConstructor變量初始化, 按照slf4j, commons-logging, log2j2, log4j, jdk-logging,no-logging的順序嘗試, 如果沒有日志組件, 默認(rèn)會用jdk的logging(jdk自帶的, 不會少), 如果實在是jdk的logging都沒有, 就不打日志
-
tryImplementation(Runnable runnable)
方法
private static void tryImplementation(Runnable runnable) {
//判斷如果logConstructor是空的情況下, 執(zhí)行runnable的
//這里保證了不會重復(fù)初始化
if (logConstructor == null) {
try {
runnable.run();
} catch (Throwable t) {
// 忽略異常
}
}
}
這里的Runnable是個函數(shù)接口, 可以接收jdk8的lamba表達(dá)式
-
useSlf4jLogging()
方法
public static synchronized void useSlf4jLogging() {
//調(diào)用setImplementation, 并傳入slf4j的Log的實現(xiàn)類
setImplementation(org.apache.ibatis.logging.slf4j.Slf4jImpl.class);
}
- 其他類同的方法, 這里就不多說了
public static synchronized void useCustomLogging(Class<? extends Log> clazz) {
setImplementation(clazz);
}
public static synchronized void useSlf4jLogging() {
setImplementation(org.apache.ibatis.logging.slf4j.Slf4jImpl.class);
}
public static synchronized void useCommonsLogging() {
setImplementation(org.apache.ibatis.logging.commons.JakartaCommonsLoggingImpl.class);
}
public static synchronized void useLog4JLogging() {
setImplementation(org.apache.ibatis.logging.log4j.Log4jImpl.class);
}
public static synchronized void useLog4J2Logging() {
setImplementation(org.apache.ibatis.logging.log4j2.Log4j2Impl.class);
}
public static synchronized void useJdkLogging() {
setImplementation(org.apache.ibatis.logging.jdk14.Jdk14LoggingImpl.class);
}
public static synchronized void useStdOutLogging() {
setImplementation(org.apache.ibatis.logging.stdout.StdOutImpl.class);
}
public static synchronized void useNoLogging() {
setImplementation(org.apache.ibatis.logging.nologging.NoLoggingImpl.class);
}
如果有自定義的日志實現(xiàn), 調(diào)用useCustomLogging(Class<? extends Log> clazz)
來實現(xiàn)
-
setImplementation(Class<? extends Log> implClass)
方法
private static void setImplementation(Class<? extends Log> implClass) {
try {
//獲取日志實現(xiàn)的構(gòu)造方法, 構(gòu)造方法帶了一個字符串參數(shù)
Constructor<? extends Log> candidate = implClass.getConstructor(String.class);
//嘗試創(chuàng)建Log對象
Log log = candidate.newInstance(LogFactory.class.getName());
if (log.isDebugEnabled()) {
log.debug("Logging initialized using '" + implClass + "' adapter.");
}
//如果創(chuàng)建成功, 初始化logConstructor變量
logConstructor = candidate;
} catch (Throwable t) {
throw new LogException("Error setting Log implementation. Cause: " + t, t);
}
}
2.2 getLog(String logger)
方法
public static Log getLog(String logger) {
try {
//用構(gòu)造器創(chuàng)建Log的實例返回
return logConstructor.newInstance(logger);
} catch (Throwable t) {
throw new LogException("Error creating logger for logger " + logger + ". Cause: " + t, t);
}
}
2.3 getLog(Class<?> aClass)
方法
public static Log getLog(Class<?> aClass) {
//調(diào)用上面的```getLog(String logger)```
return getLog(aClass.getName());
}
3. Log接口
org.apache.ibatis.logging.Log
, mybatis所有的日志打印都是通過Log這接口來使用的. 接口很簡單
public interface Log {
boolean isDebugEnabled();
boolean isTraceEnabled();
void error(String s, Throwable e);
void error(String s);
void debug(String s);
void trace(String s);
void warn(String s);
}
它的實現(xiàn)類比較多, 我們挑一個說一下, 其他類同
3.1 Slf4jImpl 類
public class Slf4jImpl implements Log {
private Log log;
public Slf4jImpl(String clazz) {
Logger logger = LoggerFactory.getLogger(clazz);
//如果logger 是 LocationAwareLogger
if (logger instanceof LocationAwareLogger) {
try {
// check for slf4j >= 1.6 method signature
//根據(jù)指定參數(shù)嘗試獲取log的方法, 如果不報錯則可以創(chuàng)建Slf4jLocationAwareLoggerImpl
logger.getClass().getMethod("log", Marker.class, String.class, int.class, String.class, Object[].class, Throwable.class);
log = new Slf4jLocationAwareLoggerImpl((LocationAwareLogger) logger);
return;
} catch (SecurityException | NoSuchMethodException e) {
//如果創(chuàng)建不成功, 退回用Slf4jLoggerImpl
}
}
// Logger is not LocationAwareLogger or slf4j version < 1.6
log = new Slf4jLoggerImpl(logger);
}
@Override
public boolean isDebugEnabled() {
return log.isDebugEnabled();
}
@Override
public boolean isTraceEnabled() {
return log.isTraceEnabled();
}
@Override
public void error(String s, Throwable e) {
log.error(s, e);
}
@Override
public void error(String s) {
log.error(s);
}
@Override
public void debug(String s) {
log.debug(s);
}
@Override
public void trace(String s) {
log.trace(s);
}
@Override
public void warn(String s) {
log.warn(s);
}
}
- 在構(gòu)造方法里, 會根據(jù)不同的slf4j的版本來選擇不同的實現(xiàn)接口
4 BaseJdbcLogger類
- 這個類是執(zhí)行sql日志的基類, 通過它我們可以了解到mybatis是如何打印sql, 參數(shù)和返回值的
4.1 構(gòu)造實現(xiàn)
/**
* 緩存所有set方法的名稱
*/
protected static final Set<String> SET_METHODS;
/**
* 存所有執(zhí)行sql的方法
*/
protected static final Set<String> EXECUTE_METHODS = new HashSet<>();
/**
* 保存sql的參數(shù)名和參數(shù)值
*/
private final Map<Object, Object> columnMap = new HashMap<>();
/**
* 保存sql的參數(shù)名
*/
private final List<Object> columnNames = new ArrayList<>();
/**
* 保存執(zhí)行sql的參數(shù)值
*/
private final List<Object> columnValues = new ArrayList<>();
/**
* Log日志實例
*/
protected final Log statementLog;
/**
* 目前主要發(fā)現(xiàn)它是用于控制prefix的=號的長度, 默認(rèn)是1
*/
protected final int queryStack;
//默認(rèn)的構(gòu)造器, 如果queryStack不傳, 則默認(rèn)給1
public BaseJdbcLogger(Log log, int queryStack) {
this.statementLog = log;
if (queryStack == 0) {
this.queryStack = 1;
} else {
this.queryStack = queryStack;
}
}
static {
//初始化所有set方法的名稱, 只要PreparedStatement方法下, 以set開頭, 且參數(shù)個數(shù)大于1的方法名
//這里的方法跟Statement的也一樣
SET_METHODS = Arrays.stream(PreparedStatement.class.getDeclaredMethods())
.filter(method -> method.getName().startsWith("set"))
.filter(method -> method.getParameterCount() > 1)
.map(Method::getName)
.collect(Collectors.toSet());
//初始化 要執(zhí)行sql的方法名
EXECUTE_METHODS.add("execute");
EXECUTE_METHODS.add("executeUpdate");
EXECUTE_METHODS.add("executeQuery");
EXECUTE_METHODS.add("addBatch");
}
- 這里主要做一些初始化操作
4.2 setColumn(Object key, Object value)
方法
- 主要用于緩存列名和列值
protected void setColumn(Object key, Object value) {
columnMap.put(key, value);
columnNames.add(key);
columnValues.add(value);
}
4.3 getParameterValueString()
方法
- 將所有參數(shù)值拼接成字符串, 除了null之外的其他值都加上類開信息, 如: null,1(Integer),abc(String)
protected String getParameterValueString() {
List<Object> typeList = new ArrayList<>(columnValues.size());
for (Object value : columnValues) {
//如果是null, 則加一個'null'字符串
if (value == null) {
typeList.add("null");
} else {
//非null, 則在值的后面加上類型
typeList.add(objectValueString(value) + "(" + value.getClass().getSimpleName() + ")");
}
}
//toString()的結(jié)果是"[null,1(Integer),abc(String)]"
final String parameters = typeList.toString();
//截掉[], 變成"null,1(Integer),abc(String)"
return parameters.substring(1, parameters.length() - 1);
}
4.3 objectValueString(Object value)
方法
- 如果值是數(shù)組類型, 返回[1,2]之類的值
protected String objectValueString(Object value) {
if (value instanceof Array) {
try {
//如果是數(shù)據(jù)組, 則用數(shù)組的打印方式toString
return ArrayUtil.toString(((Array) value).getArray());
} catch (SQLException e) {
return value.toString();
}
}
return value.toString();
}
4.4 objectValueString(Object value)
方法
- 主要用于清空緩存, 因為一個PreparedStatement對象可以執(zhí)行多次sql
protected void clearColumnInfo() {
columnMap.clear();
columnNames.clear();
columnValues.clear();
}
4.5 removeBreakingWhitespace(String original)
方法
- 將original字符串中的" \t\n\r\f"這些字符替換成" "空串, 這里將sql處理成長長的一行
protected String removeBreakingWhitespace(String original) {
StringTokenizer whitespaceStripper = new StringTokenizer(original);
StringBuilder builder = new StringBuilder();
while (whitespaceStripper.hasMoreTokens()) {
builder.append(whitespaceStripper.nextToken());
builder.append(" ");
}
return builder.toString();
}
4.6 prefix(boolean isInput)
方法
-
isInput
這個控制著箭頭的方向
/**
* 主要用于產(chǎn)生日志前綴, 如: ==>,<==
* - ==> Parameters: 527(Long)
* - <== Updates: 1
*/
private String prefix(boolean isInput) {
char[] buffer = new char[queryStack * 2 + 2];
Arrays.fill(buffer, '=');
//最后面加個空格, queryStack * 2 + 1 相當(dāng)于 buffer.length - 1
buffer[queryStack * 2 + 1] = ' ';
if (isInput) {
buffer[queryStack * 2] = '>';
} else {
buffer[0] = '<';
}
return new String(buffer);
}
下圖的箭頭的來源就是這個方法生成的:
4.7 debug(String text, boolean input)
方法
-
input
這個參數(shù)代表是否輸入 - 打日志前都加個前綴箭頭代表輸入或輸出
-
trace(String text, boolean input)
方法類同, 這里就不展開了
protected void debug(String text, boolean input) {
if (statementLog.isDebugEnabled()) {
//打印參數(shù)前, 加個前綴
statementLog.debug(prefix(input) + text);
}
}
5 ConnectionLogger類
-
org.apache.ibatis.logging.jdbc.ConnectionLogger
是 BaseJdbcLogger 的實現(xiàn)類, 并且實現(xiàn)了InvocationHandler接口 - 這個類通過jdk代理的方式, 返回一個日志代理的Connection的代理對象
5.1 構(gòu)造器
//實際的Connection
private final Connection connection;
//私有構(gòu)造器, 給當(dāng)前類使用
private ConnectionLogger(Connection conn, Log statementLog, int queryStack) {
//調(diào)用 BaseJdbcLogger 的構(gòu)造器
super(statementLog, queryStack);
this.connection = conn;
}
5.2 invoke(Object proxy, Method method, Object[] params)
方法
- 這是代理對象調(diào)用的方法
- 這里在調(diào)用connetion的創(chuàng)建具體的Statement之后, 返回對應(yīng)的日志代理類
public Object invoke(Object proxy, Method method, Object[] params)
throws Throwable {
try {
//忽略O(shè)bject的方法, 不做處理, 直接調(diào)用
if (Object.class.equals(method.getDeclaringClass())) {
return method.invoke(this, params);
}
//執(zhí)行 prepareStatement 方法前, 如果是debug則打印一下sql, param[0]是sql字符串
if ("prepareStatement".equals(method.getName())) {
if (isDebugEnabled()) {
debug(" Preparing: " + removeBreakingWhitespace((String) params[0]), true);
}
//執(zhí)行方法, 獲得真正的PreparedStatement
PreparedStatement stmt = (PreparedStatement) method.invoke(connection, params);
//返回有日志代理的PreparedStatement
stmt = PreparedStatementLogger.newInstance(stmt, statementLog, queryStack);
return stmt;
} else if ("prepareCall".equals(method.getName())) {
//執(zhí)行 prepareCall 方法前, 如果是debug則打印一下sql, param[0]是sql字符串
if (isDebugEnabled()) {
debug(" Preparing: " + removeBreakingWhitespace((String) params[0]), true);
}
PreparedStatement stmt = (PreparedStatement) method.invoke(connection, params);
//返回有日志代理的PreparedStatement
stmt = PreparedStatementLogger.newInstance(stmt, statementLog, queryStack);
return stmt;
} else if ("createStatement".equals(method.getName())) {
//同上
Statement stmt = (Statement) method.invoke(connection, params);
stmt = StatementLogger.newInstance(stmt, statementLog, queryStack);
return stmt;
} else {
return method.invoke(connection, params);
}
} catch (Throwable t) {
throw ExceptionUtil.unwrapThrowable(t);
}
}
5.3 newInstance(Connection conn, Log statementLog, int queryStack)
方法
- 根據(jù)當(dāng)前的Connection, 返回日志打印的代理對象
public static Connection newInstance(Connection conn, Log statementLog, int queryStack) {
InvocationHandler handler = new ConnectionLogger(conn, statementLog, queryStack);
ClassLoader cl = Connection.class.getClassLoader();
return (Connection) Proxy.newProxyInstance(cl, new Class[]{Connection.class}, handler);
}
6 PreparedStatementLogger 類
org.apache.ibatis.logging.jdbc.PreparedStatementLogger
是PreparedStatement的日志代理封裝類, 繼成org.apache.ibatis.logging.jdbc.BaseJdbcLogger
類的代理實現(xiàn)
6.1 invoke(Object proxy, Method method, Object[] params)
方法
- jdk代理的主要執(zhí)行方法
@Override
public Object invoke(Object proxy, Method method, Object[] params) throws Throwable {
try {
//忽略O(shè)bject的方法, 不處理, 直接執(zhí)行
if (Object.class.equals(method.getDeclaringClass())) {
return method.invoke(this, params);
}
//如果準(zhǔn)要調(diào)用執(zhí)行sql的方法, 則打印一下參數(shù)
if (EXECUTE_METHODS.contains(method.getName())) {
if (isDebugEnabled()) {
debug("Parameters: " + getParameterValueString(), true);
}
//將相關(guān)緩存清空, PreparedStatement是可以多次執(zhí)行sql的
clearColumnInfo();
//如果是執(zhí)行查詢方法, 且ResultSet不為null則返回ResultSet的日志代理對象
if ("executeQuery".equals(method.getName())) {
ResultSet rs = (ResultSet) method.invoke(statement, params);
return rs == null ? null : ResultSetLogger.newInstance(rs, statementLog, queryStack);
} else {
return method.invoke(statement, params);
}
} else if (SET_METHODS.contains(method.getName())) {
//如果是set相關(guān)法, 則表明是綁定sql的參數(shù)值, 緩存相關(guān)的參數(shù)和值, 對null做'null'的處理
if ("setNull".equals(method.getName())) {
setColumn(params[0], null);
} else {
setColumn(params[0], params[1]);
}
return method.invoke(statement, params);
} else if ("getResultSet".equals(method.getName())) {
//返回ResultSet的日志代理對象
ResultSet rs = (ResultSet) method.invoke(statement, params);
return rs == null ? null : ResultSetLogger.newInstance(rs, statementLog, queryStack);
} else if ("getUpdateCount".equals(method.getName())) {
//如果是查詢更新條數(shù), 則直接打印
int updateCount = (Integer) method.invoke(statement, params);
if (updateCount != -1) {
debug(" Updates: " + updateCount, false);
}
return updateCount;
} else {
return method.invoke(statement, params);
}
} catch (Throwable t) {
throw ExceptionUtil.unwrapThrowable(t);
}
}
6.2 newInstance(PreparedStatement stmt, Log statementLog, int queryStack)
方法
- 同上, 創(chuàng)建PreparedStatement的日志代理對象
7 StatementLogger類
org.apache.ibatis.logging.jdbc.StatementLogger
繼承org.apache.ibatis.logging.jdbc.BaseJdbcLogger
是Statement的日志代理類
7.1 invoke(Object proxy, Method method, Object[] params)
方法
public Object invoke(Object proxy, Method method, Object[] params) throws Throwable {
try {
//忽略O(shè)bject對象的方法,
if (Object.class.equals(method.getDeclaringClass())) {
return method.invoke(this, params);
}
if (EXECUTE_METHODS.contains(method.getName())) {
if (isDebugEnabled()) {
//執(zhí)行查詢前, 打印一下sql
debug(" Executing: " + removeBreakingWhitespace((String) params[0]), true);
}
if ("executeQuery".equals(method.getName())) {
//如果是查詢, 則返回ResultSet的日志代理對象
ResultSet rs = (ResultSet) method.invoke(statement, params);
return rs == null ? null : ResultSetLogger.newInstance(rs, statementLog, queryStack);
} else {
return method.invoke(statement, params);
}
} else if ("getResultSet".equals(method.getName())) {
//獲取ResultSet時, 返回日志代理對象
ResultSet rs = (ResultSet) method.invoke(statement, params);
return rs == null ? null : ResultSetLogger.newInstance(rs, statementLog, queryStack);
} else {
return method.invoke(statement, params);
}
} catch (Throwable t) {
throw ExceptionUtil.unwrapThrowable(t);
}
}
7.2 Statement newInstance(Statement stmt, Log statementLog, int queryStack)
方法同上
8 ResultSetLogger類
org.apache.ibatis.logging.jdbc.ResultSetLogger
繼承org.apache.ibatis.logging.jdbc.BaseJdbcLogger, 是ResultSet的日志代理類
8.1 構(gòu)造方法
- static代碼塊主要對一些不可直接顯示的類型進行初始化
/**
* 二進制類型或大對象類型列表
*/
private static final Set<Integer> BLOB_TYPES = new HashSet<>();
/**
* 是否第一行, 如果是則打印列名
*/
private boolean first = true;
/**
* 記錄查詢結(jié)果的條數(shù)
*/
private int rows;
//代理的ResultSet
private final ResultSet rs;
/**
* 記錄二進制類型或大對象類型的索引, 用于打印具體列的值時用特殊字符代替
*/
private final Set<Integer> blobColumns = new HashSet<>();
static {
//初始化二進制類型或大對象類型列表
BLOB_TYPES.add(Types.BINARY);
BLOB_TYPES.add(Types.BLOB);
BLOB_TYPES.add(Types.CLOB);
BLOB_TYPES.add(Types.LONGNVARCHAR);
BLOB_TYPES.add(Types.LONGVARBINARY);
BLOB_TYPES.add(Types.LONGVARCHAR);
BLOB_TYPES.add(Types.NCLOB);
BLOB_TYPES.add(Types.VARBINARY);
}
private ResultSetLogger(ResultSet rs, Log statementLog, int queryStack) {
super(statementLog, queryStack);
this.rs = rs;
}
8.2 invoke(Object proxy, Method method, Object[] params)
方法
- 代理類的調(diào)用方法
public Object invoke(Object proxy, Method method, Object[] params) throws Throwable {
try {
//忽略O(shè)bject對象的方法
if (Object.class.equals(method.getDeclaringClass())) {
return method.invoke(this, params);
}
//先執(zhí)行方法
Object o = method.invoke(rs, params);
//如果執(zhí)行的是next()方法, 直根據(jù)結(jié)果處理
if ("next".equals(method.getName())) {
if ((Boolean) o) {
//如果next取到值, 行數(shù)加一
rows++;
//如果是trace級別的日志, 記錄更加詳細(xì)的日志
if (isTraceEnabled()) {
//獲取元數(shù)據(jù)
ResultSetMetaData rsmd = rs.getMetaData();
//獲取列數(shù)
final int columnCount = rsmd.getColumnCount();
if (first) {
//設(shè)置first為非第一行
first = false;
//第一行, 打印列名
printColumnHeaders(rsmd, columnCount);
}
//打印列的值
printColumnValues(columnCount);
}
} else {
//最后一次獲取不到值時, 打印sql總條數(shù)
debug(" Total: " + rows, false);
}
}
//這行不知道想干嘛, 對當(dāng)前ResultSet的日志沒影響
clearColumnInfo();
return o;
} catch (Throwable t) {
throw ExceptionUtil.unwrapThrowable(t);
}
}
8.3 printColumnHeaders(ResultSetMetaData rsmd, int columnCount)
方法
- 方法主要用逗號分割打印列名, 并且記錄那些列是BLOB_TYPE類型
private void printColumnHeaders(ResultSetMetaData rsmd, int columnCount) throws SQLException {
StringJoiner row = new StringJoiner(", ", " Columns: ", "");
for (int i = 1; i <= columnCount; i++) {
//記錄當(dāng)前i列是否是BLOB_TYPE類型
if (BLOB_TYPES.contains(rsmd.getColumnType(i))) {
blobColumns.add(i);
}
//將列表放到字符串中
row.add(rsmd.getColumnLabel(i));
}
//打印
trace(row.toString(), false);
}
8.3 printColumnValues(int columnCount)
方法
private void printColumnValues(int columnCount) {
StringJoiner row = new StringJoiner(", ", " Row: ", "");
for (int i = 1; i <= columnCount; i++) {
try {
//BLOB_TYPE類型的值不能顯示, 用<<BLOB>>來顯示
if (blobColumns.contains(i)) {
row.add("<<BLOB>>");
} else {
row.add(rs.getString(i));
}
} catch (SQLException e) {
// generally can't call getString() on a BLOB column
row.add("<<Cannot Display>>");
}
}
trace(row.toString(), false);
}
8.4 newInstance(ResultSet rs, Log statementLog, int queryStack)
方法
- 同上, 創(chuàng)建代理對象