Java的自动日志工具（高分项目）.zip

# auto-log [auto-log](https://github.com/houbb/auto-log) 是一款为 java 设计的自动日志监控框架。 [](https://travis-ci.com/houbb/auto-log) [](http://mvnrepository.com/artifact/com.github.houbb/auto-log) [](https://github.com/houbb/auto-log/blob/master/LICENSE.txt) [](https://github.com/houbb/auto-log) ## 创作目的 经常会写一些工具，有时候手动加一些日志很麻烦，引入 spring 又过于大材小用。 所以希望从从简到繁实现一个工具，便于平时使用。 ## 特性 - 基于注解+字节码，配置灵活 - 自动适配常见的日志框架 - 支持编程式的调用 - 支持注解式，完美整合 spring - 支持整合 spring-boot - 支持慢日志阈值指定，耗时，入参，出参，异常信息等常见属性指定 - 支持 traceId 特性 - 支持类级别定义注解 - 支持自定义拦截器和过滤器 - 支持 spring aop 注解切面自定义 - 支持类似 dubbo filter 的拦截器链式调用 - 支持日志条件输出，支持日志自适应输出 - 支持日志的超长截断+丢弃策略，避免极端情况的性能问题 ## 变更日志 > [变更日志](https://github.com/houbb/auto-log/blob/master/CHANGELOG.md) V0.11.0 变更 - 支持日志的超长截断+丢弃策略，避免极端情况的性能问题 ## 拓展阅读 [日志开源组件（一）java 注解结合 spring aop 实现自动输出日志](https://houbb.github.io/2023/08/06/auto-log-01-overview) [日志开源组件（二）java 注解结合 spring aop 实现日志traceId唯一标识](https://houbb.github.io/2023/08/06/auto-log-02-trace-id) [日志开源组件（三）java 注解结合 spring aop 自动输出日志新增拦截器与过滤器](https://houbb.github.io/2023/08/06/auto-log-03-filter) [日志开源组件（四）如何动态修改 spring aop 切面信息？让自动日志输出框架更好用](https://houbb.github.io/2023/08/06/auto-log-04-dynamic-aop) [日志开源组件（五）如何将 dubbo filter 拦截器原理运用到日志拦截器中？](https://houbb.github.io/2023/08/06/auto-log-05-dubbo-interceptor) [日志开源组件（六）Adaptive Sampling 自适应采样](https://mp.weixin.qq.com/s/9JH3WfR6Y474LCbY2mZxZQ) [高性能日志脱敏组件（一）java 日志脱敏框架 sensitive，优雅的打印脱敏日志](https://mp.weixin.qq.com/s/xzQNDF7s705iurk7N0uheQ) [高性能日志脱敏组件（二）金融用户敏感数据如何优雅地实现脱敏？](https://mp.weixin.qq.com/s/ljChFiNLzV6GLaUDjehA0Q) [高性能日志脱敏组件（三）日志脱敏之后，无法根据信息快速定位怎么办？](https://mp.weixin.qq.com/s/tZqOH_8QTKrD1oaclNoewg) [高性能日志脱敏组件（四）基于 log4j2 插件实现统一日志脱敏，性能远超正则替换](https://mp.weixin.qq.com/s/ZlWRqT7S92aXFuy-l9Uh3Q) [高性能日志脱敏组件（五）已支持 log4j2 和 logback 插件](https://mp.weixin.qq.com/s/3ARK6PW7pyUhAbO2ctnndg) # 快速开始 ## maven 引入 ```xml <dependency> <group>com.github.houbb</group> <artifact>auto-log-core</artifact> <version>0.12.0</version> </dependency> ``` ## 入门案例 ```java UserService userService = AutoLogHelper.proxy(new UserServiceImpl()); userService.queryLog("1"); ``` - 日志如下 ``` 信息: [TID=9d5ad747342e4f909d42001f1419c58b][METHOD=com.github.houbb.auto.log.test.service.impl.UserServiceImpl.queryLog:java.lang.String#查询日志][PARAM=["1"]][RESULT="result-1"][COST=607 ms] ``` ### 属性说明 | 属性 | 说明 | |:-------|:------| | TID | 日志跟踪号 | | METHOD | 方法签名 | | PARAM | 方法入参 | | RESULT | 方法出参 | | COST | 方法耗时 | | SLOW-THRESHOLD | 慢日志阈值 | | EXCEPTION | 方法异常 | ### 代码 其中方法实现如下： - UserService.java ```java public interface UserService { String queryLog(final String id); } ``` - UserServiceImpl.java 直接使用注解 `@AutoLog` 指定需要打日志的方法即可。 ```java public class UserServiceImpl implements UserService { @Override @AutoLog(description = "查询日志", enableTraceId = true) public String queryLog(String id) { return "result-"+id; } } ``` # 注解说明 ## @AutoLog 核心注解 `@AutoLog` 的属性说明如下： | 属性 | 类型 | 默认值 | 说明 | |:--|:--|:--|:--| | enable | boolean | true | 是否启用 | | param | boolean | true | 是否打印入参 | | result | boolean | true | 是否打印出参 | | costTime | boolean | false | 是否打印耗时 | | exception | boolean | true | 是否打印异常 | | slowThresholdMills | long | -1 | 当这个值大于等于 0 时，且耗时超过配置值，会输出慢日志 | | description | string |"" | 方法描述，默认选择方法名称 | | paramFilter | Class | WebParamFilter | 入参过滤器，支持自定义 | | traceId | Class | Id.class | 日志跟踪号生成策略 | | enableTraceId | boolean | true | 是否启用 traceId 的变化 | 使用建议，在入口的方法中设置 `enableTraceId=true`，会统一设置 traceId，贯穿整个日志周期。 底层依赖的 service/biz 层等，设置为 false 即可。 # 自定义策略 ## 自定义日志拦截器（interceptor） ### 内置拦截器 `AutoLogCommonFilter` 默认日志增强实现 ### 定义 直接实现 `CommonFilter` 类，并且实现对应的方法即可。 ```java package com.github.houbb.auto.log.test.interceptor; import com.github.houbb.auto.log.core.constant.AutoLogAttachmentKeyConst; import com.github.houbb.common.filter.annotation.FilterActive; import com.github.houbb.common.filter.api.CommonFilter; import com.github.houbb.common.filter.api.Invocation; import com.github.houbb.common.filter.api.Invoker; import com.github.houbb.common.filter.api.Result; import com.github.houbb.common.filter.exception.CommonFilterException; /** * 自定义日志拦截器 * @author binbin.hou * @since 0.0.12 */ @FilterActive(order = 1) public class MyAutoLogInterceptor implements CommonFilter { @Override public Result invoke(Invoker invoker, Invocation invocation) throws CommonFilterException { final String tid = (String) invocation.getAttachment(AutoLogAttachmentKeyConst.AUTO_LOG_TRACE_ID); System.out.println("my test filter before " + tid); Result result = invoker.invoke(invocation); System.out.println("my test filter after " + tid); return result; } } ``` 我们可以通过 `@FilterActive(order = 1)` 指定拦截器执行的顺序，数值越小，越先执行。 `invocation.getAttachment(AutoLogAttachmentKeyConst.AUTO_LOG_TRACE_ID)` 可以获取 invocation 中传递的属性。 ### 使用 SPI 指定 创建文件 `resources\META-INF\services\com.github.houbb.common.filter.api.CommonFilter` 在文件中指定我们定义的接口： ``` com.github.houbb.auto.log.test.interceptor.MyAutoLogInterceptor ``` ### 测试效果 ``` my test filter before 2bc181d4efb8408e948072022c9227c0 my test filter after 2bc181d4efb8408e948072022c9227c0 八月 06, 2023 8:13:19 下午 com.github.houbb.auto.log.core.support.interceptor.chain.AutoLogCommonFilter info 信息: [TID=2bc181d4efb8408e948072022c9227c0][METHOD=com.github.houbb.auto.log.test.service.impl.UserServiceImpl.queryLog:java.lang.String#查询日志][PARAM=["1"]][RESULT="result-1"][COST=535 ms] ``` ## 自定义入参过滤器（paramFilter） ### 内置 `WebParamFilter` 主要用于过滤 HttpRequest HttpServlet 等无法直接 JSON 序列化的对象。 ### 自定义 直接继承 `AbstractParamFilter` 类实现对应的方法即可。 ```java public class MyParamFilter extend