在我们开发的过程中,可能存在如下情况:
1、 有些时候我们需要调用第三方的接口
,一般情况下,调用接口,我们都会记录请求的入参和响应的。如果我们自己系统的日志和第三方的日志混合到一个日志文件中,那么可能查找日志就比较麻烦了。 那么我们是否可以将第三方系统的日志单独放到另外的文件中呢?
2、或者有些时候我们系统需要进行数据迁移,如果某条数据迁移失败了, 是否单独放到一个日志文件中比较清晰呢?
从上图中可以看到我们的需求比较简单
1、系统启动日志和 login
模块日志记录到 springboot-spring.log
文件中。
2、第三方业务( QQ
)模块的日志记录到 springboot-qq.log
文件中。
3、第三方业务( QQ
)模块提供了一个 login(loginName)
方法, 方法的入参loginName
需要记录到 springboot-qqLoginName.log
文件中,模拟 一、背景
中提到的数据迁移失败,记录失败的数据到单独的日志文件中。
此处使用 logback
来完成日志的记录,因为 SpringBoot
应用程序默认的就是采用的logback来记录日志。
appender
,这个可以简单的理解日志需要输出到哪里。比如:
%d{yyyy-MM-dd HH:mm:ss.SSS} [${PID:- }] [%thread] %-5level %logger{50}#%method:%L -%msg%n logs/springboot-qq-%d{yyyy-MM-dd}-.%i.log
此处就需要我们来配置 logger
了。logger的 name
属性指定到具体的全包名,然后引用我们上面定义的 appender
即可。
配置logger,logger的name为需要单独生成文件的那个包的全包名,然后在里面引用上面定义的appender
其实还是使用 logger
来实现,logger的 name
需要和 LoggerFactory.getLogger("此处写具体logger的name的值")
注意:
此处可能有一个坑,就是可能会丢失类名,那么我们如何进行解决呢?可以通过 MDC
来解决。
.... %X{CLASSNAME}#%method:%L -%msg%n
MDC.put("CLASSNAME", QQService.class.getName()); qqLoginName.info("登录用户:[{}]", loginName);
即 xml
中使用 %X{CLASSNAME}
,在 java
代码中使用 MDC
存入 CLASSNAME
的值。
1、输出日志到控制台
%d{yyyy-MM-dd HH:mm:ss.SSS} [${PID:- }] [%thread] %-5level %logger{50}#%method:%L -%msg%n UTF-8
2、编写 login
模板的日志
logs/springboot-spring-%d{yyyy-MM-dd}-.%i.log 7 1MB 2GB %d{yyyy-MM-dd HH:mm:ss.SSS} [${PID:- }] [%thread] %-5level %logger{50}#%method:%L -%msg%n UTF-8
3、编写 qq
模板的日志
logs/springboot-qq-%d{yyyy-MM-dd}-.%i.log 7 1MB 2GB %d{yyyy-MM-dd HH:mm:ss.SSS} [${PID:- }] [%thread] %-5level %logger{50}#%method:%L -%msg%n UTF-8
4、编写qq模块loginName单独输出到文件的日志
logs/springboot-qqLoginName-%d{yyyy-MM-dd}-.%i.log 7 1MB 2GB %d{yyyy-MM-dd HH:mm:ss.SSS} [${PID:- }] [%thread] %-5level %X{CLASSNAME}#%method:%L -%msg%n UTF-8
1、配置login模块
login
模块属于我们自己的系统模块,此处使用 root
标签来配置。
2、配置qq模块
此处 name
的值直接指定到了 qq
的全包名路径。
3、配置loginName单独输出到文件
@Component public class QQService { private static final Logger log = LoggerFactory.getLogger(QQService.class); // getLogger("qqLoginName") 里的 qqLoginName 需要和 logback-spring.xml 中 logger的name一致,才会应用 private static final Logger qqLoginName = LoggerFactory.getLogger("qqLoginName"); public void login(String loginName) { log.info("QQ业务: 用户:[{}]开始使用QQ来登录系统", loginName); MDC.put("CLASSNAME", QQService.class.getName()); qqLoginName.info("登录用户:[{}]", loginName); } }
@RestController public class LoginController { private static final Logger log = LoggerFactory.getLogger(LoginController.class); @Resource private QQService qqService; @GetMapping("login/{loginName}") public String login(@PathVariable("loginName") String loginName) { log.info("自己业务:用户:[{}]进行登录", loginName); qqService.login(loginName); return "ok"; } }
可以看到得到了我们期望的结果。
spring-cloud-parent: spring cloud 技术栈学习 - Gitee.com
在SpringBoot中,如果我们要覆盖默认的logback配置,推荐使用 logback-spring.xml
来配置。