[Перевод] Использование 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-объекте с типом ожидаемого результата.
@GET("users")
Call> getUsers();
Можно использовать замещающие блоки и параметры запроса для настройки URL-адреса. Замещающий блок добавляется к относительному URL-адресу с помощью {}. С помощью аннотации @ Path для параметра метода значение этого параметра привязывается к конкретному замещающему блоку.
@GET("users/{name}/commits")
Call> getCommitsByName(@Path("name") String name);
Параметры запроса добавляются с помощью аннотации @ Query к параметру метода. Они автоматически добавляются в конце URL-адреса.
@GET("users")
Call getUserById(@Query("id") Integer id);
Аннотация @ Body к параметру метода говорит Retrofit использовать объект в качестве тела запроса для вызова.
@POST("users")
Call postUser(@Body User user)
В следующих примерах используется Eclipse IDE с системой сборки Gradle.
Это упражнение предполагает, что вы знакомы с Gradle и использованием Gradle с Eclipse.
Другие среды разработки, такие как Visual Studio Code или IntelliJ, позволяют сделать то же самое, так что вы можете использовать свой любимый инструмент.
В этом упражнении вы создадите автономный REST клиент. Ответы генерируются Mock-сервером.
3.1. Создание и настройка проекта
Создайте новый проект Gradle, с именем com.vogella.retrofitgerrit. Добавьте новый пакет в src/main/java с именем com.vogella.retrofitgerrit.
Добавьте следующие зависимости в файл build.gradle.
// retrofit
implementation 'com.squareup.retrofit2:retrofit:2.1.0'
implementation 'com.squareup.retrofit2:converter-gson:2.1.0'
// Junit
testImplementation("org.junit.jupiter:junit-jupiter-api:5.0.0")
testRuntime("org.junit.jupiter:junit-jupiter-engine:5.0.0")
// to run JUnit 3/4 tests:
testImplementation("junit:junit:4.12")
testRuntime("org.junit.vintage:junit-vintage-engine:4.12.0")
3.2. Определите API и Retrofit адаптер
В JSON ответе от Gerrit нас интересует только вопрос об изменениях. Поэтому создайте следующий класс данных в ранее добавленном пакете по умолчанию.
package com.vogella.java.retrofitgerrit;
public class Change {
String subject;
public String getSubject() {
return subject;
}
public void setSubject(String subject) {
this.subject = subject;
}
}
Определите REST API для Retrofit через следующий интерфейс.
package com.vogella.java.retrofitgerrit;
import java.util.List;
import retrofit2.Call;
import retrofit2.http.GET;
import retrofit2.http.Query;
public interface GerritAPI {
@GET("changes/")
Call> loadChanges(@Query("q") String status);
}
Создайте следующий класс контроллера. Этот класс создает Retrofit клиент, вызывает Gerrit API и обрабатывает результат (выводит результат вызова в консоль).
package com.vogella.java.retrofitgerrit;
import java.util.List;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import retrofit2.Call;
import retrofit2.Callback;
import retrofit2.Response;
import retrofit2.Retrofit;
import retrofit2.converter.gson.GsonConverterFactory;
public class Controller implements Callback> {
static final String BASE_URL = "https://git.eclipse.org/r/";
public void start() {
Gson gson = new GsonBuilder()
.setLenient()
.create();
Retrofit retrofit = new Retrofit.Builder()
.baseUrl(BASE_URL)
.addConverterFactory(GsonConverterFactory.create(gson))
.build();
GerritAPI gerritAPI = retrofit.create(GerritAPI.class);
Call> call = gerritAPI.loadChanges("status:open");
call.enqueue(this);
}
@Override
public void onResponse(Call> call, Response> response) {
if(response.isSuccessful()) {
List changesList = response.body();
changesList.forEach(change -> System.out.println(change.subject));
} else {
System.out.println(response.errorBody());
}
}
@Override
public void onFailure(Call> call, Throwable t) {
t.printStackTrace();
}
}
Создайте класс с main-методом для запуска контроллера.
package com.vogella.java.retrofitgerrit;
public class Main {
public static void main(String[] args) {
Controller controller = new Controller();
controller.start();
}
}
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:
compile 'com.squareup.retrofit2:adapter-rxjava2:latest.version'
или используя Apache Maven:
com.squareup.retrofit2
adapter-rxjava2
latest.version
Чтобы добавить адаптер, необходимо использовать метод retrofit2.Retrofit.Builder.addCallAdapterFactory (Factory).
Retrofit retrofit = new Retrofit.Builder()
.baseUrl("https://api.example.com/")
.addCallAdapterFactory(RxJava2CallAdapterFactory.create())
.build();
При использовании этого адаптера интерфейсы Retrofit могут возвращать типы RxJava 2.x, например, Observable, Flowable или Single и т. д.
@GET("users")
Observable> getUsers();
Retrofit поддерживает вызовы API, требующие аутентификации. Аутентификацию можно выполнить, используя имя пользователя и пароль (аутентификация Http Basic) или API токен.
Существует два способа управления аутентификацией. Первый метод — управлять заголовком запроса с помощью аннотаций. Другой способ — использовать для этого OkHttp перехватчик.
5.1. Аутентификация с аннотациями
Предположим, что вы хотите запросить информацию о пользователе, для которой требуется аутентификация. Вы можете сделать это, добавив новый параметр в определение API, например:
@GET("user")
Call getUserDetails(@Header("Authorization") String credentials)
С помощью аннотации @ Header («Authorization») вы говорите Retrofit добавить заголовок Authorization в запрос со значением, которое вы передаете.
Чтобы генерировать учетные данные для Basic authentication, вы можете использовать класс OkHttps Credentials с его базовым (String, String) методом. Метод принимает имя пользователя и пароль и возвращает учетные данные аутентификации для Http Basic схемы.
Credentials.basic("ausername","apassword");
Если вы хотите использовать API токен и не использовать Basic схему, просто вызовите метод getUserDetails (String) с вашим токеном.
5.2. Аутентификация с помощью OkHttp перехватчиков.
Метод выше добавляет учетные данные, только если вы запрашиваете данные пользователя. Если у вас больше вызовов, требующих аутентификации, для этого вы можете использовать перехватчик. Перехватчик используется для изменения каждого запроса до его выполнения и устанавливает заголовок запроса. Преимущество состоит в том, что вам не нужно добавлять @ Header («Authorization») к каждому определению метода API.
Чтобы добавить перехватчик, вы должны использовать метод okhttp3.OkHttpClient.Builder.addInterceptor (Interceptor) в OkHttp Builder.
OkHttpClient okHttpClient = new OkHttpClient().newBuilder().addInterceptor(new Interceptor() {
@Override
public okhttp3.Response intercept(Chain chain) throws IOException {
Request originalRequest = chain.request();
Request.Builder builder = originalRequest.newBuilder().header("Authorization",
Credentials.basic("aUsername", "aPassword"));
Request newRequest = builder.build();
return chain.proceed(newRequest);
}
}).build();
Созданный OkHttp клиент должен быть добавлен в ваш Retrofit клиент с помощью метода retrofit2.Retrofit.Builder.client (OkHttpClient).
Retrofit retrofit = new Retrofit.Builder()
.baseUrl("https://api.example.com/")
.client(okHttpClient)
.build();
Как вы заметили, здесь используется класс Credentials для Basic авторизации.
Опять же, если вы хотите использовать токен API, просто используйте вместо этого токен.
В следующем разделе описывается, как создать минимальное Java приложение, которое использует Retrofit для получения объектов открытых изменений из Gerrit API. Результаты печатаются в консоли.
6.1. Создание и настройка проекта
Это упражнение предполагает, что вы знакомы с Gradle и Buildship для Eclipse.
Создайте новый проект Gradle с именем com.vogella.java.retrofitgerrit. Добавьте новый пакет в src/main/java с именем com.vogella.java.retrofitgerrit.
Добавьте следующие зависимости в файл build.gradle.
// retrofit
implementation 'com.squareup.retrofit2:retrofit:2.1.0'
implementation 'com.squareup.retrofit2:converter-gson:2.1.0'
// Junit
testImplementation("org.junit.jupiter:junit-jupiter-api:5.0.0")
testRuntime("org.junit.jupiter:junit-jupiter-engine:5.0.0")
// to run JUnit 3/4 tests:
testImplementation("junit:junit:4.12")
testRuntime("org.junit.vintage:junit-vintage-engine:4.12.0")
6.2. Определите API и Retrofit адаптер
В JSON ответе от Gerrit нас интересует только вопрос об изменениях. Поэтому создайте следующий класс данных в ранее добавленном пакете по умолчанию.
package com.vogella.java.retrofitgerrit;
public class Change {
String subject;
public String getSubject() {
return subject;
}
public void setSubject(String subject) {
this.subject = subject;
}
}
Определите REST API для Retrofit с помощью следующего интерфейса.
package com.vogella.java.retrofitgerrit;
import java.util.List;
import retrofit2.Call;
import retrofit2.http.GET;
import retrofit2.http.Query;
public interface GerritAPI {
@GET("changes/")
Call> loadChanges(@Query("q") String status);
}
Создайте следующий класс контроллера. Этот класс создает Retrofit клиент, вызывает Gerrit API и обрабатывает результат (выводит результат вызова в консоль).
package com.vogella.java.retrofitgerrit;
import java.util.List;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import retrofit2.Call;
import retrofit2.Callback;
import retrofit2.Response;
import retrofit2.Retrofit;
import retrofit2.converter.gson.GsonConverterFactory;
public class Controller implements Callback> {
static final String BASE_URL = "https://git.eclipse.org/r/";
public void start() {
Gson gson = new GsonBuilder()
.setLenient()
.create();
Retrofit retrofit = new Retrofit.Builder()
.baseUrl(BASE_URL)
.addConverterFactory(GsonConverterFactory.create(gson))
.build();
GerritAPI gerritAPI = retrofit.create(GerritAPI.class);
Call> call = gerritAPI.loadChanges("status:open");
call.enqueue(this);
}
@Override
public void onResponse(Call> call, Response> response) {
if(response.isSuccessful()) {
List changesList = response.body();
changesList.forEach(change -> System.out.println(change.subject));
} else {
System.out.println(response.errorBody());
}
}
@Override
public void onFailure(Call> call, Throwable t) {
t.printStackTrace();
}
}
Создайте класс с main-методом для запуска контроллера.
package com.vogella.java.retrofitgerrit;
public class Main {
public static void main(String[] args) {
Controller controller = new Controller();
controller.start();
}
}
В этом разделе описывается использование 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.
implementation 'com.squareup.retrofit2:retrofit:2.1.0'
implementation 'com.squareup.retrofit2:converter-simplexml:2.1.0'
7.2. Определяем XML представление
Новостная RSS лента выглядит следующим образом:
Eclipse and Android Information
http://www.vogella.com
Eclipse and Android Information
en
Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Germany (CC BY-NC-SA 3.0)
Tue, 03 May 2016 11:46:11 +0200
-
Android user interface testing with Espresso - Tutorial
This tutorial describes how to test Android applications with the Android Espresso testing framework.
http://www.vogella.com/tutorials/AndroidTestingEspresso/article.html
lars.vogel@vogella.com (Lars Vogel)
http://www.vogella.com/tutorials/AndroidTestingEspresso/article.html
-
Using the Gradle build system in the Eclipse IDE - Tutorial
This article describes how to use the Gradle tooling in Eclipse
http://www.vogella.com/tutorials/EclipseGradle/article.html
lars.vogel@vogella.com (Lars Vogel)
http://www.vogella.com/tutorials/EclipseGradle/article.html
-
Unit tests with Mockito - Tutorial
This tutorial explains testing with the Mockito framework for writting software tests.
http://www.vogella.com/tutorials/Mockito/article.html
lars.vogel@vogella.com (Lars Vogel)
http://www.vogella.com/tutorials/Mockito/article.html
Кроме XML заголовка этот файл состоит из различных элементов XML. Rss-элемент содержит элемент канала, в котором содержатся другие элементы (например, title, description, pubDate) и несколько item-элементов (статей).
Создайте следующие два класса данных: RSSFeed и Article.
package com.vogella.java.retrofitxml;
import org.simpleframework.xml.Element;
import org.simpleframework.xml.Root;
@Root(name = "item", strict = false)
public class Article {
@Element(name = "title")
private String title;
@Element(name = "link")
private String link;
public String getTitle() {
return title;
}
public void setTitle(String title) {
this.title = title;
}
public String getLink() {
return link;
}
public void setLink(String link) {
this.link = link;
}
}
package com.vogella.java.retrofitxml;
import java.util.List;
import org.simpleframework.xml.Element;
import org.simpleframework.xml.ElementList;
import org.simpleframework.xml.Path;
import org.simpleframework.xml.Root;
@Root(name="rss", strict=false)
public class RSSFeed {
@Element(name="title")
@Path("channel")
private String channelTitle;
@ElementList(name="item", inline=true)
@Path("channel")
private List articleList;
public String getChannelTitle() {
return channelTitle;
}
public void setChannelTitle(String channelTitle) {
this.channelTitle = channelTitle;
}
public List getArticleList() {
return articleList;
}
public void setArticleList(List articleList) {
this.articleList = articleList;
}
}
Класс 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 через следующий интерфейс.
package com.vogella.java.retrofitxml;
import retrofit2.Call;
import retrofit2.http.GET;
public interface VogellaAPI {
@GET("article.rss")
Call loadRSSFeed();
}
Создайте следующий класс контроллера. Этот класс создает Retrofit клиент, вызывает Vogella API и обрабатывает результат.
package com.vogella.java.retrofitxml;
import retrofit2.Call;
import retrofit2.Callback;
import retrofit2.Response;
import retrofit2.Retrofit;
import retrofit2.converter.simplexml.SimpleXmlConverterFactory;
public class Controller implements Callback {
static final String BASE_URL = "http://vogella.com/";
public void start() {
Retrofit retrofit = new Retrofit.Builder().baseUrl(BASE_URL)
.addConverterFactory(SimpleXmlConverterFactory.create()).build();
VogellaAPI vogellaAPI = retrofit.create(VogellaAPI.class);
Call call = vogellaAPI.loadRSSFeed();
call.enqueue(this);
}
@Override
public void onResponse(Call call, Response response) {
if (response.isSuccessful()) {
RSSFeed rss = response.body();
System.out.println("Channel title: " + rss.getChannelTitle());
rss.getArticleList().forEach(
article -> System.out.println("Title: " + article.getTitle() + " Link: " + article.getLink()));
} else {
System.out.println(response.errorBody());
}
}
@Override
public void onFailure(Call call, Throwable t) {
t.printStackTrace();
}
}
Последний шаг — создать класс с main-методом для запуска контроллера.
package com.vogella.java.retrofitxml;
public class Application {
public static void main(String[] args) {
Controller ctrl = new Controller();
ctrl.start();
}
}
StackOverflow — популярный сайт для вопросов связанных с программированиес. Он также предоставляет REST API, хорошо документированный на странице Stackoverflow API.
В этом упражнении вы будете использовать REST Retrofit библиотеку. Вы будете ее использовать для запроса к StackOverflow вопросов по тегу и их ответов.
В нашем примере мы используем следующий URL-адрес запроса. Откройте этот URL в браузере и посмотрите на ответ.
https://api.stackexchange.com/2.2/search?order=desc&sort=votes&tagged=android&site=stackoverflow
8.1. Создание и настройка проекта
Создайте приложение для Android, с названием com.vogella.android.stackoverflow. Используйте com.vogella.android.stackoverflow как имя пакета верхнего уровня.
Добавьте следующие зависимости в файл build.gradle.
compile "com.android.support:recyclerview-v7:25.3.1"
compile 'com.google.code.gson:gson:2.8.1'
8.2. Создание модели данных
Нас интересуют вопросы и ответы от Stackoverflow. Для этой цели создайте следующие два класса данных.
package com.vogella.android.stackoverflow;
import com.google.gson.annotations.SerializedName;
public class Question {
public String title;
public String body;
@SerializedName("question_id")
public String questionId;
@Override
public String toString() {
return(title);
}
}
package com.vogella.android.stackoverflow;
import com.google.gson.annotations.SerializedName;
public class Answer {
@SerializedName("answer_id")
public int answerId;
@SerializedName("is_accepted")
public boolean accepted;
public int score;
@Override
public String toString() {
return answerId + " - Score: " + score + " - Accepted: " + (accepted ? "Yes" : "No");
}
}
8.3. Создание activity и layout
Задайте activity_main.xml для вашей activity.
Добавьте в свой проект класс recycler view адаптера, с именем RecyclerViewAdapter.
Одна из возможных реализаций выглядит следующим образом.
package com.vogella.android.stackoverflow;
import android.support.v7.widget.RecyclerView;
import android.view.LayoutInflater;
import android.view.View;
import android.view.ViewGroup;
import android.widget.TextView;
import java.util.List;
public class RecyclerViewAdapter extends RecyclerView.Adapter {
private List data;
public class ViewHolder extends RecyclerView.ViewHolder {
public TextView text;
public ViewHolder(View v) {
super(v);
text = (TextView) v.findViewById(android.R.id.text1);
}
}
public RecyclerViewAdapter(List data) {
this.data = data;
}
@Override
public RecyclerViewAdapter.ViewHolder onCreateViewHolder(ViewGroup parent, int viewType) {
View v;
v = LayoutInflater.from(parent.getContext()).inflate(android.R.layout.simple_selectable_list_item, parent, false);
return new ViewHolder(v);
}
@Override
public void onBindViewHolder(RecyclerViewAdapter.ViewHolder holder, int position) {
Answer answer = ((Answer) data.get(position));
holder.text.setText(answer.toString());
holder.itemView.setTag(answer.answerId);
}
@Override
public int getItemCount() {
return data.size();
}
}
Измените класс MainActivity таким образом:
package com.vogella.android.stackoverflow;
import android.app.Activity;
import android.content.Intent;
import android.os.Bundle;
import android.support.v7.widget.LinearLayoutManager;
import android.support.v7.widget.RecyclerView;
import android.util.Log;
import android.view.View;
import android.widget.AdapterView;
import android.widget.ArrayAdapter;
import android.widget.Button;
import android.widget.Spinner;
import android.widget.Toast;
import java.util.ArrayList;
import java.util.List;
public class MainActivity extends Activity implements View.OnClickListener {
private String token;
private Button authenticateButton;
private Spinner questionsSpinner;
private RecyclerView recyclerView;
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
questionsSpinner = (Spinner) findViewById(R.id.questions_spinner);
questionsSpinner.setOnItemSelectedListener(new AdapterView.OnItemSelectedListener() {
@Override
public void onItemSelected(AdapterView parent, View view, int position, long id) {
Toast.makeText(MainActivity.this, "Spinner item selected", Toast.LENGTH_LONG).show();
}
@Override
public void onNothingSelected(AdapterView parent) {
}
});
authenticateButton = (Button) findViewById(R.id.authenticate_button);
recyclerView = (RecyclerView) findViewById(R.id.list);
recyclerView.setHasFixedSize(true);
recyclerView.setLayoutManager(new LinearLayoutManager(MainActivity.this));
}
@Override
protected void onResume() {
super.onResume();
if (token != null) {
authenticateButton.setEnabled(false);
}
}
@Override
public void onClick(View v) {
switch (v.getId()) {
case android.R.id.text1:
if (token != null) {
// TODO
} else {
Toast.makeText(this, "You need to authenticate first", Toast.LENGTH_LONG).show();
}
break;
case R.id.authenticate_button:
// TODO
break;
}
}
@Override
protected void onActivityResult(int requestCode, int resultCode, Intent data) {
if (resultCode == RESULT_OK && requestCode == 1) {
token = data.getStringExtra("token");
}
}
}
8.4. Использование поддельного поставщика данных
Создайте поддельный поставщик данных и заполните spinner фальшивыми вопросами и recyclerview фальшивыми ответами (после изменения выбора в spinner).
package com.vogella.android.stackoverflow;
import java.util.ArrayList;
import java.util.List;
public class FakeDataProvider {
public static List getQuestions(){
List questions = new ArrayList<>();
for (int i = 0; i<10; i++) {
Question question = new Question();
question.questionId = String.valueOf(i);
question.title = String.valueOf(i);
question.body = String.valueOf(i) + "Body";
questions.add(question);
}
return questions;
}
public static List getAnswers(){
List answers = new ArrayList<>();
for (int i = 0; i<10; i++) {
Answer answer = new Answer();
answer.answerId = i;
answer.accepted = false;
answer.score = i;
answers.add(answer);
}
return answers;
}
}
Теперь настроим spinner и recyclerview для использования этих поддельных данных.
package com.vogella.android.stackoverflow;
import android.app.Activity;
import android.content.Intent;
import android.os.Bundle;
import android.support.v7.widget.LinearLayoutManager;
import android.support.v7.widget.RecyclerView;
import android.view.View;
import android.widget.AdapterView;
import android.widget.ArrayAdapter;
import android.widget.Button;
import android.widget.Spinner;
import android.widget.Toast;
import java.util.List;
public class MainActivity extends Activity implements View.OnClickListener {
private String token;
private Button authenticateButton;
private Spinner questionsSpinner;
private RecyclerView recyclerView;
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
questionsSpinner = (Spinner) findViewById(R.id.questions_spinner);
questionsSpinner.setOnItemSelectedListener(new AdapterView.OnItemSelectedListener() {
@Override
public void onItemSelected(AdapterView parent, View view, int position, long id) {
Toast.makeText(MainActivity.this, "Spinner item selected", Toast.LENGTH_LONG).show();
}
@Override
public void onNothingSelected(AdapterView parent) {
}
});
List questions = FakeDataProvider.getQuestions();
ArrayAdapter arrayAdapter = new ArrayAdapter(MainActivity.this, android.R.layout.simple_spinner_dropdown_item, questions);
questionsSpinner.setAdapter(arrayAdapter);
authenticateButton = (Button) findViewById(R.id.authenticate_button);
recyclerView = (RecyclerView) findViewById(R.id.list);
recyclerView.setHasFixedSize(true);
recyclerView.setLayoutManager(new LinearLayoutManager(MainActivity.this));
List answers = FakeDataProvider.getAnswers();
RecyclerViewAdapter adapter = new RecyclerViewAdapter(answers);
recyclerView.setAdapter(adapter);
}
@Override
protected void onResume() {
super.onResume();
if (token != null) {
authenticateButton.setEnabled(false);
}
}
@Override
public void onClick(View v) {
switch (v.getId()) {
case android.R.id.text1:
if (token != null) {
// TODO
} else {
Toast.makeText(this, "You need to authenticate first", Toast.LENGTH_LONG).show();
}
break;
case R.id.authenticate_button:
// TODO
break;
}
}
@Override
protected void onActivityResult(int requestCode, int resultCode, Intent data) {
if (resultCode == RESULT_OK && requestCode == 1) {
token = data.getStringExtra("token");
}
}
}
8.5. Добавление Gradle зависимостей и разрешений
Добавьте следующие зависимости в build.gradle файл.
implementation 'com.squareup.retrofit2:retrofit:2.1.0'
implementation 'com.squareup.retrofit2:converter-gson:2.1.0'
Добавьте разрешение на доступ к Интернету в манифест.
8.6. Определение API и Retrofit адаптера
Stackoverflow API оборачивает ответы или вопросы в JSON объект с именем items. Чтобы обработать это, создайте следующий класс данных с именем ListWrapper. Это необходимо для того, чтобы обработать обертку элементов Stackoverflow. Этот класс принимает параметр типа и просто упаковывает список объектов этого типа.
package com.vogella.android.stackoverflow;
import java.util.List;
public class ListWrapper {
List items;
}
Определите REST API для Retrofit через следующий интерфейс.
package com.vogella.android.stackoverflow;
import java.util.List;
import okhttp3.ResponseBody;
import retrofit2.http.Field;
import retrofit2.http.FormUrlEncoded;
import retrofit2.http.GET;
import retrofit2.http.POST;
import retrofit2.http.Path;
import retrofit2.Call;
public interface StackOverflowAPI {
String BASE_URL = "https://api.stackexchange.com/";
@GET("/2.2/questions?order=desc&sort=votes&site=stackoverflow&tagged=android&filter=withbody")
Call> getQuestions();
@GET("/2.2/questions/{id}/answers?order=desc&sort=votes&site=stackoverflow")
Call> getAnswersForQuestion(@Path("id") String questionId);
}
8.7. Установка activity
Измените код MainActivity следующим образом.
package com.vogella.android.stackoverflow;
import android.app.Activity;
import android.content.Intent;
import android.os.Bundle;
import android.support.v7.widget.LinearLayoutManager;
import android.support.v7.widget.RecyclerView;
import android.util.Log;
import android.view.View;
import android.widget.AdapterView;
import android.widget.ArrayAdapter;
import android.widget.Button;
import android.widget.Spinner;
import android.widget.Toast;
import com.google.gson.Gson;
import com.google.gson.GsonBuilder;
import java.util.ArrayList;
import java.util.List;
import okhttp3.ResponseBody;
import retrofit2.Call;
import retrofit2.Callback;
import retrofit2.Response;
import retrofit2.Retrofit;
import retrofit2.converter.gson.GsonConverterFactory;
public class MainActivity extends Activity implements View.OnClickListener {
private StackOverflowAPI stackoverflowAPI;
private String token;
private Button authenticateButton;
private Spinner questionsSpinner;
private RecyclerView recyclerView;
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
questionsSpinner = (Spinner) findViewById(R.id.questions_spinner);
questionsSpinner.setOnItemSelectedListener(new AdapterView.OnItemSelectedListener() {
@Override
public void onItemSelected(AdapterView parent, View view, int position, long id) {
Question question = (Question) parent.getAdapter().getItem(position);
stackoverflowAPI.getAnswersForQuestion(question.questionId).enqueue(answersCallback);
}
@Override
public void onNothingSelected(AdapterView parent) {
}
});
authenticateButton = (Button) findViewById(R.id.authenticate_button);
recyclerView = (RecyclerView) findViewById(R.id.list);
recyclerView.setHasFixedSize(true);
recyclerView.setLayoutManager(new LinearLayoutManager(MainActivity.this));
createStackoverflowAPI();
stackoverflowAPI.getQuestions().enqueue(questionsCallback);
}
@Override
protected void onResume() {
super.onResume();
if (token != null) {
authenticateButton.setEnabled(false);
}
}
private void createStackoverflowAPI() {
Gson gson = new GsonBuilder()
.setDateFormat("yyyy-MM-dd'T'HH:mm:ssZ")
.create();
Retrofit retrofit = new Retrofit.Builder()
.baseUrl(StackOverflowAPI.BASE_URL)
.addConverterFactory(GsonConverterFactory.create(gson))
.build();
stackoverflowAPI = retrofit.create(StackOverflowAPI.class);
}
@Override
public void onClick(View v) {
switch (v.getId()) {
case android.R.id.text1:
if (token != null) {
//TODO
} else {
Toast.makeText(this, "You need to authenticate first", Toast.LENGTH_LONG).show();
}
break;
case R.id.authenticate_button:
// TODO
break;
}
}
@Override
protected void onActivityResult(int requestCode, int resultCode, Intent data) {
if (resultCode == RESULT_OK && requestCode == 1) {
token = data.getStringExtra("token");
}
}
Callback> questionsCallback = new Callback>() {
@Override
public void onResponse(Call> call, Response> response) {
if (response.isSuccessful()) {
ListWrapper questions = response.body();
ArrayAdapter arrayAdapter = new ArrayAdapter(MainActivity.this, android.R.layout.simple_spinner_dropdown_item, questions.items);
questionsSpinner.setAdapter(arrayAdapter);
} else {
Log.d("QuestionsCallback", "Code: " + response.code() + " Message: " + response.message());
}
}
@Override
public void onFailure(Call> call, Throwable t) {
t.printStackTrace();
}
};
Callback> answersCallback = new Callback>() {
@Override
public void onResponse(Call> call, Response> response) {
if (response.isSuccessful()) {
List data = new ArrayList<>();
data.addAll(response.body().items);
recyclerView.setAdapter(new RecyclerViewAdapter(data));
} else {
Log.d("QuestionsCallback", "Code: " + response.code() + " Message: " + response.message());
}
}
@Override
public void onFailure(Call> call, Throwable t) {
t.printStackTrace();
}
};
Callback upvoteCallback = new Callback() {
@Override
public void onResponse(Call call, Response response) {
if (response.isSuccessful()) {
Toast.makeText(MainActivity.this, "Upvote successful", Toast.LENGTH_LONG).show();
} else {
Log.d("QuestionsCallback", "Code: " + response.code() + " Message: " + response.message());
Toast.makeText(MainActivity.this, "You already upvoted this answer", Toast.LENGTH_LONG).show();
}
}
@Override
public void onFailure(Call call, Throwable t) {
t.printStackTrace();
}
};
}
8.8. Необязательно: получение изображения профиля пользователя
Измените layout строки в recycler view, чтобы отобразить также изображение профиля пользователя. Расширьте свою модель данных, чтобы получать изображение профиля пользователя, который ответил на вопрос. Добавьте ImageView в layout строки и используйте библиотеку Glide для загрузки изображения.
8.9. Необязательно: используйте разные layout«ы для четных и нечетных строк
Измените реализацию адаптера, чтобы использовать разные макеты для четных и нечетных строк.
Это требует создания различных layout на основе типа данных. Используйте getItemViewType () в адаптере.
8.10. Необязательно: Обработка ошибки сети
Если у вас произошел сбой в сети, покажите кнопку повторного запроса вместо основного пользовательского интерфейса.
В этом упражнении описывается, как перечислить все 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
implementation 'com.squareup.retrofit2:retrofit:2.3.0'
implementation 'com.squareup.retrofit2:converter-gson:2.3.0'
implementation 'com.squareup.retrofit2:adapter-rxjava2:2.3.0'
implementation 'io.reactivex.rxjava2:rxandroid:2.0.1'
Добавьте разрешение на доступ к Интернету в манифест.
9.2. Определение API
Создайте следующие два класса данных: GithubIssue и GithubRepo.
package com.vogella.android.retrofitgithub;
import com.google.gson.annotations.SerializedName;
public class GithubIssue {
String id;
String title;
String comments_url;
@SerializedName("body")
String comment;
@Override
public String toString() {
return id + " - " + title;
}
}
package com.vogella.android.retrofitgithub;
public class GithubRepo {
String name;
String owner;
String url;
@Override
public String toString() {
return(name + " " + url);
}
}
Из информации о репозиториях только имя и URL-адрес репозитория будут отображены в раскрывающемся списке. Также добавляем владельца (owner) в класс данных, так как имя владельца необходимо для того, чтобы позже запрашивать обсуждения.
Мы показываем только id и заголовок обсуждения в раскрывающемся поле, поэтому создаем поле для каждого из них. Кроме того, ответ от Github содержит URL-адрес для публикации комментария, который сохраняется в поле comments_url. Чтобы позже опубликовать новый комментарий к Github API, добавляем поле с именем comment. Github API указывает, что содержимое комментария должно быть привязано к полю с именем body в запросе JSON. Поскольку Retrofit (де)сериализует все поля на основе их имени, и поскольку мы не хотим использовать тело в качестве имени поля в нашем классе GithubIssue, мы используем аннотацию @SerializedName. С помощью этой аннотации мы можем изменить имя, с которым поле (де)сериализуется в JSON.
К сожалению, класса GithubRepo недостаточно, чтобы запросить всю необходимую информацию о репозитории. Как вы видите здесь, владелец репозитория является отдельным JSON объектом в ответе репозитория, и поэтому обычно ему нужен соответствующий Java-класс для (де)сериализации. К счастью, Retrofit дает возможность добавить собственный типизированный JSONDeserializer для управления десериализацией определенного типа. Каждый раз, когда объект определенного типа должен быть десериализован, используется этот пользовательский десериализатор.
Для этого добавьте следующий класс GithubRepoDeserialzer.
package com.vogella.android.retrofitgithub;
import com.google.gson.JsonDeserializationContext;
import com.google.gson.JsonDeserializer;
import com.google.gson.JsonElement;
import com.google.gson.JsonObject;
import com.google.gson.JsonParseException;
import java.lang.reflect.Type;
public class GithubRepoDeserializer implements JsonDeserializer {
@Override
public GithubRepo deserialize(JsonElement json, Type typeOfT, JsonDeserializationContext context) throws JsonParseException {
GithubRepo githubRepo = new GithubRepo();
JsonObject repoJsonObject = json.getAsJsonObject();
githubRepo.name = repoJsonObject.get("name").getAsString();
githubRepo.url = repoJsonObject.get("url").getAsString();
JsonElement ownerJsonElement = repoJsonObject.get("owner");
JsonObject ownerJsonObject = ownerJsonElement.getAsJsonObject();
githubRepo.owner = ownerJsonObject.get("login").getAsString();
return githubRepo;
}
}
Определите REST API для Retrofit через следующий интерфейс:
package com.vogella.android.retrofitgithub;
import java.util.List;
import io.reactivex.Single;
import okhttp3.ResponseBody;
import retrofit2.http.Body;
import retrofit2.http.GET;
import retrofit2.http.POST;
import retrofit2.http.Path;
import retrofit2.http.Url;
public interface GithubAPI {
String ENDPOINT = "https://api.github.com";
@GET("user/repos?per_page=100")
Single> getRepos();
@GET("/repos/{owner}/{repo}/issues")
Single> getIssues(@Path("owner") String owner, @Path("repo") String repository);
@POST
Single postComment(@Url String url, @Body GithubIssue issue);
}
У вас может возникнуть вопрос об аннотации @ Url. С помощью этой аннотации мы можем указать URL для этого запроса. Это позволяет нам изменять URL для каждого запроса динамически. Нам нужно это для поля comments_url класса GithubIssue.
Аннотации @ Path связывают значение параметра с соответствующей переменной (фигурные скобки) в URL-адресе запроса. Это необходимо для указания владельца и имени репозитория, для которого должны быть запрошены обсуждения.
9.3. Диалоговое окно «Создание учетных данных»
Чтобы предоставить пользователю возможность хранить свои учетные данные в приложении, используется DialogFragment. Поэтому создайте следующий класс с именем CredentialsDialog, а также добавьте layout файл с именем dialog_credentials.xml в папку layout ресурсов.
Результат должен выглядеть примерно так, как показано на следующем скриншоте.
© Habrahabr.ru
