JAVA的SPI和ServiceLoader

为什么80%的码农都做不了架构师？>>>   

    SPI即Service Provider Interface，用于提供一些服务给第三方实现或扩展，可以增强框架的扩展或者替换一些组件，其实就是约定的一种规范，可以参考JDBC，不同厂家使用相同的约束去实现不同的功能。

    那么JAVA如何来抽取公共的抽象部分，来调用具体的实现呢，SPI机制就可以选择不同的实现。

    ServiceLoader就是SPI的一种实现，如何使用ServiceLoader？

    首先定义一个接口 LogService

package com.xxx.service;

public interface LogService {
   void log(String msg);
}

    针对这个接口我们提供一个实现：

package com.xx.service;

public class DefaultLogService implements LogService {

   @Override
   public void log(String msg) {
      System.out.println(msg);
   }
}

    这个实现，你可以认为是第三方插件过来的实现，下面我们想要获取这个接口的服务，也就是具体的实现，我们需要在META-INF中添加services文件夹，然后在该文件夹中创建一个文件，文件名为服务接口的全限定类名。因此这里完整的文件路径应为：META-INF/services/com.xx.service.LogService ，最后我们需要在该文件中添加服务实现的全限定类名，一行数据一个全限定类名，文件内容如下：

    com.xxx.service.DefaultLogService

    准备工作已经完成，我们就来使用ServiceLoader加载我们的服务。

public class ServiceLoaderTest {
   @Test
   public void test() {
      ServiceLoader<LogService> loader = ServiceLoader.load(LogService.class);

      for (LogService service : loader) {
         System.out.println(service.getClass());
      }
   }
}

    这样就加载了我们的相关实现类了，当然ServiceLoader是一个迭代器，我们也可以使用迭代的方式来获取。

   简要分析下原理

       为什么我们需要放在META-INF/services这个文件夹下，并且文件名称是接口的全限定类名？我们来分析下ServiceLoader相关的代码实现。 

    ServiceLoader.load(clazz.class)

    这里会创建一个ServiceLoader，并进行相关的reload()

private ServiceLoader(Class<S> svc, ClassLoader cl) {
        service = Objects.requireNonNull(svc, "Service interface cannot be null");
        loader = (cl == null) ? ClassLoader.getSystemClassLoader() : cl;
        acc = (System.getSecurityManager() != null) ? AccessController.getContext() : null;
        reload();
    }

    reload()操作，其实是创建了一个LazyIterator，为什么叫做LazyIterator呢？因为只有在真正使用进行迭代的时候，才会进行相关class的载入。我们下面接着看:

public void reload() {
        providers.clear();
        lookupIterator = new LazyIterator(service, loader);
    }

我们在获取真正的实现的时候，会调用ServiceLoader的hasNext进行判断，我们看下hasNext的具体实现:

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;
                //这里lookupIterator使用的就是我们之前创建的LazyIterator
                return lookupIterator.hasNext();
            }

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

 LazyIterator.hasNext()

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

private class LazyIterator
        implements Iterator<S>
    {

        Class<S> service;
        ClassLoader loader;
        Enumeration<URL> configs = null;
        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 {
                    // 这里显示了为什么是在META-INF/services/文件夹下，使用接口的全限定类名作为文件的名称。
                    String fullName = PREFIX + service.getName();
                    if (loader == null)
                        configs = ClassLoader.getSystemResources(fullName);
                    else
                        configs = loader.getResources(fullName);
                } catch (IOException x) {
                    fail(service, "Error locating configuration files", x);
                }
            }
            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);
            } catch (ClassNotFoundException x) {
                fail(service,
                     "Provider " + cn + " not found");
            }
            if (!service.isAssignableFrom(c)) {
                fail(service,
                     "Provider " + cn  + " not a subtype");
            }
            try {
                S p = service.cast(c.newInstance());
                providers.put(cn, p);
                return p;
            } catch (Throwable x) {
                fail(service,
                     "Provider " + cn + " could not be instantiated",
                     x);
            }
            throw new Error();          // This cannot happen
        }

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

    }

ok，分析结束了

 

总结：ServiceLoader的服务的加载是延迟的，需要在META-INF中添加services文件夹，然后在该文件夹中创建一个文件，文件名为服务接口的全限定类名，真正的加载方式采用的还是ClassLoader.getResources()

使用场景：存在多种序列化组件的时候，可以选用不同的序列化组件。

转载于:https://my.oschina.net/guanhe/blog/2875087