Retrofit系列文章翻譯8—自定義一個響應轉(zhuǎn)換器

原文鏈接:https://futurestud.io/blog/retrofit-send-objects-in-request-body
本篇介紹了在 Retrofit 里如何設置自定義 JSON 轉(zhuǎn)換器役纹。下面的列表顯示了該系列的所有文章:

在 Retrofit 2里實現(xiàn)自定義響應轉(zhuǎn)換器是一個復雜的過程. 我們一定會寫一篇關(guān)于如何在 Retrofit 2中創(chuàng)建和集成自己的響應轉(zhuǎn)換器的另一篇博客. 一旦發(fā)布忌怎,我們將在此處鏈接和更新本說明竣况。(原文評論里提到 Retrofit 2的自定義轉(zhuǎn)換器教程不會公開發(fā)布了, 有讀者自己做了實現(xiàn), 可以參考, 譯者注)

Retrofit 系列目錄

  1. 開始創(chuàng)建android客戶端[已翻譯]
  2. Android上的基本認證[已翻譯]
  3. Android上的令牌認證[已翻譯]
  4. Android上的OAuth
  5. 多個 Query 參數(shù)使用同一名字[已翻譯]
  6. 同步與異步請求[已翻譯]
  7. 在請求體里發(fā)送對象[已翻譯]
  8. 自定義一個響應轉(zhuǎn)換器
  9. 添加自定義請求頭
  10. 可選的 Query 參數(shù)
  11. 如何集成 XML 轉(zhuǎn)換器
  12. 使用 Log Level 調(diào)試請求
  13. 如何上傳文件
  14. Series Round-Up
  15. Retrofit 2 — 1.9 升級指南
  16. Retrofit 2 — 如何上傳文件
  17. Retrofit 2 — Log 請求與響應
  18. Retrofit 2 — Android 上的 Hawk 認證
  19. Retrofit 2 — 簡單錯誤處理
  20. 如何在 Retrofit 1 里使用 OkHttp 3
  21. Retrofit 2 — 圖書更新發(fā)布慶典
  22. 提交表單數(shù)據(jù) — Urlencoded
  23. 提交表單數(shù)據(jù) — Urlencoded 使用FieldMap
  24. Retrofit 2 — 在 OkHttp 攔截器里管理請求頭部
  25. Retrofit 2 — 如何給每一個請求添加 Query 參數(shù)
  26. Retrofit 2 — 使用QueryMap 添加多個 Query 參數(shù)
  27. Retrofit 2 — 如何在請求時使用動態(tài) Url
  28. Retrofit 2 — Url 處理团驱,分辨和解析
  29. Retrofit 2 — POST 和PUT 請求里的常量, 默認值和邏輯值
  30. Retrofit 2 — 如何下載文件
  31. Retrofit 2 — 取消請求
  32. Retrofit 2 — 重用分析請求
  33. Retrofit 2 — 如何在運行時修改 API Base Url
  34. 可選Path參數(shù)
  35. 如何刷新 Access Token
  36. Retrofit 2 — 如何提交文本請求體
  37. Retrofit 2 — 使用 Query 參數(shù)來分頁
  38. Retrofit 2 — 使用 鏈接頭和動態(tài) Url 來分頁(比如GitHub)
  39. Retrofit 2 — 使用范圍頭字段來分頁 (比如 Heroku)
  40. Retrofit 2 — 轉(zhuǎn)換器介紹
  41. Retrofit 2 — 添加并自定義 Gson 轉(zhuǎn)換器
  42. Retrofit 2 — 實現(xiàn)自定義轉(zhuǎn)換器
  43. Retrofit 2 — 只在開發(fā)環(huán)境里啟用日志
  44. Retrofit 2 — 如何上傳多個文件
  45. Retrofit 2 — Passing Multiple Parts Along a File with @PartMap
  46. Retrofit 2 — 模仿服務端響應基本概念
  47. Retrofit 2 — 模仿服務端響應自定義網(wǎng)絡行為
  48. Retrofit 2 — 使用 @HeaderMap 定義動態(tài)請求頭

