前往小程序，Get更优阅读体验！
立即前往
文档建议反馈控制台
首页
学习
活动
专区
圈层
工具
文章/答案/技术大牛
发布
首页
学习
活动
专区
圈层
工具
返回腾讯云官网
社区首页 >专栏 >dubbo的SPI 机制与运用实现

dubbo的SPI 机制与运用实现

作者头像
政采云前端团队
发布于 2023-12-11 10:58:16
发布于 2023-12-11 10:58:16
35800
代码可运行
举报
文章被收录于专栏：采云轩采云轩
运行总次数：0
代码可运行
关联问题
换一批

前言

SPI（Service Provider Interface），是 JDK 内置的一种服务发现机制，可以用来启用框架扩展和替换组件，主要被开发人员使用。比如 java.sql.Driver 接口，不同厂商可以针对同一接口提供不同实现，MySQL 和 PostgreSQL 都有各自不同实现提供给用户。Java SPI 机制可以为某个接口寻找服务实现。Java 中 SPI 机制主要思想是将装配控制权移到程序之外，模块化设计中这个机制尤其重要，其核心思想就是 解耦。

其流程可以参考下图

Dubbo 并未使用 Java 原生 SPI 机制，而是对其进行增强，能够更好满足需求。

在学习 Dubbo SPI 之前，需要先了解 Java SPI 运行原理。

Java SPI

SPI 简单示例

  1. 这是一个搜索接口（行为）
代码语言：javascript
代码运行次数：0
运行
AI代码解释
复制
public interface Search {
  List<String> searchData(String query);
}
  • 文件搜索实现
代码语言：javascript
代码运行次数：0
运行
AI代码解释
复制
public class FileSearch implements Search {
  @Override
  public List<String> searchData(String query) {
    return Lists.newArrayList("这里是文件搜索");
  }
}
  • DB 搜索实现
代码语言：javascript
代码运行次数：0
运行
AI代码解释
复制
public class DbSearch implements Search {
  @Override
  public List<String> searchData(String query) {
    return Lists.newArrayList("这里 db 搜索");
  }
}
  • ES 搜索实现
代码语言：javascript
代码运行次数：0
运行
AI代码解释
复制
public class ElasticSearchSearch implements Search {
  @Override
  public List<String> searchData(String query) {
    return Lists.newArrayList("这里是 es 搜索");
  }
}
  1. 在resources下新建 META-INF/services/ 目录，新建接口全限定名的文件: cn.zcy.spi.Search，文件内加上需要用到的实现类
代码语言：javascript
代码运行次数：0
运行
AI代码解释
复制
cn.zcy.spi.DbSearch
cn.zcy.spi.FileSearch
cn.zcy.spi.ElasticSearchSearch
  1. 测试
代码语言：javascript
代码运行次数：0
运行
AI代码解释
复制
public class start {

  public static void main(String[] args) {
    ServiceLoader<Search> s = ServiceLoader.load(Search.class);
    Iterator<Search> iterator = s.iterator();
    while (iterator.hasNext()) {
      Search next = iterator.next();
        System.out.println(next.searchData());
    }
  }
}

结果：Main 方法会将文件内部定义的所有实现类实例化，并调用其 SearchData 方法。

代码语言：javascript
代码运行次数：0
运行
AI代码解释
复制
[这里是 db 搜索]
[这里是文件搜索]
[这里是 es 搜索]

这就是 SPI 思想，接口实现由 Provider 提供，Provider 只用在提供的 Jar 包 META-INF/services 下根据平台定义的接口新建文件，并添加进相应的实现类内容就好。

SPI 实现

通过上述例子，可以简单猜想一下 ServiceLoader.Load 的实现方式：

  1. 在 META-INF/services 目录下创建的文件名，是需要 Load 方法加载的接口的全限定名， 即系统可以通过 Load 方法入参， 找到定义的文件。
  2. 通过读取文件内容找到对应实现类的全限定名。
  3. 知道全限定名后， 很容易通过反射的方式来拿到对应的实现， 然后执行对应的方法。

根据以上猜想看 ServiceLoader.Load 具体实现

省略部分代码， 只关注关键处理逻辑

代码语言：javascript
代码运行次数：0
运行
AI代码解释
复制
//ServiceLoader实现了Iterable接口，可以遍历所有的服务实现者
public final class ServiceLoader<S> implements Iterable<S>{
  //查找配置文件的目录
  private static final String PREFIX = "META-INF/services/";

  //解析服务提供者配置文件中的一行
  //首先去掉注释校验，然后保存
  //返回下一行行号
  //重复的配置项和已经被实例化的配置项不会被保存
  private int parseLine(Class<?> service, URL u, BufferedReader r, int lc, List<String> names) throws IOException, ServiceConfigurationError {
        //读取一行
    String ln = r.readLine();
    if (ln == null) {
        return -1;
    }
    //#号代表注释行
    int ci = ln.indexOf('#');
    if (ci >= 0) ln = ln.substring(0, ci);
    ln = ln.trim();
    int n = ln.length();
    if (n != 0) {
        if ((ln.indexOf(' ') >= 0) || (ln.indexOf('\t') >= 0))
           fail(service, u, lc, "Illegal configuration-file syntax");
        int cp = ln.codePointAt(0);
        if (!Character.isJavaIdentifierStart(cp))
           fail(service, u, lc, "Illegal provider-class name: " + ln);
        for (int i = Character.charCount(cp); i < n; i += Character.charCount(cp)) {
            cp = ln.codePointAt(i);
            if (!Character.isJavaIdentifierPart(cp) && (cp != '.'))
              fail(service, u, lc, "Illegal provider-class name: " + ln);
        }
        if (!providers.containsKey(ln) && !names.contains(ln))
          names.add(ln);
    }
    return lc + 1;
}

//解析配置文件，解析指定的url配置文件
//使用parseLine方法进行解析，未被实例化的服务提供者会被保存到缓存中去
private Iterator<String> parse(Class<?> service, URL u) throws ServiceConfigurationError {
  InputStream in = null;
  BufferedReader r = null;
  ArrayList<String> names = new ArrayList<>();
  try {
    in = u.openStream();
    r = new BufferedReader(new InputStreamReader(in, "utf-8"));
    int lc = 1;
    while ((lc = parseLine(service, u, r, lc, names)) >= 0);
  }
  return names.iterator();
}

//服务提供者查找的迭代器
private class LazyIterator implements Iterator<S>{

