2. Retrofit2 -- Basic Authentication on Android
2. Retrofit2 -- Basic Authentication on Android
上一节课中,我们创建了用于执行 API/HTTP
请求的原始 Android
客户端版本。本节课中,我们将使用上节课的客户端,对它进行增强,给它添加基本的认证功能。
整合基本的认证
首先,更新 ServiceGenerator
类,添加方法,用于把认证添加到请求上。下面的代码使用 1.9
、2.0
版本分别进行了扩展:
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.0
- 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);
- }
- }
新方法中,多了两个参数: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
- public interface LoginService {
- @POST("/login")
- void basicLogin(Callback<User> cb);
- }
Retrofit 2.0
- public interface LoginService {
- @POST("/login")
- Call<User> basicLogin();
- }
上面的接口只有一个方法:basicLogin
。它的响应值类型是:User
,没有其它的查询、或路径参数。
现在,我们创建一个客户端并把认证信息(username password
)传入:
Retrofit 1.9
- LoginService loginService =
- ServiceGenerator.createService(LoginService.class, "user", "secretpassword");
- loginService.basicLogin(new Callback<User>() {
- @Override
- public void success(User user, Response response) {
- // user object available
- }
- @Override
- public void failure(RetrofitError error) {
- // handle errors, too
- }
- });
Retrofit 2.0
- LoginService loginService =
- ServiceGenerator.createService(LoginService.class, "user", "secretpassword");
- Call<User> call = loginService.basicLogin();
- call.enqueue(new Callback<User >() {
- @Override
- public void onResponse(Call<User> call, Response<User> response) {
- if (response.isSuccessful()) {
- // user object available
- } else {
- // error response, no access to resource?
- }
- }
- @Override
- public void onFailure(Call<User> call, Throwable t) {
- // something went completely south (like no internet connection)
- Log.d("Error", t.getMessage());
- }
- }
ServiceGenerator
方法将创建包含预定义认证头部的 HTTP
客户端。一旦调用 loginService
的 basicLogin
方法,提供的认证信息将自动被传入到请求的 API
端点。
2. Retrofit2 -- Basic Authentication on Android的更多相关文章
- Atitit HTTP 认证机制基本验证 (Basic Authentication) 和摘要验证 (Digest Authentication)attilax总结
Atitit HTTP认证机制基本验证 (Basic Authentication) 和摘要验证 (Digest Authentication)attilax总结 1.1. 最广泛使用的是基本验证 ( ...
- Nancy 学习-身份认证(Basic Authentication) 继续跨平台
开源 示例代码:https://github.com/linezero/NancyDemo 前面讲解Nancy的进阶部分,现在来学习Nancy 的身份认证. 本篇主要讲解Basic Authentic ...
- HTTP Basic Authentication
Client端发送请求, 要在发送请求的时候添加HTTP Basic Authentication认证信息到请求中,有两种方法:1. 在请求头中添加Authorization: Authoriz ...
- Web services 安全 - HTTP Basic Authentication
根据 RFC2617 的规定,HTTP 有两种标准的认证方式,即,BASIC 和 DIGEST.HTTP Basic Authentication 是指客户端必须使用用户名和密码在一个指定的域 (Re ...
- Web API 基于ASP.NET Identity的Basic Authentication
今天给大家分享在Web API下,如何利用ASP.NET Identity实现基本认证(Basic Authentication),在博客园子搜索了一圈Web API的基本认证,基本都是做的Forms ...
- PYTHON实现HTTP基本认证(BASIC AUTHENTICATION)
参考: http://www.voidspace.org.uk/python/articles/authentication.shtml#id20 http://zh.wikipedia.org/wi ...
- HTTP Basic Authentication认证的各种语言 后台用的
访问需要HTTP Basic Authentication认证的资源的各种语言的实现 无聊想调用下嘀咕的api的时候,发现需要HTTP Basic Authentication,就看了下. 什么是HT ...
- 一个HTTP Basic Authentication引发的异常
这几天在做一个功能,其实很简单.就是调用几个外部的API,返回数据后进行组装然后成为新的接口.其中一个API是一个很奇葩的API,虽然是基于HTTP的,但既没有基于SOAP规范,也不是Restful风 ...
- HTTP Basic Authentication认证(Web API)
当下最流行的Web Api 接口认证方式 HTTP Basic Authentication: http://smalltalllong.iteye.com/blog/912046 什么是HTTP B ...
随机推荐
- 流畅的python第二十章属性描述符学习记录
描述符是对多个属性运用相同存取逻辑的一种方式.例如,Django ORM 和 SQL Alchemy等 ORM 中的字段类型是描述符,把数据库记录中字段里的数据与 Python 对象的属性对应起来.描 ...
- Indirect Buffers
间接cmd 用在 gpu建立的cmd 不需要cpu参与 用indirect cpu gpu就不会互相等待了 直接gpu建立了 gpu用 之前的cmd是cpu建立 填入数据 gpu拿来执行的 在meta ...
- Android面试题(1)
1. 下列哪些语句关于内存回收的说明是正确的? (b ) A. 程序员必须创建一个线程来释放内存 B. 内存回收程序负责释放无用内存 C. 内存回收程序允许程序员直接释放内存 D. 内存回收程序可以在 ...
- scala 2.11报错error: not found: type Application
FROM: http://j-q-j.org/scala/scala-2-11-application-error.html 这两天学习scala,官网下载的最新版本2.11,书用的是<Prog ...
- (转)Scala的“=>”符号简介
Scala中的=>符号可以看做是创建函数实例的语法糖.例如:A => T,A,B => T表示一个函数的输入参数类型是“A”,“A,B”,返回值类型是T.请看下面这个实例: scal ...
- Maven Dependencies 不见了
解决办法: 1. 选中项目 --> 右键 --> Maven --> Disable Maven Nature 此时,右键菜单中将隐藏[Maven]菜单选项 2. 选中项目 --&g ...
- Kolla 4.0.0环境下VIP无法迁移问题排查
VRRP无法切换VIP的问题分析: Keepalived的配置文件:/etc/kolla/keepalived/keepalived.conf当中,nopreempt选项是影响切换的因素之一,另一个因 ...
- c语言指针详解 经典
指针是C语言中广泛使用的一种数据类型. 运用指针编程是C语言最主要的风格之一.利用指针变量可以表示各种数据结构: 能很方便地使用数组和字符串: 并能象汇编语言一样处理内存地址,从而编出精练而高效的程序 ...
- 在Lucene或Solr中实现高亮的策略
一:功能背景 近期要做个高亮的搜索需求,曾经也搞过.所以没啥难度.仅仅只是原来用的是Lucene,如今要换成Solr而已,在Lucene4.x的时候,散仙在曾经的文章中也分析过怎样在搜索的时候实现高亮 ...
- python的基本知识点
一.数据类型 1.整数2.浮点数3.字符串4.布尔值:True/False5.空值:None 二.变量 变量名必须是大小写英文.数字和_的组合,且不能以数字开头 三.常量 全部大写的变量名表示常量,p ...