Technologieaustausch

한어Русский языкEnglishFrançaisIndonesianSanskrit日本語DeutschPortuguêsΕλληνικάespañolItalianoSuomalainenLatina

SPI steht für Service Provider Interface und kann als Schnittstelle verstanden werden, die speziell für Dienstanbieter oder Entwickler bereitgestellt wird, die Framework-Funktionen erweitern. SPI trennt die Serviceschnittstelle von der spezifischen Serviceimplementierung, entkoppelt den Serviceaufrufer und den Serviceimplementierer und kann die Skalierbarkeit und Wartbarkeit des Programms verbessern. Das Ändern oder Ersetzen einer Dienstimplementierung erfordert keine Änderung des Aufrufers. Viele Frameworks verwenden den SPI-Mechanismus von Java, z. B. Spring Framework, Datenbankladetreiber, Protokollschnittstelle und Dubbo-Erweiterungsimplementierung usw. Informationen zur Implementierung des SPI-Teils dieses RPC-Frameworks finden Sie im SPI-Mechanismus von Dubbo.

Wenn der Client beispielsweise mit dem Server kommuniziert, muss er die Nachricht serialisieren. Es gibt viele Serialisierungsalgorithmen, die während der Serialisierung verwendet werden können, darunter Hessian, Kryo und ProtoStuff. Die Anforderung des Systems besteht darin, die Methode in der Klasse aufzurufen, die dem relevanten Serialisierungsalgorithmus entspricht, basierend auf dem Namen des Serialisierungsalgorithmus in der Nachricht, um die Serialisierung und Deserialisierung durchzuführen. Darüber hinaus muss SPI zur Entkopplung verwendet werden .

SPI wird wie folgt verwendet:

Serializer serializer = ExtensionLoader.getExtensionLoader(Serializer.class)
                    .getExtension(codecName);

CodecName ist der Name des Serialisierungsalgorithmus, und die entsprechende Klasse muss entsprechend diesem Namen geladen werden.

    private final Class<?> type;
 
    private ExtensionLoader(Class<?> type) {
        this.type = type;
    }
 
    // 每个SPI接口都有自身的ExtensionLoader
    public static <S> ExtensionLoader<S> getExtensionLoader(Class<S> type) {
        if (type == null) {
            throw new IllegalArgumentException("Extension type should not be null.");
        }
        if (!type.isInterface()) {
            throw new IllegalArgumentException("Extension type must be an interface.");
        }
        if (type.getAnnotation(SPI.class) == null) {
            throw new IllegalArgumentException("Extension type must be annotated by @SPI");
        }
        // firstly get from cache, if not hit, create one
        ExtensionLoader<S> extensionLoader = (ExtensionLoader<S>) EXTENSION_LOADERS.get(type);
        if (extensionLoader == null) {
            EXTENSION_LOADERS.putIfAbsent(type, new ExtensionLoader<S>(type));
            extensionLoader = (ExtensionLoader<S>) EXTENSION_LOADERS.get(type);
        }
        return extensionLoader;
    }

Jede SPI-Schnittstelle verfügt über einen eigenen ExtensionLoader. Wenn dies nicht möglich ist, führt sie zunächst eine Reihe zulässiger Prüfvorgänge durch und versucht dann, den ExtensionLoader der Schnittstelle abzurufen erhalten, erstellen Sie ein Loader-Objekt.

Danach wird die Instanz über getExtension abgerufen und auch lokal zwischengespeichert. Wenn sie sich nicht im Cache befindet, erstellen Sie die Instanz erneut.

    private final Map<String, Holder<Object>> cachedInstances = new ConcurrentHashMap<>();
 
    public T getExtension(String name) {
        if (StringUtil.isBlank(name)) {
            throw new IllegalArgumentException("Extension name should not be null or empty.");
        }
        // firstly get from cache, if not hit, create one
        // 缓存holder
        Holder<Object> holder = cachedInstances.get(name);
        if (holder == null) {
            cachedInstances.putIfAbsent(name, new Holder<>());
            holder = cachedInstances.get(name);
        }
        // create a singleton if no instance exists
        // holder为空，双重检查锁创建示例
        Object instance = holder.get();
        if (instance == null) {
            synchronized (holder) {
                instance = holder.get();
                if (instance == null) {
                    instance = createExtension(name);
                    holder.set(instance);
                }
            }
        }
        return (T) instance;
    }

Nachdem Sie das Klassenobjekt der Klasse erhalten haben, können Sie dieses Objekt durch Reflektion erstellen.

   // 缓存   
   private static final Map<Class<?>, Object> EXTENSION_INSTANCES = new ConcurrentHashMap<>();
 
   private T createExtension(String name) {
        // load all extension classes of type T from file and get specific one by name
        // SPI接口对应的实现类，其标识名与class文件的映射，根据标识名获取class
        Class<?> clazz = getExtensionClasses().get(name);
        if (clazz == null) {
            throw new RuntimeException("No such extension of name " + name);
        }
        T instance = (T) EXTENSION_INSTANCES.get(clazz);
        if (instance == null) {
            try {
                // 缓存中不存在，则创建实例
                EXTENSION_INSTANCES.putIfAbsent(clazz, clazz.newInstance());
                instance = (T) EXTENSION_INSTANCES.get(clazz);
            } catch (Exception e) {
                log.error(e.getMessage());
            }
        }
        return instance;
    }

