https://github.com/xkcoding/magic-starter-log-demo
magic-starter-log 日志模块集成 demo
https://github.com/xkcoding/magic-starter-log-demo
demo logger magic-starter spring-boot-2 spring-boot-starter xkcoding
Last synced: 11 months ago
JSON representation
magic-starter-log 日志模块集成 demo
- Host: GitHub
- URL: https://github.com/xkcoding/magic-starter-log-demo
- Owner: xkcoding
- Created: 2019-09-24T16:41:00.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-09-25T02:18:49.000Z (over 6 years ago)
- Last Synced: 2025-02-03T15:55:39.866Z (about 1 year ago)
- Topics: demo, logger, magic-starter, spring-boot-2, spring-boot-starter, xkcoding
- Language: Java
- Homepage:
- Size: 2.97 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# magic-starter-log-demo
> 演示日志模块的使用
## 使用方法
### 1. 三种日志如何触发
- 操作日志
> 在需要记录操作日志的方法上添加注解，例子：https://github.com/xkcoding/magic-starter-log-demo/blob/be5a26decb6339d0e0daddf5f24ce6ab63e234e9/src/main/java/com/xkcoding/magicstarterlogdemo/controller/TestController.java#L25
```java
@OperateLog("操作日志内容")
```
- 自定义日志
> 例子：https://github.com/xkcoding/magic-starter-log-demo/blob/be5a26decb6339d0e0daddf5f24ce6ab63e234e9/src/main/java/com/xkcoding/magicstarterlogdemo/controller/TestController.java#L28
```java
@Autowired
private MagicLogger magicLogger;
magicLogger.warn("日志前缀", "日志内容");
magicLogger.debug("日志前缀", "日志内容");
magicLogger.info("日志前缀", "日志内容");
magicLogger.error("日志前缀", "日志内容");
```
- 错误日志
> 建议在全局拦截的地方触发，例子：https://github.com/xkcoding/magic-starter-log-demo/blob/be5a26decb6339d0e0daddf5f24ce6ab63e234e9/src/main/java/com/xkcoding/magicstarterlogdemo/handler/GlobalExceptionHandler.java#L23
```java
LogEventPublisher.publishErrorLogEvent(exception);
```
### 2. 三种日志如何处理
> 1. 继承 LogHandler 重写对应日志类型处理方法即可，例子：https://github.com/xkcoding/magic-starter-log-demo/blob/master/src/main/java/com/xkcoding/magicstarterlogdemo/config/support/DemoLogHandler.java
> 2. 交给 Spring 容器管理，例子：https://github.com/xkcoding/magic-starter-log-demo/blob/master/src/main/java/com/xkcoding/magicstarterlogdemo/config/LogConfig.java
```java
/**
*
* 日志执行逻辑
*
*
* @author yangkai.shen
* @date Created in 2019/9/24 19:43
*/
@Slf4j
public class DemoLogHandler implements LogHandler {
@Override
public void handleOperateLog(OperateLogModel logModel) {
log.info("【OperateLogModel】= {}", JSONUtil.toJsonStr(logModel));
}
@Override
public void handleCustomLog(CustomLogModel logModel) {
log.info("【CustomLogModel】= {}", JSONUtil.toJsonStr(logModel));
}
@Override
public void handleErrorLog(ErrorLogModel logModel) {
log.info("【ErrorLogModel】= {}", JSONUtil.toJsonStr(logModel));
}
}
```
### 3. web请求/响应日志
```yaml
magic:
log:
request:
enabled: true
```
### 4. 通用日志配置文件
```yaml
spring:
application:
name: magic-starter-log-demo
logging:
config: classpath:com/xkcoding/magic/log/logback/logback-spring.xml
```