上線了:用自己手搓的高性能網(wǎng)關(guān)訪問(wèn)后端服務(wù)是種什么感受?
一、本節(jié)重點(diǎn)
實(shí)戰(zhàn)通過(guò)高性能Polaris網(wǎng)關(guān)訪問(wèn)后端服務(wù),深入理解高性能Polaris網(wǎng)關(guān)啟動(dòng)流程、請(qǐng)求路由轉(zhuǎn)發(fā)流程和響應(yīng)結(jié)果的流程設(shè)計(jì)與實(shí)現(xiàn)。重點(diǎn)掌握整體調(diào)用鏈路的設(shè)計(jì)思路和設(shè)計(jì)方法,并能夠?qū)⑵潇`活應(yīng)用到自身實(shí)際項(xiàng)目中。
二、實(shí)戰(zhàn)場(chǎng)景
本節(jié),通過(guò)高性能網(wǎng)關(guān)訪問(wèn)后端服務(wù)接口主要驗(yàn)證如下幾個(gè)簡(jiǎn)單的場(chǎng)景,驗(yàn)證高性能Polaris網(wǎng)關(guān)的核心功能:
- 只啟動(dòng)后端服務(wù),直接訪問(wèn)后端服務(wù)接口,正確返回hello polaris。
- 啟動(dòng)網(wǎng)關(guān)和后端服務(wù),通過(guò)網(wǎng)關(guān)訪問(wèn)后端服務(wù)接口,正確返回hello polaris。
- 停止后端服務(wù),通過(guò)網(wǎng)關(guān)訪問(wèn)后端服務(wù)接口,返回503:后端服務(wù)暫時(shí)不可用,請(qǐng)稍后再試。
三、服務(wù)規(guī)劃
實(shí)戰(zhàn)通過(guò)高性能Polaris網(wǎng)關(guān)訪問(wèn)后端服務(wù)的規(guī)劃如下所示。
四、測(cè)試服務(wù)實(shí)現(xiàn)
1.實(shí)現(xiàn)后端服務(wù)
用于測(cè)試的后端服務(wù)的實(shí)現(xiàn)比較簡(jiǎn)單,主要是通過(guò)SpringBoot快速實(shí)現(xiàn)一個(gè)訪問(wèn)接口。
源碼詳見:polaris-examples-http工程下的io.binghe.polaris.examples.http.controller.HttpController
@RestController
public class HttpController {
@RequestMapping(value = "/http_test")
public String helloPolaris(){
return "hello polaris";
}
}
就是這么簡(jiǎn)單,實(shí)現(xiàn)一個(gè)簡(jiǎn)單的HTTP接口用于測(cè)試即可,正常情況下,接口會(huì)返回hello polaris。
隨后,基于SpringBoot實(shí)現(xiàn)后端服務(wù)的啟動(dòng)類即可。
源碼詳見:polaris-examples-http工程下的io.binghe.polaris.examples.http.HttpExampleStarter。
@SpringBootApplication
public class HttpExampleStarter {
public static void main(String[] args) {
SpringApplication.run(HttpExampleStarter.class, args);
}
}
至此,后端服務(wù)實(shí)現(xiàn)完畢。
2.實(shí)現(xiàn)網(wǎng)關(guān)啟動(dòng)服務(wù)
由于Polaris網(wǎng)關(guān)在啟動(dòng)時(shí),需要通過(guò)服務(wù)發(fā)現(xiàn)從注冊(cè)中心獲取后端服務(wù)調(diào)用器對(duì)象,后端服務(wù)的定義對(duì)象、網(wǎng)關(guān)過(guò)濾器規(guī)則、后端服務(wù)實(shí)例對(duì)象等,將其存放到本地緩存并定期更新。由于目前我們是測(cè)試網(wǎng)關(guān)訪問(wèn)后端服務(wù)的接口,先直接創(chuàng)建對(duì)應(yīng)的實(shí)例對(duì)象放到本地緩存。
后續(xù)我們會(huì)通過(guò)SPI對(duì)接多個(gè)注冊(cè)中心實(shí)現(xiàn)服務(wù)注冊(cè)與發(fā)現(xiàn),基于SPI對(duì)接多個(gè)配置中心,基于SPI實(shí)現(xiàn)多種負(fù)載均衡算法,實(shí)現(xiàn)熔斷限流,實(shí)現(xiàn)網(wǎng)關(guān)熱插拔插件,并且為了簡(jiǎn)化服務(wù)對(duì)接網(wǎng)關(guān),也會(huì)專門設(shè)計(jì)和開發(fā)服務(wù)對(duì)接網(wǎng)關(guān)的SDK等等,妥妥的企業(yè)級(jí)網(wǎng)關(guān)。
好了,開始實(shí)現(xiàn)網(wǎng)關(guān)的啟動(dòng)服務(wù)。
源碼詳見:polaris-examples-http-gateway工程下的io.binghe.polaris.examples.http.HttpExampleGatewayStarter。
為了大家理解的更加清晰,這里,我對(duì)HttpExampleGatewayStarter類的實(shí)現(xiàn)方法進(jìn)行拆解。
(1)實(shí)現(xiàn)main()方法
main()方法也是測(cè)試網(wǎng)關(guān)的啟動(dòng)服務(wù)的入口,主要實(shí)現(xiàn)如下所示。
public static void main(String[] args) {
// 初始化后端服務(wù)相關(guān)配置
initServiceConfig();
// 啟動(dòng)網(wǎng)關(guān)
startPolaris(args);
}
可以看到,在main()方法的實(shí)現(xiàn)中,主要調(diào)用了initServiceConfig()方法初始化后端服務(wù)配置,隨后調(diào)用了startPolaris()方法加載網(wǎng)關(guān)的核心配置并啟動(dòng)網(wǎng)關(guān)。
(2)實(shí)現(xiàn)initServiceConfig()方法
initServiceConfig()方法是模擬服務(wù)發(fā)現(xiàn)加載后端服務(wù)配置的核心方法,這里,對(duì)initServiceConfig()方法的實(shí)現(xiàn)進(jìn)行拆解。
定義基礎(chǔ)變量
定義后端服務(wù)的基本信息,例如訪問(wèn)的后端接口path,服務(wù)id,版本號(hào)、唯一id、規(guī)則id、訪問(wèn)協(xié)議、目標(biāo)后端服務(wù)地址等,源碼如下所示。
// 接口path
String path = "/http_test";
String serviceId = "100001";
String version = "1.0.0";
String uniqueId = serviceId + ":" + version;
String ruleId = "10001";
String protocol = "http";
String targetAddress = "localhost:8080";
這里,需要注意的是通過(guò)網(wǎng)關(guān)訪問(wèn)后端服務(wù)時(shí),請(qǐng)求頭中需要攜帶uniqueId。
創(chuàng)建服務(wù)調(diào)用器對(duì)象
創(chuàng)建服務(wù)調(diào)用器對(duì)象的源碼如下所示。
// 創(chuàng)建ServiceInvoker對(duì)象
ServiceInvoker serviceInvoker = new HttpServiceInvoker();
serviceInvoker.setInvokerPath(path);
serviceInvoker.setRuleId(ruleId);
serviceInvoker.setTimeout(5000);
可以看到,在serviceInvoker服務(wù)調(diào)用器對(duì)象中,主要封裝了調(diào)用后端服務(wù)的path,規(guī)則id和超時(shí)時(shí)間。
創(chuàng)建服務(wù)定義對(duì)象
服務(wù)定義對(duì)象會(huì)注冊(cè)到服務(wù)注冊(cè)中心,是對(duì)后端服務(wù)的一種描述,會(huì)封裝后端服務(wù)的詳情信息,源碼如下所示。
// 創(chuàng)建ServiceDefinition對(duì)象,后續(xù)注冊(cè)到注冊(cè)中心
ServiceDefinition serviceDefinition = new ServiceDefinition();
serviceDefinition.setServiceId(serviceId);
serviceDefinition.setVersion(version);
serviceDefinition.setUniqueId(uniqueId);
serviceDefinition.setProtocol(protocol);
serviceDefinition.setPatternPath(path);
serviceDefinition.setEnvType("local");
Map<String, ServiceInvoker> invokerMap = new HashMap<>();
invokerMap.put(path, serviceInvoker);
serviceDefinition.setInvokerMap(invokerMap);
ConfigCacheFactory.getInstance().putServiceDefinition(uniqueId, serviceDefinition);
可以看到,serviceDefinition服務(wù)定義對(duì)象中主要封裝后端服務(wù)的定義信息,并切會(huì)封裝封裝后端服務(wù)path與服務(wù)調(diào)用器的關(guān)系,最終會(huì)將serviceDefinition服務(wù)定義對(duì)象存儲(chǔ)到本地緩存。
實(shí)現(xiàn)規(guī)則定義
對(duì)過(guò)濾器的規(guī)則進(jìn)行實(shí)現(xiàn)和封裝,源碼如下所示。
Set<FilterRule> filterRules = new HashSet<>();
FilterRule filterRule = new FilterRule();
filterRule.setId(FilterConstants.LOADBALANCER_FILTER_ID);
filterRule.setConfig("{\"balanceType\" : \"roundRibbonBalance\"}");
filterRules.add(filterRule);
filterRule = new FilterRule();
filterRule.setId(FilterConstants.HTTP_FILTER_ID);
filterRules.add(filterRule);
filterRule = new FilterRule();
filterRule.setId(FilterConstants.ERROR_FILTER_ID);
filterRules.add(filterRule);
Rule rule = new Rule(ruleId, "測(cè)試規(guī)則", protocol, serviceId, path, Arrays.asList(path), 1, filterRules);
ConfigCacheFactory.getInstance().putRule(ruleId, rule);
可以看到,這里會(huì)創(chuàng)建對(duì)個(gè)過(guò)濾器規(guī)則,將其封裝到一個(gè)Set集合中,最終將Set集合封裝到總體規(guī)則對(duì)象Rule中,并存儲(chǔ)到本地緩存。
需要注意的是:每個(gè)規(guī)則的id需要對(duì)應(yīng)過(guò)濾器實(shí)現(xiàn)類上@Filter注解的id屬性的值。
實(shí)現(xiàn)服務(wù)實(shí)例對(duì)象
服務(wù)實(shí)例對(duì)象會(huì)注冊(cè)到服務(wù)注冊(cè)中心,這里模擬創(chuàng)建服務(wù)實(shí)例對(duì)象,并將其存儲(chǔ)到本地緩存。源碼如下所示。
ServiceInstance serviceInstance = new ServiceInstance();
serviceInstance.setInstanceId(targetAddress);
serviceInstance.setUniqueId(uniqueId);
serviceInstance.setAddress(targetAddress);
serviceInstance.setWeight(100);
serviceInstance.setRegisterTime(System.currentTimeMillis());
serviceInstance.setVersion(version);
ConfigCacheFactory.getInstance().addServiceInstance(uniqueId, serviceInstance);
可以看到,服務(wù)實(shí)例對(duì)象中封裝了后端服務(wù)實(shí)例的具體信息,包括服務(wù)的目標(biāo)地址,唯一id、權(quán)重、注冊(cè)時(shí)間、版本號(hào)等,最終將服務(wù)實(shí)例存儲(chǔ)到本地緩存。
(3)實(shí)現(xiàn)startPoalris()方法
startPoalris()方法是啟動(dòng)Poalris網(wǎng)關(guān)的核心方法,源碼如下所示。
private static void startPolaris(String[] args) {
// 加載配置
PolarisConfig polarisConfig = PolarisConfigLoader.getInstance().loadConfig(args);
// 初始化容器
PolarisContainer container = new PolarisContainer(polarisConfig);
// 啟動(dòng)容器
container.start();
// 優(yōu)雅關(guān)閉
Runtime.getRuntime().addShutdownHook(new Thread(container::shutdown));
}
相信小伙伴們對(duì)于startPolaris()方法的實(shí)現(xiàn)并不陌生,加載網(wǎng)關(guān)核心配置,創(chuàng)建并啟動(dòng)容器來(lái)驅(qū)動(dòng)網(wǎng)關(guān)的運(yùn)行,在優(yōu)雅關(guān)閉中停止容器。
至此,高性能Polaris網(wǎng)關(guān)的測(cè)試程序?qū)崿F(xiàn)完畢。
五、測(cè)試場(chǎng)景驗(yàn)證
接下來(lái),對(duì)網(wǎng)關(guān)的測(cè)試場(chǎng)景進(jìn)行驗(yàn)證。
場(chǎng)景一: 只啟動(dòng)后端服務(wù),直接訪問(wèn)后端服務(wù)接口,正確返回hello polaris。
只啟動(dòng)后端服務(wù)后,通過(guò)Apifox訪問(wèn)http://localhost:8080/http_test,如下所示。
測(cè)試結(jié)果符合預(yù)期,正確返回了hello polaris字符串。
場(chǎng)景二: 啟動(dòng)網(wǎng)關(guān)和后端服務(wù),通過(guò)網(wǎng)關(guān)訪問(wèn)后端服務(wù)接口,正確返回hello polaris。
啟動(dòng)網(wǎng)關(guān)和后端服務(wù)后,通過(guò)Apifox訪問(wèn)http://localhost:10000/http_test,如下所示。
測(cè)試結(jié)果符合預(yù)期,正確返回了hello polaris字符串。
場(chǎng)景三: 停止后端服務(wù),通過(guò)網(wǎng)關(guān)訪問(wèn)后端服務(wù)接口,返回503:后端服務(wù)暫時(shí)不可用,請(qǐng)稍后再試。
停止后端服務(wù)后,通過(guò)Apifox訪問(wèn)http://localhost:10000/http_test,如下所示。
測(cè)試結(jié)果符合預(yù)期,正確返回了503:后端服務(wù)暫時(shí)不可用,請(qǐng)稍后再試。
六、本節(jié)總結(jié)
本節(jié)主要以實(shí)現(xiàn)的形式通過(guò)高性能Poalris網(wǎng)關(guān)訪問(wèn)后端服務(wù)接口,對(duì)典型的正常和異常場(chǎng)景都進(jìn)行了驗(yàn)證,結(jié)果都符合預(yù)期效果。
希望這節(jié)內(nèi)容能夠?yàn)榇蠹規(guī)?lái)實(shí)質(zhì)性的收獲,最后,可以在評(píng)論區(qū)寫下你學(xué)完本章節(jié)的收獲,祝大家都能學(xué)有所成,我們一起搞定高性能Polaris網(wǎng)關(guān)。