日志模块和Plus模块升级以及问题修复

1.common-log4j2-starter

1.目录

2.LogAspectProperties.java 日志切面配置

package com.sunxiansheng.log4j2.config.properties;import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;/*** Description: 日志切面配置** @Author sun* @Create 2024/10/24 23:16* @Version 1.0*/
@Component
@ConfigurationProperties(prefix = "log.aspect")
public class LogAspectProperties {private boolean enable = false;public boolean isEnable() {return enable;}public void setEnable(boolean enable) {this.enable = enable;}
}

3.TraceProperties.java 链路追踪配置

package com.sunxiansheng.log4j2.config.properties;import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;/*** Description: 链路追踪配置** @Author sun* @Create 2024/10/24 23:12* @Version 1.0*/
@Component
@ConfigurationProperties(prefix = "log.trace")
public class TraceProperties {private boolean enable = false;public boolean isEnable() {return enable;}public void setEnable(boolean enable) {this.enable = enable;}
}

4.Log4j2AutoConfiguration.java 条件注入链路追踪过滤器

package com.sunxiansheng.log4j2.config;import com.sunxiansheng.log4j2.aspectj.LogAspect;
import com.sunxiansheng.log4j2.config.properties.TraceProperties;
import com.sunxiansheng.log4j2.trace.TraceIdFilter;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;/*** Description: Log4j2自动配置类** @Author sun* @Create 2024/10/24 10:36* @Version 1.0*/
@Configuration
@EnableConfigurationProperties({TraceProperties.class, TraceProperties.class}) // 启用配置类
public class Log4j2AutoConfiguration {/*** 条件注入LogAspect** @return*/@Bean@ConditionalOnMissingBean@ConditionalOnProperty(name = "log.aspect.enable", havingValue = "true", matchIfMissing = true)LogAspect logAspect() {return new LogAspect();}/*** 条件注入链路追踪过滤器** @return*/@Bean@ConditionalOnMissingBean@ConditionalOnProperty(name = "log.trace.enable", havingValue = "true", matchIfMissing = true)TraceIdFilter traceIdFilter() {return new TraceIdFilter();}
}

2.common-mybatis-plus-starter

1.目录

2.引入依赖

<!-- gson -->
<dependency><groupId>com.google.code.gson</groupId><artifactId>gson</artifactId>
</dependency>

3.SqlBeautyProperties.java 读取sql.beauty相关配置

package com.sunxiansheng.mybatis.plus.config.properties;import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;/*** Description: 读取sql.beauty相关配置** @Author sun* @Create 2024/10/24 23:17* @Version 1.0*/
@Component
@ConfigurationProperties(prefix = "sql.beauty")
public class SqlBeautyProperties {private boolean enabled = false;public boolean isEnabled() {return enabled;}public void setEnabled(boolean enabled) {this.enabled = enabled;}
}

4.MybatisPLusAutoConfiguration.java 启用配置类

5.SqlBeautyInterceptor.java SQL优化器升级

