SPI

SPI是一种扩展机制,在java中SPI机制被广泛应用,比如Spring中的SpringServletContainerInitializer 使得容器启动的时候SpringServletContainerInitializer 执行onStartup方法。在dubbo中,dubbo实现了自己的spi扩展机制,下面详细的讲解下,dubbo的扩展机制。

dubbo SPI使用-Filter的定义使用

dubbo中的fiter是使用spi机制实现的典型应用,现在使用filter作为例子,展示先dubbo的spi机制。

首先定义一个filter。

public class MyFilter implements Filter {

  public Result invoke(Invoker<?> invoker, Invocation invocation)
throws RpcException {
System.out.println("开始调用 MyFilter");
Result result = invoker.invoke(invocation);
System.out.println("结束调用 MyFilter");
return result;
}
}

将filter加到dubbo默认的filter

@Activate(group = {Constants.CONSUMER})

在消费端使用filter

在消费者的resource文件下建

/META-INF/dubbo/internal/com.alibaba.dubbo.rpc.Filter

内容为:

myFilter=com.lenny.sample.dubbo.common.filter.MyFilter

在消费端指定filter

@Reference(version = "1.0.0",filter = "myFilter")
private UserDubboService userDubboService;

在调用userDubboService的服务器时在控制台打印如下内容:

在服务端使用filter

在服务端的resource文件下建

/META-INF/dubbo/internal/com.alibaba.dubbo.rpc.Filter

内容为:

myFilter=com.lenny.sample.dubbo.common.filter.MyFilter

在服务提供者指定filter:

@Service(version = "1.0.0",filter = "myFilter")

同样在控制台打印如下内容:

dubbo默认filter

dubbo默认提供一些filter。

dubbo filter源码分析

Filter的加载源码位于ProtocolFilterWrapper类,具体实现过程


// 服务端暴露
@Override
public <T> Exporter<T> export(Invoker<T> invoker) throws RpcException {
if (Constants.REGISTRY_PROTOCOL.equals(invoker.getUrl().getProtocol())) {
return protocol.export(invoker);
}
return protocol.export(buildInvokerChain(invoker, Constants.SERVICE_FILTER_KEY, Constants.PROVIDER));
} // 消费端
@Override
public <T> Invoker<T> refer(Class<T> type, URL url) throws RpcException {
if (Constants.REGISTRY_PROTOCOL.equals(url.getProtocol())) {
return protocol.refer(type, url);
}
return buildInvokerChain(protocol.refer(type, url), Constants.REFERENCE_FILTER_KEY, Constants.CONSUMER);
}

主要看buildInvokerChain。

private static <T> Invoker<T> buildInvokerChain(final Invoker<T> invoker, String key, String group) {
Invoker<T> last = invoker;
// 获取全部的filter
List<Filter> filters = ExtensionLoader.getExtensionLoader(Filter.class).getActivateExtension(invoker.getUrl(), key, group);
if (!filters.isEmpty()) {
for (int i = filters.size() - 1; i >= 0; i--) {
final Filter filter = filters.get(i);
final Invoker<T> next = last;
last = new Invoker<T>() {
@Override
public Class<T> getInterface() {
return invoker.getInterface();
}
@Override
public URL getUrl() {
return invoker.getUrl();
}
@Override
public boolean isAvailable() {
return invoker.isAvailable();
} @Override
public Result invoke(Invocation invocation) throws RpcException {
// 执行filter的invoke方法
return filter.invoke(next, invocation);
} @Override
public void destroy() {
invoker.destroy();
} @Override
public String toString() {
return invoker.toString();
}
};
}
}
return last;
}

在执行export的时候获取全部的filter,绑定到要执行的方法上面,在要执行的方面的时候,执行filter方法。

Spi的加载原理

在ExtensionLoader中有loadExtensionClasses方法,加载全部的扩展类。

