大模型,如chatGPT3.5、GPT-4,国内的文心一言、通义千问、讯飞星火等,对文字工作者,图片、视频工作者的工作效率提升是巨大的,当你学会使用这些工具之后,你的工作和学习效率会大大提升,把其他人甩在身后。
今天,我就用 zelinAI 包装 chatGPT3.5 学习了 Spring Boot 项目使用 logback 打印日志的最佳实践,效率杠杠的,一起来学习吧。
Spring Boot 项目打印 log 的最佳实践是使用 SLF4J API,以及在 logback.xml 中进行配置。
SLF4J(Simple Logging Facade for Java)是一种针对 Java 应用开发的日志规范,支持多种日志实现(如 log4j、logback)。在 Spring Boot 项目中,可以使用 SLF4J API 进行统一的日志输出。
具体使用方法如下:
org.springframework.boot
spring-boot-starter-web
org.slf4j
slf4j-api
ch.qos.logback
logback-classic
logback.xml 是 logback 日志框架的配置文件,需要放置在项目的 src/main/resources 目录下。下面是一个示例配置文件:
%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
${LOG_HOME}/${PROJECT_NAME}.log
${LOG_HOME}/${PROJECT_NAME}.%d{yyyy-MM-dd}.log.gz
30
%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
该配置文件中定义了两个日志输出器,分别是控制台输出器 STDOUT
和文件输出器 FILE
。可以根据自己的需求进行修改。
同时,
指定了日志输出的级别为 INFO
,表示只输出 INFO
级别及以上的日志信息。可以根据需要修改为其他级别。
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@RestController
public class MyController {
// 获取日志记录器对象
private static final Logger logger = LoggerFactory.getLogger(MyController.class);
@GetMapping("/hello")
public String hello() {
logger.info("hello world");
return "hello world";
}
}
在代码中,使用 LoggerFactory.getLogger()
方法获取 logger 对象,然后在需要输出日志的地方使用该对象的 info()
、error()
、debug()
等方法进行日志输出。
总结:使用 SLF4J API 和 logback 配置框架可以实现 Spring Boot 项目的统一日志输出,增强日志的可维护性和易读性。
我继续问
SLF4J 接口是一个日志统一接口,不能单独使用,需要与具体的日志框架结合使用。以下是一些常用的日志框架,它们都实现了 SLF4J 接口:
我发现项目中除了 info.log, error.log, debug.log 之外,还有其他很多自定义命名的 log 文件,这个是怎么实现的?看了下项目代码,发现都有个 name 属性。根据这个继续问它:
在 logback.xml
配置文件中,每个
标签都对应着一个 appender 的实例,而每个 appender 都可以指定一个唯一的 name
属性值来标识自己。因此,我们可以通过为每个 appender 指定不同的 name 属性值,来创建不同的日志文件。例如:
<configuration>
<appender name="FILE_DEBUG" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>logs/debug.logfile>
appender>
<appender name="FILE_ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>logs/error.logfile>
appender>
<root level="info">
<appender-ref ref="FILE_DEBUG"/>
<appender-ref ref="FILE_ERROR"/>
root>
configuration>
上述配置创建了两个 appender,分别使用 name 属性为 FILE_DEBUG
和 FILE_ERROR
,分别对应着两个日志文件 debug.log
和 error.log
。注意,我们将两个 appender 都添加到了 root 节点中,表示日志会同时输出到这两个文件中。
如果要在代码中使用这些 appender,可以分别通过 LoggerFactory.getLogger
方法获取到不同的 Logger 对象,并在代码中使用。例如:
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class MyClass {
private static final Logger debugLogger = LoggerFactory.getLogger("FILE_DEBUG");
private static final Logger errorLogger = LoggerFactory.getLogger("FILE_ERROR");
public void test() {
// 输出调试日志
debugLogger.debug("this is a debug log");
// 输出错误日志
errorLogger.error("this is an error log");
}
}
上述代码中,我们分别使用了 FILE_DEBUG
和 FILE_ERROR
两个 appender 的 Logger 对象,并在代码中通过 debugLogger
和 errorLogger
执行不同级别的日志输出。需要注意的是,LoggerFactory.getLogger 方法的参数需要传入对应 appender 的 name 属性值。
在使用LoggerFactory.getLogger()方法时,如果不指定name参数,则会默认使用当前类的类名作为参数。这意味着创建的日志记录器将会与当前类绑定,使用当前类的名称命名,并记录当前类中发生的事件。这种做法的优势在于,当代码复制到其他类中时,日志记录器也会自动更改为相应的类名,从而避免了手动更改记录器名称的麻烦。此外,这样做还可以避免命名冲突和混乱,使得代码更加清晰易懂。
logback打印日志的最佳实践通常包括以下几个方面:
使用slf4j统一日志接口,避免直接使用具体的日志框架。这样日志框架可以在不改变应用程序代码的情况下进行更换。
配置logback.xml或logback.groovy以指定日志输出格式和输出目标。要注意配置文件的路径和文件名,并保证配置文件的正确性和合理性。
使用日志级别来控制输出的详细程度。根据实际需要设置日志级别,建议在开发环境中使用DEBUG或INFO级别,而在生产环境中使用WARN或ERROR级别。
使用{}来避免字符串拼接,在需要输出大量字符串时会提高性能,减少对于字符串池的占用。使用占位符的方式输出,例如:
logger.info("用户{}登录成功", username);
此外,还可以使用条件日志,类似于断言的功能,如下所示:
logger.debug("x={}, y={}", x, y);
logger.debug("Value of i is {}, Value of j is {}", i, j);
logger.debug("Value of k is {}", k);
if (logger.isDebugEnabled()) {
logger.debug("The value of x is " + x);
}
根据上述最佳实践,以下是一个示例代码,假设使用了logback框架:
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class MyClass {
private static final Logger logger = LoggerFactory.getLogger(MyClass.class);
public void doSomething() {
logger.debug("doing something...");
try {
// do something
} catch (Exception e) {
logger.error("an error occurred while doing something", e);
}
logger.info("something has been done.");
}
}
其中,类名和logger对象要相对应,logger可以根据需要使用不同的日志级别,使用{}占位符输出日志信息。