From 1eff0fa846cccb2fb2df9cee5333a8f2214aa4af Mon Sep 17 00:00:00 2001 From: Looly Date: Wed, 26 May 2021 14:08:48 +0800 Subject: [PATCH] add logtube support --- CHANGELOG.md | 4 +- .../hutool/core/exceptions/ExceptionUtil.java | 24 +++- .../main/java/cn/hutool/core/io/FileUtil.java | 4 +- .../core/exceptions/ExceptionUtilTest.java | 4 + .../java/cn/hutool/core/io/FileUtilTest.java | 7 ++ hutool-log/pom.xml | 6 + .../log/dialect/logtube/LogTubeLog.java | 103 ++++++++++++++++++ .../dialect/logtube/LogTubeLogFactory.java | 29 +++++ .../log/dialect/logtube/package-info.java | 7 ++ .../services/cn.hutool.log.LogFactory | 3 +- .../java/cn/hutool/log/test/LogTubeTest.java | 17 +++ .../src/test/resources/logtube.properties | 90 +++++++++++++++ 12 files changed, 291 insertions(+), 7 deletions(-) create mode 100644 hutool-log/src/main/java/cn/hutool/log/dialect/logtube/LogTubeLog.java create mode 100644 hutool-log/src/main/java/cn/hutool/log/dialect/logtube/LogTubeLogFactory.java create mode 100644 hutool-log/src/main/java/cn/hutool/log/dialect/logtube/package-info.java create mode 100644 hutool-log/src/test/java/cn/hutool/log/test/LogTubeTest.java create mode 100644 hutool-log/src/test/resources/logtube.properties diff --git a/CHANGELOG.md b/CHANGELOG.md index 92fa60e69..d0bb010ad 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,7 +3,7 @@ ------------------------------------------------------------------------------------------------------------- -# 5.6.6 (2021-05-24) +# 5.6.6 (2021-05-26) ### 🐣新特性 * 【cron 】 增加时间轮简单实现 @@ -16,12 +16,14 @@ * 【core 】 IdCardUtil.isValidCard增加非空判断 * 【json 】 JSONObject构造增加SortedMap判断（pr#333@Gitee） * 【core 】 Tuple增加部分方法（pr#333@Gitee） +* 【log 】 增加LogTube支持 ### 🐞Bug修复 * 【core 】 修复XmlUtil中omitXmlDeclaration参数无效问题（issue#1581@Github） * 【core 】 修复NumberUtil.decimalFormat参数传错的问题（issue#I3SDS3@Gitee） * 【json 】 修复JSONArray.put方法不能覆盖值的问题 * 【poi 】 修复sax方式读取xls无法根据sheet名称获取数据（issue#I3S4NH@Gitee） +* 【core 】 修复路径中多个~都被替换的问题（pr#1599@Github） ------------------------------------------------------------------------------------------------------------- # 5.6.5 (2021-05-08) diff --git a/hutool-core/src/main/java/cn/hutool/core/exceptions/ExceptionUtil.java b/hutool-core/src/main/java/cn/hutool/core/exceptions/ExceptionUtil.java index 8904b8248..e9cf0b304 100644 --- a/hutool-core/src/main/java/cn/hutool/core/exceptions/ExceptionUtil.java +++ b/hutool-core/src/main/java/cn/hutool/core/exceptions/ExceptionUtil.java @@ -150,7 +150,25 @@ public class ExceptionUtil { * @since 4.1.4 */ public static StackTraceElement getStackElement(int i) { - return getStackElements()[i]; + return Thread.currentThread().getStackTrace()[i]; + } + + /** + * 获取指定层的堆栈信息 + * + * @param fqcn 指定类名为基础 + * @param i 指定类名的类堆栈相对层数 + * @return 指定层的堆栈信息 + * @since 5.6.6 + */ + public static StackTraceElement getStackElement(String fqcn, int i) { + final StackTraceElement[] stackTraceArray = Thread.currentThread().getStackTrace(); + final int index = ArrayUtil.matchIndex((ele) -> StrUtil.equals(fqcn, ele.getClassName()), stackTraceArray); + if(index > 0){ + return stackTraceArray[index + i]; + } + + return null; } /** @@ -160,8 +178,8 @@ public class ExceptionUtil { * @since 4.1.4 */ public static StackTraceElement getRootStackElement() { - final StackTraceElement[] stackElements = getStackElements(); - return stackElements[stackElements.length - 1]; + final StackTraceElement[] stackElements = Thread.currentThread().getStackTrace(); + return Thread.currentThread().getStackTrace()[stackElements.length - 1]; } /** diff --git a/hutool-core/src/main/java/cn/hutool/core/io/FileUtil.java b/hutool-core/src/main/java/cn/hutool/core/io/FileUtil.java index d34e2f358..acbefd755 100644 --- a/hutool-core/src/main/java/cn/hutool/core/io/FileUtil.java +++ b/hutool-core/src/main/java/cn/hutool/core/io/FileUtil.java @@ -1422,8 +1422,8 @@ public class FileUtil extends PathUtil { pathToUse = StrUtil.removePrefixIgnoreCase(pathToUse, URLUtil.FILE_URL_PREFIX); // 识别home目录形式，并转换为绝对路径 - if (pathToUse.startsWith("~")) { - pathToUse = pathToUse.replaceFirst("~", getUserHomePath()); + if (StrUtil.startWith(pathToUse, '~')) { + pathToUse = getUserHomePath() + pathToUse.substring(1); } // 统一使用斜杠 diff --git a/hutool-core/src/test/java/cn/hutool/core/exceptions/ExceptionUtilTest.java b/hutool-core/src/test/java/cn/hutool/core/exceptions/ExceptionUtilTest.java index 9bcbba672..d03b00caa 100644 --- a/hutool-core/src/test/java/cn/hutool/core/exceptions/ExceptionUtilTest.java +++ b/hutool-core/src/test/java/cn/hutool/core/exceptions/ExceptionUtilTest.java @@ -26,6 +26,10 @@ public class ExceptionUtilTest { Assert.assertEquals("main", ele.getMethodName()); } + @Test + public void getStackElementTest(){ + } + @Test public void convertTest() { // RuntimeException e = new RuntimeException(); diff --git a/hutool-core/src/test/java/cn/hutool/core/io/FileUtilTest.java b/hutool-core/src/test/java/cn/hutool/core/io/FileUtilTest.java index ad3c984f7..e1df8a0d0 100644 --- a/hutool-core/src/test/java/cn/hutool/core/io/FileUtilTest.java +++ b/hutool-core/src/test/java/cn/hutool/core/io/FileUtilTest.java @@ -168,6 +168,13 @@ public class FileUtilTest { Assert.assertEquals(home + "/bar/", FileUtil.normalize("~/foo/../bar/")); } + @Test + public void normalizeHomePathTest2() { + String home = FileUtil.getUserHomePath().replace('\\', '/'); + // 多个~应该只替换开头的 + Assert.assertEquals(home + "/~bar/", FileUtil.normalize("~/foo/../~bar/")); + } + @Test public void normalizeClassPathTest() { Assert.assertEquals("", FileUtil.normalize("classpath:")); diff --git a/hutool-log/pom.xml b/hutool-log/pom.xml index b6f6e0fc1..dfe0f4ae0 100644 --- a/hutool-log/pom.xml +++ b/hutool-log/pom.xml @@ -83,6 +83,12 @@ ${jboss-logging.version} true + + io.github.logtube + logtube + 0.39.1 + true + org.slf4j slf4j-simple diff --git a/hutool-log/src/main/java/cn/hutool/log/dialect/logtube/LogTubeLog.java b/hutool-log/src/main/java/cn/hutool/log/dialect/logtube/LogTubeLog.java new file mode 100644 index 000000000..62a9e89ef --- /dev/null +++ b/hutool-log/src/main/java/cn/hutool/log/dialect/logtube/LogTubeLog.java @@ -0,0 +1,103 @@ +package cn.hutool.log.dialect.logtube; + +import cn.hutool.core.exceptions.ExceptionUtil; +import cn.hutool.core.util.StrUtil; +import cn.hutool.log.AbstractLog; +import cn.hutool.log.level.Level; +import io.github.logtube.Logtube; +import io.github.logtube.core.IEventLogger; + +/** + * LogTube log.封装
+ * + * @author looly + * @since 5.6.6 + */ +public class LogTubeLog extends AbstractLog { + + private final IEventLogger logger; + + // ------------------------------------------------------------------------- Constructor + public LogTubeLog(IEventLogger logger) { + this.logger = logger; + } + + public LogTubeLog(Class clazz) { + this((null == clazz) ? StrUtil.NULL : clazz.getName()); + } + + public LogTubeLog(String name) { + this(Logtube.getLogger(name)); + } + + + @Override + public String getName() { + return logger.getName(); + } + + // ------------------------------------------------------------------------- Trace + @Override + public boolean isTraceEnabled() { + return logger.isTraceEnabled(); + } + + @Override + public void trace(String fqcn, Throwable t, String format, Object... arguments) { + log(fqcn, Level.TRACE, t, format, arguments); + } + + // ------------------------------------------------------------------------- Debug + @Override + public boolean isDebugEnabled() { + return logger.isDebugEnabled(); + } + + @Override + public void debug(String fqcn, Throwable t, String format, Object... arguments) { + log(fqcn, Level.DEBUG, t, format, arguments); + } + + // ------------------------------------------------------------------------- Info + @Override + public boolean isInfoEnabled() { + return logger.isInfoEnabled(); + } + + @Override + public void info(String fqcn, Throwable t, String format, Object... arguments) { + log(fqcn, Level.INFO, t, format, arguments); + } + + // ------------------------------------------------------------------------- Warn + @Override + public boolean isWarnEnabled() { + return logger.isWarnEnabled(); + } + + @Override + public void warn(String fqcn, Throwable t, String format, Object... arguments) { + log(fqcn, Level.WARN, t, format, arguments); + } + + // ------------------------------------------------------------------------- Error + @Override + public boolean isErrorEnabled() { + return logger.isErrorEnabled(); + } + + @Override + public void error(String fqcn, Throwable t, String format, Object... arguments) { + log(fqcn, Level.ERROR, t, format, arguments); + } + + @Override + public void log(String fqcn, Level level, Throwable t, String format, Object... arguments) { + final String topic = level.name().toLowerCase(); + logger.topic(topic) + .xStackTraceElement(ExceptionUtil.getStackElement(6), null) + .message(StrUtil.format(format, arguments)) + .xException(t) + .commit(); + } +} diff --git a/hutool-log/src/main/java/cn/hutool/log/dialect/logtube/LogTubeLogFactory.java b/hutool-log/src/main/java/cn/hutool/log/dialect/logtube/LogTubeLogFactory.java new file mode 100644 index 000000000..5a4b110c7 --- /dev/null +++ b/hutool-log/src/main/java/cn/hutool/log/dialect/logtube/LogTubeLogFactory.java @@ -0,0 +1,29 @@ +package cn.hutool.log.dialect.logtube; + +import cn.hutool.log.Log; +import cn.hutool.log.LogFactory; + +/** + * LogTube log. 封装
+ * + * @author Looly + * @since 5.6.6 + */ +public class LogTubeLogFactory extends LogFactory { + + public LogTubeLogFactory() { + super("LogTube"); + checkLogExist(io.github.logtube.Logtube.class); + } + + @Override + public Log createLog(String name) { + return new LogTubeLog(name); + } + + @Override + public Log createLog(Class clazz) { + return new LogTubeLog(clazz); + } + +} diff --git a/hutool-log/src/main/java/cn/hutool/log/dialect/logtube/package-info.java b/hutool-log/src/main/java/cn/hutool/log/dialect/logtube/package-info.java new file mode 100644 index 000000000..9ee60169b --- /dev/null +++ b/hutool-log/src/main/java/cn/hutool/log/dialect/logtube/package-info.java @@ -0,0 +1,7 @@ +/** + * LogTube的实现封装 + * + * @author looly + * + */ +package cn.hutool.log.dialect.logtube; diff --git a/hutool-log/src/main/resources/META-INF/services/cn.hutool.log.LogFactory b/hutool-log/src/main/resources/META-INF/services/cn.hutool.log.LogFactory index 120601792..b0bec7baa 100644 --- a/hutool-log/src/main/resources/META-INF/services/cn.hutool.log.LogFactory +++ b/hutool-log/src/main/resources/META-INF/services/cn.hutool.log.LogFactory @@ -1,7 +1,8 @@ +cn.hutool.log.dialect.logtube.LogTubeLogFactory cn.hutool.log.dialect.slf4j.Slf4jLogFactory cn.hutool.log.dialect.log4j2.Log4j2LogFactory cn.hutool.log.dialect.log4j.Log4jLogFactory cn.hutool.log.dialect.commons.ApacheCommonsLogFactory cn.hutool.log.dialect.tinylog.TinyLogFactory cn.hutool.log.dialect.tinylog.TinyLog2Factory -cn.hutool.log.dialect.jboss.JbossLogFactory \ No newline at end of file +cn.hutool.log.dialect.jboss.JbossLogFactory diff --git a/hutool-log/src/test/java/cn/hutool/log/test/LogTubeTest.java b/hutool-log/src/test/java/cn/hutool/log/test/LogTubeTest.java new file mode 100644 index 000000000..073523128 --- /dev/null +++ b/hutool-log/src/test/java/cn/hutool/log/test/LogTubeTest.java @@ -0,0 +1,17 @@ +package cn.hutool.log.test; + +import cn.hutool.log.Log; +import cn.hutool.log.LogFactory; +import cn.hutool.log.dialect.logtube.LogTubeLogFactory; +import org.junit.Test; + +public class LogTubeTest { + + @Test + public void logTest(){ + LogFactory factory = new LogTubeLogFactory(); + LogFactory.setCurrentLogFactory(factory); + Log log = LogFactory.get(); + log.debug("LogTube debug test."); + } +} diff --git a/hutool-log/src/test/resources/logtube.properties b/hutool-log/src/test/resources/logtube.properties new file mode 100644 index 000000000..feb474e82 --- /dev/null +++ b/hutool-log/src/test/resources/logtube.properties @@ -0,0 +1,90 @@ +########################################## +# +# 项目基本信息 +# +########################################## +# +# 项目名 !!!按照实际需要修改!!! 不允许点号，使用 - 分割 +logtube.project=test-hutool +# +# 项目环境 !!!按照实际需要修改!!! 允许的值为 'dev', 'test', 'staging' 和 'prod' +logtube.env=test +# +# 全局主题过滤器，默认设置为不包括 trace 和 debug，调试环境可以酌情打开 +logtube.topics.root=ALL,-trace +# +# 分包主题过滤器 +# +# logtube.topics.com.google.gson=error +# logtube.topics.com.google.gson=error +# +# 全局主题映射，trace 合并进入 debug, error 重命名为 err, warn 合并进入 info +logtube.topic-mappings=trace=debug,error=err,warn=info +# +# +########################################## +# +# 命令行输出 +# +########################################## +# +# 是否开启命令行输出，设置为开启 +logtube.console.enabled=true +# +# 命令行输出设置为包括所有主题 （仍然受制于全局过滤器） +logtube.console.topics=ALL +# +# +########################################## +# +# 日志文件输出 +# +########################################## +# +# 启动日志文件输出 +# +logtube.file.enabled=false +# +# 日志文件输出包含所有主题（仍然受制于全局过滤器） +logtube.file.topics=ALL +# +# 日志文件重新打开信号文件，用于 logrotate +logtube.file.signal=/tmp/xlog.reopen.txt +# +# 日志文件路径 +logtube.file.dir=logs +# +# 日志子文件夹，除了 trace 和 debug 日志进入 others 子文件夹，剩下的全部进入 xlog 子文件夹 +# 一般情况下，xlog 子文件夹的日志文件会被收集，然后进入 xlog 系统 +logtube.file.subdir-mappings=ALL=xlog,trace=others,debug=others +# +# +########################################## +# +# 远程输出，Redis 协议 +# +########################################## +# +# 是否开启远程输出，设置为关闭 +logtube.redis.enabled=false +# +# 远程输出设置为包含所有主题（仍然受制于全局主题过滤器） +logtube.redis.topics=ALL +# +# 远程输出目标主机，设置为为 127.0.0.1:6379，可使用逗号分隔多个主机 +logtube.redis.hosts=127.0.0.1:6379 +# +# 远程输出 Redis 键值 +logtube.redis.key=xlog +# +######################################### +# +# 组件配置 +# +######################################### +# +# 响应时间 > 100 ms 的 Redis 操作会被 LogtubeRedis 组件汇报 +logtube.filter.redis-min-duration=100 +# +# 结果集 > 1000 bytes 的 Redis 操作会被 LogtubeRedis 组件汇报 +logtube.filter.redis-min-result-size=1000