ElasticSearch 源码分析 插件机制

在了解ES插件机制的问题前，我们要了解ES组件（Modules），可以大致的认为ES是由一个一个的组件构成的，插件机制只是它的一个组件，具体在(PluginsModule)。

 

接下来我们先看一段Modules.java代码：

public static void processModules(Iterable<Module> modules) {
        for (Module module : modules) {
            if (module instanceof PreProcessModule) {
                for (Module module1 : modules) {
                    ((PreProcessModule) module).processModule(module1);
                }
            }
        }
 }

 

这段功能是处理预处理组件。

 

插件调用的层次为：

Modules->PluginsModule->PluginsService->XXPlugin  都是调用void processModule(Module module)方法。

区别在于

PluginsModule实现的是PreProcessModule接口。

PluginsService是自己本来的方法。

XXPlugin实现的是Plugin接口。

虽然他们都有processModule方法，但不是实现的同一个类。

 

再来看一下插件服务具体实现的类PluginsService，功能是注册ES根目录/[plugins]文件夹下的所有插件，继续看代码：

@Inject
    public PluginsService(Settings settings, Environment environment) {
        super(settings);
        this.environment = environment;

        loadPluginsIntoClassLoader();//动态加载jar包或zip包

        // first, find all the ones that are in the classpath
        Map<String, Plugin> plugins = Maps.newHashMap();
        plugins.putAll(loadPluginsFromClasspath(settings)); //将es-plugin.properties里配置的类加载到Map里。
        Set<String> sitePlugins = sitePlugins(); //获取插件下有_site目录的插件名，如：plugins/[插件名]/_site/

        String[] mandatoryPlugins = settings.getAsArray("plugin.mandatory", null);//委托的插件，用","隔开
        if (mandatoryPlugins != null) {
            Set<String> missingPlugins = Sets.newHashSet();
            for (String mandatoryPlugin : mandatoryPlugins) {
                if (!plugins.containsKey(mandatoryPlugin) && !sitePlugins.contains(mandatoryPlugin) && !missingPlugins.contains(mandatoryPlugin)) {
                    missingPlugins.add(mandatoryPlugin);
                }
            }
            if (!missingPlugins.isEmpty()) {
                throw new ElasticSearchException("Missing mandatory plugins " + missingPlugins);
            }
        }

        logger.info("loaded {}, sites {}", plugins.keySet(), sitePlugins);

        this.plugins = ImmutableMap.copyOf(plugins);

        MapBuilder<Plugin, List<OnModuleReference>> onModuleReferences = MapBuilder.newMapBuilder();
        for (Plugin plugin : plugins.values()) { 
            List<OnModuleReference> list = Lists.newArrayList();
            for (Method method : plugin.getClass().getDeclaredMethods()) { 
                if (!method.getName().equals("onModule")) {
                    continue;
                }
                if (method.getParameterTypes().length == 0 || method.getParameterTypes().length > 1) {
                    logger.warn("Plugin: {} implementing onModule with no parameters or more than one parameter", plugin.name());
                    continue;
                }
                Class moduleClass = method.getParameterTypes()[0];
                if (!Module.class.isAssignableFrom(moduleClass)) {
                    logger.warn("Plugin: {} implementing onModule by the type is not of Module type {}", plugin.name(), moduleClass);
                    continue;
                }
                method.setAccessible(true);
                list.add(new OnModuleReference(moduleClass, method));
            }
            if (!list.isEmpty()) {
                onModuleReferences.put(plugin, list);
            }
        }
        this.onModuleReferences = onModuleReferences.immutableMap();
    }

 

plugins.putAll(loadPluginsFromClasspath(settings)); 需要注意，

因为之前调用了 loadPluginsIntoClassLoader(); 方法动态加载jar，所以es-plugin.properties可以在jar包里出现。