  Class<S> service;//服务提供者接口
  ClassLoader loader;//类加载器
  Enumeration<URL> configs = null;//保存实现类的url
  Iterator<String> pending = null;//保存实现类的全名
  String nextName = null;//迭代器中下一个实现类的全名

  private LazyIterator(Class<S> service, ClassLoader loader) {
    this.service = service;
    this.loader = loader;
  }

  private boolean hasNextService() {
    if (nextName != null) {
      return true;
    }
    if (configs == null) {
      try {
        String fullName = PREFIX + service.getName();
        if (loader == null)
          configs = ClassLoader.getSystemResources(fullName);
        else
          configs = loader.getResources(fullName);
        }
      }
      while ((pending == null) || !pending.hasNext()) {
        if (!configs.hasMoreElements()) {
          return false;
        }
        pending = parse(service, configs.nextElement());
       }
      nextName = pending.next();
      return true;
  }

  private S nextService() {
    if (!hasNextService())
      throw new NoSuchElementException();
      String cn = nextName;
      nextName = null;
      Class<?> c = null;
      try {
        c = Class.forName(cn, false, loader);
      }
      if (!service.isAssignableFrom(c)) {
        fail(service, "Provider " + cn  + " not a subtype");
      }
      try {
        S p = service.cast(c.newInstance());
        providers.put(cn, p);
        return p;
      }
   }

  public boolean hasNext() {
    if (acc == null) {
      return hasNextService();
    } else {
      PrivilegedAction<Boolean> action = new PrivilegedAction<Boolean>() {
      public Boolean run() { return hasNextService(); }
      };
      return AccessController.doPrivileged(action, acc);
      }
    }

  public S next() {
     if (acc == null) {
       return nextService();
     } else {
       PrivilegedAction<S> action = new PrivilegedAction<S>() {
         public S run() { return nextService(); }
         };
       return AccessController.doPrivileged(action, acc);
      }
  }

  public void remove() {
    throw new UnsupportedOperationException();
  }
}

//获取迭代器
//返回遍历服务提供者的迭代器
//以懒加载的方式加载可用的服务提供者
//懒加载的实现是：解析配置文件和实例化服务提供者的工作由迭代器本身完成
public Iterator<S> iterator() {
  return new Iterator<S>() {
    //按照实例化顺序返回已经缓存的服务提供者实例
    Iterator<Map.Entry<String,S>> knownProviders = providers.entrySet().iterator();
    public boolean hasNext() {
      if (knownProviders.hasNext())
        return true;
      return lookupIterator.hasNext();
    }

   public S next() {
      if (knownProviders.hasNext())
        return knownProviders.next().getValue();
      return lookupIterator.next();
     }

   public void remove() {
     throw new UnsupportedOperationException();
   }
  };
}