private static final String SERVICES_DIRECTORY = "META-INF/services/";
private static final String DUBBO_DIRECTORY = "META-INF/dubbo/";
private static final String DUBBO_INTERNAL_DIRECTORY = DUBBO_DIRECTORY + "internal/";
private static final Pattern NAME_SEPARATOR = Pattern.compile("\\s*[,]+\\s*"); 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<?>>();
// 去相应的文件路径下扫描文件
loadDirectory(extensionClasses, DUBBO_INTERNAL_DIRECTORY);
loadDirectory(extensionClasses, DUBBO_DIRECTORY);
loadDirectory(extensionClasses, SERVICES_DIRECTORY);
return extensionClasses;
}
private void loadDirectory(Map<String, Class<?>> extensionClasses, String dir) {
// 文件路径加上全类名
String fileName = dir + type.getName();
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);
}
}

根据使用@SPI的注解的类全类名去如下路径,找到相应问文件,解析文件内容

  • META-INF/dubbo/internal/全类名
  • META-INF/dubbo/全类名
  • META-INF/services/全类名

如以filter为例:

package com.alibaba.dubbo.rpc;
import com.alibaba.dubbo.common.extension.SPI; @SPI
public interface Filter {
Result invoke(Invoker<?> invoker, Invocation invocation) throws RpcException;
}

Filter的全类名是com.alibaba.dubbo.rpc.Filter。所以可以去扫描如下路径

  • META-INF/dubbo/internal/com.alibaba.dubbo.rpc.Filter

  • META-INF/dubbo/com.alibaba.dubbo.rpc.Filter

  • META-INF/services/com.alibaba.dubbo.rpc.Filter

在上面的例子中将MyFilter的文件定义到了META-INF/dubbo/internal/com.alibaba.dubbo.rpc.Filter路径下。

当然也可以放到META-INF/dubbo/com.alibaba.dubbo.rpc.Filter和META-INF/services/com.alibaba.dubbo.rpc.Filter。

如图:放到下面三个位置任何一个位置都是可以的。

本文源代码:https://github.com/applenele/sample

最新文章

  1. 2012 Multi-University #7
  2. windows Server 2008各版本区别详解
  3. C++实现双缓冲
  4. springMVC注解@initbinder日期类型的属性自动转换
  5. NGUI OnChange Event
  6. POJ1845 Sumdiv(求所有因数和+矩阵快速幂)
  7. androidactivity与webview结合
  8. C# 之 Excel 导入一列中既有汉字又有数字:数字可以正常导入,汉字导入为空
  9. BZOJ 1754: [Usaco2005 qua]Bull Math
  10. 《VIM-Adventures攻略》前言
  11. webService请求方式快速生成代码 (Postman)
  12. 在不用Promise的情况下如何控制异步请求?
  13. MyEclipse 2014 破解版下载:我有,需要的给我说一声,给你发过去
  14. MVC-AOP思想-Filter 三种注册方式
  15. [Swift]LeetCode968.监控二叉树 | Binary Tree Cameras
  16. [物理学与PDEs]第5章习题9 伴随矩阵的特征值
  17. SET || BZOJ 1588: [HNOI2002]营业额统计 || Luogu P2234 [HNOI2002]营业额统计
  18. ReCAPTCHA &amp; 手势验证
  19. Nginx 配置反向代理后,页面中取绝对URL地址的问题显示代理端口
  20. php Pthread 线程 互斥锁

热门文章

  1. 文档对象模型DOM通俗讲解
  2. mysql 查询制定日期数据
  3. 排序算法总结第二弹----冒泡排序---javascript描述
  4. 如何使用C自带的qsort快速排序
  5. c# base关键的理解
  6. Failed to execute goal org.codehaus.mojo:rpm-maven-plugin:2.1.1:rpm (default) on project **
  7. struts2的标签中得到JSP脚本的变量值
  8. 【整理】JavaEE基本框架(Struts2+Spring+MyBatis三层,Struts MVC)之间的关系
  9. Eclipse编辑jsp、js文件时,经常出现卡死现象解决汇总
  10. logstash ArgumentError: comparison of String with 5 failed
  11. 【转载】python 模块 - random生成随机数模块
  12. EMMC与RAND的区别
  13. DBCC命令
  14. django——简介
  15. 【手机端判断】PC_to_M自写
  16. Kali学习笔记13:操作系统识别
  17. 【转】python模块分析之hashlib加密(二)
  18. Java反射之基础概念
  19. linux之文件增删改查
  20. day2-python工具的选择使用