package com.sunxiansheng.mybatis.plus.inteceptor;import org.apache.ibatis.executor.statement.StatementHandler;
import org.apache.ibatis.mapping.*;
import org.apache.ibatis.plugin.*;
import org.apache.ibatis.reflection.*;
import org.apache.ibatis.session.Configuration;
import org.apache.ibatis.session.ResultHandler;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.github.vertical_blank.sqlformatter.SqlFormatter;
import com.github.vertical_blank.sqlformatter.languages.Dialect;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;import java.sql.Statement;
import java.util.List;
import java.util.Properties;
import java.util.regex.Matcher;/*** SQL美化拦截器：显示完整的SQL，并输出执行结果*/
@Intercepts({@Signature(type = StatementHandler.class, method = "query", args = {Statement.class, ResultHandler.class}),@Signature(type = StatementHandler.class, method = "update", args = {Statement.class}),@Signature(type = StatementHandler.class, method = "batch", args = {Statement.class})
})
public class SqlBeautyInterceptor implements Interceptor {private static final Logger logger = LoggerFactory.getLogger(SqlBeautyInterceptor.class);// ANSI 颜色代码private static final String ANSI_RESET = "\u001B[0m";private static final String ANSI_BRIGHT_GREEN = "\u001B[92m";   // 亮绿色（结果）private static final String ANSI_BRIGHT_BLUE = "\u001B[94m";    // 亮蓝色（项目名称）// Gson 实例，用于格式化结果private static final Gson GSON = new GsonBuilder().setPrettyPrinting().disableHtmlEscaping().create();@Overridepublic Object intercept(Invocation invocation) throws Throwable {StatementHandler statementHandler = (StatementHandler) invocation.getTarget();// 通过 MetaObject 获取 delegate 对象MetaObject metaObject = SystemMetaObject.forObject(statementHandler);// 获取 MappedStatementMappedStatement mappedStatement = (MappedStatement) metaObject.getValue("delegate.mappedStatement");// 获取 SQL 类型SqlCommandType sqlCommandType = mappedStatement.getSqlCommandType();// 获取 ConfigurationConfiguration configuration = mappedStatement.getConfiguration();long startTime = System.currentTimeMillis();Object result = null;try {// 执行 SQL，获取结果result = invocation.proceed();return result;} finally {long endTime = System.currentTimeMillis();long sqlCost = endTime - startTime;BoundSql boundSql = statementHandler.getBoundSql();String sql = boundSql.getSql();Object parameterObject = boundSql.getParameterObject();// 创建 MetaObject 实例MetaObject metaObjectParam = configuration.newMetaObject(parameterObject);// 格式化 SQLString formattedSql = formatSql(sql, boundSql, metaObjectParam);// 格式化执行结果String formattedResult = formatResult(result, sqlCommandType);// 日志输出，使用指定的颜色显示各部分logger.info("\n========================\n{}SQL 类型:{} {}{}{}\n{}SQL:{}\n{}{}{}\n{}执行耗时:{} {}{}ms{} \n{}结果:{}\n{}{}\n{}========================{}",ANSI_BRIGHT_BLUE, ANSI_RESET,ANSI_BRIGHT_GREEN, sqlCommandType, ANSI_RESET,ANSI_BRIGHT_BLUE, ANSI_RESET,ANSI_BRIGHT_GREEN, formattedSql, ANSI_RESET,ANSI_BRIGHT_BLUE, ANSI_RESET,ANSI_BRIGHT_GREEN, sqlCost, ANSI_RESET,ANSI_BRIGHT_BLUE, ANSI_RESET,ANSI_BRIGHT_GREEN, formattedResult, ANSI_RESET,ANSI_BRIGHT_BLUE, ANSI_RESET);}}@Overridepublic Object plugin(Object target) {// 使用 Plugin.wrap 生成代理对象return Plugin.wrap(target, this);}@Overridepublic void setProperties(Properties properties) {// 可以通过配置文件设置属性}/*** 格式化 SQL，将参数替换到 SQL 中，并使用 SQLFormatter 进行格式化** @param sql        原始 SQL* @param boundSql   绑定的 SQL* @param metaObject 参数对象的 MetaObject* @return 格式化后的 SQL*/private String formatSql(String sql, BoundSql boundSql, MetaObject metaObject) {if (sql == null || sql.trim().isEmpty()) {return "";}try {// 获取参数映射List<ParameterMapping> parameterMappings = boundSql.getParameterMappings();if (parameterMappings != null && !parameterMappings.isEmpty()) {// 遍历参数映射，替换占位符for (ParameterMapping parameterMapping : parameterMappings) {String propertyName = parameterMapping.getProperty();Object value;if (metaObject.hasGetter(propertyName)) {value = metaObject.getValue(propertyName);} else if (boundSql.hasAdditionalParameter(propertyName)) {value = boundSql.getAdditionalParameter(propertyName);} else {// 对于无法获取值的参数，使用 "?" 替代value = "?";}sql = sql.replaceFirst("\\?", Matcher.quoteReplacement(getParameterValue(value)));}}// 使用 SQLFormatter 格式化 SQL，指定数据库方言（根据实际情况选择）String formattedSql = SqlFormatter.of(Dialect.MySql).format(sql);return formattedSql;} catch (Exception e) {logger.error("Error formatting SQL: ", e);return sql;}}/*** 获取参数值的字符串表示，处理字符串、日期等类型** @param obj 参数值* @return 字符串表示*/private String getParameterValue(Object obj) {if (obj == null) {return "null";}if (obj instanceof String) {return "'" + obj + "'";}if (obj instanceof Number) {return obj.toString();}if (obj instanceof java.util.Date || obj instanceof java.sql.Date || obj instanceof java.sql.Timestamp) {return "'" + obj.toString() + "'";}return "'" + obj.toString() + "'";}/*** 格式化 SQL 执行结果** @param result         执行结果* @param sqlCommandType SQL 类型* @return 格式化后的结果字符串*/private String formatResult(Object result, SqlCommandType sqlCommandType) {if (result == null) {return "null";}try {String formattedResult;if (sqlCommandType == SqlCommandType.SELECT) {// 查询语句，结果通常是 ListformattedResult = GSON.toJson(result);} else if (sqlCommandType == SqlCommandType.UPDATE || sqlCommandType == SqlCommandType.DELETE || sqlCommandType == SqlCommandType.INSERT) {// 更新语句，结果是受影响的行数formattedResult = result.toString() + " 行受影响";} else {// 其他类型formattedResult = result.toString();}// 可根据需要限制结果输出长度，避免日志过大int maxLength = 2000;if (formattedResult.length() > maxLength) {formattedResult = formattedResult.substring(0, maxLength) + "... [结果过长，已截断]";}return formattedResult;} catch (Exception e) {logger.error("Error formatting result: ", e);return result.toString();}}
}

3.common-mybatis-plus-starter-demo 引入日志模块

1.目录

2.pom.xml 引入依赖以及排除logging（重要！！！）

<!-- spring-boot-starter-test -->
<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-test</artifactId><exclusions><exclusion><artifactId>spring-boot-starter-logging</artifactId><groupId>org.springframework.boot</groupId></exclusion></exclusions>
</dependency>
<dependency><groupId>com.sunxiansheng</groupId><artifactId>common-log4j2-starter</artifactId><version>1.0-SNAPSHOT</version>
</dependency>

3.application.yml 开启日志配置

log:aspect:enable: true # 开启自定义的日志切面trace:enable: true # 开启自定义的日志追踪

4.测试

1.traceId

2.方法出入参

3.SQL打印