Оновлення маркера OAuth за допомогою Retrofit без зміни всіх дзвінків

Ми використовуємо Retrofit у нашому додатку Android для спілкування із захищеним сервером OAuth2. Все чудово працює, ми використовуємо RequestIntercepttor для включення маркера доступу до кожного дзвінка. Однак наступить час, коли маркер доступу закінчиться, і маркер потрібно оновити. Коли маркер закінчиться, наступний дзвінок повернеться з несанкціонованим HTTP-кодом, тому це легко контролювати. Ми можемо змінити кожен виклик Retrofit наступним чином: У випадку зворотного виклику помилки перевірте код помилки, якщо він дорівнює Несанкціонованому, оновіть маркер OAuth та повторіть виклик модернізації. Однак для цього всі виклики повинні бути модифіковані, що не є легко ремонтом і хорошим рішенням. Чи є спосіб це зробити, не змінюючи всі дзвінки Retrofit?

Будь ласка, не використовуйте Interceptorsдля роботи з автентифікацією.

В даний час найкращим підходом до обробки автентифікації є використання нового AuthenticatorAPI, розробленого спеціально для цієї мети .

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 , який був представлений в . Ви хочете використовувати перехоплювач додатків , який дозволяє вам це робити .OkHttp 2.2.0retry 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);

Попередження: As Jesse Wilson(від площі) згадується тут , це небезпечне кількість енергії.

Зважаючи на це, я, безумовно, думаю, що це найкращий спосіб впоратися з таким чимось зараз. Якщо у вас є якісь питання, будь ласка, не соромтесь запитати їх у коментарі.

TokenAuthenticator залежить від класу обслуговування. Клас обслуговування залежить від екземпляра OkHttpClient. Для створення OkHttpClient мені потрібен TokenAuthenticator. Як я можу порушити цей цикл? Два різні 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 ВОЛІ НЕ НАЗВАЛИ )

• Якщо до getImage()цих пір не вдалися з помилкою 401, authenticateметод всередині TokenAuthenticatorволі вистрілив знову і знову , то він видасть помилку про виклик методу багато часу ( 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, так що я в кінцевому підсумку забезпечуючи клас обслуговування , як Лінивий впорскується в TokenAuthenticator, ви можете прочитати докладніше про «Ледачу ін'єкцію» в кинджалі 2 тут , але це як би сказати Дагеру НЕ йти і створити послугу, необхідну TokenAuthenticator відразу.

Ви можете звернутися до цього потоку SO для зразкового коду: Як вирішити кругову залежність, використовуючи Dagger2?

Ви можете спробувати створити базовий клас для всіх вантажників, у яких ви зможете зловити певний виняток, а потім діяти як потрібно. Зробіть так, щоб усі ваші навантажувачі виходили з базового класу, щоб поширити поведінку.

Після довгих досліджень я налаштував клієнт Apache для обробки Refreshing AccessToken For Retrofit, в якому ви надсилаєте маркер доступу як параметр.

Ініціюйте свій адаптер за допомогою постійного клієнта

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

Постійний клієнт-клієнт, який підтримує файли 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 : маркер не вводився під час першого дзвінка (перехоплювач), а автентифікатор викликався: було зроблено два запити.

Виправлення полягало лише в тому, щоб вплинути на запит на збірку в перехоплювачі:

ПЕРЕД:

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