  //使用扩展类加载器为指定的服务创建ServiceLoader
  //只能找到并加载已经安装到当前Java虚拟机中的服务提供者，应用程序类路径中的服务提供者将被忽略
  public static <S> ServiceLoader<S> loadInstalled(Class<S> service) {
    ClassLoader cl = ClassLoader.getSystemClassLoader();
    ClassLoader prev = null;
    while (cl != null) {
      prev = cl;
      cl = cl.getParent();
    }
    return ServiceLoader.load(service, prev);
  }
}
  1. 首先 ， ServiceLoader 实现 Iterable 接口，所以具有迭代器属性，主要实现了迭代器的 HasNext 和 Next 方法，调用 LookupIterator 的 HasNext 和 Next 方法，LookupIterator 是懒加载迭代器。
  2. 其次 ，LazyIterator 的 HasNext 方法，静态变量 Prefix 就是 META-INF/services/ 目录，这就是为什么需要在 Classpath下META-INF/services/目录创建以服务接口命名的文件。
  3. 最后 ，通过反射方法 Class.ForName()加载类对象，并用 NewInstance 方法将类实例化，并把实例化后的类缓存到 Providers对象中，(LinkedHashMap<String,S>类型）然后返回实例对象。

所以可以看到 ServiceLoader 不是实例化后就读取配置文件中具体实现并进行实例化，而是等到使用迭代器去遍历的时候，才会加载对应配置文件去解析，调用 HasNext 方法的时候会去加载配置文件进行解析，调用 Next 方法的时候进行实例化并缓存。

所有配置文件只会加载一次，服务提供者也只会被实例化一次，重新加载配置文件可使用 Reload 方法。

SPI 机制缺陷

通过阅读 ServiceLoader 源码，可以反向推断出基础 SPI 在使用上存在部分缺陷：

  1. 无法按需来获取。遍历所有实现，并实例化，然后在循环中才能找到需要的实现。如果不想用某些实现类，或者某些类实例化很耗时，也会被载入并实例化了，造成了浪费。
  2. 获取某个实现类的方式不够灵活，只能通过 Iterator 形式获取，不能根据某个参数来获取对应的实现类。
  3. 多个并发线程使用 ServiceLoader 类的实例不安全。

Dubbo SPI 机制

Dubbo SPI 并非原创一种新的加载机制，它是在 Java 原生 SPI 基础上加以改进，解决原生 SPI 一些缺陷。

Dubbo SPI 机制简单示例

  1. 同样 Search 接口
代码语言：javascript
代码运行次数：0
运行
AI代码解释
复制
@SPI
public interface Search {
  List<String> searchData();
}
  • 文件搜索实现
代码语言：javascript
代码运行次数：0
运行
AI代码解释
复制
public class FileSearch implements Search {
  @Override
  public List<String> searchData() {
    return Lists.newArrayList("这里是文件搜索");
  }
}
  • DB 搜索实现
代码语言：javascript
代码运行次数：0
运行
AI代码解释
复制
public class DbSearch implements Search {
  @Override
  public List<String> searchData() {
    return Lists.newArrayList("这里是 db 搜索");
  }
}
  • ES 搜索实现
代码语言：javascript
代码运行次数：0
运行
AI代码解释
复制
public class ElasticSearchSearch implements Search {
  @Override
  public List<String> searchData() {
    return Lists.newArrayList("这里是 es 搜索");
  }
}
  1. 接下来同样是在 META-INF/services/ 目录下，新建接口全限定名的文件: cn.zcy.spi.Search，里面加上我们需要用到的实现类
代码语言：javascript
代码运行次数：0
运行
AI代码解释
复制
db=cn.lzy.playwright.spi.dubbo.DbSearch
file=cn.lzy.playwright.spi.dubbo.FileSearch
es=cn.lzy.playwright.spi.dubbo.ElasticSearchSearch
  1. 测试
代码语言：javascript
代码运行次数：0
运行
AI代码解释
复制
@Slf4j
public class start {

  public static void main(String[] args) {
    ExtensionLoader<Search> extensionLoader = ExtensionLoader.getExtensionLoader(Search.class);
    Search dbSearch = extensionLoader.getExtension("db");
    log.info("dbSearch.method : {}", dbSearch.searchData());
    Search fileSearch = extensionLoader.getExtension("file");
    log.info("fileSearch.method : {}", fileSearch.searchData());
    Search esSearch = extensionLoader.getExtension("es");
    log.info("esSearch.method : {}", esSearch.searchData());
  }
}

结果

代码语言：javascript
代码运行次数：0
运行
AI代码解释
复制
dbSearch.method : [这里是 db 搜索]
fileSearch.method : [这里是文件搜索]
esSearch.method : [这里是 es 搜索]

分析一下，Dubbo SPI 和 Java 原生 SPI 实现上，有三个明显不同：

  • Interface 上加入了 Dubbo 内部 @SPI 。
  • 全限定名文件的内容，不再仅仅只是对应实现的全限定名， 而是类似 K-V 格式一种编写方式。
  • Main 方法内部，不是通过原生 ServiceLoader 加载，而是通过 Dubbo 自定义的 ExtensionLoader 加载。

通过示例很明显发现：Dubbo SPI 机制，通过改变全限定名文件内容格式，解决了原生 SPI 在使用上无法按需实例化这个缺陷。

那么 Dubbo SPI 如何实现，接下来看一下对应源码。

Dubbo SPI 实现

从入口 ExtensionLoader 来查看 GetExtensinLoader 方法

代码语言：javascript
代码运行次数：0
运行
AI代码解释
复制
public static <T> ExtensionLoader<T> getExtensionLoader(Class<T> type) {
  if (type == null) { // 规避了入参 NPE 问题
    throw new IllegalArgumentException("Extension type == null");
  }
  if (!type.isInterface()) { // 规避入参非接口的问题
    throw new IllegalArgumentException("Extension type(" + type + ") is not interface!");
  }
  if (!withExtensionAnnotation(type)) { // 方法内部判读接口是否存在 @SPI 注解
    throw new IllegalArgumentException("Extension type(" + type +
        ") is not extension, because WITHOUT @" + SPI.class.getSimpleName() + " Annotation!");
  }

  ExtensionLoader<T> loader = (ExtensionLoader<T>) EXTENSION_LOADERS.get(type);
    if (loader == null) { // 懒加载的实现逻辑
      EXTENSION_LOADERS.putIfAbsent(type, new ExtensionLoader<T>(type));
      loader = (ExtensionLoader<T>) EXTENSION_LOADERS.get(type);
    }
    return loader;
  }

方法内容很简单，除去一些判断外， 真正有价值的逻辑处理只有一个懒加载的实现，而关于代码上中 EXTENSION_LOADERS 其实是一个 ConcurrentHashMap

代码语言：javascript
代码运行次数：0
运行
AI代码解释
复制
private static final ConcurrentMap<Class<?>, ExtensionLoader<?>> EXTENSION_LOADERS = new ConcurrentHashMap<Class<?>, ExtensionLoader<?>>();

这在一定程度上解决了重复读取和并发问题。关键读取处理逻辑是在 new ExtensionLoader<T>(type) 这个构造方法内部，这个构造方法十分简单，是一个三元表达式

代码语言：javascript
代码运行次数：0
运行
AI代码解释
复制
private ExtensionLoader(Class<?> type) {
  this.type = type;
  objectFactory = (type == ExtensionFactory.class ? null : ExtensionLoader.getExtensionLoader(ExtensionFactory.class).getAdaptiveExtension());
}

所以要关注的就是 GetAdaptiveExtension 这个方法实现

如下是具体实现逻辑

代码语言：javascript
代码运行次数：0
运行
AI代码解释
复制
public T getAdaptiveExtension() {
  Object instance = cachedAdaptiveInstance.get();
  if (instance == null) {
  if (createAdaptiveInstanceError == null) {
    synchronized (cachedAdaptiveInstance) { // 懒加载的双重锁校验, 避免了并发问题
      instance = cachedAdaptiveInstance.get();
      if (instance == null) {
        try {
          instance = createAdaptiveExtension(); // 实例化的关键处理
          cachedAdaptiveInstance.set(instance);
        } catch (Throwable t) {
          createAdaptiveInstanceError = t;
          throw new IllegalStateException("fail to create adaptive instance: " + t.toString(), t);
        }
      }
    }
  } else {
    throw new IllegalStateException("fail to create adaptive instance: " + createAdaptiveInstanceError.toString(), createAdaptiveInstanceError);
    }
  }
  return (T) instance;
}

CreateAdaptiveExtension 关键是调用 GetAdaptiveExtensionClass 方法

代码语言：javascript
代码运行次数：0
运行
AI代码解释
复制
private T createAdaptiveExtension() {
  try {
    return injectExtension((T) getAdaptiveExtensionClass().newInstance());
    } catch (Exception e) {
    throw new IllegalStateException("Can not create adaptive extension " + type + ", cause: " + e.getMessage(), e);
    }
 }

继续看内部逻辑， 查到 GetExtensionClasses 方法

代码语言：javascript
代码运行次数：0
运行
AI代码解释
复制
private Class<?> getAdaptiveExtensionClass() {
  getExtensionClasses();
  if (cachedAdaptiveClass != null) {
    return cachedAdaptiveClass;
  }
  return cachedAdaptiveClass = createAdaptiveExtensionClass();
}

最后看到读取 Interface 对应实现类的方法是 LoadExtensionClasses ， 具体实现逻辑如下

代码语言：javascript
代码运行次数：0
运行
AI代码解释
复制
private Map<String, Class<?>> getExtensionClasses() {
   Map<String, Class<?>> classes = cachedClasses.get();
     if (classes == null) {
       synchronized (cachedClasses) {
         classes = cachedClasses.get();
         if (classes == null) {
           classes = loadExtensionClasses(); // 懒加载双重判定解决并发问题
           cachedClasses.set(classes);
          }
        }
     }
   return classes;
}

 // synchronized in getExtensionClasses
private Map<String, Class<?>> loadExtensionClasses() {
   final SPI defaultAnnotation = type.getAnnotation(SPI.class);
   if (defaultAnnotation != null) {
     String value = defaultAnnotation.value();
     if ((value = value.trim()).length() > 0) {
       String[] names = NAME_SEPARATOR.split(value);
       if (names.length > 1) {
         throw new IllegalStateException("more than 1 default extension name on extension " + type.getName() + ": " + Arrays.toString(names));
        }
        if (names.length == 1) {
          cachedDefaultName = names[0];
        }
      }
  }
  Map<String, Class<?>> extensionClasses = new HashMap<String, Class<?>>();
  // 指定地址读取文件内容, 兼容原生的 SPI 地址和默认的 duboo 文件地址
  loadDirectory(extensionClasses, DUBBO_INTERNAL_DIRECTORY, type.getName());
  loadDirectory(extensionClasses, DUBBO_INTERNAL_DIRECTORY, type.getName().replace("org.apache", "com.alibaba"));
  loadDirectory(extensionClasses, DUBBO_DIRECTORY, type.getName());
  loadDirectory(extensionClasses, DUBBO_DIRECTORY, type.getName().replace("org.apache", "com.alibaba"));
  loadDirectory(extensionClasses, SERVICES_DIRECTORY, type.getName());
  loadDirectory(extensionClasses, SERVICES_DIRECTORY, type.getName().replace("org.apache", "com.alibaba"));
        return extensionClasses;
}

private void loadDirectory(Map<String, Class<?>> extensionClasses, String dir, String type) {
  String fileName = dir + type;
  try {
    Enumeration<java.net.URL> urls;
    ClassLoader classLoader = findClassLoader();
    if (classLoader != null) {
      urls = classLoader.getResources(fileName);
    } else {
      urls = ClassLoader.getSystemResources(fileName);
    }
    if (urls != null) {
      while (urls.hasMoreElements()) {
        java.net.URL resourceURL = urls.nextElement();
        loadResource(extensionClasses, classLoader, resourceURL); // 读取指定地址文件资源
       }
    }
  } catch (Throwable t) {
    logger.error("Exception when load extension class(interface: " +type + ", description file: " + fileName + ").", t);
  }
}

private void loadResource(Map<String, Class<?>> extensionClasses, ClassLoader classLoader, java.net.URL resourceURL) {
  try {
    BufferedReader reader = new BufferedReader(new InputStreamReader(resourceURL.openStream(), "utf-8"));
    try {
      String line;
      // 按行读取配置
      while ((line = reader.readLine()) != null) {
        final int ci = line.indexOf('#');
        if (ci >= 0) {
        // 忽略 # 后的注释内容
        line = line.substring(0, ci);
      }
      line = line.trim();
      if (line.length() > 0) {
        try {
          String name = null;
          // 根据 = 分割内容, 拆解成 K-V 格式数据
          int i = line.indexOf('=');
          if (i > 0) {
            name = line.substring(0, i).trim();
            line = line.substring(i + 1).trim();
          }
          if (line.length() > 0) {
            // 加载 Class
            loadClass(extensionClasses, resourceURL, Class.forName(line, true, classLoader), name);
          }
        } catch (Throwable t) {
          IllegalStateException e = new IllegalStateException("Failed to load extension class(interface: " + type + ", class line: " + line + ") in " + resourceURL + ", cause: " + t.getMessage(), t);
                            exceptions.put(line, e);
        }
      }
    }
  } finally {
    reader.close();
  }
  } catch (Throwable t) {
    logger.error("Exception when load extension class(interface: " +type + ", class file: " + resourceURL + ") in " + resourceURL, t);
  }
}

由上述代码逻辑可以了解，Dubbo SPI 加载 Class 信息过程主要分成以下几步：

  1. 首先：通过名称获取拓展类之前，需要根据配置文件解析出拓展项名称到拓展类的映射关系表（Map<名称, 拓展类>），之后再根据拓展项名称从映射关系表中取出相应的拓展类
  2. 其次： GetExtensionClasses 内部先检查缓存，若缓存未命中，则通过 synchronized 加锁。加锁后再次检查缓存，并判空，此时如果 Classes 仍为 Null，则通过 LoadExtensionClasses 加载拓展类
  3. 然后： LoadExtensionClasses 中的逻辑比较简单, 总共就两件事情：一是对 SPI 注解进行解析，二是调用 LoadDirectory 方法加载指定文件夹配置文件
  4. 接着 LoadDirectory 方法先通过ClassLoader 获取所有资源链接，然后再通过 LoadResource 方法加载资源
  5. 最后 LoadResource 方法用于读取和解析配置文件，并通过反射加载类，最后调用 LoadClass 方法进行其他操作。LoadClass 方法用于主要用于操作缓存

加载完 Interface 对应实现 Class 之后就需要对其进行实例化，看一下源码实现

代码语言：javascript
代码运行次数：0
运行
AI代码解释
复制
public T getExtension(String name) {
  if (name == null || name.length() == 0) {
    throw new IllegalArgumentException("Extension name == null");
  }
  if ("true".equals(name)) {
     return getDefaultExtension();
  }
  // 缓存 Holder
  Holder<Object> holder = cachedInstances.get(name);
  if (holder == null) {
     cachedInstances.putIfAbsent(name, new Holder<Object>());
     holder = cachedInstances.get(name);
   }
   Object instance = holder.get();
     if (instance == null) { // 懒加载的双重判定, 避免并发情况
       synchronized (holder) {
         instance = holder.get();
         if (instance == null) {
           instance = createExtension(name);
           holder.set(instance);
         }
       }
     }
   return (T) instance;
 }

该方法内部是一个普通缓存读取内容，创建内容在方法 CreateExtension 内部

代码语言：javascript
代码运行次数：0
运行
AI代码解释
复制
private T createExtension(String name) {
  // 从配置文件中加载所有的拓展类，可得到“配置项名称”到“配置类”的映射关系表
  Class<?> clazz = getExtensionClasses().get(name);
  if (clazz == null) {
    throw findException(name);
  }
  try {
    T instance = (T) EXTENSION_INSTANCES.get(clazz);
    if (instance == null) {
      // 通过反射创建实例
      EXTENSION_INSTANCES.putIfAbsent(clazz, clazz.newInstance());
      instance = (T) EXTENSION_INSTANCES.get(clazz);
      }
      // 向实例中注入依赖
      injectExtension(instance);
      Set<Class<?>> wrapperClasses = cachedWrapperClasses;
      if (wrapperClasses != null && !wrapperClasses.isEmpty()) {
        // 循环创建 Wrapper 实例
        for (Class<?> wrapperClass : wrapperClasses) {
          // 将当前 instance 作为参数传给 Wrapper 的构造方法，并通过反射创建 Wrapper 实例。
          // 然后向 Wrapper 实例中注入依赖，最后将 Wrapper 实例再次赋值给 instance 变量
          instance = injectExtension((T) wrapperClass.getConstructor(type).newInstance(instance));
        }
      }
      return instance;
    } catch (Throwable t) {
       throw new IllegalStateException("Extension instance(name: " + name + ", class: " +
                    type + ")  could not be instantiated: " + t.getMessage(), t);
   }
 }

CreateExtension 方法逻辑稍复杂一下，包含了如下步骤：

  • 通过 GetExtensionClasses 获取所有的拓展类
  • 通过反射创建拓展对象
  • 向拓展对象中注入依赖
  • 将拓展对象包裹在相应的 Wrapper 对象中

以上步骤中，第一个步骤是加载拓展类的关键，第三和第四个步骤是 Dubbo IOC 与 AOP 的具体实现

代码语言：javascript
代码运行次数：0
运行
AI代码解释
复制
private T injectExtension(T instance) {
  try {
    if (objectFactory != null) {
      // 遍历目标类的所有方法
      for (Method method : instance.getClass().getMethods()) {
        // 检测方法是否以 set 开头，且方法仅有一个参数，且方法访问级别为 public
        if (method.getName().startsWith("set") && method.getParameterTypes().length == 1
          && Modifier.isPublic(method.getModifiers())) {
          /**
          * Check {@link DisableInject} to see if we need auto injection for this property
          */
          if (method.getAnnotation(DisableInject.class) != null) {
            continue;
          }
          // 获取 setter 方法参数类型
          Class<?> pt = method.getParameterTypes()[0];
          if (ReflectUtils.isPrimitives(pt)) {
            continue;
          }
          try {
            // 获取属性名，比如 setName 方法对应属性名 name
            String property = method.getName().length() > 3 ? method.getName().substring(3, 4).toLowerCase() + method.getName().substring(4) : "";
           // 从 ObjectFactory 中获取依赖对象
           Object object = objectFactory.getExtension(pt, property);
           if (object != null) {
             // 通过反射调用 setter 方法设置依赖
             method.invoke(instance, object);
           }
         } catch (Exception e) {
           logger.error("fail to inject via method " + method.getName()
                                    + " of interface " + type.getName() + ": " + e.getMessage(), e);
         }
       }
     }
   }
 } catch (Exception e) {
   logger.error(e.getMessage(), e);
 }
 return instance;
}

在上面代码中，ObjectFactory 变量类型为 AdaptiveExtensionFactory，AdaptiveExtensionFactory 内部维护了一个 ExtensionFactory 列表，用于存储其他类型的 ExtensionFactory。Dubbo 目前提供两种 ExtensionFactory，分别是 SpiExtensionFactory 和 SpringExtensionFactory。前者用于创建自适应的拓展，后者用于从 Spring IOC 容器中获取所需拓展。这两个类代码不是很复杂，这里就不一一分析了。

可以看出，Dubbo SPI 在原生 SPI 基础上，通过对配置文件格式改造，生成了一个映射关系表（Map<名称, 拓展类>），这样能够按需去实例化需要的实现类。解决原生 SPI 必须全部遍历然后遍历查询实现实例的问题.

同时无论是读取配置 Class 亦或是实例化对应的实现实例，都采用了懒加载的双重锁校验，解决了原生 SPI 在多线程情况下，可能存在的并发问题。

总结

自 JDK 1.6 以后，Java 提出了 SPI，一种服务提供发现机制，可以用来启用框架扩展和替换组件。其主要目的是将装配控制权移到程序之外，模块化设计中这个机制尤其重要。其核心思想是 解耦。

这种原生 SPI 机制并不完美，其实现存在若干问题

  • 无法按需进行实例化，只能全部实例化之后，遍历去获取需要的实现，造成内存浪费以及无谓的实例化资源消耗。
  • 并没有解决多线程下的并发问题。

Duboo 在原生 SPI 基础上进行改良，通过改变配置文件内容格式，针对每个实现类划分出 K-V ，能够满足在业务上按需实例化的要求。同时采用懒加载的双重锁校验，解决多线程情况下可能存在的并发问题。

本文参与 腾讯云自媒体同步曝光计划，分享自微信公众号。
原始发表：2023-12-04，如有侵权请联系 cloudcommunity@tencent.com 删除
缓存
dubbo
spi
接口
搜索

本文分享自 政采云技术 微信公众号，前往查看

如有侵权，请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ，欢迎热爱写作的你一起参与！

缓存
dubbo
spi
接口
搜索
评论
登录后参与评论
暂无评论
登录 后参与评论
推荐阅读
编辑精选文章
换一批
鹅厂写码13年，我总结的程序员高效阅读方法论
6513
进程，线程，协程 - 你了解多少？
2685
微服务与分布式系统设计看这篇就够了！
2284
腾讯文档表格卡顿指标探索之路
2073
从Hadoop1.0到Hadoop2.0架构的优化和发展探索详解
2050
微服务架构：由浅入深带你了解底层注册中心
2040
Dubbo SPI 实现原理
dubbo缓存jdk
Dubbo 并未使用 Java SPI ,而是重新设计了一套增强版的 SPI 。Dubbo SPI 的相关逻辑封装在了 ExtensionLoader 类中，通过 ExtensionLoader ，我们可以加载指定的实现类。Dubbo SPI 所需要的配置文件在 META-INF/dubbo 路径下。
王小明_HIT
2020/06/10
5250
一、dubbo初体验之SPI
缓存dubbospringjava
SPI 全称为 Service Provider Interface，是一种服务发现机制。SPI 的本质是将接口实现类的全限定名配置在文件中，并由服务加载器读取配置文件，加载实现类。这样可以在运行时，动态为接口替换实现类。
JathonKatu
2022/12/02
4580
一篇文章彻底弄懂dubbo的SPI机制的原理
缓存dubbohtml
在dubbo中几乎所有的功能组件都是基于SPI来实现的，dubbo良好的扩展性也与SPI加载机制密不可分，所以要想更进一步理解使用dubbo或者阅读dubbo的源码，SPI是一定要懂的。本文主要通过源码分析的方式来理解dubbo SPI的实现原理。
Java进阶之路
2022/08/03
7780
一篇文章彻底弄懂dubbo的SPI机制的原理
【七夕特殊礼物】Dubbo学习之SPI实战与debug源码
dubboxml缓存网络安全
上篇文章《dubbo学习之源码创建属于自己的dubbo-demo》溪源带着大家简单搭建了自己的demo，基础环境已经搭建完成，从这篇文章开始，溪源便开始学习并总结Dubbo的相关机制，此篇文章的核心是实践SPI机制和SPI源码跟踪。时间宝贵，下面步入正题： 对于SPI机制，溪源不再做介绍了，大家有兴趣的可以自行谷歌，同时分享溪源之前总结的：java实践SPI机制及浅析源码。
沁溪源
2020/09/03
3280
谈谈一个框架的扩展加载
spring缓存html网络安全dubbo
在 SpringBoot 启动类上都会标注@SpringBootApplication这个注解，其中的最重要的组成是@EnableAutoConfiguration, 再进入会发现是 @Import (AutoConfigurationImportSelector.class)这个注解在起作用。
leobhao
2022/06/28
5190
dubbo SPI机制源码分析
dubbojdk
dubbo是微内核架构，SPI是dubbo的架构根基 什么是微内核?还是开闭原则的应用。把核心流程架构固定，但流程各个节点对重新改进是开放的，也可以说是面下接口编程。具体实现方法就是SPI(servi
技术蓝海
2018/04/26
1.7K0
Dubbo源码学习--环境搭建及基础准备(ServiceLoader、ExtensionLoader)
dubbo
该文介绍了Dubbo的SPI以及其拓展点实现，对Dubbo的SPI机制和拓展点进行了详细的分析和讲解，并提供了相关代码和实现。
YGingko
2017/12/28
1.3K0
[适合初中级Java程序员修炼手册从0搭建整个Web项目]（七）
dubbojava网站rpchtml
一个Web后端框架的轮子从处理Http请求【基于Netty的请求级Web服务器】 到mvc【接口封装转发)】，再到ioc【依赖注入】，aop【切面】，再到 rpc【远程过程调用】最后到orm【数据库操作】全部自己撸一个（简易）的轮子。
用户9927510
2022/07/29
2280
[适合初中级Java程序员修炼手册从0搭建整个Web项目]（七）
（一）Dubbo源码解析：增强SPI
缓存dubbospi对象源码
在Dubbo的架构设计中，如何可以通过“类插拔”的方式，对其功能进行灵活的扩展或者削弱，那么，SPI起到了极其关键的作用。本篇文章作为分析Dubbo源码的第一篇文章，我们先暂时放下“服务注册发布流程”、“服务启动流程”、“请求处理流程”……这些功能代码的探索，我们先从最基本的一个问题着手，即：Dubbo的增强SPI是如何实现的，只有搞懂了这个问题，我们后续再看其他功能代码的时候，才会更加游刃有余、畅快无阻~
爪哇缪斯
2023/09/05
1380
（一）Dubbo源码解析：增强SPI
手写dubbo框架8-SPI 自适应扩展机制
dubbophp缓存
博客中代码地址：https://github.com/farliu/farpc.git
并发笔记
2020/10/21
8530
深度Dubbo源码 - SPI的使用与好处
负载均衡spring负载均衡缓存html
相信阅读过Dubbo源码的同学应该看到在Dubbo中的很多接口上都有一个 @SPI的注解，笔者也不例外，但是一直不知道这个注解具体是干什么的，为了解决什么问题，怎么去使用？网上简单检索了下，中文名：服务供给接口，详见下图（来自百度百科）。
RedSheep
2019/09/19
6750
深度Dubbo源码 - SPI的使用与好处
Dubbo 源码分析 - SPI 机制
其他
SPI 全称为 Service Provider Interface，是 Java 提供的一种服务发现机制。SPI 的本质是将接口实现类的全限定名配置在文件中，并由服务加载器读取配置文件，加载实现类。这样可以在运行时，动态为接口替换实现类。正因此特性，我们可以很容易的通过 SPI 机制为我们的程序提供拓展功能。SPI 机制在第三方框架中也有所应用，比如 Dubbo 就是通过 SPI 机制加载所有的组件。不过，Dubbo 并未使用 Java 原生的 SPI 机制，而是对其进行了增强，使其能够更好的满足需求。在 Dubbo 中，SPI 是一个非常重要的模块。如果大家想要学习 Dubbo 的源码，SPI 机制务必弄懂。下面，我们先来了解一下 Java SPI 与 Dubbo SPI 的使用方法，然后再来分析 Dubbo SPI 的源码。
田小波
2018/10/11
5860
Dubbo 源码分析 - SPI 机制
Java必备之从JDK到Dubbo的SPI深度剖析
dubbo缓存javahtml
本示例路径META-INF/services/com.springboot.dubbo.spi.SayHelloService
用户5397975
2019/10/14
9610
Dubbo扩展点开发指南
缓存编程算法dubbo网络安全
本文介绍了 Dubbo SPI 的原理和实现细节 ◆ 1.简介 SPI 全称为 Service Provider Interface，是一种服务发现机制。SPI 的本质是将接口实现类的全限定名配置在文件中，并由服务加载器读取配置文件，加载实现类。这样可以在运行时，动态为接口替换实现类。正因此特性，我们可以很容易的通过 SPI 机制为我们的程序提供拓展功能。SPI 机制在第三方框架中也有所应用，比如 Dubbo 就是通过 SPI 机制加载所有的组件。不过，Dubbo 并未使用 Java 原生的 SPI 机制，
IT大咖说
2022/04/11
5070
Dubbo扩展点开发指南
Dubbo2.7的Dubbo SPI实现原理细节
apache缓存dubbojavascript编程算法
本文主要记录我对Dubbo SPI实现原理的理解，至于什么是SPI，我这里就不像其他博文一样详细地从概念再到Java SPI细细分析了，直接开门见山来分享我对Dubbo SPI的见解。
朱季谦
2023/02/05
7150
dubbo（一）SPI机制与实现路径
dubbohtmljdk缓存
了解dubbo内核之前，我们先看下dubbo的启动流程，参考了本地启动时日志打印的dubbo启动整理出来的流程图：
虞大大
2020/09/18
9130
Dubbo 扩展点加载机制：从 Java SPI 到 Dubbo SPI
dubbo缓存javahtmlide
SPI 全称为 Service Provider Interface，是一种服务发现机制。当程序运行调用接口时，会根据配置文件或默认规则信息加载对应的实现类。所以在程序中并没有直接指定使用接口的哪个实现，而是在外部进行装配。 要想了解 Dubbo 的设计与实现，其中 Dubbo SPI 加载机制是必须了解的，在 Dubbo 中有大量功能的实现都是基于 Dubbo SPI 实现解耦，同时也使得 Dubbo 获得如此好的可扩展性。
ytao
2020/06/04
9350
Dubbo 扩展点加载机制：从 Java SPI 到 Dubbo SPI
手写dubbo框架7-SPI(dubbo和jdk的区别)
dubbo缓存aophtml
博客中代码地址：https://github.com/farliu/farpc.git
并发笔记
2020/10/21
8220
【Dubbo源码】SPI机制源码解析
编程算法dubbojavaphp
SPI 全称为 Service Provider Interface，是一种服务发现机制。SPI 的本质是将接口实现类的全限定名配置在文件中，并由服务加载器读取配置文件，加载实现类。这样可以在运行时，动态为接口替换实现类。正因此特性，我们可以很容易的通过 SPI 机制为我们的程序提供拓展功能。SPI 机制在第三方框架中也有所应用，比如 Dubbo 就是通过 SPI 机制加载所有的组件。不过，Dubbo 并未使用 Java 原生的 SPI 机制，而是对其进行了增强，使其能够更好的满足需求。在 Dubbo 中，SPI 是一个非常重要的模块。基于 SPI，我们可以很容易的对 Dubbo 进行拓展。如果大家想要学习 Dubbo 的源码，SPI 机制务必弄懂。接下来，我们先来了解一下 Java SPI 与 Dubbo SPI 的用法，然后再来分析 Dubbo SPI 的源码。
石臻臻的杂货铺[同名公众号]
2021/07/14
1.5K0
Dubbo源码解析（2）SPI原理
dubbohtmlphp
本篇文章是Dubbo源码解析系列文章的第二篇，本系列文章分析基于Dubbo官方代码2.7.5-release版本，本篇文章主要分析Dubbo中是如何使用SPI机制来加载扩展类的
Java学习录
2020/03/31
3740
Dubbo源码解析（2）SPI原理
推荐阅读
编辑精选文章
鹅厂写码13年，我总结的程序员高效阅读方法论进程，线程，协程 - 你了解多少？微服务与分布式系统设计看这篇就够了！
相关讨论
dubbo应用如何迁移？云开发能够运用与网站数据存储吗？云计算实现中虚拟化技术是如何运用的？
相关课程
AI驱动的TDSQL-Cserverless实战营C/Python数字化IT从业者知识体系
Dubbo SPI 实现原理
5250
一、dubbo初体验之SPI
4580
一篇文章彻底弄懂dubbo的SPI机制的原理
7780
【七夕特殊礼物】Dubbo学习之SPI实战与debug源码
3280
谈谈一个框架的扩展加载
5190
dubbo SPI机制源码分析
1.7K0
Dubbo源码学习--环境搭建及基础准备(ServiceLoader、ExtensionLoader)
1.3K0
[适合初中级Java程序员修炼手册从0搭建整个Web项目]（七）
2280
（一）Dubbo源码解析：增强SPI
1380
手写dubbo框架8-SPI 自适应扩展机制
8530
深度Dubbo源码 - SPI的使用与好处
6750
Dubbo 源码分析 - SPI 机制
5860
Java必备之从JDK到Dubbo的SPI深度剖析
9610
Dubbo扩展点开发指南
5070
Dubbo2.7的Dubbo SPI实现原理细节
7150
dubbo（一）SPI机制与实现路径
9130
Dubbo 扩展点加载机制：从 Java SPI 到 Dubbo SPI
9350
手写dubbo框架7-SPI(dubbo和jdk的区别)
8220
【Dubbo源码】SPI机制源码解析
1.5K0
Dubbo源码解析（2）SPI原理
3740
相关推荐
Dubbo SPI 实现原理
更多 >
政采云前端团队0
LV.0
政采云有限公司
文章
241
获赞
507
专栏
1
作者相关精选
换一批
加入讨论
的问答专区 >
王新栋0
相关课程
一站式学习中心 >
云开发微搭低代码平台-一人构建企业级应用实战训练营
1775人在学
腾讯云微搭低代码
云开发
C/Python
686人在学
c 语言
python
数字化IT从业者知识体系
365人在学
CODING DevOps
软件开发
领券
社区富文本编辑器全新改版！诚邀体验～
全新交互，全新视觉，新增快捷键、悬浮工具栏、高亮块等功能并同时优化现有功能，全面提升创作效率和体验

腾讯云开发者

扫码关注腾讯云开发者

扫码关注腾讯云开发者

领取腾讯云代金券

热门产品

热门推荐

更多推荐

Copyright © 2013 - 2025 Tencent Cloud. All Rights Reserved. 腾讯云 版权所有 

深圳市腾讯计算机系统有限公司 ICP备案/许可证号：粤B2-20090059 深公网安备号 44030502008569

腾讯云计算（北京）有限责任公司 京ICP证150476号 |  京ICP备11018762号 | 京公网安备号11010802020287

问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档

Copyright © 2013 - 2025 Tencent Cloud.

All Rights Reserved. 腾讯云 版权所有

登录 后参与评论
1
目录
查看详情【社区公告】 技术创作特训营有奖征文