面试官: 项目中用到过SLF4J吗?
了不起: 用过,会在相关类上加上@Slf4j注解
面试官: 他底层是如何打日志的呢?
了不起: 运用到了Java的SPI技术
Java SPI(Service Provider Interface)是一种服务发现机制,它允许第三方为现有的Java库提供实现。SPI的主要目的是为了解耦,使得接口和实现可以独立地进行开发和部署。这种机制在许多Java库中都有应用,例如JDBC驱动程序、日志框架等。
实现SPI主要有下面几步:
当Java程序需要使用SPI时,它会通过java.util.ServiceLoader类来加载所有可用的实现。ServiceLoader会扫描类路径下的META-INF/services目录,找到对应的接口文件,并实例化其中列出的实现类。
参考SLF4J,我们自己实现一个日志门面 假设我们有一个日志接口Logger:
public interface Logger {
void info(String message);
void debug(String message);
}
现在,我们想要为这个接口提供一个实现,例如LogbackLogger:
public class LogbackLogger implements Logger {
@Override
public void info(String message) {
// Logback info logging implementation
}
@Override
public void debug(String message) {
// Logback debug logging implementation
}
}
为了使用SPI,我们需要在META-INF/services目录下创建一个名为com.example.Logger的文件,并在其中添加LogbackLogger的全限定名
com.example.LogbackLogger
最后,我们可以通过ServiceLoader来加载所有可用的Logger实现:
ServiceLoader<Logger> serviceLoader = ServiceLoader.load(Logger.class);
for (Logger logger : serviceLoader) {
logger.info("你好");
logger.debug("测试Java SPI 机制");
}
运行结果如下
Logback info 打印日志:你好
Logback debug 打印日志:测试 Java SPI 机制
当存在多个日志框架实现时,Java SPI会加载所有可用的实现。但是,通常情况下,我们需要根据某种策略来选择一个特定的实现。为了实现这一目标,我们可以采用以下方法:
为每个实现分配一个优先级,并在加载实现时根据优先级进行排序。这可以通过在META-INF/services中的接口文件中为每个实现分配一个权重值来实现。然后,在使用ServiceLoader加载实现时,可以根据权重值对实现进行排序,选择权重最高的实现。例如:
public class LoggerPriorityComparator implements Comparator<Logger> {
@Override
public int compare(Logger logger1, Logger logger2) {
return Integer.compare(logger2.getPriority(), logger1.getPriority());
}
}
ServiceLoader<Logger> serviceLoader = ServiceLoader.load(Logger.class);
List<Logger> loggers = new ArrayList<>();
for (Logger logger : serviceLoader) {
loggers.add(logger);
}
loggers.sort(new LoggerPriorityComparator());
Logger selectedLogger = loggers.get(0);
在应用的配置文件中指定要使用的日志框架实现。在加载实现时,可以根据配置文件中的设置来选择特定的实现。例如,可以在application.properties文件中添加以下配置:
logger.implementation=com.example.LogbackLogger
然后,在代码中使用以下方法加载指定的实现:
String loggerImplementation = // 从配置文件中读取实现类名
ServiceLoader<Logger> serviceLoader = ServiceLoader.load(Logger.class);
Logger selectedLogger = null;
for (Logger logger : serviceLoader) {
if (logger.getClass().getName().equals(loggerImplementation)) {
selectedLogger = logger;
break;
}
}
可以使用环境变量或系统属性来指定要使用的日志框架实现。这种方法类似于使用配置文件,但是更适用于在部署时动态指定实现的场景。例如,可以在启动应用时设置系统属性:
java -Dlogger.implementation=com.example.LogbackLogger -jar myapp.jar
然后,在代码中使用以下方法加载指定的实现
String loggerImplementation = System.getProperty("logger.implementation");
ServiceLoader<Logger> serviceLoader = ServiceLoader.load(Logger.class);
Logger selectedLogger = null;
for (Logger logger : serviceLoader) {
if (logger.getClass().getName().equals(loggerImplementation)) {
selectedLogger = logger;
break;
}
}
通过以上方法,可以在存在多个日志框架实现时,根据不同的策略来选择使用哪个实现。
SPI技术有下面几个优点
任何技术都有缺点,SPI也不例外。
首先,定义一个工厂接口
public interface LoggerFactory {
Logger createLogger();
}
然后,在实现类中提供一个工厂方法
public class LogbackLogger implements Logger {
// Logger implementation
public static class LogbackLoggerFactory implements LoggerFactory {
@Override
public Logger createLogger() {
// 在这里可以执行任何初始化逻辑
return new LogbackLogger();
}
}
}
在META-INF/services中的接口文件中,指定工厂类而不是实现类
com.example.LoggerFactory=com.example.LogbackLogger$LogbackLoggerFactory
最后,在代码中使用ServiceLoader加载工厂类,并通过工厂方法创建实现类的实例:
ServiceLoader<LoggerFactory> serviceLoader = ServiceLoader.load(LoggerFactory.class);
LoggerFactory factory = serviceLoader.iterator().next();
Logger logger = factory.createLogger();
在这个示例中,我们将使用Spring框架作为依赖注入容器。首先,定义一个接口和实现类:
public interface Logger {
void log(String message);
}
@Component
public class LogbackLogger implements Logger {
// Logger implementation
}
然后,在Spring配置类中,配置ServiceLoader来加载Logger实现:
@Configuration
public class AppConfig {
@Bean
public Logger logger() {
ServiceLoader<Logger> serviceLoader = ServiceLoader.load(Logger.class);
return serviceLoader.iterator().next();
}
}
在这个示例中,我们使用了Spring的@Component注解来标记实现类,以便让Spring容器自动扫描和管理它。然后,在配置类中,我们使用ServiceLoader来加载Logger实现,并将其注册为Spring容器中的一个Bean。这样,我们就可以在其他地方使用依赖注入来获取Logger实例,例如:
@Service
public class MyService {
private final Logger logger;
public MyService(Logger logger) {
this.logger = logger;
}
public void doSomething() {
logger.log("Doing something...");
}
}
为了在实现类中添加版本信息,我们可以定义一个接口方法来获取版本信息,然后在实现类中提供具体的版本信息。以下是一个示例:
首先,定义一个带有getVersion方法的接口:
public interface Logger {
void log(String message);
String getVersion();
}
然后,在实现类中提供具体的版本信息
public class LogbackLogger implements Logger {
private static final String VERSION = "1.0.0";
@Override
public void log(String message) {
// Logback logging implementation
}
@Override
public String getVersion() {
return VERSION;
}
}
在加载实现时,可以根据版本信息进行筛选。例如,可以选择最新版本的实现:
ServiceLoader<Logger> serviceLoader = ServiceLoader.load(Logger.class);
Logger selectedLogger = null;
String latestVersion = null;
for (Logger logger : serviceLoader) {
String version = logger.getVersion();
if (latestVersion == null || version.compareTo(latestVersion) > 0) {
latestVersion = version;
selectedLogger = logger;
}
}