すべての呼び出しを変更せずにRetrofitを使用してOAuthトークンを更新する

AndroidアプリでRetrofitを使用して、OAuth2で保護されたサーバーと通信します。すべてが適切に機能します。RequestInterceptorを使用して、各呼び出しにアクセストークンを含めます。ただし、アクセストークンが期限切れになり、トークンを更新する必要がある場合があります。トークンの有効期限が切れると、次の呼び出しは無許可のHTTPコードで返されるため、監視は簡単です。各Retrofit呼び出しを次のように変更できます。失敗コールバックでエラーコードを確認し、Unauthorizedに等しい場合は、OAuthトークンを更新してから、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);

使用している場合は改修を > = 1.9.0あなたが使用作ることができるOkHttpの新しいインターセプターに導入されました、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が必要です。どうすればこのサイクルを壊すことができますか？2つの異なるOkHttpClients？それらは異なる接続プールを持つことになります。

たとえば、TokenService内部に必要なレトロフィットAuthenticatorがあっ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または同様の依存関係注入フレームワークを使用している場合、この質問への回答にいくつかの例があります

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 クラス

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()意志AUTOと呼ばれる（新しいヘッダーでHttpLogging ログインしないものとします（この呼び出しを）intercept内AuthInterceptor WILLは呼び出されません）

• getImage()それでもエラー401で失敗する場合は、authenticate内部のメソッドがAGAINおよびAGAINTokenAuthenticatorを起動し、メソッドの呼び出しに関するエラーを何度もスローします（java.net.ProtocolException: Too many follow-up requests）。カウントレスポンスで防ぐことができます。たとえば、もしあなたreturn nullでauthenticate3回再試行した後、getImage()なり仕上げとreturn response 401

• getImage()応答が成功した場合=>通常の結果になります（getImage()エラーなしで呼び出すようなもの）

それが役に立てば幸い

私はこれが古いスレッドであることを知っていますが、誰かがそれにつまずいた場合に備えて。

TokenAuthenticatorはサービスクラスに依存します。サービスクラスはOkHttpClientインスタンスに依存します。OkHttpClientを作成するには、TokenAuthenticatorが必要です。どうすればこのサイクルを壊すことができますか？2つの異なるOkHttpClients？それらは異なる接続プールを持つことになります。

私は同じ問題に直面していましたが、TokenAuthenticator自体のために別のOkHttpClientが必要だとは思わないため、1つだけOkHttpClientを作成したかったので、Dagger2を使用していたため、LazyがTokenAuthenticatorについては、ダガー2 でのレイジーインジェクションの詳細についてはこちらをご覧ください。ただし、基本的にDaggerに対して、TokenAuthenticatorが必要とするサービスをすぐに作成しないように指示するようなものです。

サンプルコードについては、このSOスレッドを参照できます。Dagger2を使用しながら循環依存関係を解決する方法は？

すべてのローダーの基本クラスを作成して、特定の例外をキャッチし、必要に応じて機能させることができます。振る舞いを広げるために、すべての異なるローダーを基本クラスから拡張させます。

長期にわたる調査の後、Apacheクライアントをカスタマイズして、アクセストークンをパラメーターとして送信するRetrofitの更新AccessTokenを処理しました。

アダプターをCookie Persistent Clientで開始する

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

すべての要求のCookieを維持し、不正なアクセスである場合は各要求の応答を確認するCookie Persistentクライアント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;
    }
}

1つのインターセプター（トークンの挿入）と1つのオーセンティケーター（更新操作）を使用すると、次のことができます。

私も二重呼び出しの問題がありました：最初の呼び出しは常に401を返しました：トークンは最初の呼び出し（インターセプター）で注入されず、オーセンティケーターが呼び出されました：2つの要求が行われました。

修正は、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);
    };
}

1つのブロックで：

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