Der Schlüssel ist der Prozess zum Abrufen des Klassenobjekts, dh der getExtensionCalsses-Methode:

    // 该SPI接口所有实现类的标识与其Class对象的缓存
    private final Holder<Map<String, Class<?>>> cachedClasses = new Holder<>(); 
 
    private static final String SERVICE_DIRECTORY = "META-INF/extensions/";  
 
    private Map<String, Class<?>> getExtensionClasses() {
        // get the loaded extension class from the cache
        // 根据Interface实现类的类名获取对应类的缓存
        Map<String, Class<?>> classes = cachedClasses.get();
        // double check
        if (classes == null) {
            synchronized (cachedClasses) {
                classes = cachedClasses.get();
                if (classes == null) {
                    classes = new HashMap<>();
                    // load all extensions from our extensions directory
                    loadDirectory(classes);
                    // 将Map集合存储在Holder中进行缓存
                    cachedClasses.set(classes);
                }
            }
        }
        return classes;
    }
 
    private void loadDirectory(Map<String, Class<?>> extensionClasses) {
        // 固定路径下的文件，SPI接口的类名作为文件名，在此文件中规定需要加载的实现类
        String fileName = ExtensionLoader.SERVICE_DIRECTORY + type.getName();
        try {
            Enumeration<URL> urls;
            // 系统类加载器，它能够加载用户类路径（ClassPath）上的类和资源。对于SPI机制尤为重要，因为SPI的实现类通常是由应用程序提供并放置在应用程序的类路径下的
            ClassLoader classLoader = ExtensionLoader.class.getClassLoader();
            // 获取当前类加载器加载的URL资源，文件名确定一般urls是唯一的
            urls = classLoader.getResources(fileName);
            if (urls != null) {
                while (urls.hasMoreElements()) {
                    URL resourceUrl = urls.nextElement();
                    // 使用classLoader加载资源，资源目标在resourceUrl下，加载后的class存储在extensionClasses Map集合当中
                    loadResource(extensionClasses, classLoader, resourceUrl);
                }
            }
        } catch (IOException e) {
            log.error(e.getMessage());
        }
    }
 
    private void loadResource(Map<String, Class<?>> extensionClasses, ClassLoader classLoader, URL resourceUrl) {
        try (BufferedReader reader = new BufferedReader(new InputStreamReader(resourceUrl.openStream(), UTF_8))) {
            String line;
            // read every line
            // #是注释，截取注释之前的部分
            while ((line = reader.readLine()) != null) {
                // get index of comment
                final int ci = line.indexOf('#');
                if (ci >= 0) {
                    // string after # is comment so we ignore it
                    line = line.substring(0, ci);
                }
                line = line.trim();
                if (line.length() > 0) {
                    try {
                        final int ei = line.indexOf('=');
                        // 标识与类名
                        String name = line.substring(0, ei).trim();
                        String clazzName = line.substring(ei + 1).trim();
                        // our SPI use key-value pair so both of them must not be empty
                        if (name.length() > 0 && clazzName.length() > 0) {
                            // 加载类
                            Class<?> clazz = classLoader.loadClass(clazzName);
                            // 在map中保存
                            extensionClasses.put(name, clazz);
                        }
                    } catch (ClassNotFoundException e) {
                        log.error(e.getMessage());
                    }
                }
 
            }
        } catch (IOException e) {
            log.error(e.getMessage());
        }
    }

kyro=github.javaguide.serialize.kyro.KryoSerializer
protostuff=github.javaguide.serialize.protostuff.ProtostuffSerializer
hessian=github.javaguide.serialize.hessian.HessianSerializer

Der schichtweise Methodenaufruf realisiert den Prozess des Ladens der entsprechenden SPI-Konfigurationsdatei unter dem Pfad META-INF/extensions/, um das Klassenobjekt zu laden und die Instanz zu erhalten. Bitte beachten Sie die Kommentare für wichtige Teile.

Es ist zu beachten, dass der Dateiname unter META-INF/extensions/ mit dem Code übereinstimmen muss. Der im Code angegebene Dateiname ist der vollständige Klassenname der SPI-Schnittstellenklasse. Der Inhalt der Datei muss außerdem gemäß (Implementierungsklassenkennung = vollständiger Klassenname der Implementierungsklasse) geschrieben werden, damit er mit dem Code übereinstimmt und das Programm die Datei korrekt analysieren und den Klassenlader verwenden kann Laden Sie die entsprechende Klasse. Schließlich wird der Cache gemäß <Implementierungsklassenkennung, Implementierungsklassenklassenobjekt> gespeichert.

Aufgrund der Existenz der drei Caches (Klassenkennung, Klassenobjekt), (Klassenobjekt, Objektinstanz) und (Klassenkennung, Objektinstanz) können Sie die Kennung direkt übergeben, um die Instanz der entsprechenden Klasse zu erhalten Optimiert auch die Leistung des RPC-Frameworks.