使用翻新功能刷新OAuth令牌，而无需修改所有调用

我们正在Android应用中使用Retrofit，以与OAuth2安全服务器进行通信。一切正常，我们使用RequestInterceptor在每个调用中都包含访问令牌。但是，有时访问令牌将过期，并且令牌需要刷新。当令牌到期时，下一个调用将返回未经授权的HTTP代码，因此易于监视。我们可以通过以下方式修改每个Retrofit调用：在失败回调中，检查错误代码，如果错误代码等于Unauthorized，则刷新OAuth令牌，然后重复Retrofit调用。但是，为此，应修改所有调用，这不是一个易于维护的好的解决方案。有没有一种方法可以修改所有Retrofit调用？

请不要使用Interceptors来处理身份验证。

当前，处理身份验证的最佳方法是使用Authenticator专门为此目的设计的新API 。

OkHttp会自动询问了Authenticator时的响应凭据401 Not Authorised 重试最后一次失败的请求与他们。

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与您相同的方式附加Interceptors

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);

如果您使用的是Retrofit > =，1.9.0则可以使用OkHttp的新Interceptor（已在中引入）OkHttp 2.2.0。您可能需要使用Application Interceptor，它允许您进行以下操作retry and make multiple calls。

您的拦截器可能类似于以下伪代码：

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) {

            // 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());

最后，OkHttpClient在创建时使用它RestAdapter。

    RestService restService = new RestAdapter().Builder
            ...
            .setClient(new OkClient(okHttpClient))
            .create(RestService.class);

警告：由于Jesse Wilson（从广场）提到这里，这是权力的危险量。

话虽如此，我绝对认为这是现在处理此类问题的最佳方法。如果您有任何疑问，请随时在评论中提问。

TokenAuthenticator依赖于服务类。服务类取决于OkHttpClient实例。要创建OkHttpClient，我需要TokenAuthenticator。如何打破这个周期？两个不同的OkHttpClients？他们将具有不同的连接池。

举例来说，如果您有一个TokenService内部需要的翻新产品，Authenticator但只想设置一个翻新产品，则OkHttpClient可以将TokenServiceHolder用作依赖项TokenAuthenticator。您将必须在应用程序（单个）级别上维护对它的引用。如果使用Dagger 2，这很容易，否则只需在Application内创建类字段。

在 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或类似的依赖项注入框架，则此问题的答案中将包含一些示例

使用TokenAuthenticatorlike @theblang答案是handle的正确方法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 类

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())
    }
}

最后，添加Interceptor和Authenticator您OKHttpClient创建服务时PotoAuthApi

演示版

https://github.com/PhanVanLinh/AndroidMVPKotlin

注意

• 示例API getImage()返回401错误代码
• authenticate里面的方法TokenAuthenticator会被解雇
• 同步noneAuthAPI.refreshToken(...)调用
• 后noneAuthAPI.refreshToken(...)响应- >新的令牌会增加头
• getImage()将使用新的标头自动调用（HttpLogging 不会记录此调用）（intercept内部AuthInterceptor 不会调用）

• 如果getImage()仍然由于错误401而失败，则authenticate内部方法TokenAuthenticator将触发AGAIN和AGAIN，然后它将多次抛出有关调用方法的错误java.net.ProtocolException: Too many follow-up requests。您可以通过计数响应来阻止它。例如，如果你return null在authenticate经过3次重试，getImage()将完成和return response 401

• 如果getImage()响应成功=>，我们将正常生成结果（就像您正确调用一样getImage()）

希望对你有帮助

我知道这是一个旧线程，但以防万一有人偶然发现它。

TokenAuthenticator依赖于服务类。服务类取决于OkHttpClient实例。要创建OkHttpClient，我需要TokenAuthenticator。如何打破这个周期？两个不同的OkHttpClients？他们将具有不同的连接池。

我遇到了同样的问题，但是我只想创建一个OkHttpClient，因为我不认为我只需要为TokenAuthenticator本身就需要另一个，所以我使用的是Dagger2，所以最终我提供了Lazy注入的服务类。 TokenAuthenticator，您可以在此处阅读更多有关dagger 2中的惰性注入的信息，但这就像是对Dagger说不要立即创建TokenAuthenticator所需的服务一样。

您可以参考此SO线程获取示例代码：如何在仍使用Dagger2的情况下解决循环依赖关系？

您可以尝试为所有装入程序创建基类，在其中可以捕获特定异常，然后根据需要进行操作。让您所有不同的装载机都从基类扩展以扩展行为。

经过长时间的研究，我定制了Apache客户端来处理Refreshing AccessToken for Retrofit，在其中您将访问令牌作为参数发送。

使用cookie持久客户端启动适配器

restAdapter = new RestAdapter.Builder()
                .setEndpoint(SERVER_END_POINT)
                .setClient(new CookiePersistingClient())
                .setLogLevel(RestAdapter.LogLevel.FULL).build();

Cookie持久客户端，它为所有请求维护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;
    }
}

使用一个拦截器（注入令牌）和一个身份验证器（刷新操作）可以完成此任务，但：

我也遇到双重调用问题：第一个调用总是返回401：在第一个调用（拦截器）没有注入令牌，并且调用了身份验证器：发出了两个请求。

解决的办法只是使请求对Interceptor中的构建产生影响：

之前：

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);
    };
}

希望能帮助到你。

编辑：我没有找到一种方法来避免仅使用身份验证器而不使用拦截器来避免始终返回401的第一次调用

希望在刷新令牌时解决并发/并行调用的任何人。这是一种解决方法

class TokenAuthenticator: Authenticator {

    override fun authenticate(route: Route?, response: Response?): Request? {
        response?.let {
            if (response.code() == 401) {
                while (true) {
                    if (!isRefreshing) {
                        val requestToken = response.request().header(AuthorisationInterceptor.AUTHORISATION)
                        val currentToken = OkHttpUtil.headerBuilder(UserService.instance.token)

                        currentToken?.let {
                            if (requestToken != currentToken) {
                                return generateRequest(response, currentToken)
                            }
                        }

                        val token = refreshToken()
                        token?.let {
                            return generateRequest(response, token)
                        }
                    }
                }
            }
        }

        return null
    }

    private fun generateRequest(response: Response, token: String): Request? {
        return response.request().newBuilder()
                .header(AuthorisationInterceptor.USER_AGENT, OkHttpUtil.UA)
                .header(AuthorisationInterceptor.AUTHORISATION, token)
                .build()
    }

    private fun refreshToken(): String? {
        synchronized(TokenAuthenticator::class.java) {
            UserService.instance.token?.let {
                isRefreshing = true

                val call = ApiHelper.refreshToken()
                val token = call.execute().body()
                UserService.instance.setToken(token, false)

                isRefreshing = false

                return OkHttpUtil.headerBuilder(token)
            }
        }

        return null
    }

    companion object {
        var isRefreshing = false
    }
}