java spi机制

SPI机制

Java SPI三步曲
1. Java SPI : JDK自带的 spi机制
2. Slf4j
3. springboot

Java SPI

SPI

# 1. SPI全称: Service Provider Interface,
# 是从Java6开始引入的, 是一种基于ClassLoader来发现并加载服务的机制

一个标准的SPI 由3个组件构成, 分别是:
# 1. Service  是一个公开的接口或抽象类, 定义了一个抽象的功能模块
# 2. Service Provider  是Service接口的一个实现类
# 3. Service Loader  是SPI机制中的核心组件, 负责在运行时发现并加载Service Provider
#(其中ServiceLoader对应的是JDK中的ServiceLoader类, 调用load方法, 就可以在运行时发现和加载Service Provider)

Java SPI运行流程

Application   ->    ServiceLoader  -> Service     ->    面向Service的接口编程
(应用程序)          (服务发现&加载)           (服务接口)


ServiceLoader  -> Service Provider  -> Service服务接口

# Application应用程序不用关注Service的具体实现, 它只和Service接口交互

Java SPI相关的问题

# 1. 它的作用是什么? 解决了什么问题

# 2. 如果要实现一个SPI应用, 需要怎么做?

# 3. 背后的设计思想是什么?  我们能得到什么启示?

Java SPI在JDBC中的应用

JDBC 全称是: Java DataBase Connectivity

JDBC即使用Java语言来访问数据库的一套API

每个数据库厂商会提供各自的JDBC实现

Java SPI的三大规范要素

1. 规范的配置文件
    * 文件路径: 必须在JAR包中的META-INF/services目录下
    * 文件名称: Service接口的全限定名
    * 文件内容: Service实现类(即Service Provider类)的全限定名,如果有多个实现类,那么每一个实现类在文件中单独占据一行
    
2. ServiceProvider类必须具备无参的默认构造方法
    * Service接口的实现类, 即Service Provider类, 必须具备无参的默认构造方法, 因为通过反射技术实例它时, 是不带参数的
    
3. 保证能加载到配置文件和Service Provider类
    * 方式一: 将Service Provider的JAR包放到 classpath中(最常用)
    * 方式二: 将JAR包安装到JRE的扩展目录中
    * 方式三: 自定义一个 ClassLoader
    

Java SPI在maven项目文件结构

src/main/resources/META-INF/services/接口名全路径名

文件内容为: 实现类全名

Java SPI总结

1. 作用
    提供了一种组件发现和注册的方式, 可以用于实现各种插件, 或是灵活替换框架所使用的组件
2. 优点
    基于面向接口编程, 优雅的实现模块之间的解耦
3. 设计思想
    面向接口 + 配置文件 + 反射技术
4. 应用场景
    JDBC、SLF4、Servlet容器初始化 等等

Java SPI应用例1

公司A Simple-Company(业务模块),simple-api(spi接口)

移动 simple-api-mobile

联通 simple-api-union

引入不同的依赖包, 则调用相关实现逻辑

Java SPI 与 SpringBoot自动配置

SpringBoot自动配置, 即大名鼎鼎的Auto-Configuration
* 它基于你引入的依赖包, 对SpringBoot应用进行自动配置
* 提供了自动配置功能的依赖 jar 包, 通常称为 starter, 例如: mybatis-spring-boot-starter 等等

提需:
Java SPI 设计思想 SpringBoot 自动装配核心实现
1. 使用约定的配置文件 使用约定的配置文件: * 文件路径是: META-INF/spring.factories * 文件内容是“key=value1,value2, ... valueN" 的格式, 其中key是 EnableAutoConfiguration的类名, value是自动配置类的类名
2. 谁提供Jar包, 也负责提供配置文件, 高内聚低耦合, 代码+配置一肩挑 提供自动配置类的jar包中, 也同时提供配置文件 META-INF/spring.factories
3. 使用ClassLoader的getResource 和 getResources方法, 来读取classpath中的配置文件 和SPI一样, 使用ClassLoader的getResource和getSources方法, 来读取classpath中的配置文件

SpringBoot自动配置核心流程

SpringBoot应用程序启动 -> 通过Spring Factories机制加载配置文件 -> 筛选出所有自动配置类 -> 将这些类注入到Spring IOC 容器中

即:
1. 通过ClassLoader去获取classpath中的配置文件 META-INF/spring.factories
注: SpringFactories机制是Spring框架内置的,是Spring框架对外扩展的重要入口, 在很多地方都会用到
2. 在所有的配置文件META-INF/spring.factories中, 筛选出以EnableAutoConfiguration为key的配置值

SLF4J的原理和实践

java世界中的日志框架

slf4j、jul、jcl、logback、log4j、log4j2、reload4j

名称 Jar包 描述
slf4j Slf4j-api.jar 门面日志框架
jcl Commons-logging.jar 门面日志框架。已经很久没有更新
log4j log4j.jar Log4j 1.x, 底层日志框架, 已不再更新维护
reload4j reload4j.jar Log4j 1.x的分叉版本, 并修复了安全漏洞, 底层日志框架
log4j2 log4j-api.jar、log4j-core.jar Log4j 2.x,底层日志框架
jul JDK 底层日志框架
logback Logback-classic.jar、logback-core.jar 底层日志框架

