请不要使用拦截器
来处理身份验证。
目前,处理身份验证的最佳方法是使用新的Authenticator
API,该API专门设计用于这个目的。
当响应为401 Not Authorised
时,OkHttp会自动请求Authenticator
凭据,然后重试上一次失败的请求。
public class TokenAuthenticator implements Authenticator {
@Override
public Request authenticate(Proxy proxy, Response response) throws IOException {
// Refresh your access_token using a synchronous api request
newAccessToken = service.refreshToken();
// Add new header to rejected request and retry it
return response.request().newBuilder()
.header(AUTHORIZATION, newAccessToken)
.build();
}
@Override
public Request authenticateProxy(Proxy proxy, Response response) throws IOException {
// Null indicates no attempt to authenticate.
return null;
}
与拦截器一样,您可以将 Authenticator
附加到 OkHttpClient
上。
OkHttpClient okHttpClient = new OkHttpClient();
okHttpClient.setAuthenticator(authAuthenticator);
在创建 Retrofit
RestAdapter
时请使用此客户端。
RestAdapter restAdapter = new RestAdapter.Builder()
.setEndpoint(ENDPOINT)
.setClient(new OkClient(okHttpClient))
.build();
return restAdapter.create(API.class);
TokenAuthenticator
依赖于一个 service
类。service
类依赖于一个 OkHttpClient
实例。要创建一个 OkHttpClient
,我需要 TokenAuthenticator
。如何打破这个循环依赖呢?使用两个不同的 OkHttpClient
吗?它们将拥有不同的连接池... 如何打破这个循环依赖呢?可以使用依赖注入,将 OkHttpClient
的实例注入到 service
中,然后再将 service
的实例注入到 TokenAuthenticator
中。这样就可以避免循环依赖了。如果需要使用多个 OkHttpClient
实例,则可以分别创建它们并配置不同的连接池。 - Brais Gabin1.9.0
,则可以利用OkHttp的新Interceptor,该拦截器在OkHttp 2.2.0
中引入。您需要使用一个Application Interceptor,它允许您重试并进行多个调用
。public class CustomInterceptor implements Interceptor {
@Override
public Response intercept(Chain chain) throws IOException {
Request request = chain.request();
// try the request
Response response = chain.proceed(request);
if (response shows expired token) {
// close previous response
response.close()
// get a new token (I use a synchronous Retrofit call)
// create a new request and modify it accordingly using the new token
Request newRequest = request.newBuilder()...build();
// retry the request
return chain.proceed(newRequest);
}
// otherwise just pass the original response on
return response;
}
}
Interceptor
之后,创建一个OkHttpClient
并将拦截器添加为应用程序拦截器。 OkHttpClient okHttpClient = new OkHttpClient();
okHttpClient.interceptors().add(new CustomInterceptor());
RestAdapter
时,请使用此 OkHttpClient
。 RestService restService = new RestAdapter().Builder
...
.setClient(new OkClient(okHttpClient))
.create(RestService.class);
警告:正如Square公司的Jesse Wilson在这里提到的那样,这是一种危险的强大力量。
话虽如此,我肯定认为现在处理这类问题的最佳方式。如果您有任何疑问,请在评论中不要犹豫地提出。
TokenAuthenticator依赖于一个服务类。该服务类依赖于一个OkHttpClient实例。要创建一个OkHttpClient,我需要TokenAuthenticator。如何打破这个循环?使用两个不同的OkHttpClients吗?它们将拥有不同的连接池。
如果你有一个需要在你的Authenticator
中使用的RetrofitTokenService
,但你只想设置一个OkHttpClient
,那么你可以使用TokenServiceHolder
作为TokenAuthenticator
的依赖项。您需要在应用程序(单例)级别维护对它的引用。如果您使用Dagger 2,则很容易实现此操作,否则只需在应用中创建一个类字段即可。
在TokenAuthenticator.java
中:
public class TokenAuthenticator implements Authenticator {
private final TokenServiceHolder tokenServiceHolder;
public TokenAuthenticator(TokenServiceHolder tokenServiceHolder) {
this.tokenServiceHolder = tokenServiceHolder;
}
@Override
public Request authenticate(Proxy proxy, Response response) throws IOException {
//is there a TokenService?
TokenService service = tokenServiceHolder.get();
if (service == null) {
//there is no way to answer the challenge
//so return null according to Retrofit's convention
return null;
}
// Refresh your access_token using a synchronous api request
newAccessToken = service.refreshToken().execute();
// Add new header to rejected request and retry it
return response.request().newBuilder()
.header(AUTHORIZATION, newAccessToken)
.build();
}
@Override
public Request authenticateProxy(Proxy proxy, Response response) throws IOException {
// Null indicates no attempt to authenticate.
return null;
}
在 TokenServiceHolder.java
文件中:
public class TokenServiceHolder {
TokenService tokenService = null;
@Nullable
public TokenService get() {
return tokenService;
}
public void set(TokenService tokenService) {
this.tokenService = tokenService;
}
}
客户端设置:
//obtain instance of TokenServiceHolder from application or singleton-scoped component, then
TokenAuthenticator authenticator = new TokenAuthenticator(tokenServiceHolder);
OkHttpClient okHttpClient = new OkHttpClient();
okHttpClient.setAuthenticator(tokenAuthenticator);
Retrofit retrofit = new Retrofit.Builder()
.baseUrl("https://api.github.com/")
.client(okHttpClient)
.build();
TokenService tokenService = retrofit.create(TokenService.class);
tokenServiceHolder.set(tokenService);
如果您正在使用Dagger 2或类似的依赖注入框架,则在此问题的答案中有一些示例。TokenService
类是在哪里创建的? - Yogesh Sutharservice.refreshToken().execute();
中refreshToken()
的实现吗?我在任何地方都找不到它的实现。 - Yogesh SutharTokenService
而不是TokenServiceHolder
呢? - Abbas使用TokenAuthenticator
,像@theblang的答案一样,是处理refresh_token
的正确方式。
这是我的实现(我使用了Kotlin、Dagger、RX,但你可以根据你的情况使用这个思路)
TokenAuthenticator
class TokenAuthenticator @Inject constructor(private val noneAuthAPI: PotoNoneAuthApi, private val accessTokenWrapper: AccessTokenWrapper) : Authenticator {
override fun authenticate(route: Route, response: Response): Request? {
val newAccessToken = noneAuthAPI.refreshToken(accessTokenWrapper.getAccessToken()!!.refreshToken).blockingGet()
accessTokenWrapper.saveAccessToken(newAccessToken) // save new access_token for next called
return response.request().newBuilder()
.header("Authorization", newAccessToken.token) // just only need to override "Authorization" header, don't need to override all header since this new request is create base on old request
.build()
}
}
为了避免像@Brais Gabin评论中提到的依赖循环,我创建了2个接口,如下所示:
interface PotoNoneAuthApi { // NONE authentication API
@POST("/login")
fun login(@Body request: LoginRequest): Single<AccessToken>
@POST("refresh_token")
@FormUrlEncoded
fun refreshToken(@Field("refresh_token") refreshToken: String): Single<AccessToken>
}
并且
interface PotoAuthApi { // Authentication API
@GET("api/images")
fun getImage(): Single<GetImageResponse>
}
AccessTokenWrapper
类class AccessTokenWrapper constructor(private val sharedPrefApi: SharedPrefApi) {
private var accessToken: AccessToken? = null
// get accessToken from cache or from SharePreference
fun getAccessToken(): AccessToken? {
if (accessToken == null) {
accessToken = sharedPrefApi.getObject(SharedPrefApi.ACCESS_TOKEN, AccessToken::class.java)
}
return accessToken
}
// save accessToken to SharePreference
fun saveAccessToken(accessToken: AccessToken) {
this.accessToken = accessToken
sharedPrefApi.putObject(SharedPrefApi.ACCESS_TOKEN, accessToken)
}
}
AccessToken
class
data class AccessToken(
@Expose
var token: String,
@Expose
var refreshToken: String)
我的拦截器
class AuthInterceptor @Inject constructor(private val accessTokenWrapper: AccessTokenWrapper): Interceptor {
override fun intercept(chain: Interceptor.Chain): Response {
val originalRequest = chain.request()
val authorisedRequestBuilder = originalRequest.newBuilder()
.addHeader("Authorization", accessTokenWrapper.getAccessToken()!!.token)
.header("Accept", "application/json")
return chain.proceed(authorisedRequestBuilder.build())
}
}
OKHttpClient
添加Interceptor
和Authenticator
。
https://github.com/PhanVanLinh/AndroidMVPKotlin
getImage()
返回401错误代码TokenAuthenticator
内的authenticate
方法将被触发noneAuthAPI.refreshToken(...)
noneAuthAPI.refreshToken(...)
响应之后 ->新令牌将添加到标头中getImage()
将使用新标头自动调用(HttpLogging
不会记录此调用)(AuthInterceptor
内的intercept
不会被调用)如果getImage()
仍然失败并显示401错误,则TokenAuthenticator
内的authenticate
方法将再次触发,然后它将抛出有关多次调用方法的错误(java.net.ProtocolException: Too many follow-up requests
)。您可以通过计数响应来防止它。例如,如果您在3次重试后在authenticate
中return null
,则getImage()
将完成并返回401响应
如果getImage()
响应成功 =>我们将正常返回结果(就像您没有错误地调用getImage()
一样)
class TokenAuthenticator : Authenticator {
override fun authenticate(route: Route?, response: Response): Request? {
return runBlocking {
// 1. Refresh your access_token using a synchronous api request
val response = getUpdatedToken(refreshToken)
//2. In my case here I store the new token and refreshToken into SharedPreferences
response.request.newBuilder()
.header("Authorization", "Bearer ${tokenResponse.data?.accessToken}")
.build()
// 3. If there's any kind of error I return null
}
}
private suspend fun getUpdatedToken( refreshToken: String): TokenResponse {
val okHttpClient = OkHttpClient().newBuilder()
.addInterceptor(errorResponseInterceptor)
.build()
val retrofit = Retrofit.Builder()
.baseUrl(BuildConfig.BASE_URL)
.client(okHttpClient)
.addConverterFactory(MoshiConverterFactory.create())
.build()
val service = retrofit.create(RefreshTokenApi::class.java)
return service.refreshToken(refreshToken)
}
}
刷新令牌 API
interface RefreshTokenApi {
@FormUrlEncoded
@POST("refreshToken")
suspend fun refreshToken(
@Field("refresh_token") refreshToeken: String
): TokenResponse
}
在这个项目中,我使用了Koin,并进行了如下配置:
object RetrofigConfig {
fun provideRetrofit(okHttpClient: OkHttpClient): Retrofit {
return Retrofit.Builder()
.baseUrl(BuildConfig.BASE_URL)
.client(okHttpClient)
.addConverterFactory(MoshiConverterFactory.create())
.build()
}
fun provideOkHttpClient(
tokenAuthenticator: TokenAuthenticator
): OkHttpClient {
return OkHttpClient().newBuilder()
.authenticator(tokenAuthenticator)
.build()
}
fun provideServiceApi(retrofit: Retrofit): ServiceApi {
return retrofit.create(ServiceApi::class.java)
}
}
这里最重要的一行是 OkHttpClient().newBuilder().authenticator(tokenAuthenticator)
由于这是我第一次实现,我不确定这是否是最好的方法,但这是在我的项目中工作的方法。
runBlocking
是否安全,还是只是为了简单起见? - gts13authenticate
函数中返回 null,对吧? - gts13我知道这是一个旧帖子,但以防万一有人碰巧看到了它。
TokenAuthenticator依赖于一个服务类。服务类依赖于一个OkHttpClient实例。要创建OkHttpClient,我需要TokenAuthenticator。如何打破这个循环?两个不同的OkHttpClient?它们将具有不同的连接池..
我面临着同样的问题,但我只想创建一个OkHttpClient,因为我认为我不需要另一个仅用于TokenAuthenticator本身的OkHttpClient,我正在使用Dagger2,所以最终我提供了服务类作为TokenAuthenticator中的延迟注入,您可以在这里了解有关Dagger 2中的Lazy注入的更多信息,但基本上就像告诉Dagger不要立即创建TokenAuthenticator所需的服务。
您可以参考此SO线程以获取示例代码:如何在仍然使用Dagger2的情况下解决循环依赖关系?
使用一个拦截器(注入令牌)和一个身份验证器(刷新操作)可以完成工作,但是:
我还遇到了双重调用问题:第一次调用总是返回401:在第一次调用时未注入令牌(拦截器),并且调用了身份验证器:进行了两个请求。
解决方法就是将请求重新分配给内置的拦截器:
之前:
private Interceptor getInterceptor() {
return (chain) -> {
Request request = chain.request();
//...
request.newBuilder()
.header(AUTHORIZATION, token))
.build();
return chain.proceed(request);
};
}
private Interceptor getInterceptor() {
return (chain) -> {
Request request = chain.request();
//...
request = request.newBuilder()
.header(AUTHORIZATION, token))
.build();
return chain.proceed(request);
};
}
private Interceptor getInterceptor() {
return (chain) -> {
Request request = chain.request().newBuilder()
.header(AUTHORIZATION, token))
.build();
return chain.proceed(request);
};
}
restAdapter = new RestAdapter.Builder()
.setEndpoint(SERVER_END_POINT)
.setClient(new CookiePersistingClient())
.setLogLevel(RestAdapter.LogLevel.FULL).build();
Cookie Persistent客户端维护所有请求的cookie,并在每个请求响应中进行检查,如果未经授权访问ERROR_CODE = 401,则刷新访问令牌并重新调用请求,否则只处理请求。
private static class CookiePersistingClient extends ApacheClient {
private static final int HTTPS_PORT = 443;
private static final int SOCKET_TIMEOUT = 300000;
private static final int CONNECTION_TIMEOUT = 300000;
public CookiePersistingClient() {
super(createDefaultClient());
}
private static HttpClient createDefaultClient() {
// Registering https clients.
SSLSocketFactory sf = null;
try {
KeyStore trustStore = KeyStore.getInstance(KeyStore
.getDefaultType());
trustStore.load(null, null);
sf = new MySSLSocketFactory(trustStore);
sf.setHostnameVerifier(SSLSocketFactory.ALLOW_ALL_HOSTNAME_VERIFIER);
} catch (KeyManagementException e) {
e.printStackTrace();
} catch (UnrecoverableKeyException e) {
e.printStackTrace();
} catch (KeyStoreException e) {
e.printStackTrace();
} catch (NoSuchAlgorithmException e) {
e.printStackTrace();
} catch (CertificateException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
HttpParams params = new BasicHttpParams();
HttpConnectionParams.setConnectionTimeout(params,
CONNECTION_TIMEOUT);
HttpConnectionParams.setSoTimeout(params, SOCKET_TIMEOUT);
SchemeRegistry registry = new SchemeRegistry();
registry.register(new Scheme("https", sf, HTTPS_PORT));
// More customization (https / timeouts etc) can go here...
ClientConnectionManager cm = new ThreadSafeClientConnManager(
params, registry);
DefaultHttpClient client = new DefaultHttpClient(cm, params);
// Set the default cookie store
client.setCookieStore(COOKIE_STORE);
return client;
}
@Override
protected HttpResponse execute(final HttpClient client,
final HttpUriRequest request) throws IOException {
// Set the http context's cookie storage
BasicHttpContext mHttpContext = new BasicHttpContext();
mHttpContext.setAttribute(ClientContext.COOKIE_STORE, COOKIE_STORE);
return client.execute(request, mHttpContext);
}
@Override
public Response execute(final Request request) throws IOException {
Response response = super.execute(request);
if (response.getStatus() == 401) {
// Retrofit Callback to handle AccessToken
Callback<AccessTockenResponse> accessTokenCallback = new Callback<AccessTockenResponse>() {
@SuppressWarnings("deprecation")
@Override
public void success(
AccessTockenResponse loginEntityResponse,
Response response) {
try {
String accessToken = loginEntityResponse
.getAccessToken();
TypedOutput body = request.getBody();
ByteArrayOutputStream byte1 = new ByteArrayOutputStream();
body.writeTo(byte1);
String s = byte1.toString();
FormUrlEncodedTypedOutput output = new FormUrlEncodedTypedOutput();
String[] pairs = s.split("&");
for (String pair : pairs) {
int idx = pair.indexOf("=");
if (URLDecoder.decode(pair.substring(0, idx))
.equals("access_token")) {
output.addField("access_token",
accessToken);
} else {
output.addField(URLDecoder.decode(
pair.substring(0, idx), "UTF-8"),
URLDecoder.decode(
pair.substring(idx + 1),
"UTF-8"));
}
}
execute(new Request(request.getMethod(),
request.getUrl(), request.getHeaders(),
output));
} catch (IOException e) {
e.printStackTrace();
}
}
@Override
public void failure(RetrofitError error) {
// Handle Error while refreshing access_token
}
};
// Call Your retrofit method to refresh ACCESS_TOKEN
refreshAccessToken(GRANT_REFRESH,CLIENT_ID, CLIENT_SECRET_KEY,accessToken, accessTokenCallback);
}
return response;
}
}
这是我的代码,对我很有效。可能对某些人有帮助。
class AuthenticationInterceptorRefreshToken @Inject
constructor( var hIltModules: HIltModules,) : Interceptor {
@Throws(IOException::class)
override fun intercept(chain: Interceptor.Chain): Response {
val originalRequest = chain.request()
val response = chain.proceed(originalRequest)
if (response.code == 401) {
synchronized(this) {
val originalRequest = chain.request()
val authenticationRequest = originalRequest.newBuilder()
.addHeader("refreshtoken", " $refreshToken")
.build()
val initialResponse = chain.proceed(authenticationRequest)
when (initialResponse.code) {
401 -> {
val responseNewTokenLoginModel = runBlocking {
hIltModules.provideAPIService().refreshToken()
}
when (responseNewTokenLoginModel.statusCode) {
200 -> {
refreshToken = responseNewTokenLoginModel.refreshToken
access_token = responseNewTokenLoginModel.accessToken
val newAuthenticationRequest = originalRequest.newBuilder()
.header("refreshtoken",
" $refreshToken")
.build()
return chain.proceed(newAuthenticationRequest)
}
else -> {
return null!!
}
}
}
else -> return initialResponse
}
}
}; return response
}