日志框架能解决Java程序中信息记录不规范、调试困难、生产环境监控不便等问题，推荐使用slf4j作为门面，搭配log4j 2或logback实现；1. 选择框架时优先考虑slf4j+logback或log4j 2以提升灵活性；2. 配置log4j 2需定义appenders（输出目的地）、layouts（格式）和loggers（日志级别），通过log4j2.xml文件实现；3. 在代码中通过slf4j的loggerfactory获取logger实例并按级别输出日志；4. 生产环境中应设置info或warn级别，使用滚动文件策略控制大小与保留周期，并结合elk或splunk进行监控；5. 通过异步logger或异步appender提升性能，避免主线程阻塞；6. spring boot默认集成logback，可通过application.properties配置基础日志参数，或使用logback-spring.xml进行高级定制；7. 自定义日志格式需利用pattern layout中的转换字符如%d、%t、%level、%logger、%msg等设计输出模板；掌握这些方法可系统提升java应用的日志管理能力，从而有效支持调试、监控与维护工作。
使用日志框架，简单来说，就是让你的Java程序学会“说话”，把运行过程中的重要信息记录下来，方便你调试、监控和排错。与其说“怎样使用”，不如说是“为什么要用”和“怎么用好”。
日志框架能帮你解决什么问题？又该如何选择和配置呢？
日志记录程序信息，不仅仅是
System.out.println
的替代品。它是一种结构化的信息记录方式，允许你根据不同的日志级别（例如DEBUG、INFO、WARN、Error）来区分信息的严重程度，并且可以灵活地配置日志输出到不同的目的地（例如控制台、文件、数据库）。
立即学习“Java免费学习笔记（深入）”；
如何选择合适的Java日志框架？
选择日志框架就像选工具，适合自己的才是最好的。目前流行的选择包括：
- java.util.Logging (JUL): Java自带的日志API，无需额外依赖，但功能相对简单。
- Log4j 2: apache的开源项目，性能优秀，配置灵活，支持异步日志和多种Appender。
- SLF4J (Simple Logging Facade for Java): 一个日志门面，不提供具体的日志实现，而是允许你在运行时选择具体的日志框架（例如Log4j 2或Logback）。
- Logback: spring boot默认使用的日志框架，性能好，配置简单，与SLF4J集成良好。
推荐使用SLF4J作为门面，搭配Log4j 2或Logback作为具体实现。这样可以提高代码的灵活性，方便日后更换日志框架。
如何配置Log4j 2？
Log4j 2的配置主要通过
log4j2.xml
或
log4j2.properties
文件进行。配置文件的核心包括：
- Appenders: 定义日志输出的目的地，例如控制台（console Appender）、文件（File Appender、Rolling File Appender）等。
- Layouts: 定义日志输出的格式，例如Pattern Layout、json Layout等。
- Loggers: 定义哪些包或类的日志信息应该被记录，以及记录的级别。
- Root Logger: 根Logger，用于配置全局的日志级别和Appenders。
一个简单的
log4j2.xml
配置示例：
<?xml version="1.0" encoding="UTF-8"?> <Configuration status="WARN"> <Appenders> <Console name="Console" target="SYSTEM_OUT"> <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/> </Console> <RollingFile name="RollingFile" fileName="logs/app.log" filePattern="logs/app-%d{yyyy-MM-dd}.log"> <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/> <Policies> <TimeBasedTriggeringPolicy/> </Policies> </RollingFile> </Appenders> <Loggers> <Root level="INFO"> <AppenderRef ref="Console"/> <AppenderRef ref="RollingFile"/> </Root> </Loggers> </Configuration>
这个配置定义了两个Appender：一个输出到控制台，一个输出到文件，并且每天生成一个新的日志文件。Root Logger的级别设置为INFO，意味着只有INFO级别及以上的日志信息会被记录。
如何在Java代码中使用日志框架？
首先，添加SLF4J和Log4j 2的依赖到你的项目中（例如，使用maven或gradle）。
<!-- Maven --> <dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-api</artifactId> <version>1.7.36</version> </dependency> <dependency> <groupId>org.apache.logging.log4j</groupId> <artifactId>log4j-slf4j-impl</artifactId> <version>2.17.1</version> <scope>runtime</scope> </dependency> <dependency> <groupId>org.apache.logging.log4j</groupId> <artifactId>log4j-core</artifactId> <version>2.17.1</version> </dependency>
然后，在你的Java类中，获取一个Logger实例：
import org.slf4j.Logger; import org.slf4j.LoggerFactory; public class MyClass { private Static final Logger logger = LoggerFactory.getLogger(MyClass.class); public void myMethod() { logger.debug("This is a debug message."); logger.info("This is an info message."); logger.warn("This is a warning message."); logger.error("This is an error message."); try { // Some code that might throw an exception int result = 10 / 0; } catch (Exception e) { logger.error("An exception occurred!", e); } } }
注意，Logger实例通常声明为
static final
，并且使用当前类的Class对象作为参数传递给
LoggerFactory.getLogger()
方法。
如何在生产环境中使用日志框架？
生产环境的日志配置与开发环境略有不同。通常需要考虑以下几点：
- 日志级别: 生产环境通常设置为INFO或WARN，避免记录过多的DEBUG信息。
- 日志文件大小: 使用Rolling File Appender来限制单个日志文件的大小，避免磁盘空间被耗尽。
- 日志文件保留策略: 配置TimeBasedTriggeringPolicy或SizeBasedTriggeringPolicy来定期清理旧的日志文件。
- 日志监控: 使用ELK Stack（elasticsearch, Logstash, Kibana）或Splunk等工具来监控和分析日志。
日志框架如何提升Java应用性能？
异步日志是提升性能的关键。Log4j 2支持异步Logger和异步Appender。异步Logger将日志事件放入一个队列，由一个单独的线程来处理，从而避免阻塞主线程。异步Appender则将日志事件异步地写入到目的地。
配置异步Logger：
<Configuration status="WARN" monitorInterval="30"> <AsyncLoggers> <Root level="INFO"> <AppenderRef ref="Console"/> <AppenderRef ref="RollingFile"/> </Root> </AsyncLoggers> ... </Configuration>
或者，配置混合异步Logger：
<Configuration status="WARN" monitorInterval="30"> <Loggers> <AsyncLogger name="com.example" level="DEBUG" additivity="false"> <AppenderRef ref="Console"/> </AsyncLogger> <Root level="INFO"> <AppenderRef ref="Console"/> <AppenderRef ref="RollingFile"/> </Root> </Loggers> ... </Configuration>
如何在Spring Boot中使用日志框架？
Spring Boot已经默认集成了Logback，并且提供了方便的配置方式。你只需要在
application.properties
或
application.yml
文件中配置日志相关的属性即可。
例如：
logging.level.root=INFO logging.file.name=logs/spring.log logging.pattern.console=%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n logging.pattern.file=%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n
Spring Boot还支持使用
logback-spring.xml
或
logback-spring.properties
文件进行更高级的配置。这些文件可以放在
src/main/resources
目录下。
如何自定义日志格式？
自定义日志格式的关键在于Pattern Layout。Pattern Layout允许你使用各种转换字符来定义日志信息的格式。
一些常用的转换字符：
-
%d{pattern}: 日期和时间，pattern可以是任何SimpleDateFormat支持的格式。
-
%t
: 线程名。
-
%-5level
: 日志级别，左对齐，宽度为5个字符。
-
%logger{Length}: Logger名，length指定Logger名的最大长度。
-
%msg
: 日志消息。
-
%n
: 换行符。
-
%throwable
例如，一个自定义的日志格式：
%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n
这个格式会输出：日期时间、线程名、日志级别、Logger名、日志消息和换行符。
总之，掌握日志框架的使用，是Java开发者的基本功。选择合适的框架，合理配置，并熟练运用，可以帮助你更好地理解和维护你的代码。
