13,8 тыс подписчиков

Доступно об API-вызове во Flutter: лучшие практики с демонстрацией кода

5 минут

31 прочтение

20 апреля 2023

Курс SkillFactory Android-разработчик. Ваш прямой путь к созданию мобильных приложений на Android с нуля.

Flutter стал популярной платформой для создания мобильных приложений благодаря своей простоте и гибкости. Одной из важнейших особенностей мобильных приложений является возможность взаимодействия с сервером для получения данных и выполнения какого-либо действия. Это взаимодействие осуществляется с помощью API, которые позволяют отправлять и получать данные в структурированном формате.

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

HTTP-запросы во Flutter

HTTP-запросы используются для связи с сервером через API. Flutter имеет HTTP-библиотеку, которая предоставляет функции для выполнения HTTP-запросов. HTTP-библиотека во Flutter основана на http-пакете, который предоставляет следующие методы.

GET — для получения данных с сервера.
POST — для отправки данных на сервер.
PUT — для обновления данных на сервере.
DELETE — для удаления данных с сервера.

Методы API-вызова во Flutter

1. Метод GET

Метод GET используется для получения данных с сервера. Во Flutter метод GET может быть реализован с помощью метода http.get().

Следующий код демонстрирует, как реализовать метод GET во Flutter:

import 'package:http/http.dart' as http;
import 'dart:convert';

Future<dynamic> getData() async {
final response = await http.get(Uri.parse('https://api.example.com/data'));
if (response.statusCode == 200) {
return json.decode(response.body);
} else {
throw Exception('Failed to load data');
}
}

Приведенный выше код получает данные с сервера и возвращает их в формате JSON. Метод json.decode() используется для преобразования данных JSON в объекты Dart.

2. Метод POST

Метод POST используется для отправки данных на сервер. Во Flutter метод POST может быть реализован с помощью метода http.post().

Следующий код демонстрирует, как реализовать метод POST во Flutter:

import 'package:http/http.dart' as http;
import 'dart:convert';

Future<dynamic> sendData(String name, String email) async {
final response = await http.post(Uri.parse('https://api.example.com/user'),
body: json.encode({'name': name, 'email': email}),
headers: {'Content-Type': 'application/json'});
if (response.statusCode == 200) {
return json.decode(response.body);
} else {
throw Exception('Failed to send data');
}
}

Приведенный выше код отправит данные на сервер в формате JSON. Метод json.encode() используется для преобразования объектов Dart в формат JSON.

3. Метод GET с Headers (заголовками)

Иногда вместе с GET-запросом на сервер может потребоваться отправить некоторые заголовки. Во Flutter метод GET с заголовками можно реализовать с помощью метода http.get() с параметром headers.

Следующий код демонстрирует, как реализовать метод GET с заголовками во Flutter:

import 'package:http/http.dart' as http;
import 'dart:convert';

Future<dynamic> getDataWithHeader(String token) async {
final response = await http.get(Uri.parse('https://api.example.com/data'),
headers: {'Authorization': 'Bearer $token'});
if (response.statusCode == 200) {
return json.decode(response.body);
} else {
throw Exception('Failed to load data');
}
}

Приведенный выше код получит данные с сервера с указанными заголовками.

4. Метод POST с Headers

Иногда нужно отправить заголовки вместе с POST-запросом на сервер. Во Flutter метод POST с заголовками может быть реализован с помощью метода http.post() с параметром headers.

Следующий код демонстрирует, как реализовать метод POST с заголовками во Flutter:

import 'package:http/http.dart' as http;
import 'dart:convert';

Future<dynamic> sendDataWithHeader(String name, String email, String token) async {
final response = await http.post(Uri.parse('https://api.example.com/user'),
body: json.encode({'name': name, 'email': email}),
headers: {'Content-Type': 'application/json', 'Authorization': 'Bearer $token'});
if (response.statusCode == 200) {
return json.decode(response.body);
} else {
throw Exception('Failed to send data');
}
}

Приведенный выше код отправит данные на сервер в формате JSON с указанными заголовками.

Создание моделей во Flutter

Во Flutter принято создавать модели для представления данных, получаемых с сервера. Модель — это класс, который содержит поля для хранения данных. Получив данные с сервера, можно преобразовать данные JSON в объекты модели.

Вот пример класса модели:

class User {
final String name;
final String email;

User({required this.name, required this.email});

factory User.fromJson(Map<String, dynamic> json) {
return User(
name: json['name'],
email: json['email'],
);
}
}

Приведенный выше коде создает класс User с полями name и email. Метод fromJson() используется для преобразования данных JSON в объект User.

Лучшие практики для API-вызова во Flutter

Всегда обрабатывайте ошибки. Каждый раз есть вероятность, что API-вызов может завершиться неудачей. Поэтому необходимо правильно обрабатывать ошибки и показывать пользователю соответствующие сообщения.
Используйте модели для представления данных. Применение моделей для представления данных, получаемых с сервера, облегчает работу с данными в приложении.
Используйте async/await. Применение async/await при выполнении API-вызовов облегчает чтение и понимание кода.
Используйте библиотеки. Во Flutter есть множество библиотек для выполнения вызовов API. Используйте их вместо того, чтобы заново изобретать колесо.
Используйте константы. Определите константы для URL, заголовков и других данных, которые вы часто используете. Это облегчит их обновление в случае необходимости.

Заключение

API-вызов — неотъемлемая часть разработки мобильных приложений. В этой статье мы рассмотрели различные методы API-вызова во Flutter и лучшие практики для новичков. Мы также показали примеры реализации этих методов во Flutter с помощью фрагментов кода. Следуйте этим лучшим практикам — и ваш код станет более надежным и эффективным.