Android retrofit auth interceptor

Token-Based Authentication with Retrofit | Android OAuth 2.0

Feb 15, 2020 · 3 min read

Retrofit is a type-safe HTTP client by Square that was built for the Android platform. It offers an easy and clean way to make REST API network calls and parses the JSON/XML response(s) into Java Objects which we can then use in our app.

As a security measure, most API access points require us e rs to provide an authentication token that can be used to verify the identity of the user making the request so as to grant them access to data/ resources from the backend. The client app usually fetches the token upon successful login or registration then saves the token locally and appends it to subsequent requests so that the server can authenticate the user.

In this blog we are going to see a clean way to append the logged in user’s token to our app API requests once the user has logged in. Our use case assumes the user needs to fetch a list of posts from the server.

Setup Project

First we’ll proceed and create a new Android Studio project. For this project we’ll be using Kotlin however the same implementation works for Java.

Add the Retrofit dependencies to your app/build.gradle:

Then add the internet permission in your AndroidManifest.xml

Setup models

Let’s create the User.kt class that will contain the basic details of the User. For our use case it will only contain the user ID, first name, last name and email.

For login, the user will be required to provide the email and password so let’s create the LoginRequest.kt data class.

On successful login, the user will receive a response containing the status code, authentication token and user details. Let’s create the LoginResponse.kt.

Setup Retrofit

We will create a Constants.kt class that will hold our static variables.

Then we will create the ApiClient.kt class that will initialize our Retrofit client instance and the ApiService.kt interface where we will define our API request functions.

Fetching the token

In order to be able to save and fetch the token on the user’s device, we will create a SessionManager.kt class.

On successful login, we will save the fetched token.

Adding the token to our requests

Now that our user can login, we can finally fetch a list of posts. Let’s first create a sample Post.kt object.

And the corresponding PostsResponse.kt data class.

In order to fetch the list of posts, we can add the authorization token as a header to the function to fetch posts then pass it as a parameter:

This should work quite well and we should be able to fetch the list of posts. However using this method means for each and every authenticated request we will have to add the Header parameter and pass the token from the function making the request. Not clean, is it?

Using a request Interceptor

Fortunately, Retrofit uses Okhttp through which we can add interceptors to our retrofit client. Retrofit triggers the Interceptor instance whenever a request is made.

Let’s go ahead and make an AuthInterceptor.kt for our requests so that we can add the token to the request.

We will then update our ApiClient.kt to include the custom Okhttp client.

Then we can remove the header parameter from our request function and from the function making the request then just call the request functions directly. For the unauthenticated endpoints such as login, the token value from Session Manager will be null thus will not be added to the request.

Источник

Headers, Interceptors, and Authenticators with Retrofit

In Android sometimes you need to add a couple of parameters, like headers, to make a successful request, this is normal behavior from all the Android Apps when you are using Retrofit, you can do it in multiple ways

For example, you can add parameters directly to your request interface using the annotation Headers and putting a plain String, like this:

Another solution is to send the Headers as a parameter to your interface function, using an annotation Header and sending a parameter, this gives you the possibility to have a custom parameter that you can manage from every request:

Interceptor

A couple of people using Dagger probably will go for an Interceptor, you can have two types of interceptor:
The first one is using an interceptor directly in your Singleton, this will not give you versatility, but it will solve your problem faster, in this example, you can go for the chain object, get the request of the Retrofit call, get a new Builder and then add the Headers.

Or you can use this as file apart, extending Interceptor class, this will let you have the reusable code.

Authenticator

Imagine you want to catch the response before to go to your Observable, maybe trying to catch a specific error before hitting your Throwable, for this specific behavior you need an Authenticator.
This authenticator will catch the response, when there is an error (401 error) then we will update the AuthToken for the failed request and it will send resend the request, no need to send anything else or make any logic inside your presentation layer.

To make the implementation you only need to set this object like this:

And you re ready to go.
Happy Coding! 👩🏻‍💻

If you have questions, you can reach me here.

Источник

Использование Retrofit 2.x в качестве REST клиента — Tutorial

