Поиск во мере ввода
Реальный пример использования FutureProvider
для реализации поисковой строки.
Пример использования: "Поиск во мере ввода"
Реализация "поиска во мере ввода" поначалу может показаться сложной задачей. Следует учесть несколько важных моментов:
- обработка ошибок.
- использование debounce при вводе, чтобы избежать отправки запроса при нажатии каждой клавиши.
- отмена предыдущего незавершенного запроса при изменении поисковой фразы.
Однако с помощью FutureProvider
и [ref.watch] мы можем значительно упростить
эту задачу.
Распространенным случаем выполнения асинхронных запросов является использование нескольких провайдеров:
- [StateNotifierProvider] или
StateProvider
для параметров запроса (либо модификатор [family]) FutureProvider
, который будет осуществлять запрос, получая параметры из других провайдеров/[family].
Во-первых, пользовательский ввод нужно где-то хранить. Например воспользуемся
StateProvider
(т. к. состояние поиска выражается только в виде String
):
final searchInputProvider = StateProvider<String>((ref) => '');
Теперь мы можем связать провайдер и [TextField]:
Consumer(
builder: (context, ref, child) {
return TextField(
onChanged: (value) => ref.read(searchInputProvider.notifier).state = value,
);
},
)
Далее мы можем создать FutureProvider
, который будет осуществлять запросы:
final searchProvider = FutureProvider<
<!--
// Copyright (c) 2019, the Dart project authors. Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.
import 'package:flutter/material.dart';
import 'package:flutter_riverpod/flutter_riverpod.dart';
import 'package:http/http.dart' as http;
import 'dart:convert';
final searchFieldProvider = StateProvider<String>((ref) => '');
final questionsProvider = FutureProvider<List>((ref) async {
final client = http.Client();
ref.onDispose(client.close);
final search = ref.watch(searchFieldProvider);
Uri uri;
if (search.isEmpty) {
uri = Uri.parse(
'https://api.stackexchange.com/2.3/questions?order=desc&sort=activity&site=stackoverflow',
);
} else {
final encodedQuery = Uri.encodeComponent(search);
uri = Uri.parse(
'https://api.stackexchange.com/2.3/search?order=desc&sort=activity&intitle=$encodedQuery&site=stackoverflow',
);
}
final response = await client.get(uri);
final questions = jsonDecode(response.body);
return questions['items'].map((question) => question['title']).toList();
});
void main() => runApp(const ProviderScope(child: MyApp()));
class MyApp extends StatelessWidget {
const MyApp({Key? key}) : super(key: key);
Widget build(BuildContext context) {
return const MaterialApp(home: MyHomePage());
}
}
class MyHomePage extends ConsumerWidget {
const MyHomePage({Key? key}) : super(key: key);
Widget build(BuildContext context, WidgetRef ref) {
final questions = ref.watch(questionsProvider);
return Scaffold(
appBar: AppBar(title: const Text('Questions')),
body: Column(
children: [
TextField(
onChanged: (value) =>
ref.read(searchFieldProvider.notifier).state = value,
),
Expanded(
child: questions.when(
loading: () => const Center(child: CircularProgressIndicator()),
error: (error, stack) => Center(child: Text('Error $error')),
data: (questions) {
return ListView.builder(
itemCount: questions.length,
itemBuilder: (context, index) {
final question = questions[index];
return ListTile(
title: Text(
question.toString(),
),
);
},
);
},
),
),
],
),
);
}
}