2. Retrofit2 -- Basic Authentication on Android

2. Retrofit2 -- Basic Authentication on Android

android
Retrofit
tutorial

上一节课中，我们创建了用于执行 API/HTTP 请求的原始 Android 客户端版本。本节课中，我们将使用上节课的客户端，对它进行增强，给它添加基本的认证功能。

整合基本的认证

首先，更新 ServiceGenerator 类，添加方法，用于把认证添加到请求上。下面的代码使用 1.9、2.0 版本分别进行了扩展：

Retrofit 1.9

  1. public class ServiceGenerator { 
  2.  
  3. public static final String API_BASE_URL = "https://your.api-base.url"; 
  4.  
  5. private static RestAdapter.Builder builder = new RestAdapter.Builder() 
  6. .setEndpoint(API_BASE_URL) 
  7. .setClient(new OkClient(new OkHttpClient())); 
  8.  
  9. public static <S> S createService(Class<S> serviceClass) { 
  10. return createService(serviceClass, null, null); 
  11. } 
  12.  
  13. public static <S> S createService(Class<S> serviceClass, String username, String password) { 
  14. if (username != null && password != null) { 
  15. // concatenate username and password with colon for authentication 
  16. String credentials = username + ":" + password; 
  17. // create Base64 encodet string 
  18. final String basic = 
  19. "Basic " + Base64.encodeToString(credentials.getBytes(), Base64.NO_WRAP); 
  20.  
  21. builder.setRequestInterceptor(new RequestInterceptor() { 
  22. @Override 
  23. public void intercept(RequestFacade request) { 
  24. request.addHeader("Authorization", basic); 
  25. request.addHeader("Accept", "application/json"); 
  26. } 
  27. }); 
  28. } 
  29.  
  30. RestAdapter adapter = builder.build(); 
  31. return adapter.create(serviceClass); 
  32. } 
  33. } 

Retrofit 2.0

  1. public class ServiceGenerator { 
  2.  
  3. public static final String API_BASE_URL = "https://your.api-base.url"; 
  4.  
  5. private static OkHttpClient.Builder httpClient = new OkHttpClient.Builder(); 
  6.  
  7. private static Retrofit.Builder builder = 
  8. new Retrofit.Builder() 
  9. .baseUrl(API_BASE_URL) 
  10. .addConverterFactory(GsonConverterFactory.create()); 
  11.  
  12. public static <S> S createService(Class<S> serviceClass) { 
  13. return createService(serviceClass, null, null); 
  14. } 
  15.  
  16. public static <S> S createService(Class<S> serviceClass, String username, String password) { 
  17. if (username != null && password != null) { 
  18. String credentials = username + ":" + password; 
  19. final String basic = 
  20. "Basic " + Base64.encodeToString(credentials.getBytes(), Base64.NO_WRAP); 
  21.  
  22. httpClient.addInterceptor(new Interceptor() { 
  23. @Override 
  24. public Response intercept(Interceptor.Chain chain) throws IOException { 
  25. Request original = chain.request(); 
  26.  
  27. Request.Builder requestBuilder = original.newBuilder() 
  28. .header("Authorization", basic) 
  29. .header("Accept", "application/json") 
  30. .method(original.method(), original.body()); 
  31.  
  32. Request request = requestBuilder.build(); 
  33. return chain.proceed(request); 
  34. } 
  35. }); 
  36. } 
  37.  
  38. OkHttpClient client = httpClient.build(); 
  39. Retrofit retrofit = builder.client(client).build(); 
  40. return retrofit.create(serviceClass); 
  41. } 
  42. } 

新方法中，多了两个参数：username 和 password。创建客户端的基本方法与老方法一样：使用 RestAdapter（2.0 版本是 Retrofit）类为所有的 HTTP 请求和响应处理创建 OKHttp 客户端。

新方法的不同在于：使用了 RequestInterceptor（2.0 版本是 Inteceptor）类来为 OKHttp 客户端执行的 HTTP 请求设置认证的头部。当然，只有提供了 username 和 password 参数，才会设置的。如果该方法没有接收到 username 和 password 参数，那么它创建的客户端与第一个方法相同。

关于验证部分，我们必须调整 username 和 password 的格式。基本认证请求把所有值当作一个以逗号分隔的多行索引字符串。此外，新创建的字符串必须是 Base64 格式的编码。

大多数的 webservice 和 API 都会对 HTTP 请求的认证头部进行计算。这就是为什么我们要把编码认证的值设置到头部。如果你调用 web 服务的客户端使用了其它的头部字段来接收用户的认证，那你应该把头部的 Authorization 转换为你服务所需的字段。

如果你想使用某种特定的格式来接收服务响应，那么，Accept 头部字段起着决定性的作用。在示例中，我们要求服务器返回的信息格式是 JSON。这是因为我们配置了 retrofit 使用 Google GSON 把序列化的对象和 JSON 互相转换。

用法

新方法的调用方法与上节课旧方法的调用方法一样。假定，我们定义了一个 LoginService：

Retrofit 1.9

  1. public interface LoginService {  
  2. @POST("/login") 
  3. void basicLogin(Callback<User> cb); 
  4. } 

Retrofit 2.0

  1. public interface LoginService {  
  2. @POST("/login") 
  3. Call<User> basicLogin(); 
  4. } 

上面的接口只有一个方法：basicLogin。它的响应值类型是：User，没有其它的查询、或路径参数。

现在，我们创建一个客户端并把认证信息（username password）传入：

Retrofit 1.9

  1. LoginService loginService =  
  2. ServiceGenerator.createService(LoginService.class, "user", "secretpassword"); 
  3. loginService.basicLogin(new Callback<User>() {  
  4. @Override 
  5. public void success(User user, Response response) { 
  6. // user object available 
  7. } 
  8.  
  9. @Override 
  10. public void failure(RetrofitError error) { 
  11. // handle errors, too 
  12. } 
  13. }); 

Retrofit 2.0

  1. LoginService loginService =  
  2. ServiceGenerator.createService(LoginService.class, "user", "secretpassword"); 
  3. Call<User> call = loginService.basicLogin();  
  4. call.enqueue(new Callback<User >() {  
  5. @Override 
  6. public void onResponse(Call<User> call, Response<User> response) { 
  7. if (response.isSuccessful()) { 
  8. // user object available 
  9. } else { 
  10. // error response, no access to resource? 
  11. } 
  12. } 
  13.  
  14. @Override 
  15. public void onFailure(Call<User> call, Throwable t) { 
  16. // something went completely south (like no internet connection) 
  17. Log.d("Error", t.getMessage()); 
  18. } 
  19. } 

ServiceGenerator 方法将创建包含预定义认证头部的 HTTP 客户端。一旦调用 loginService 的 basicLogin 方法，提供的认证信息将自动被传入到请求的 API 端点。

posted @ 2016-11-10 15:28  wchhuangya  阅读(2023)  评论(0)  编辑  收藏  举报