1.1. Что такое Retrofit

Retrofit — это REST клиент для Java и Android. Он позволяет легко получить и загрузить JSON (или другие структурированные данные) через веб-сервис на основе REST. В Retrofit вы настраиваете, какой конвертер используется для сериализации данных. Обычно для JSON используется GSon, но вы можете добавлять собственные конвертеры для обработки XML или других протоколов. В Retrofit используется библиотека OkHttp для HTTP-запросов.

Вы можете создавать объекты Java на основе JSON, используя следующий инструмент: www.jsonschema2pojo.org Это может быть полезно для создания сложных структур данных Java из существующего JSON.

1.2. Использование Retrofit

Для работы с Retrofit вам понадобятся следующие три класса:

• Model класс, который используется как модель JSON
• Интерфейсы, которые определяют возможные HTTP операции
• Класс Retrofit.Builder — экземпляр, который использует интерфейс и API Builder, чтобы задать определение конечной точки URL для операций HTTP

Каждый метод интерфейса представляет собой один из возможных вызовов API. Он должен иметь HTTP аннотацию (GET, POST и т. д.), чтобы указать тип запроса и относительный URL. Возвращаемое значение завершает ответ в Call-объекте с типом ожидаемого результата.

Можно использовать замещающие блоки и параметры запроса для настройки URL-адреса. Замещающий блок добавляется к относительному URL-адресу с помощью <>. С помощью аннотации @ Path для параметра метода значение этого параметра привязывается к конкретному замещающему блоку.

Параметры запроса добавляются с помощью аннотации @ Query к параметру метода. Они автоматически добавляются в конце URL-адреса.

Аннотация @ Body к параметру метода говорит Retrofit использовать объект в качестве тела запроса для вызова.

2. Предварительные требования

В следующих примерах используется Eclipse IDE с системой сборки Gradle.
Это упражнение предполагает, что вы знакомы с Gradle и использованием Gradle с Eclipse.

Другие среды разработки, такие как Visual Studio Code или IntelliJ, позволяют сделать то же самое, так что вы можете использовать свой любимый инструмент.

3. Упражнение: Первый Retrofit клиент

В этом упражнении вы создадите автономный REST клиент. Ответы генерируются Mock-сервером.

3.1. Создание и настройка проекта

Создайте новый проект Gradle, с именем com.vogella.retrofitgerrit. Добавьте новый пакет в src/main/java с именем com.vogella.retrofitgerrit.

Добавьте следующие зависимости в файл build.gradle.

3.2. Определите API и Retrofit адаптер

В JSON ответе от Gerrit нас интересует только вопрос об изменениях. Поэтому создайте следующий класс данных в ранее добавленном пакете по умолчанию.

Определите REST API для Retrofit через следующий интерфейс.

Создайте следующий класс контроллера. Этот класс создает Retrofit клиент, вызывает Gerrit API и обрабатывает результат (выводит результат вызова в консоль).

Создайте класс с main-методом для запуска контроллера.

4. Retrofit конвертеры и адаптеры

4.1. Retrofit конвертеры

Retrofit может быть настроен на использование конкретного конвертера. Этот конвертер обрабатывает (де)сериализацию данных. Несколько конвертеров уже доступны для различных форматов сериализации.

• Для конвертации в JSON и обратно:
  • Gson: com.squareup.retrofit:converter-gson
  • Jackson: com.squareup.retrofit:converter-jackson
  • Moshi: com.squareup.retrofit:converter-moshi

• Для конвертации в Protocol Buffers и обратно:
  • Protobuf: com.squareup.retrofit:converter-protobuf
  • Wire: com.squareup.retrofit:converter-wire

• Для конвертации в XML и обратно:
  • Simple XML: com.squareup.retrofit:converter-simplexml

Помимо перечисленных конвертеров, вы также можете создавать собственные для обработки других протоколов путем расширения класса Converter.Factory.

4.2. Retrofit Адаптеры

Retrofit также может быть расширен адаптерами для взаимодействия с другими библиотеками, такими как RxJava 2.x, Java 8 и Guava.