门面日志框架

1. 什么是门面日志框架?

2. 它的作用是什么? 解决了什么问题?


注: 
1. 不同的日志框架, API接口也往往不一样
2. 不同的日志框架, 配置文件的格式也不一样

举例: 假如Java应用程序本身使用了LogBack, 第三方应用使用了Log4j, 则Java应用依赖第三方应用时, 就会需要依赖两套日志框架, 因为日志文件路径、级别、日志格式是应用本身来维护, 所以为了解决这些问题, 引入了门面日志框架

Application应用程序 -> 日志框架
    开始记录日志-> 调用门面日志API -> 适配层转发 -> 底层日志框架实际处理->记录到日志文件

现在最常用的门面日志框架: SLF4J
另一个门面日志框架JCL, 已经很久没有更新了

使用门面日志框架的好处: 底层的日志框架可以轻松替换, 只需要更换对应的 Jar包以及配置文件就行

SLF4J日志框架

SLF4J: 全称是Simple Logging Facade for Java, 是现在Java生态中最流行的一个门面日志框架
             中文: 简单的日志门面
             
       

SLF4J使用总结

1. 引入 Jar 包 Slf4j-api.jar
2. 引入适配层的jar包(如果有需要的话, 非必要)
3. 引入底层日志框架的 jar 包
4. 确认是否是安全版本(最近出现了多个日志框架相关的漏洞, 需要确认所使用的版本为安全版本)
5. 开始你的SLF4J日志之旅

SPI接口标准由谁来制定

1. 谁掌握了话语权, 谁就能制定接口标准
2. 谁制定了标准, 反过来就能提升业界影响力

SpringBoot自动配置的原理与实践

springboot自动配置

SpringBoot自动配置, 英文是Auto-Configuration
    1. 它是指基于你引入的依赖 jar包, 对SpringBoot 应用进行自动配置
    2. 它为SpringBoot框架的 "开箱即用" 提供了基础支撑

举例redis自动配置

1. 引入依赖
    <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-redis</artifactId>
    </dependency>
    
2. 配置Redis服务连接信息
    spring:
        redis:
            database: 0
            host: 127.0.0.1
            port: 6379
            password: 123456
            
3. 可以直接使用了
    @Autowired
    private RedisTemplate<Object,Object> redisTemplate;
    
    @Autowired
    private StringRedisTemplate stringRedisTemplate;

// 经过以上配置, SpringBoot就会将相关对象注入到IOC容器中

SpringBoot启动流程简化版

SpringApplication.run(..)-> 
    1. 创建IOC容器 createApplicationContext(..) -> 
    2. 加载源配置类 loadSourceClass(..) -> 
            源配置类: 通常指main方法所在的类, 而且会被注解@SpringBootApplication所修饰, 又称之为主类
    3.加载并处理所有的配置类 processConfigurationClasses(..) -> 
            SpringBoot会自动找到所有的配置类, 然后加载和处理它们, "自动配置" 就是这一环
    4. 实例化所有的单例Bean BeanInstantiateSingletonBeans(..) -> 
            实例化所有的单例Bean, "依赖注入" 和 “自动装配” 就属于这一环
    5.启动Web服务器startWebServer

Dubbo SPI

相比于原生 java spi, 原生 java spi缺陷
1. 只能遍历所有的实现, 并全部实例化
2. 配置文件中只是简单的列出了所有的扩展实现, 而没有给他们命名, 导致在程序中很难去准确的引用它们
3. 扩展如果依赖其他的扩展, 做不到自动注入和装配
4. 扩展很难和其他的框架集成, 比如扩展里面依赖了一个Spring Bean, 原生的 Java SPI不支持


dubbo 的 spi有如下几个概念
1. 扩展点: 一个接口
2. 扩展: 扩展(接口)的实现
3. 扩展自适应实例: 其实就是一个Extension的代理, 它实现了扩展点接口. 在调用扩展点的接口方法时,  会根据实际的参数来决定使用哪个扩展.
        dubbo会根据接口中的参数, 自动地决定选择哪个实现
4. @SPI: 该注解作用于扩展点的接口上, 表明该接口是一个扩展点
5. @Adaptive: @Adaptive注解用在扩展接口的方法上, 表示该方法是一个自适应方法. Dubbo在为扩展点生成自适应实例时,如果方法有@Adaptive注解,会为该方法生成对应的代码。


SPI使用总结

框架 文件名 文件内容
Java SPI Src/main/resources/services/接口类名(包名+类名) 实现类全路径(包名+类名)
Dubbo SPI src/main/resources/dubbo/接口类名(包名+类名) key1=value1的形式 key2=value2
SpringBoot key=value1,value2,...valuen
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,324评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,303评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,192评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,555评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,569评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,566评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,927评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,583评论 0 257
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,827评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,590评论 2 320
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,669评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,365评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,941评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,928评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,159评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,880评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,399评论 2 342

推荐阅读更多精彩内容