2021年10月19日更新
近期發(fā)現(xiàn)這篇文章閱讀量還不少病涨，為了避免誤導(dǎo)大家熬北，更新一下說法疙描。這種插件化的方式其實是我早期自己的探索，核心是JAVA的SPI機制讶隐，這種機制下起胰，通過熱加載的方式實現(xiàn)插件。之前看sentinel的源碼巫延，充滿了SPI的使用效五。這種模式有一點點領(lǐng)域驅(qū)動設(shè)計里的四層結(jié)構(gòu)的理念，算是我自己思考的一個萌芽炉峰，其實業(yè)界早有人已經(jīng)做的很深了畏妖。推薦大家學(xué)習(xí)領(lǐng)域驅(qū)動設(shè)計，高內(nèi)聚疼阔、低耦合戒劫、可復(fù)用是永遠的追求。
在網(wǎng)上看了幾篇插件化開發(fā)的文章婆廊，都比較繁瑣迅细，不直接。我理解最關(guān)鍵的部分是如何在springboot啟動后否彩，加載外部的依賴jar包疯攒，還有從如何從配置中得到實現(xiàn)類名并加載。
通過這樣的模式列荔，可以實現(xiàn)主程序中只有一個接口敬尺，通過依賴lib+配置的方式在主程序中調(diào)起實際的實現(xiàn)方法并執(zhí)行。
后續(xù)的開發(fā)測試模式應(yīng)該是這樣：
- 主程序負(fù)責(zé)最基礎(chǔ)的功能
- 為所有可插件化的功能設(shè)計接口
- 開發(fā)插件jar包贴浙，完成后放到主程序的lib目錄下
- 主程序修改配置文件重啟（或熱加載）來加載功能
- 每個接口有統(tǒng)一的測試方法砂吞，實現(xiàn)不同插件的測試
Serviceloader方式
serviceloader是java提供的spi模式的實現(xiàn)。按照接口開發(fā)實現(xiàn)類崎溃，而后配置蜻直，java通過ServiceLoader來實現(xiàn)統(tǒng)一接口不同實現(xiàn)的依次調(diào)用。與springboot結(jié)合后，該方式要實現(xiàn)的關(guān)鍵點有：
- 在springboot啟動時調(diào)用加載lib目錄下所有jar包的方法概而。
- 在需要調(diào)用服務(wù)時呼巷，使用ServiceLoader的方式來動態(tài)加載所有類。
- 定義接口和實現(xiàn)類赎瑰，接口必須在主程序中加載王悍，實現(xiàn)類可以不在主程序中。
上代碼餐曼，這里沒有在springboot啟動時加載lib目錄压储，而是為了測試方便在每次調(diào)用接口時都加載一次。
//接口類
package com.example.demo;
public interface IHello {
public void sayHello();
}
//實現(xiàn)類源譬，這個類可放在主程序中集惋，也可以放在新的jar包里
public class dogHello implements IHello {
@Override
public void sayHello() {
System.out.println("WANG WANG");
}
}
//實現(xiàn)類，這個類可放在主程序中踩娘，也可以放在新的jar包里刮刑，這里放在catHello.jar中
package com.example.demo;
public class catHello implements IHello {
@Override
public void sayHello() {
System.out.println("MIAO MIAO");
}
}
//META-INF/services/com.example.demo.IHello文件
com.example.demo.dogHello
com.example.demo.catHello
//動態(tài)加載lib下所有jar包的方法
public class Utils {
public static String getApplicationFolder() {
String path = Utils.class.getProtectionDomain().getCodeSource().getLocation().getPath();
return new File(path).getParent();
}
public static void loadJarsFromAppFolder() throws Exception {
String path = "./lib";
File f = new File(path);
if (f.isDirectory()) {
for (File subf : f.listFiles()) {
if (subf.isFile()) {
loadJarFile(subf);
}
}
} else {
loadJarFile(f);
}
}
public static void loadJarFile(File path) throws Exception {
URL url = path.toURI().toURL();
// 可以獲取到AppClassLoader，可以提到前面霸饲，不用每次都獲取一次
URLClassLoader classLoader = (URLClassLoader) ClassLoader.getSystemClassLoader();
// 加載
Method method = URLClassLoader.class.getDeclaredMethod("addURL", URL.class);
method.setAccessible(true);
method.invoke(classLoader, url);
}
}
//主程序
@SpringBootApplication
@Controller
public class DemoApplication {
public static void main(String[] args) {
SpringApplication.run(DemoApplication.class, args);
}
@RequestMapping(value = "/",method = RequestMethod.GET)
@ResponseBody
public String index() throws Exception {
Utils.loadJarsFromAppFolder();
ServiceLoader<IHello> serviceLoader= ServiceLoader.load(IHello.class);
for (IHello hello:serviceLoader){
hello.sayHello();
}
return "hello world!";
}
}
只需要把catHello.jar放在編譯后代碼的lib目錄下为朋，然后執(zhí)行臂拓，就可以實現(xiàn)訪問一次localhost:8080厚脉，就在控制臺輸出一次
WANG WANG
MIAO MIAO
此外，ServiceLoader這個類大部分是靜態(tài)接口胶惰，其實我們可以自己復(fù)制一份改名稱ProjectServiceLoader來進行修改傻工，比如可以修改不從META-INF來加載等等，再說看看ServiceLoader源碼還是很有趣的孵滞。
自定義方式
基于上面的方式中捆，Serviceloader其實是有缺陷的，就是必須在META-INF里定義接口名稱的文件坊饶，在文件中才能寫上實現(xiàn)類的類名泄伪，如果一個項目里插件化的東西比較多，那很可能會出現(xiàn)越來越多配置文件的情況匿级。
考慮把配置全部都放到application.yml里蟋滴。
server :
port : 8080
impl:
//也可以考慮不在這里寫包名，而是在程序里進行拼裝
name : com.example.demo.IHello
clazz :
- com.example.demo.dogHello
- com.example.demo.catHello
接下來定義一下讀取impl配置的類痘绎，這里用了lombok
package com.example.demo.configuration;
import lombok.Getter;
import lombok.Setter;
import lombok.ToString;
import org.springframework.boot.context.properties.ConfigurationProperties;
@ConfigurationProperties("impl")
@ToString
public class ClassImpl {
@Getter
@Setter
String name;
@Getter
@Setter
String[] clazz;
}
主程序里的代碼改成：
package com.example.demo;
@SpringBootApplication
@Controller
@EnableConfigurationProperties({ClassImpl.class})
public class DemoApplication {
public static void main(String[] args) {
SpringApplication.run(DemoApplication.class, args);
}
@Autowired
ClassImpl classImpl;
@RequestMapping(value = "/",method = RequestMethod.GET)
@ResponseBody
public String index() throws Exception {
Utils.loadJarsFromAppFolder("lib");
for (int i=0;i<classImpl.getClazz().length;i++) {
Class helloClass= Class.forName(classImpl.getClazz()[i]);
IHello hello = (IHello) helloClass.newInstance();
hello.sayHello();
}
return "hello world!";
}
}
當(dāng)然還有很多異常處理沒有做津函，實際使用中要記得補上。還有就是java的反射機制效率并不高孤页，所以要考慮反射出實例一次后尔苦，盡量嘗試復(fù)用，這就要求接口設(shè)計要好一點了。
其實根據(jù)這樣的模式允坚，其實都可以實現(xiàn)在數(shù)據(jù)庫中配置實現(xiàn)類了魂那。
上面的兩種方法基本其實脫離了springboot，直接使用java插件化的模式考慮了稠项，后續(xù)可以進一步看看如何將加載到的jar包變成bean來調(diào)用冰寻。
