Java 学习笔记

👉 所有文章
基础 Java 安装 Java : 第一个程序 Hello World Java : 建议使用 UTF-8 编写 Java 代码 Java : package 包命名规范 使用 Intellij IDEA 创建 Java 项目 Java 布尔类型 Java 处理日期和时间 Java 正则表达式 Java finalize 方法 Java : 空值 null Java 如何触发垃圾回收 Java ThreadLocal Java InheritableThreadLocal Java Integer之间的比较 Java 动态代理 Java 匿名类 Java 枚举 Java: 加速maven、gradle依赖下载 Java 如何静态导入 import static println Java 引用级别:强引用、软引用、弱引用、幽灵引用 Java try finally return 解惑 Java WeakHashMap Java ReferenceQueue 怎么写 Java 示例代码? Java 匿名类双大括号初始化 什么是 Java Bean Java 多行字符串 Java 快速生成 List Java 快速生成 Map Java 将异常堆栈转换为 String JDK SPI 的使用和源码分析 Java Map 中的 key 和 value 能否为 null Java List 和 数组的互相转换 Java 获取环境变量 Java 获取和设置系统属性 Java: 如何获取当前进程的 PID ? Java 字符串左侧/右侧补充空格或者其他字符 Java 线程 Java: 如何获取文本文件内容 Java: 读取资源文件内容 Java: 获取 jar 中文件的内容 Java: 使用 JavaFx 构建 GUI Java: Class 类 Java : 使用 instanceof 判断对象类型 一个自定义的 Java 工具类 Java : 获取当前函数所属类的类名 Java : 获取当前执行的函数名 Java : 使用 String 的 split 函数拆分字符串 Java : 获取字符的 Unicode 编号(代码点) Java : 获取当前工作目录 Java : 使用 Class 对象的 isArray 方法判断对象是否为数组 使用 Java 生成 CSV 文件
工具 Java : jps 命令的使用 Java : jcmd 命令的使用 Java : VisualVM 工具的使用 Java : 使用 javap 解析 class 文件 Java : jar 命令
项目构建 ( 基于 Gradle ) Java: 使用 Gradle 将源码打包为 jar Java: Gradle 下载项目依赖 Java : 清理 Gradle 生成的 build、out 目录 Java : 将 maven 项目转换为 gradle 项目
测试 Java Mockito 测试框架快速入门 JMockit 入门 JUnit 入门 JUnit 单测隔离
三方库 Java JOOR 反射库 Java alibaba transmittable-thread-local 库:让 ThreadLocal 跨线程传播 Java 日志组件 slf4j 的使用和源码分析 Java Lombok 库:为你减少样板代码 Java: 使用 cglib 实现动态代理 Java Hibernate validator 校验框架 Java 使用 Hessian2 序列化和反序列化 H2 数据库快速入门 Java : 使用 Gson 库处理json数据
IDE Intellij IDEA 使用技巧汇总 Intellij IDEA 如何修改/添加代码颜色主题 解决 Intellij IDEA 右下角不显示 git 分支的问题 Intellij IDEA 指定/修改 JDK 版本 Intellij IDEA 文件初始化模板
其他 Java: 加速maven、gradle依赖下载 Java: 如何创建多模块项目 Java 集成 groovy 构建规则引擎 Java 13: 安装 Java 13 新特性:文本块(多行字符串) 卸载 MacOS 上安装的 Java Java: 执行 sql 文件 Java JDK 有哪些发行版 ? java拾遗:String和数组 java拾遗:由反转数组想到System.out的实现机制 java拾遗:如何读取properties文件内容 Java并发概念汇总 java拾遗:System.out.println()是什么? java拾遗:通过示例理解位运算 使用“庖丁解牛”进行中文分词 DBUtils简明教程 试用velocity模板引擎
TODO Java: 如何使用 java、javac 、jar 命令 使用 Nexus Repository Manager 搭建 maven 私有仓库

JDK SPI 的使用和源码分析


SPI 是什么? Service Provider Interface,服务提供接口。是一种基于资源文件配置的服务发现机制。

我们用一个示例看下 Oracle JDK 自带的 SPI 机制如何使用。代码参考了「 Java SPI(Service Provider Interface)简介 」。

这篇文章中,使用 IDEA 创建maven项目,maven版本是3.5.3,Java版本是1.8。

1. 从一个简单的项目开始

我们使用 IDEA 创建一个maven项目,增加两个module,一个是child1,一个是child2。child1提供服务,child2调用服务。