基礎

Retrofit 默認附帶了 Google's JSON. 每個JSON映射都在GSON的幫助下完成. 有時候叁丧,你的框架或?qū)傩孕枰淖兗傻腏SON轉(zhuǎn)換器. 一個著名的轉(zhuǎn)換器是 Jackson. 我們將使用 Jackson 做為代碼示例.

現(xiàn)有的 Retrofit 轉(zhuǎn)換器

除了 GSON, Retrofit 可被配置成各種內(nèi)容格式. retrofit-converters 目錄列出了現(xiàn)有的響應轉(zhuǎn)換器:

與gradle的整合可以用以下命令來完成:

compile 'com.squareup.retrofit:converter-<converter-name>:1.9.0'

# e.g. Jackson
compile 'com.squareup.retrofit:converter-jackson:1.9.0'

# e.g. XML
compile 'com.squareup.retrofit:converter-simplexml:1.9.0' 

你應該知道如何整合 protocol buffers :)

創(chuàng)建你自己的轉(zhuǎn)換器

一旦你需要或想要創(chuàng)建自己的 Retrofit 響應轉(zhuǎn)換器咳蔚,你可以按照下面的步驟. 我們將使用 Jackson 庫來說明具體的定義和處理.
記住: 目前已有的 Retrofit 轉(zhuǎn)換器 你可以通過集成各自的gradle依賴直接使用它們.

Jackson Gradle 依賴

首先, 定義 Jackson 依賴. 本例使用的是 Jackson 2.x ,與以前的 Jackson 1.x 有很大的不同. 添加需要的 Maven 庫和編譯依賴.

repositories {  
    maven { url "http://repository.codehaus.org/org/codehaus" }
}

dependencies {  
    compile 'com.fasterxml.jackson.core:jackson-databind:2.4.3'
}

實現(xiàn)自定義的 JSON 轉(zhuǎn)換器

替換 Retrofit 的 JSON 轉(zhuǎn)換器最重要的部分是實現(xiàn) Converter 接口并覆蓋兩個方法: fromBody and toBody.

public class JacksonConverter implements Converter {
    private ObjectMapper mapper = new ObjectMapper();

    @Override
    public Object fromBody(TypedInput body, Type type) throws ConversionException {
        JavaType javaType = mapper.getTypeFactory().constructType(type);

        try {
            return mapper.readValue(body.in(), javaType);
        } catch (IOException e) {
            throw new ConversionException(e);
        }
    }

    @Override
    public TypedOutput toBody(Object object) {
        try {
            String charset = "UTF-8";
            String json = mapper.writeValueAsString(object);
            return new JsonTypedOutput(json.getBytes(charset));
        } catch (IOException e) {
            throw new AssertionError(e);
        }
    }

    private static class JsonTypedOutput implements TypedOutput {
        private final byte[] jsonBytes;

        JsonTypedOutput(byte[] jsonBytes) { this.jsonBytes = jsonBytes; }

        @Override public String fileName() { return null; }
        @Override public String mimeType() { return "application/json; charset=UTF-8"; }
        @Override public long length() { return jsonBytes.length; }
        @Override public void writeTo(OutputStream out) throws IOException { out.write(jsonBytes); }
    }
}

JsonTypedOutput 類被用來設置正確的 mimeType. 由于輸出類型是JSON, mime 類型也應該是 application/json.

設置自定義JSON轉(zhuǎn)換器

