SPI全称Service Provider Interface,是Java提供的一套用来被第三方实现或者扩展的API,它可以用来启用框架扩展和替换组件。他是一种服务发现机制。它通过在ClassPath路径下的META-INF/services文件夹查找文件,自动加载文件里所定义的类。
主要是使用,java.util包下的ServiceLoader实现:
public static <S> ServiceLoader<S> load(Class<S> service, ClassLoader loader) {
return new ServiceLoader<>(service, loader);
}
使用spi机制配置logback
第一步:创建maven项目,添加依赖
<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.example</groupId>
<artifactId>logging-test</artifactId>
<version>0.0.1-SNAPSHOT</version>
<properties>
<maven.compiler.source>8</maven.compiler.source>
<maven.compiler.target>8</maven.compiler.target>
</properties>
<dependencies>
<dependency>
<artifactId>junit</artifactId>
<groupId>junit</groupId>
<version>4.12</version>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
<version>1.2.10</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.8.1</version>
<configuration>
<source>${maven.compiler.source}</source>
<target>${maven.compiler.target}</target>
<encoding>UTF-8</encoding>
</configuration>
</plugin>
</plugins>
</build>
</project>
第二步:创建MyConfiguration
package com.example.test;
import ch.qos.logback.classic.Logger;
import ch.qos.logback.classic.LoggerContext;
import ch.qos.logback.classic.PatternLayout;
import ch.qos.logback.classic.spi.Configurator;
import ch.qos.logback.classic.spi.ILoggingEvent;
import ch.qos.logback.core.ConsoleAppender;
import ch.qos.logback.core.encoder.LayoutWrappingEncoder;
import ch.qos.logback.core.spi.ContextAwareBase;
public class MyConfiguration extends ContextAwareBase implements Configurator {
public MyConfiguration() {
}
public void configure(LoggerContext lc) {
addInfo("Setting up default configuration.");
ConsoleAppender<ILoggingEvent> ca = new ConsoleAppender<ILoggingEvent>();
ca.setContext(lc);
ca.setName("console");
LayoutWrappingEncoder<ILoggingEvent> encoder = new LayoutWrappingEncoder<ILoggingEvent>();
encoder.setContext(lc);
// same as
PatternLayout layout = new PatternLayout();
layout.setPattern("logback %d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n");
// TTLLLayout layout = new TTLLLayout();
layout.setContext(lc);
layout.start();
encoder.setLayout(layout);
ca.setEncoder(encoder);
ca.start();
Logger rootLogger = lc.getLogger(Logger.ROOT_LOGGER_NAME);
rootLogger.addAppender(ca);
}
}
第三步:在resources下创建文件
ch.qos.logback.classic.spi.Configurator
com.example.test.MyConfiguration
其中在META-INF/services文件夹下的ch.qos.logback.classic.spi.Configurator文件并不是随便建的,是参考logback源码里的autoconfig方法的Configurator c = EnvUtil.loadFromServiceLoader(Configurator.class);该行代码的Configurator类的全限定名,因为spi的大致原理是当执行到EnvUtil.loadFromServiceLoader(Configurator.class)这行代码时,他会去META-INF/services目录下找到Configurator的全限定名的文件,获取该文件里的内容,该文件里的内容基本上是一个该Configurator的实现类,然后取出来的实现类的全限定名,进行反射得到实例,然后进行其他的操作。
第四步:测试代码
package com.example.test;
import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class TestLogback {
private static final Logger logger = LoggerFactory.getLogger(TestLogback.class);
@Test
public void testLogback() {
logger.error("error");
logger.warn("warn");
logger.info("info");
logger.debug("debug");
logger.trace("trace");
}
}
spi机制模拟mysql
spi机制也应用在mysql在logging项目里
第一步:创建接口
package org.example.logback;
/**
* 模拟jdbc的接口Driver
*/
public interface Diver {
void getConnection();
}
在mysql-connection项目中
第一步:创建java项目
第二步:创建接口
package org.example.logback;
/**
* 模拟jdbc的接口Driver
*
* 由于模拟的,所以才需要在实现类搞个接口,实际上在mysql-connector依赖包中是没有的,毕竟是java项目肯定需要jdk的
*/
public interface Diver {
void getConnection();
}
第三步:创建实现类
package org.example.mysql;
import org.example.logback.Diver;
/**
*这里模仿mysql实现jdbc的实现类
*/
public class MySqlDiver implements Diver {
@Override
public void getConnection() {
System.out.println("mysql connection模拟");
}
}
第四步:创建文件
org.example.logback.Diver文件是接口的全限定名,因为这项目是具体的实现,需要知道规范的接口全限定名,然后在文件里写入实现类的全限定名。 ![在这里插入图片描述](https://img-blog.csdnimg.cn/2b1b323d43764dec9dc7bdb82b15430c.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA5pCe6ZKx6Ieq5b6L,size_13,color_FFFFFF,t_70,g_se,x_16)org.example.logback.Diver:
org.example.mysql.MySqlDiver
第五步:将项目打成jar包
点击ok
jar包位置,点击ok
然后我们会在项目中发现
在logging项目里
第二步:依赖模拟的mysql驱动
弹出你要加的依赖包的文件框
然后ok
第三步:创建测试代码
package org.example.logback;
import java.util.Iterator;
import java.util.ServiceLoader;
public class Spi {
public static void main(String[] args) {
ServiceLoader<Diver> load = ServiceLoader.load(Diver.class);
Iterator<Diver> iterator = load.iterator();
while (iterator.hasNext()){
Diver diver = iterator.next();
if (diver!=null){
diver.getConnection();
}
}
}
}