原文鏈接：https://futurestud.io/blog/android-basic-authentication-with-retrofit
本文是Retrofit系列文章的第二篇。本節(jié)介紹了 Retrofit 如何使用用戶名/郵箱和密碼集成認證功能。下面的列表顯示了該系列的所有文章:
Retrofit 系列目錄
- 開始創(chuàng)建android客戶端[已翻譯]
- Android上的基本認證
- Android上的令牌認證[已翻譯]
- Android上的OAuth
- 多個 Query 參數(shù)使用同一名字[已翻譯]
- 同步與異步請求[已翻譯]
- 在請求體里發(fā)送對象[已翻譯]
- 自定義一個響應(yīng)轉(zhuǎn)換器[已翻譯]
- 添加自定義請求頭
- 可選的 Query 參數(shù)
- 如何集成 XML 轉(zhuǎn)換器
- 使用 Log Level 調(diào)試請求
- 如何上傳文件
- Series Round-Up
- Retrofit 2 — 1.9 升級指南
- Retrofit 2 — 如何上傳文件
- Retrofit 2 — Log 請求與響應(yīng)
- Retrofit 2 — Android 上的 Hawk 認證
- Retrofit 2 — 簡單錯誤處理
- 如何在 Retrofit 1 里使用 OkHttp 3
- Retrofit 2 — 圖書更新發(fā)布慶典
- 提交表單數(shù)據(jù) — Urlencoded
- 提交表單數(shù)據(jù) — Urlencoded 使用FieldMap
- Retrofit 2 — 在 OkHttp 攔截器里管理請求頭部
- Retrofit 2 — 如何給每一個請求添加 Query 參數(shù)
- Retrofit 2 — 使用QueryMap 添加多個 Query 參數(shù)
- Retrofit 2 — 如何在請求時使用動態(tài) Url
- Retrofit 2 — Url 處理，分辨和解析
- Retrofit 2 — POST 和PUT 請求里的常量, 默認值和邏輯值
- Retrofit 2 — 如何下載文件
- Retrofit 2 — 取消請求
- Retrofit 2 — 重用分析請求
- Retrofit 2 — 如何在運行時修改 API Base Url
- 可選Path參數(shù)
- 如何刷新 Access Token
- Retrofit 2 — 如何提交文本請求體
- Retrofit 2 — 使用 Query 參數(shù)來分頁
- Retrofit 2 — 使用 鏈接頭和動態(tài) Url 來分頁(比如GitHub)
- Retrofit 2 — 使用范圍頭字段來分頁 (比如 Heroku)
- Retrofit 2 — 轉(zhuǎn)換器介紹
- Retrofit 2 — 添加并自定義 Gson 轉(zhuǎn)換器
- Retrofit 2 — 實現(xiàn)自定義轉(zhuǎn)換器
- Retrofit 2 — 只在開發(fā)環(huán)境里啟用日志
- Retrofit 2 — 如何上傳多個文件
- Retrofit 2 — Passing Multiple Parts Along a File with @PartMap
- Retrofit 2 — 模仿服務(wù)端響應(yīng)基本概念
- Retrofit 2 — 模仿服務(wù)端響應(yīng)自定義網(wǎng)絡(luò)行為
- Retrofit 2 — 使用 @HeaderMap 定義動態(tài)請求頭
在上一篇 開始創(chuàng)建android客戶端, 我們創(chuàng)建了Android客戶端的最初版本來進行API/HTTP請求. 我們將在上一篇創(chuàng)建的客戶端基礎(chǔ)上增加基本認證功能.
再次提醒, 如果有不理解的地方請閱讀上一篇以了解更多.
集成基本認證
讓我們升級 ServiceGenerator 類并且增加創(chuàng)建認證請求的方法. 下面的代碼片段擴展了 ServiceGenerator 類. 我們增加了 Retrofit 1.9 的示范代碼. 如果您使用的是 Retrofit 2, 請直接跳到第2段代碼 :)
Retrofit 1.9
public class ServiceGenerator {
public static final String API_BASE_URL = "https://your.api-base.url";
private static RestAdapter.Builder builder = new RestAdapter.Builder()
.setEndpoint(API_BASE_URL)
.setClient(new OkClient(new OkHttpClient()));
public static <S> S createService(Class<S> serviceClass) {
return createService(serviceClass, null, null);
}
public static <S> S createService(Class<S> serviceClass, String username, String password) {
if (username != null && password != null) {
// concatenate username and password with colon for authentication
String credentials = username + ":" + password;
// create Base64 encodet string
final String basic =
"Basic " + Base64.encodeToString(credentials.getBytes(), Base64.NO_WRAP);
builder.setRequestInterceptor(new RequestInterceptor() {
@Override
public void intercept(RequestFacade request) {
request.addHeader("Authorization", basic);
request.addHeader("Accept", "application/json");
}
});
}
RestAdapter adapter = builder.build();
return adapter.create(serviceClass);
}
}
Retrofit 2
public class ServiceGenerator {
public static final String API_BASE_URL = "https://your.api-base.url";
private static OkHttpClient.Builder httpClient = new OkHttpClient.Builder();
private static Retrofit.Builder builder =
new Retrofit.Builder()
.baseUrl(API_BASE_URL)
.addConverterFactory(GsonConverterFactory.create());
public static <S> S createService(Class<S> serviceClass) {
return createService(serviceClass, null, null);
}
public static <S> S createService(Class<S> serviceClass, String username, String password) {
if (username != null && password != null) {
String credentials = username + ":" + password;
final String basic =
"Basic " + Base64.encodeToString(credentials.getBytes(), Base64.NO_WRAP);
httpClient.addInterceptor(new Interceptor() {
@Override
public Response intercept(Interceptor.Chain chain) throws IOException {
Request original = chain.request();
Request.Builder requestBuilder = original.newBuilder()
.header("Authorization", basic)
.header("Accept", "application/json")
.method(original.method(), original.body());
Request request = requestBuilder.build();
return chain.proceed(request);
}
});
}
OkHttpClient client = httpClient.build();
Retrofit retrofit = builder.client(client).build();
return retrofit.create(serviceClass);
}
}
新方法 (第2個)有兩個參數(shù): username 和 password. 你也可以用 username 代表郵箱. 創(chuàng)建客戶端的目的與第1個方法相同: 使用RestAdapter( Retrofit 2 中是Retrofit) 類來創(chuàng)建OkHttp 客戶端, 用來做HTTP請求和響應(yīng)處理.
不同之處在于: 我們使用了 RequestInterceptor ( Retrofit 2 中是Interceptor) 來設(shè)置此OkHttp客戶端執(zhí)行的任何HTTP請求的授權(quán)標頭值. 但是這只有在提供username 和password參數(shù)的情況下才會執(zhí)行. 如果你沒有提供這兩個參數(shù)給方法, 它將會創(chuàng)建跟第1個方法一樣的客戶端. 這也是我們可以在ServiceGenerator 類中簡化第1個方法的原因.
在認證部分我們必須調(diào)整給定的用戶名/郵箱和密碼格式. 基本的授權(quán)需要這兩個值用冒號分割拼接成字符串, 然后用 Base64 編碼.
幾乎每一個 webservice 和API都評估HTTP請求的Authorization頭. 這就是為什么我們在頭部域設(shè)置編碼憑據(jù). 如果你的客戶端調(diào)用的webservice指定另一個頭部域來存放用戶憑據(jù),只需要將頭部域 Authorization 改為你需要的.
如果你想接收特定格式的服務(wù)器響應(yīng)的話, Accept 頭將派上用場. 在我們的例子中，我們想接收JSON格式的響應(yīng)，因為 Retrofit 附帶了 Google’s GSON 來序列化對象到 JSON 格式, 反之亦然.
使用
只需要像上一篇一樣調(diào)用 ServiceGenerator 類的新方法. 比如, 假設(shè)我們定義了一個 LoginService 接口, 代碼如下.
Retrofit 1.9
public interface LoginService {
@POST("/login")
User basicLogin();
}
Retrofit 2
public interface LoginService {
@POST("/login")
Call<User> basicLogin();
}
上述接口只有一個方法: basicLogin. 此方法使用 User 類作為返回值, 除此以外不需要任何query 或者 path 參數(shù).
現(xiàn)在你可以通過傳送給定的憑據(jù)(username, password)來創(chuàng)建你的 HTTP 客戶端 .
Retrofit 1.9
LoginService loginService =
ServiceGenerator.createService(LoginService.class, "user", "secretpassword");
User user = loginService.basicLogin();
Retrofit 2
LoginService loginService =
ServiceGenerator.createService(LoginService.class, "user", "secretpassword");
Call<User> call = loginService.basicLogin();
User user = call.execute().body();
該ServiceGenerator方法將創(chuàng)建HTTP客戶端，包括定義的授權(quán)標頭. 一旦你調(diào)用 loginService的basicLogin方法 , 提供的憑據(jù)將自動傳遞到請求的API端點.
接下來做什么
接下來的文章介紹了如何實現(xiàn) Retrofit 自定義 OAuth 客戶端.
如果有任何問題或建議請 Twitter: @futurestud_io.