先看下最终的项目结构:

├── child1
│   ├── pom.xml
│   ├── src
│       └── main
│           ├── java
│           │   └── com
│           │       └── example
│           │           └── child1
│           │               ├── impl
│           │               │   ├── DemoServiceImpl01.java
│           │               │   └── DemoServiceImpl02.java
│           │               └── spi
│           │                   └── DemoService.java
│           └── resources
│               └── META-INF
│                   └── services
│                       └── com.example.child1.spi.DemoService
├── child2
│   ├── libs
│   │   └── child1-1.0-SNAPSHOT.jar
│   ├── pom.xml
│   ├── src
│       └── main
│           └── java
│               └── Example01.java
├── pom.xml

在child1模块中添加接口DemoService,内容如下:

package com.example.child1.spi;

public interface DemoService {

    public String sayHi(String msg);

}

是的,我们要把这个接口当做服务提供出去的。

对于这个接口(服务),编写两个实现类DemoServiceImpl01DemoServiceImpl02。代码分别如下:

package com.example.child1.impl;

import com.example.child1.spi.DemoService;

public class DemoServiceImpl01 implements DemoService {
    public String sayHi(String msg) {
        return "Hello " + msg;
    }
}
package com.example.child1.impl;

import com.example.child1.spi.DemoService;

public class DemoServiceImpl02 implements DemoService {
    public String sayHi(String msg) {
        return "Hi " + msg;
    }
}

然后,需要把服务暴露出去。

child1/src/main/resources/META-INF/services/目录中创建文件 com.example.child1.spi.DemoService,将实现类全路径写进去:

com.example.child1.impl.DemoServiceImpl01
com.example.child1.impl.DemoServiceImpl02

命令行进入child1目录,执行打包命令:

$ mvn package

可以看到child1/target/目录下生成了child1-1.0-SNAPSHOT.jar

我们把这个jar挪到child2/libs下面,然后在child2/pom.xml中将它作为依赖引入进来。

<dependencies>
    <dependency>
        <groupId>com.example</groupId>
        <artifactId>child1</artifactId>
        <version>1.0-SNAPSHOT</version>
        <scope>system</scope>
        <systemPath>${basedir}/libs/child1-1.0-SNAPSHOT.jar</systemPath>
    </dependency>
</dependencies>

child2如何通过 SPI 调用 child1 提供的服务呢?很简单,编写 Example01类:

import com.example.child1.spi.DemoService;

import java.util.Iterator;
import java.util.ServiceLoader;

public class Example01 {

    public static void main(String[] args)  {
        ServiceLoader<DemoService> serviceLoader = ServiceLoader.load(DemoService.class);
        Iterator<DemoService> it = serviceLoader.iterator();
        while (it.hasNext()) {
            DemoService demoService = it.next();
            System.out.println(String.format("class: %s, result: %s ", demoService.getClass().getName(), demoService.sayHi("World")));
        }
    }
}

运行后输出:

class: com.example.child1.impl.DemoServiceImpl01, result: Hello World 
class: com.example.child1.impl.DemoServiceImpl02, result: Hi World 

从main函数里发现了什么没有?对,调用方child2只需要关心child1提供的接口就行,不关心具体的实现类。

2. 再复杂点

我们重新创建一个maven项目,把在上面的child1和child2再实现一遍。child1不打包成jar供child2用了,直接mvn install。如此,child2的pom.xml中的依赖要改成:

<dependency>
    <groupId>com.example</groupId>
    <artifactId>child1</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>

我们再增加一个module,叫child3。child3依赖child1,同时child3也实现一个DemoService。

首先在child3的pom.xml中加入对child1的依赖:

<dependency>
    <groupId>com.example</groupId>
    <artifactId>child1</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>

然后增加一个实现类:

package com.example.child3;

import com.example.child1.spi.DemoService;

public class DemoServiceImpl implements DemoService {

    public String sayHi(String msg) {
        return "你好," + msg;
    }
}

接着在child3/src/main/resources/META-INF/services/目录中创建文件 com.example.child1.spi.DemoService,将实现类全路径写进去:

com.example.child3.DemoServiceImpl

然后针对该模块,执行mvn install

child2的pom.xml中的依赖增加以下内容:

<dependency>
    <groupId>com.example</groupId>
    <artifactId>child3</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>

执行 child2 中的Example01,输出:

class: com.example.child1.impl.DemoServiceImpl01, result: Hello World 
class: com.example.child1.impl.DemoServiceImpl02, result: Hi World 
class: com.example.child3.DemoServiceImpl, result: 你好,World 

最终的项目结构:

.
├── child1
│   ├── child1.iml
│   ├── pom.xml
│   ├── src
│       └── main
│           ├── java
│           │   └── com
│           │       └── example
│           │           └── child1
│           │               ├── impl
│           │               │   ├── DemoServiceImpl01.java
│           │               │   └── DemoServiceImpl02.java
│           │               └── spi
│           │                   └── DemoService.java
│           └── resources
│               └── META-INF
│                   └── services
│                       └── com.example.child1.spi.DemoService
├── child2
│   ├── child2.iml
│   ├── pom.xml
│   ├── src
│       └── main
│           └── java
│               └── Example01.java
├── child3
│   ├── child3.iml
│   ├── pom.xml
│   ├── src
│       └── main
│           ├── java
│           │   └── com
│           │       └── example
│           │           └── child3
│           │               └── DemoServiceImpl.java
│           └── resources
│               └── META-INF
│                   └── services
│                       └── com.example.child1.spi.DemoService
└── pom.xml

3. 原理剖析

ServiceLoader的代码并不多,算上注释不到600行。但它用了懒加载、迭代器,直接贴代码,我怕解释的不好。干脆写个简化版本的吧,不到60行。

在child2中增加类CustomServiceLoader

import java.io.BufferedReader;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.net.URL;
import java.util.ArrayList;
import java.util.Enumeration;
import java.util.List;

public class CustomServiceLoader<S> {

    private static final String PREFIX = "META-INF/services/";

    // 读取 META-INF/services/ 下文件的内容,返回由每一行内容组成的List
    private static List<String> parseConfigFile(URL configURL) throws Exception {
        InputStream in = configURL.openStream();
        BufferedReader reader = new BufferedReader(new InputStreamReader(in, "utf-8"));
        ArrayList<String> names = new ArrayList<>();
        while(true) {
            String line = reader.readLine();
            if (line != null) {
                int ci = line.indexOf('#');  // `#`字符后的内容是注释
                if (ci >= 0) line = line.substring(0, ci);
                line = line.trim();
                if (line.length()>0) {  // 空行就不要了
                    names.add(line);
                }
            } else {
                break;
            }
        }
        return names;
    }

    // 得到参数 service 的所有实现类的实例
    public static <S> List<S> load(Class<S> service) throws Exception {
        ClassLoader classLoader = Thread.currentThread().getContextClassLoader();
        String fullName = PREFIX + service.getName();

        // 符合要求的文件可能不止一个
        Enumeration<URL> configs = ClassLoader.getSystemResources(fullName);

        List<S> instanceList = new ArrayList<>();

        while(configs.hasMoreElements()) {
            URL config = configs.nextElement();
            List<String> implClassNames = parseConfigFile(config);
            for(String impl: implClassNames) {
                Class<?> cls = Class.forName(impl, false, classLoader);
                S instance = service.cast(cls.newInstance()); // 生成实例
                instanceList.add(instance);
            }
        }
        return instanceList;
    }

}

然后,我们增加一个Example02类:

import com.example.child1.spi.DemoService;
import java.util.List;

public class Example02 {

    public static void main(String[] args)  throws Exception {
        List<DemoService> serviceImplList = CustomServiceLoader.load(DemoService.class);

        for (DemoService impl: serviceImplList) {
            System.out.println(String.format("class: %s, result: %s ", impl.getClass().getName(), impl.sayHi("World")));
        }

    }
}

运行结果如下:

class: com.example.child1.impl.DemoServiceImpl01, result: Hello World 
class: com.example.child1.impl.DemoServiceImpl02, result: Hi World 
class: com.example.child3.DemoServiceImpl, result: 你好,World 

嗯,CustomServiceLoader写的没问题😆

如果看懂了CustomServiceLoader,再去看ServiceLoader,应该会更快看明白。

相比于CustomServiceLoaderServiceLoader多了两个特性:

  1. 懒加载。
  2. 引入AccessController进行安全控制。想象下,如果有一个恶意的jar中针对com.example.child1.spi.DemoService接口实现了一个恶意的服务类,这个类中的sayHi函数会删掉你的操作系统中的文件,怎么办?引入安全管理(Security manager)机制。具体机制可以谷歌下。

4. 值得读


( 本文完 )

文章目录