Обзор доступных адаптеров можно найти на Github square/retrofit/retrofit-adapters/.

Например, адаптер RxJava 2.x можно подключить, используя Gradle:

или используя Apache Maven:

Чтобы добавить адаптер, необходимо использовать метод retrofit2.Retrofit.Builder.addCallAdapterFactory(Factory).

При использовании этого адаптера интерфейсы Retrofit могут возвращать типы RxJava 2.x, например, Observable, Flowable или Single и т. д.

5. Retrofit аутентификация

Retrofit поддерживает вызовы API, требующие аутентификации. Аутентификацию можно выполнить, используя имя пользователя и пароль (аутентификация Http Basic) или API токен.

Существует два способа управления аутентификацией. Первый метод — управлять заголовком запроса с помощью аннотаций. Другой способ — использовать для этого OkHttp перехватчик.

5.1. Аутентификация с аннотациями

Предположим, что вы хотите запросить информацию о пользователе, для которой требуется аутентификация. Вы можете сделать это, добавив новый параметр в определение API, например:

С помощью аннотации @ Header(«Authorization») вы говорите Retrofit добавить заголовок Authorization в запрос со значением, которое вы передаете.

Чтобы генерировать учетные данные для Basic authentication, вы можете использовать класс OkHttps Credentials с его базовым (String, String) методом. Метод принимает имя пользователя и пароль и возвращает учетные данные аутентификации для Http Basic схемы.

Если вы хотите использовать API токен и не использовать Basic схему, просто вызовите метод getUserDetails(String) с вашим токеном.

5.2. Аутентификация с помощью OkHttp перехватчиков.

Метод выше добавляет учетные данные, только если вы запрашиваете данные пользователя. Если у вас больше вызовов, требующих аутентификации, для этого вы можете использовать перехватчик. Перехватчик используется для изменения каждого запроса до его выполнения и устанавливает заголовок запроса. Преимущество состоит в том, что вам не нужно добавлять @ Header(«Authorization») к каждому определению метода API.

Чтобы добавить перехватчик, вы должны использовать метод okhttp3.OkHttpClient.Builder.addInterceptor(Interceptor) в OkHttp Builder.

Созданный OkHttp клиент должен быть добавлен в ваш Retrofit клиент с помощью метода retrofit2.Retrofit.Builder.client(OkHttpClient).

Как вы заметили, здесь используется класс Credentials для Basic авторизации.
Опять же, если вы хотите использовать токен API, просто используйте вместо этого токен.

6. Упражнение: использование Retrofit для запроса к Gerrit в Java

В следующем разделе описывается, как создать минимальное Java приложение, которое использует Retrofit для получения объектов открытых изменений из Gerrit API. Результаты печатаются в консоли.

6.1. Создание и настройка проекта

Это упражнение предполагает, что вы знакомы с Gradle и Buildship для Eclipse.

Создайте новый проект Gradle с именем com.vogella.java.retrofitgerrit. Добавьте новый пакет в src/main/java с именем com.vogella.java.retrofitgerrit.

Добавьте следующие зависимости в файл build.gradle.

6.2. Определите API и Retrofit адаптер

В JSON ответе от Gerrit нас интересует только вопрос об изменениях. Поэтому создайте следующий класс данных в ранее добавленном пакете по умолчанию.

Определите REST API для Retrofit с помощью следующего интерфейса.

Создайте следующий класс контроллера. Этот класс создает Retrofit клиент, вызывает Gerrit API и обрабатывает результат (выводит результат вызова в консоль).

Создайте класс с main-методом для запуска контроллера.

7. Упражнение: использование Retrofit для конвертирования XML-ответа от RSS-канала

В этом разделе описывается использование Retrofit для преобразования XML-ответа с помощью SimpleXMLConverter.

