Berbagi teknologi

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

SPI adalah singkatan dari Service Provider Interface, yang dapat dipahami sebagai antarmuka yang khusus disediakan untuk penyedia layanan atau pengembang yang memperluas fungsi kerangka kerja. SPI memisahkan antarmuka layanan dari implementasi layanan tertentu, memisahkan pemanggil layanan dan pelaksana layanan, dan dapat meningkatkan skalabilitas dan pemeliharaan program. Memodifikasi atau mengganti implementasi layanan tidak memerlukan modifikasi pemanggil. Banyak kerangka kerja yang menggunakan mekanisme SPI Java, seperti: kerangka pegas, driver pemuatan basis data, antarmuka log, dan implementasi ekstensi Dubbo, dll. Lihat mekanisme SPI Dubbo untuk mengimplementasikan bagian SPI dari kerangka RPC ini.

Misalnya, ketika klien berkomunikasi dengan server, ia perlu membuat pesan bersambung. Ada banyak algoritma serialisasi yang dapat digunakan selama serialisasi, antara lain Hessian, Kryo, dan ProtoStuff. Persyaratan sistem adalah memanggil metode di kelas yang sesuai dengan algoritma serialisasi yang relevan berdasarkan nama algoritma serialisasi dalam pesan untuk melakukan serialisasi dan deserialisasi. Selain itu, untuk memfasilitasi ekspansi, SPI perlu digunakan untuk decoupling .

SPI digunakan sebagai berikut:

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

codecName adalah nama algoritma serialisasi, dan kelas terkait perlu dimuat sesuai dengan nama ini.

    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;
    }

Setiap antarmuka SPI memiliki ExtensionLoader sendiri. Saat memanggil getExtensionLoader, pertama-tama ia akan melakukan serangkaian operasi pemeriksaan hukum, dan kemudian mencoba mendapatkan ExtensionLoader antarmuka. Pertama, coba dapatkan dari cache lokal CHM diperoleh, buat objek Loader.

Setelah itu, instance diperoleh melalui getExtension, dan instance tersebut juga di-cache secara lokal. Jika tidak ada dalam cache, buat kembali instance tersebut.

    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;
    }

Setelah mendapatkan objek Kelas dari kelas tersebut, Anda dapat membuat objek ini melalui refleksi.

   // 缓存   
   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;
    }

Kuncinya adalah proses mendapatkan objek Kelas, yaitu metode getExtensionCalsses:

    // 该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

Pemanggilan metode lapis demi lapis menyadari proses memuat file konfigurasi SPI yang sesuai di bawah jalur META-INF/extensions/ untuk memuat objek Kelas dan mendapatkan instance. Silakan merujuk ke komentar untuk bagian penting.

Perlu dicatat bahwa nama file di bawah META-INF/extensions/ harus konsisten dengan kode. Nama file yang ditentukan dalam kode adalah nama kelas lengkap dari kelas antarmuka SPI. Konten dalam file juga perlu ditulis sesuai dengan (pengidentifikasi kelas implementasi = nama kelas lengkap dari kelas implementasi), sehingga dapat konsisten dengan kode, dan program dapat mengurai file dengan benar dan menggunakan pemuat kelas untuk memuat Kelas yang sesuai. Terakhir, cache menurut <pengidentifikasi kelas implementasi, objek kelas implementasi>.

Karena adanya tiga cache (pengidentifikasi kelas, objek Kelas), (Objek kelas, contoh objek), dan (pengidentifikasi kelas, contoh objek), Anda dapat langsung meneruskan pengidentifikasi untuk mendapatkan turunan dari kelas yang sesuai, yang mana juga mengoptimalkan kinerja kerangka RPC.