惊爆！Java插件式开发框架，功能随心增减，无需改代码

对于插件()是什么, 无需过多阐述。像一些常用的软件, 诸如、、等, 都都对插件扩展予以支持。插件能够动态地为软件增添某些功能, 并且也能够随时予以删除, 如此这般的好处在于, 任何人都能够针对这个软件实施功能方面的扩展, 而并非要去改动软件自身的代码。适用场景若要开发一个系统, 此系统用于向客户推送某些数据, 重点不在于推送何种数据。存在三个客户, 甲客户要求将数据整理成xml格式文本, 借助FTP上传至客户服务器乙客户需把数据整合成json格式后, 通过HTTP请求交付丙客户祈愿产生一个Excel文件乃后续借由E-mail发送…往后或许会涌现更多客户, 还会出现诸多令人糟心的需求。假使针对这样一套系统来开展开发工作, 要是运用常普通规的方式去进行打造, 那么每当添补上一个客户, 便需要对系统代码予以一次修改, 于代码里增添一项针对特定某个客户的功用, 这显得极为缺乏灵活性。要是减掉一个客户, 那与之对应的代码便已然失去效用, 究竟要不要将其删去, 这又变成了一个难题。上述仅仅是单一个例子, 于实际开展开发期间, 常常会出现与此相类似的状况, 当这样的时候, 运用插件化的途径会更具灵活性, 更适宜那种情境。要是碰到这种情形, 能够将跟客户无关联的数据获取以及整理 的逻辑置入主程序里, 并且主程序给出一个针对客户推送的接口, 该接口划定了一个还未达成的抽象方法称作“推送数据”, 此方法由各个客户所对应的插件去予以实现。这般一来, 要是新增一项客户需求, 用不着去改动主程序的代码, 仅仅需要去实现这个接口便可, 插件编写妥当打成 jar 包置于指定的目录当中, 接着完成一下配置工作, 主程序能够运用这个插件了。当不需要这个插件的时候, 同样能够借助配置将其去除。主程序配置插件方才提及, 主程序能够依据配置去动态地对插件进行添加以及删除之举配置手段通常存在两种情形, 分别是 XML 这种形式或者数据库此类形式, 从中选取一者便可达成。方法一XML主程序可以通过一个xml配置文件动态配置插件。plugins plugin nameA客户插件name jarD:/plugin/a-plugin.jarjar classcom.xxg.aplugin.APluginclass plugin plugin nameB客户插件name jarD:/plugin/b-plugin.jarjar classcom.xxg.bplugin.BPluginclass plugin plugin nameC客户插件name jarD:/plugin/c-plugin.jarjar classcom.xxg.cplugin.CPluginclass plugin plugins主程序通过解析这个XML来调用插件元素即一个插件可以通过添加和删除要对插件进行动态地添加以及删除, 所依据的是元素, 这里的插件有着特定名称, 其jar文件处于特定某处路径, 并且存在一个类, 这个类是插件用于实现主程序接口的。方法二数据库如果使用数据库来配置插件需要一个插件表idnamejarclassA客户插件D://a-.jarcom.xxg..B客户插件D://b-.jarcom.xxg..C客户插件D://c-.jarcom.xxg..两种方法的区别从功能方面来讲, 两种方式是相同的。采用数据库方式具备的益处便是能够较为便利地再度开创一个用于管理的界面以进行管理, 其不足之处则是依附于数据库。主程序下面是以XML作为插件配置方式的调用插件的主程序。主程序需要提供一个接口来提供给插件开发者来实现package com.xxg.main; public interface PluginService { public void service(); }存在于上方的, 是一个接口, 其之中含有一个尚未被实现的方法, 此方法就是与客户相关联的逻辑, 是要由插件去达成实现的。插件封装类package com.xxg.main; public class Plugin { private String name; private String jar; private String className; // setter、getter省略… }解析XML获取所有插件信息这里用到dom4jpackage com.xxg.main; import java.io.File; import java.util.ArrayList; import java.util.List; import org.dom4j.Document; import org.dom4j.DocumentException; import org.dom4j.Element; import org.dom4j.io.SAXReader; public class XMLParser { public static List getPluginList() throws DocumentException { List list new ArrayList(); SAXReader saxReader new SAXReader(); Document document saxReader.read(new File(plugin.xml)); Element root document.getRootElement(); List plugins root.elements(plugin); for(Object pluginObj : plugins) { Element pluginEle (Element)pluginObj; Plugin plugin new Plugin(); plugin.setName(pluginEle.elementText(name)); plugin.setJar(pluginEle.elementText(jar)); plugin.setClassName(pluginEle.elementText(class)); list.add(plugin); } return list; } }使用动态加载jar文件实例化插件中的对象package com.xxg.main; import java.net.MalformedURLException; import java.net.URL; import java.net.URLClassLoader; import java.util.List; public class PluginManager { private URLClassLoader urlClassLoader; public PluginManager(List plugins) throws MalformedURLException { init(plugins); } private void init(List plugins) throws MalformedURLException { int size plugins.size(); URL[] urls new URL[size]; for(int i 0; i size; i) { Plugin plugin plugins.get(i); String filePath plugin.getJar(); urls[i] new URL(file: filePath); } // 将jar文件组成数组来创建一个URLClassLoader urlClassLoader new URLClassLoader(urls); } public PluginService getInstance(String className) throws ClassNotFoundException, InstantiationException, IllegalAccessException { // 插件实例化对象插件都是实现PluginService接口 Class clazz urlClassLoader.loadClass(className); Object instance clazz.newInstance(); return (PluginService)instance; } }main函数依次调用插件逻辑package com.xxg.main; import java.util.List; public class Main { public static void main(String[] args) { try { List pluginList XMLParser.getPluginList(); PluginManager pluginManager new PluginManager(pluginList); for(Plugin plugin : pluginList) { PluginService pluginService pluginManager.getInstance(plugin.getClassName()); System.out.println(开始执行[ plugin.getName() ]插件...); // 调用插件 pluginService.service(); System.out.println([ plugin.getName() ]插件执行完成); } } catch (Exception e) { e.printStackTrace(); } } }插件开发只需要将主程序的jar包引入到项目之中, 然后实现主程序所提供的接口, 插件开发便会实现, 这一过程是很简单的:package com.xxg.aplugin; import com.xxg.main.PluginService; public class APlugin implements PluginService { Override public void service() { System.out.println(A客户插件正在执行~); } }可以实现客户相关逻辑以实现插件功能的那个方法, 在这里只用一句“out.”来予以替代。插件达成实现之后, 制作一个jar包, 并且要予以留意不能将主程序那个部分放到jar里面哟。再实现其他插件插件实现完成后配置主程序的.xml。运行程序配置好.xml插件jar放到配置的路径下。运行主程序main方法开始执行A客户插件插件…A客户插件正在执行~A客户插件插件执行完成开始执行B客户插件插件…B客户插件正在执行~B客户插件插件执行完成开始执行C客户插件插件…C客户插件正在执行~C客户插件插件执行完成以上就完成了主程序和插件的开发。扩展()参数、返回值若根据逻辑所需, 能够去添加那参数以及返回值的是, 若是为主程序要朝着插件那传入数据之类情形的话就可以加进参数, 要是为插件得朝向主程序去返程结果这样子状态, 那就能够加进返回值。给插件传些其所需的配置项, 像这样。场景之上, 各客户需求有别。A要FTP上传, 就得有其地址、端口号、用户名、密码配置项B要HTTP请求, 便要有请求地址配置项C要发邮件, 就需有e-mail地址配置项。这些配置项可以统一配置在XML或数据库中。XML每个插件元素中加入元素来配置。plugins plugin nameA客户插件name jarD:/plugin/a-plugin.jarjar classcom.xxg.aplugin.APluginclass properties property nameFTP_IP192.168.7.1property property nameFTP_PORT21property property nameFTP_USERNAMEXXGproperty property nameFTP_PASSWORD123456property properties plugin plugin nameB客户插件name jarD:/plugin/b-plugin.jarjar classcom.xxg.bplugin.BPluginclass properties property nameURLhttp://www.xxg.com/apiproperty properties plugin plugin nameC客户插件name jarD:/plugin/c-plugin.jarjar classcom.xxg.cplugin.CPluginclass properties property nameEMAILxxgxxg.comproperty properties plugin plugins数据库如果使用数据库配置的话数据库要再加一个插件配置表idnamevalue192.168.7.121XXGURLEMAIL主程序定义接口加入一个Map参数来传入这些配置package com.xxg.main; import java.util.Map; public interface PluginService { public void service(Map configs); }在插件中可以获取这些配置package com.xxg.aplugin; import java.util.Map; import com.xxg.main.PluginService; public class APlugin implements PluginService { Override public void service(Map configs) { String ftpIp configs.get(FTP_IP); String ftpPort configs.get(FTP_PORT); String ftpUsername configs.get(FTP_USERNAME); String ftpPassword configs.get(FTP_PASSWORD); // ... } }