Создается минимальное приложение Java, которое запрашивает RSS-канал Vogella (http://vogella.com/article.rss) и печатает название канала, названия и ссылки на статьи.

7.1. Создание и настройка проекта

Это упражнение предполагает, что вы знакомы с Gradle и Buildship для Eclipse.

Создайте новый проект Gradle с именем com.vogella.java.retrofitxml. Добавьте новый пакет в src/main/java с именем com.vogella.java.retrofitxml.

Добавьте следующие зависимости в файл build.gradle.

7.2. Определяем XML представление

Новостная RSS лента выглядит следующим образом:

Кроме XML заголовка этот файл состоит из различных элементов XML. Rss-элемент содержит элемент канала, в котором содержатся другие элементы (например, title, description, pubDate) и несколько item-элементов (статей).

Создайте следующие два класса данных: RSSFeed и Article.

Класс Article представляет одну статью и сохраняет только название и ссылку на статью. Это единственные поля, которые нас интересуют.

Аннотация @ Root помечает класс как подлежащий (де)сериализации. При желании вы можете указать имя в @ Root аннотации, которая соответствует имени XML элемента. Если имя не указано, имя класса используется как имя XML элемента. Поскольку имя класса (RSSFeed) отличается от имени элемента XML (rss), нам нужно указать имя.

Когда в strict параметр установлено значение false, строгий парсинг отключен. Это говорит парсеру не прерываться и не генерировать исключение, если найден XML элемент или атрибут, для которого не представлено сопоставление. Поскольку rss-элемент имеет атрибут version, для которого нет соответствующего поля, приложение будет генерировать ошибку, если strict параметр не установлен как false.

С помощью аннотации @ Element представляется XML-элемент. При необходимости можно указать имя XML элемента, представленного этим полем. Если имя не указано, используется имя поля.

Поле articleList аннотируется с помощью @ ElementList. Это показывает, что это поле используется для хранения коллекции (в нашем случае: List ) XML элементов с тем же именем. Когда inline установлено значение true, это значит, что элементы коллекции перечислены один за другим сразу внутри заданного элемента и не имеют промежуточного родительского элемента.

С помощью аннотации @ Path можно указать путь к элементу XML внутри дерева XML. Это полезно, если вы не хотите моделировать полное дерево XML с объектами Java. Для названия канала и нескольких item-элементов мы можем напрямую указывать на конкретные элементы в channel-элементе.

7.3. Определение API и Retrofit адаптера

Определите REST API для Retrofit через следующий интерфейс.

Создайте следующий класс контроллера. Этот класс создает Retrofit клиент, вызывает Vogella API и обрабатывает результат.

Последний шаг — создать класс с main-методом для запуска контроллера.

8. Упражнение: Создание приложения для запроса к StackOverflow

StackOverflow — популярный сайт для вопросов связанных с программированиес. Он также предоставляет REST API, хорошо документированный на странице Stackoverflow API.

В этом упражнении вы будете использовать REST Retrofit библиотеку. Вы будете ее использовать для запроса к StackOverflow вопросов по тегу и их ответов.

В нашем примере мы используем следующий URL-адрес запроса. Откройте этот URL в браузере и посмотрите на ответ.

8.1. Создание и настройка проекта

Создайте приложение для Android, с названием com.vogella.android.stackoverflow. Используйте com.vogella.android.stackoverflow как имя пакета верхнего уровня.

Добавьте следующие зависимости в файл build.gradle.

8.2. Создание модели данных

Нас интересуют вопросы и ответы от Stackoverflow. Для этой цели создайте следующие два класса данных.

8.3. Создание activity и layout

Задайте activity_main.xml для вашей activity.

Добавьте в свой проект класс recycler view адаптера, с именем RecyclerViewAdapter.

Одна из возможных реализаций выглядит следующим образом.

Измените класс MainActivity таким образом:

8.4. Использование поддельного поставщика данных

Создайте поддельный поставщик данных и заполните spinner фальшивыми вопросами и recyclerview фальшивыми ответами (после изменения выбора в spinner).

Теперь настроим spinner и recyclerview для использования этих поддельных данных.

8.5. Добавление Gradle зависимостей и разрешений

Добавьте следующие зависимости в build.gradle файл.

Добавьте разрешение на доступ к Интернету в манифест.

8.6. Определение API и Retrofit адаптера

Stackoverflow API оборачивает ответы или вопросы в JSON объект с именем items. Чтобы обработать это, создайте следующий класс данных с именем ListWrapper. Это необходимо для того, чтобы обработать обертку элементов Stackoverflow. Этот класс принимает параметр типа и просто упаковывает список объектов этого типа.

Определите REST API для Retrofit через следующий интерфейс.

8.7. Установка activity

Измените код MainActivity следующим образом.

8.8. Необязательно: получение изображения профиля пользователя

Измените layout строки в recycler view, чтобы отобразить также изображение профиля пользователя. Расширьте свою модель данных, чтобы получать изображение профиля пользователя, который ответил на вопрос. Добавьте ImageView в layout строки и используйте библиотеку Glide для загрузки изображения.

8.9. Необязательно: используйте разные layout’ы для четных и нечетных строк

Измените реализацию адаптера, чтобы использовать разные макеты для четных и нечетных строк.

Это требует создания различных layout на основе типа данных. Используйте getItemViewType() в адаптере.

8.10. Необязательно: Обработка ошибки сети

Если у вас произошел сбой в сети, покажите кнопку повторного запроса вместо основного пользовательского интерфейса.

9. Упражнение: Использование Retrofit для доступа к GitHub API в Android

В этом упражнении описывается, как перечислить все GitHub репозитории для пользователя в приложении для Android с помощью Retrofit. Вы можете выбрать репозиторий из раскрывающегося списка и указать обсуждения (issues), относящиеся к пользователю для выбранного репозитория.

Затем вы можете выбрать обсуждение из дополнительного раскрывающегося поля и опубликовать комментарий к нему. DialogFragment будет использоваться для ввода учетных данных для аутентификации.

Убедитесь, что у вас есть учетная запись Github, поскольку это необходимо для этого упражнения. Поскольку Retrofit будет использоваться вместе с RxJava2 во время этого упражнения, обратите внимание также на RxJava2 Tutorial.

9.1. Настройка проекта

Создайте Android приложение с именем Retrofit Github. Используйте com.vogella.android.retrofitgithub как имя пакета верхнего уровня и используйте пустой шаблон. Убедитесь, что проставлен флаг «Backwards Compatibility» (Обратная совместимость).

Чтобы использовать Retrofit и RxJava2 CallAdapter, добавьте следующие зависимости в файл build.gradle

Добавьте разрешение на доступ к Интернету в манифест.

9.2. Определение API

Создайте следующие два класса данных: GithubIssue и GithubRepo.

Из информации о репозиториях только имя и URL-адрес репозитория будут отображены в раскрывающемся списке. Также добавляем владельца (owner) в класс данных, так как имя владельца необходимо для того, чтобы позже запрашивать обсуждения.

Мы показываем только id и заголовок обсуждения в раскрывающемся поле, поэтому создаем поле для каждого из них. Кроме того, ответ от Github содержит URL-адрес для публикации комментария, который сохраняется в поле comments_url. Чтобы позже опубликовать новый комментарий к Github API, добавляем поле с именем comment. Github API указывает, что содержимое комментария должно быть привязано к полю с именем body в запросе JSON. Поскольку Retrofit (де)сериализует все поля на основе их имени, и поскольку мы не хотим использовать тело в качестве имени поля в нашем классе GithubIssue, мы используем аннотацию @SerializedName. С помощью этой аннотации мы можем изменить имя, с которым поле (де)сериализуется в JSON.

К сожалению, класса GithubRepo недостаточно, чтобы запросить всю необходимую информацию о репозитории. Как вы видите здесь, владелец репозитория является отдельным JSON объектом в ответе репозитория, и поэтому обычно ему нужен соответствующий Java-класс для (де)сериализации. К счастью, Retrofit дает возможность добавить собственный типизированный JSONDeserializer для управления десериализацией определенного типа. Каждый раз, когда объект определенного типа должен быть десериализован, используется этот пользовательский десериализатор.

Для этого добавьте следующий класс GithubRepoDeserialzer.

Определите REST API для Retrofit через следующий интерфейс:

У вас может возникнуть вопрос об аннотации @ Url. С помощью этой аннотации мы можем указать URL для этого запроса. Это позволяет нам изменять URL для каждого запроса динамически. Нам нужно это для поля comments_url класса GithubIssue.

Аннотации @ Path связывают значение параметра с соответствующей переменной (фигурные скобки) в URL-адресе запроса. Это необходимо для указания владельца и имени репозитория, для которого должны быть запрошены обсуждения.

9.3. Диалоговое окно «Создание учетных данных»

Чтобы предоставить пользователю возможность хранить свои учетные данные в приложении, используется DialogFragment. Поэтому создайте следующий класс с именем CredentialsDialog, а также добавьте layout файл с именем dialog_credentials.xml в папку layout ресурсов.

Результат должен выглядеть примерно так, как показано на следующем скриншоте.

9.4. Создание Activity

Измените activity_main.xml следующим образом.

Две кнопки (для загрузки репозиториев и отправки комментария), два Spinner (раскрывающееся поле для отображения репозиториев и обсуждений) и EditText (для написания комментариев). Для запуска CredentialsDialog используется меню на панели инструментов Android. Чтобы создать его, добавьте xml файл меню с именем menu_main.xml в папку ресурсов меню (создайте папку, если она не существует).

Поскольку мы используем Toolbar виджет, вам нужно отключить action bar по умолчанию. Для этого измените xml style файл так, как показано ниже.

Измените код своей activity на следующий.

Здесь мы добавили созданный ранее GithubRepoDeserializer в качестве TypeAdapter в GsonBuilder. Чтобы обрабатывать аутентификацию для каждого вызова, добавили Interceptor в OkHttpClient. Чтобы методы API-интерфейса возвращали типы RxJava2, добавили RxJava2 CallAdapter к своему клиенту.

10. Упражнение: использование Retrofit с OAuth для запроса сведений о пользователе из Twitter на Android

В этом упражнении описывается, как войти в Twitter с помощью Retrofit на Android. Мы напишем приложение, которое может запрашивать и отображать данные пользователя для предоставленного имени пользователя. В этом упражнении мы используем аутентификацию Twitter application-only с OAuth 2 для авторизации. Чтобы это сделать это упражнение, вам необходимо иметь учетную запись Twitter. Кроме того, вам нужно перейти к приложениям Twitter и создать новое приложение, чтобы получить свой consumer key и сonsumer secret. Нам понадобится это позже, чтобы запросить наш токен OAuth.

10.1. Настройка проекта

Создайте приложение для Android с именем Retrofit Twitter. Используйте com.vogella.android.retrofittwitter как имя пакета верхнего уровня.

Чтобы использовать Retrofit, добавьте следующие строки в файл build.gradle

Добавьте разрешение на доступ к Интернету в манифест.

10.2. Определение API

Создайте следующие два класса данных, которые называются OAuthToken и UserDetails.

Класс OAuthToken используется для хранения bearer token, который мы запрашиваем у Twitter, с нашим ключом и тайной. Мы используем аннотацию @ SerializedName для установки имени Retrofit для (де)сериализации полей.

Класс UserDetails просто сохраняет несколько полей из ответа Twitter при запросе данных о пользователе. Мы не показываем все данные пользователя, которые содержались в ответе, только имя, местоположение, URL и описание.

Определите REST API для Retrofit через следующий интерфейс:

10.3. Создание Activity

Измените файл activity_main.xml и соответствующий класс MainActivity следующим образом:

Замените aConsumerKey и aSecret на consumer key и secret, полученные от Twitter.

Также взгляните на перехватчик, который мы добавляем к нашему Retrofit клиенту. Поскольку мы используем OAuth, наши учетные данные различаются для каждого вызова. Метод postCredentials должен размещать учетные данные (consumer key и secret) в Basic схеме для Twitter. В результате этот вызов возвращает bearer token, который Retrofit десериализует в наш класс OAuthToken, который затем сохраняется в поле токена. Любой другой запрос может (и должен) теперь использовать этот токен в качестве учетных данных для авторизации. Также запрашивается информация о пользователе.

Источник