Retrofit 的 JSON轉(zhuǎn)換器被集成在RestAdapter里. 通過調(diào)用RestAdapter對象的setConverter()方法可以改變轉(zhuǎn)換器. 此外, 當創(chuàng)建 rest 客戶端時, 你可以在RestAdapter的構(gòu)建過程里直接設置轉(zhuǎn)換器來集成 jackson 轉(zhuǎn)換器.

    // Create our Converter
    JacksonConverter jacksonConverter = new JacksonConverter();

    // Build the Retrofit REST adaptor pointing to the URL specified, with the Converter.
    // Note: The Converter must be set before the .build() command
    RestAdapter restAdapter = new RestAdapter.Builder()
        .setConverter(jacksonConverter)
        .setEndpoint("https://api.example.com/")
        .build();

干得漂亮! 以后你創(chuàng)建的所有RestAdapter都將使用 JacksonConverter 來處理 JSON.

如果你遇到任何問題或困難, 請 Twitter @futurestud_io.

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末端三,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子细卧,更是在濱河造成了極大的恐慌尉桩,老刑警劉巖,帶你破解...
    沈念sama閱讀 218,755評論 6 507
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件贪庙,死亡現(xiàn)場離奇詭異蜘犁,居然都是意外死亡,警方通過查閱死者的電腦和手機止邮,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,305評論 3 395
  • 文/潘曉璐 我一進店門这橙,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人导披,你說我怎么就攤上這事屈扎。” “怎么了盛卡?”我有些...
    開封第一講書人閱讀 165,138評論 0 355
  • 文/不壞的土叔 我叫張陵助隧,是天一觀的道長筑凫。 經(jīng)常有香客問我滑沧,道長,這世上最難降的妖魔是什么巍实? 我笑而不...
    開封第一講書人閱讀 58,791評論 1 295
  • 正文 為了忘掉前任滓技,我火速辦了婚禮,結(jié)果婚禮上棚潦,老公的妹妹穿的比我還像新娘令漂。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 67,794評論 6 392
  • 文/花漫 我一把揭開白布叠必。 她就那樣靜靜地躺著荚孵,像睡著了一般。 火紅的嫁衣襯著肌膚如雪纬朝。 梳的紋絲不亂的頭發(fā)上收叶,一...
    開封第一講書人閱讀 51,631評論 1 305
  • 那天,我揣著相機與錄音共苛,去河邊找鬼判没。 笑死,一個胖子當著我的面吹牛隅茎,可吹牛的內(nèi)容都是我干的澄峰。 我是一名探鬼主播,決...
    沈念sama閱讀 40,362評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼辟犀,長吁一口氣:“原來是場噩夢啊……” “哼俏竞!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起堂竟,我...
    開封第一講書人閱讀 39,264評論 0 276
  • 序言:老撾萬榮一對情侶失蹤胞此,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后跃捣,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體漱牵,經(jīng)...
    沈念sama閱讀 45,724評論 1 315
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,900評論 3 336
  • 正文 我和宋清朗相戀三年疚漆,在試婚紗的時候發(fā)現(xiàn)自己被綠了酣胀。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 40,040評論 1 350
  • 序言:一個原本活蹦亂跳的男人離奇死亡娶聘,死狀恐怖闻镶,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情丸升,我是刑警寧澤铆农,帶...
    沈念sama閱讀 35,742評論 5 346
  • 正文 年R本政府宣布,位于F島的核電站狡耻,受9級特大地震影響墩剖,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜夷狰,卻給世界環(huán)境...
    茶點故事閱讀 41,364評論 3 330
  • 文/蒙蒙 一岭皂、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧沼头,春花似錦爷绘、人聲如沸书劝。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,944評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽购对。三九已至,卻和暖如春陶因,著一層夾襖步出監(jiān)牢的瞬間洞斯,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,060評論 1 270
  • 我被黑心中介騙來泰國打工坑赡, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留烙如,地道東北人。 一個月前我還...
    沈念sama閱讀 48,247評論 3 371
  • 正文 我出身青樓毅否,卻偏偏與公主長得像亚铁,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子螟加,可洞房花燭夜當晚...
    茶點故事閱讀 44,979評論 2 355

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