slf4j使用和原理简单分析
开发时面向slf4j-api进行编程,然后在类路径下放入具体的日志类和适配器,如log4j、logback、java util logging、common loggings等,以及对应的配置文件,log4j.properties、logback.xml等,即可使用具体的日志jar。
1. slf4j + log4j
pom.xml如下:
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.baobao</groupId>
<artifactId>javase1</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>jar</packaging>
<name>javase1</name>
<url>http://maven.apache.org</url>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>3.8.1</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-log4j12</artifactId>
<version>1.7.25</version>
</dependency>
</dependencies>
</project>
对应的类如下:
package com.baobao;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class App1
{
private Logger logger = LoggerFactory.getLogger(App1.class);
public static void main(String[] args) {
new App1().print();
}
public void print() {
logger.info("hello::{}", logger.getClass());
}
}
同时必须在src/main/java/resources下有一个log4j.properties的配置文件,否则会出现一下错误:
运行后结果如下:
值得注意的是,这里引进了slf4j-log4j12的适配器类,由于该jar间接依赖了log4j和slf4j-ap4j,所以可以不用明显引入这两个jar。如下:
2. slf4j + commons logging
本质上commons logging也是一个接口,与slf4j十分相似,需要指定具体的日志,否则会默认使用java.util.logging,如果类路径下有log4j的jar,则使用log4j来记日志。
只需要将上面的pom.xml改为如下,即可通过common-logging使用log4j,同样需要在类路径下有log4j.properties或log4j.xml。
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.baobao</groupId>
<artifactId>javase1</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>jar</packaging>
<name>javase1</name>
<url>http://maven.apache.org</url>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>3.8.1</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.17</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-jcl</artifactId>
<version>1.7.25</version>
</dependency>
</dependencies>
</project>
严格的说,commons-logging不是一个日志控件,没有日志功能,它只是统一了JDK Logging与Log4j的API,并把日志功能交给JDK Loggings或者是log4j。对于不能确定日志方式的系统,commons-logging是一个不错的选择,Spring,Hibernate,Struts等使用的都是commons-logging。
从上面可以看出,使用slf4j可以灵活的改为具体的日志系统,易于解耦。
3. 多个jar使用slf4j +(不同的日志系统),排除引进的jar的日志系统
在另一个项目javase2中,引入了javase1项目。javase1使用的是slf4j+log4j,而javase2使用的是slf4j+logback,pom2.xml如下:
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.baobao</groupId>
<artifactId>javase2</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>jar</packaging>
<name>javase2</name>
<url>http://maven.apache.org</url>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>3.8.1</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>com.baobao</groupId>
<artifactId>javase1</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
<version>1.1.8</version>
</dependency>
</dependencies>
</project>
这时运行javase2项目,将会出现以下警告:
很显然,slf4j会从中选择一个,这里是log4j,作用所使用对的实际日志系统。为了统一使用logback,这里需在javase2的pom中移除log4j,如下:
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.baobao</groupId>
<artifactId>javase2</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>jar</packaging>
<name>javase2</name>
<url>http://maven.apache.org</url>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>3.8.1</version>
<scope>test</scope>
</dependency>
<!-- https://mvnrepository.com/artifact/org.slf4j/log4j-over-slf4j -->
<!--<dependency>-->
<!--<groupId>org.slf4j</groupId>-->
<!--<artifactId>log4j-over-slf4j</artifactId>-->
<!--<version>1.7.25</version>-->
<!--</dependency>-->
<dependency>
<groupId>com.baobao</groupId>
<artifactId>javase1</artifactId>
<version>1.0-SNAPSHOT</version>
<exclusions>
<exclusion>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-log4j12</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
<version>1.1.8</version>
</dependency>
</dependencies>
</project>
这时使用的便是logback,如下:
4. 引进的jar直接使用log4j,我的应用使用slf4j,如何统一日志系统。
假设javase1直接使用log4j,pom如下:
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.baobao</groupId>
<artifactId>javase1</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>jar</packaging>
<name>javase1</name>
<url>http://maven.apache.org</url>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>3.8.1</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.17</version>
</dependency>
</dependencies>
</project>
对应的App1.java如下:
package com.baobao;
import org.apache.log4j.LogManager;
import org.apache.log4j.Logger;
public class App1
{
private static Logger logger = LogManager.getLogger(App1.class);
public static void main(String[] args) {
new App1().print();
}
public void print() {
logger.info(getClass() + ": " + logger.getClass());
}
}
这时javase2的pom.xml如下:
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.baobao</groupId>
<artifactId>javase2</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>jar</packaging>
<name>javase2</name>
<url>http://maven.apache.org</url>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>3.8.1</version>
<scope>test</scope>
</dependency>
<!-- https://mvnrepository.com/artifact/org.slf4j/log4j-over-slf4j -->
<!--<dependency>-->
<!--<groupId>org.slf4j</groupId>-->
<!--<artifactId>log4j-over-slf4j</artifactId>-->
<!--<version>1.7.25</version>-->
<!--</dependency>-->
<dependency>
<groupId>com.baobao</groupId>
<artifactId>javase1</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
<version>1.1.8</version>
</dependency>
</dependencies>
</project>
运行App2.java,可以发现同时使用了log4j和logback两套日志系统:
这时引进slf4j的log4j-over-slf4j,可以将log4转化输出到slf4j,又由于javase2使用的是logback,所以最终会使用logback输出,javase2的pom如下:
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.baobao</groupId>
<artifactId>javase2</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>jar</packaging>
<name>javase2</name>
<url>http://maven.apache.org</url>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>3.8.1</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>log4j-over-slf4j</artifactId>
<version>1.7.25</version>
</dependency>
<dependency>
<groupId>com.baobao</groupId>
<artifactId>javase1</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
<version>1.1.8</version>
</dependency>
</dependencies>
</project>
运行结果为:
实际上slf4j还提供了其他jar,将直接使用log4j、logback、commons-logging的项目的日志直接转化为slf4j输出:
<!--Java Commons Logging redirect to slf4j -->
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>jcl-over-slf4j</artifactId>
<version>1.7.25</version>
<scope>runtime</scope>
</dependency>
<!--Apache log4j redirect to slf4j -->
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>log4j-over-slf4j</artifactId>
<version>1.7.25</version>
<scope>runtime</scope>
</dependency>
<!--Java Util Logging redirect to slf4j -->
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>jul-to-slf4j</artifactId>
<version>1.7.25</version>
<scope>runtime</scope>
</dependency>
一般使用的是logback,因为logback可以使用占位符,而log4j不可以,只能使用+。各种slf4j+(具体日志系统)的配置图如下:
参考:
https://www.slf4j.org/legacy.html
https://www.slf4j.org/codes.html#multiple_bindings
源码:
https://github.com/jessin20161124/javase1
https://github.com/jessin20161124/javase2