Vert.x Java開(kāi)發(fā)指南——第六章 與第三方的Web服務(wù)集成

感興趣的朋友,可以關(guān)注微信服務(wù)號(hào)“猿學(xué)堂社區(qū)”,或加入“猿學(xué)堂社區(qū)”微信交流群

版權(quán)聲明:本文由作者自行翻譯,未經(jīng)作者授權(quán),不得隨意轉(zhuǎn)發(fā)。

現(xiàn)代應(yīng)用很少位于孤島之上,因?yàn)樗鼈冃枰c其它(分布式)應(yīng)用和服務(wù)集成。集成通常采用API實(shí)現(xiàn),這些API通過(guò)多功能的HTTP協(xié)議公開(kāi)。

本章展示了如何使用Vert.x的HTTP客戶端API與第三方Web服務(wù)集成。

6.1 場(chǎng)景:備份到GitHub Gist

GitHub Gist服務(wù)(https://gist.github.com/)因分享代碼片段到全世界而廣受歡迎。其它服務(wù)可以使用它,一個(gè)例子就是Medium publishing platform,在該平臺(tái),Gist鏈接使代碼片段可以嵌入到出版物內(nèi)部。

GitHub公開(kāi)了一個(gè)詳細(xì)的API用于獲取、創(chuàng)建、更新和刪除Gist。該API使用以http://api.github.com/開(kāi)始的HTTPS端點(diǎn)和JSON荷載。

雖然許多操作使用OAuth認(rèn)證從客戶端獲取授權(quán),但在匿名的情況下創(chuàng)建Gist是可能的。我們將利用這個(gè)特征備份我們的wiki頁(yè)面為Gist。

一個(gè)新的按鈕將被添加到wiki index頁(yè)面:

這里寫(xiě)圖片描述

點(diǎn)擊backup按鈕將觸發(fā)一個(gè)Gist的創(chuàng)建操作:

這里寫(xiě)圖片描述

備份Gist由每個(gè)Wiki頁(yè)面一個(gè)文件組成,內(nèi)容是未加工的Markdown文本:

這里寫(xiě)圖片描述

6.2 更新數(shù)據(jù)庫(kù)服務(wù)

在我們深入Web客戶端API,并執(zhí)行到其它服務(wù)的HTTP請(qǐng)求之前,我們需要更新數(shù)據(jù)庫(kù)服務(wù)API,一次性獲取所有的Wiki頁(yè)面。這相當(dāng)于添加下面的SQL查詢到db-queries.properties:

all-pages-data=select * from Pages

添加一個(gè)新的方法到WikiDatabaseService接口:

@Fluent
WikiDatabaseService fetchAllPagesData(Handler<AsyncResult<List<JsonObject>>> resultHandler);

WikiDatabaseServiceImpl中的實(shí)現(xiàn)如下:

@Override
public WikiDatabaseService fetchAllPagesData(Handler<AsyncResult<List<JsonObject>>> resultHandler) {
    dbClient.query(sqlQueries.get(SqlQuery.ALL_PAGES_DATA), queryResult -> {
        if (queryResult.succeeded()) {
            resultHandler.handle(Future.succeededFuture(queryResult.result().getRows()));
        } else {
            LOGGER.error("Database query error", queryResult.cause());
            resultHandler.handle(Future.failedFuture(queryResult.cause()));
        }
    });
    return this;
}

6.3 Web客戶端API

Vert.x核心庫(kù)在vertx上下文對(duì)象提供了一個(gè)createHttpClient方法。io.vertx.core.http.HttpClient實(shí)例提供了底層的方法用于執(zhí)行所有類型的HTTP請(qǐng)求,并對(duì)協(xié)議和事件流進(jìn)行細(xì)粒度控制。

Web客戶端API提供了一個(gè)簡(jiǎn)單的外觀,尤其是簡(jiǎn)化了荷載的編組與解組。該API以一種新的依賴的形式出現(xiàn):

<dependency>
    <groupId>io.vertx</groupId>
    <artifactId>vertx-web-client</artifactId>
    <version>${vertx.version}</version>
</dependency>

以下是來(lái)自一個(gè)單元測(cè)試的樣例用法。它啟動(dòng)一個(gè)HTTP服務(wù)器,然后使用Web客戶端API執(zhí)行一個(gè)HTTP GET請(qǐng)求,檢查到服務(wù)器的請(qǐng)求是否成功:

@Test
public void start_http_server(TestContext context) {
    Async async = context.async();
    vertx.createHttpServer()
            .requestHandler(req -> req.response().putHeader("Content-Type", "text/plain").end("Ok"))
            .listen(8080,context.asyncAssertSuccess(server -> {
                WebClient webClient = WebClient.create(vertx);
                webClient.get(8080, "localhost", "/").send(ar -> {
                    if (ar.succeeded()) {
                        HttpResponse<Buffer> response = ar.result();
                        context.assertTrue(response.headers().contains("Content-Type"));
                        context.assertEquals("text/plain",response.getHeader("Content-Type"));
                        context.assertEquals("Ok", response.body().toString());
                        webClient.close();
                        async.complete();
                    } else {
                        async.resolve(Future.failedFuture(ar.cause()));
                    }
                });
            }));
}

6.4 創(chuàng)建匿名的Gist

我們首先創(chuàng)建一個(gè)Web客戶端對(duì)象,然后向Gist API發(fā)出HTTP請(qǐng)求:

webClient = WebClient.create(vertx, new WebClientOptions()
    .setSsl(true)
    .setUserAgent("vert-x3"));

由于請(qǐng)求使用HTTPS構(gòu)造,我們需要配置Web客戶端支持SSL。

?

GitHub API需要一個(gè)有效的User-Agent頭,并請(qǐng)求一個(gè)GitHub賬號(hào)或者組織標(biāo)識(shí)。我們復(fù)寫(xiě)默認(rèn)的User-Agent為vert-x3,但是你可以選擇你自己的值替代。

我們接下來(lái)修改HttpServerVerticle類中的Web路由配置,為觸發(fā)備份添加一個(gè)新的路由:

router.get("/backup").handler(this::backupHandler);

該處理器的代碼如下:

private void backupHandler(RoutingContext context) {
    dbService.fetchAllPagesData(reply -> {
        if (reply.succeeded()) {
            JsonObject filesObject = new JsonObject();
            JsonObject gistPayload = new JsonObject() ①
                .put("files", filesObject)
                .put("description", "A wiki backup")
                .put("public", true);
            reply.result().forEach(page -> {
                JsonObject fileObject = new JsonObject(); ②
                filesObject.put(page.getString("NAME"), fileObject);
                fileObject.put("content", page.getString("CONTENT"));
            });
            webClient.post(443, "api.github.com", "/gists") ③
                .putHeader("Accept", "application/vnd.github.v3+json") ④
                .putHeader("Content-Type", "application/json")
                .as(BodyCodec.jsonObject()) ⑤
                .sendJsonObject(gistPayload, ar -> { ⑥
                    if (ar.succeeded()) {
                        HttpResponse<JsonObject> response = ar.result();
                        if (response.statusCode() == 201) {
                            context.put("backup_gist_url", response.body().getString("html_url")); ⑦
                            indexHandler(context);
                        } else {
                            StringBuilder message = new StringBuilder()
                                .append("Could not backup the wiki: ")
                                .append(response.statusMessage());
                            JsonObject body = response.body();
                            if (body != null) {
                                message.append(System.getProperty("line.separator"))
                                        .append(body.encodePrettily());
                            }
                            LOGGER.error(message.toString());
                            context.fail(502);
                        }
                    } else {
                        Throwable err = ar.cause();
                        LOGGER.error("HTTP Client error", err);
                        context.fail(err);
                    }
                });
            } else {
                context.fail(reply.cause());
            }
    });
}

① Gist創(chuàng)建的請(qǐng)求載荷(payload)是一個(gè)JSON文檔,如GitHub API文檔(https://developer.github.com/v3/gists/#create-a-gist)中所描述。

② 每個(gè)文件是載荷files對(duì)象中的一條記錄,title為鍵,值為文本。

③ web客戶端需要發(fā)出一個(gè)POST請(qǐng)求到443端口(HTTPS),路徑必須為/gists。

④ 請(qǐng)求中強(qiáng)制包含一個(gè)Accept頭,使用application/vnd.github.v3+json MIME類型,否則請(qǐng)求會(huì)失敗。在下一行中指定有效載荷是JSON對(duì)象也很重要。

⑤ BodyCodec類提供了一個(gè)助手,明確規(guī)定將響應(yīng)直接轉(zhuǎn)換為Vert.x的JsonObject實(shí)例。它也可以使用BodyCodec#json(Class<T>)方法,將JSON數(shù)據(jù)將映射為一個(gè)Java對(duì)象,類型為T(mén)(底層使用了Jackson數(shù)據(jù)映射)。

⑥ sendJsonObject是一個(gè)助手方法,用于觸發(fā)JSON載荷的HTTP請(qǐng)求。

⑦ 當(dāng)成功時(shí),我們可以通過(guò)JSON數(shù)據(jù)(html_url鍵)來(lái)獲得新建Gist的用戶友好的URL。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書(shū)系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,606評(píng)論 6 533
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 98,582評(píng)論 3 418
  • 文/潘曉璐 我一進(jìn)店門(mén),熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái),“玉大人,你說(shuō)我怎么就攤上這事。” “怎么了?”我有些...
    開(kāi)封第一講書(shū)人閱讀 176,540評(píng)論 0 376
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)。 經(jīng)常有香客問(wèn)我,道長(zhǎng),這世上最難降的妖魔是什么? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 63,028評(píng)論 1 314
  • 正文 為了忘掉前任,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 71,801評(píng)論 6 410
  • 文/花漫 我一把揭開(kāi)白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開(kāi)封第一講書(shū)人閱讀 55,223評(píng)論 1 324
  • 那天,我揣著相機(jī)與錄音,去河邊找鬼。 笑死,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,294評(píng)論 3 442
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了?” 一聲冷哼從身側(cè)響起,我...
    開(kāi)封第一講書(shū)人閱讀 42,442評(píng)論 0 289
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒(méi)想到半個(gè)月后,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 48,976評(píng)論 1 335
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 40,800評(píng)論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 42,996評(píng)論 1 369
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,543評(píng)論 5 360
  • 正文 年R本政府宣布,位于F島的核電站,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 44,233評(píng)論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 34,662評(píng)論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 35,926評(píng)論 1 286
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 51,702評(píng)論 3 392
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 47,991評(píng)論 2 374

推薦閱讀更多精彩內(nèi)容