Хочу сделать приложение на flutter которое получало бы список репозиториев с api github…
- User
Хочу сделать приложение на flutter которое получало бы список репозиториев с api github и выводило бы их на экран, как должна выглядеть файловая структура проекта?
- Assistant
Для разработки Flutter-приложения, которое получает список репозиториев с GitHub API и отображает их на экране, важно организовать файловую структуру таким образом, чтобы обеспечить чистоту кода, удобство поддержки и масштабируемость. Ниже приведен пример рекомендуемой структуры проекта с описанием основных папок и файлов:
lib/ ├── main.dart ├── models/ │ └── repository.dart ├── services/ │ └── github_service.dart ├── screens/ │ └── repository_list_screen.dart ├── widgets/ │ └── repository_item.dart ├── providers/ (или blocs/) │ └── repository_provider.dart └── utils/ └── constants.dartОписание папок и файлов:
-
main.dart
Точка входа приложения. Здесь инициализируется приложение, настраивается корневой виджет, подключаются провайдеры состояния и задается маршрутизация.// main.dart import 'package:flutter/material.dart'; import 'package:provider/provider.dart'; import 'providers/repository_provider.dart'; import 'screens/repository_list_screen.dart'; void main() { runApp(MyApp()); } class MyApp extends StatelessWidget { @override Widget build(BuildContext context) { return ChangeNotifierProvider( create: (_) => RepositoryProvider(), child: MaterialApp( title: 'GitHub Repositories', theme: ThemeData( primarySwatch: Colors.blue, ), home: RepositoryListScreen(), ), ); } } -
models/
Содержит модели данных, соответствующие структурам, получаемым из GitHub API.-
repository.dart// models/repository.dart class Repository { final String name; final String description; final int stargazersCount; final String htmlUrl; Repository({ required this.name, required this.description, required this.stargazersCount, required this.htmlUrl, }); factory Repository.fromJson(Map<String, dynamic> json) { return Repository( name: json['name'], description: json['description'] ?? '', stargazersCount: json['stargazers_count'], htmlUrl: json['html_url'], ); } }
-
-
services/
Содержит классы для взаимодействия с внешними API или сервисами.-
github_service.dart// services/github_service.dart import 'dart:convert'; import 'package:http/http.dart' as http; import '../models/repository.dart'; class GitHubService { final String baseUrl = 'https://api.github.com'; Future<List<Repository>> fetchRepositories(String username) async { final response = await http.get(Uri.parse('$baseUrl/users/$username/repos')); if (response.statusCode == 200) { List<dynamic> data = json.decode(response.body); return data.map((json) => Repository.fromJson(json)).toList(); } else { throw Exception('Не удалось загрузить репозитории'); } } }
-
-
screens/
Содержит экраны (страницы) приложения.-
repository_list_screen.dart// screens/repository_list_screen.dart import 'package:flutter/material.dart'; import 'package:provider/provider.dart'; import '../providers/repository_provider.dart'; import '../widgets/repository_item.dart'; class RepositoryListScreen extends StatelessWidget { @override Widget build(BuildContext context) { return Scaffold( appBar: AppBar( title: Text('GitHub Репозитории'), ), body: FutureBuilder( future: Provider.of<RepositoryProvider>(context, listen: false).fetchRepositories(), builder: (context, snapshot) { if (snapshot.connectionState == ConnectionState.waiting) { return Center(child: CircularProgressIndicator()); } else if (snapshot.hasError) { return Center(child: Text('Ошибка: ${snapshot.error}')); } else { return Consumer<RepositoryProvider>( builder: (context, provider, child) { return ListView.builder( itemCount: provider.repositories.length, itemBuilder: (context, index) { final repo = provider.repositories[index]; return RepositoryItem(repository: repo); }, ); }, ); } }, ), ); } }
-
-
widgets/
Содержит переиспользуемые виджеты.-
repository_item.dart// widgets/repository_item.dart import 'package:flutter/material.dart'; import '../models/repository.dart'; import 'package:url_launcher/url_launcher.dart'; class RepositoryItem extends StatelessWidget { final Repository repository; RepositoryItem({required this.repository}); @override Widget build(BuildContext context) { return ListTile( title: Text(repository.name), subtitle: Text(repository.description), trailing: Row( mainAxisSize: MainAxisSize.min, children: [ Icon(Icons.star, color: Colors.yellow), SizedBox(width: 4), Text(repository.stargazersCount.toString()), ], ), onTap: () async { final url = repository.htmlUrl; if (await canLaunch(url)) { await launch(url); } else { ScaffoldMessenger.of(context).showSnackBar( SnackBar(content: Text('Не удалось открыть ссылку')), ); } }, ); } }
-
-
providers/(илиblocs/)
Содержит классы для управления состоянием приложения. В данном примере используетсяProvider.-
repository_provider.dart// providers/repository_provider.dart import 'package:flutter/material.dart'; import '../models/repository.dart'; import '../services/github_service.dart'; class RepositoryProvider with ChangeNotifier { final GitHubService _gitHubService = GitHubService(); List<Repository> _repositories = []; List<Repository> get repositories => _repositories; Future<void> fetchRepositories({String username = 'flutter'}) async { try { _repositories = await _gitHubService.fetchRepositories(username); notifyListeners(); } catch (e) { throw e; } } }
-
-
utils/
Содержит вспомогательные классы, функции и константы.-
constants.dart(пример)// utils/constants.dart const String githubApiBaseUrl = 'https://api.github.com'; const String defaultUsername = 'flutter';
-
Дополнительные рекомендации:
-
Управление состоянием: В приведенном примере используется
Provider, но вы можете выбрать любой другой подход к управлению состоянием, например,Bloc,Riverpodи т.д., в зависимости от требований вашего проекта. -
Обработка ошибок: Не забывайте реализовать обработку ошибок при взаимодействии с API, чтобы обеспечить хороший пользовательский опыт.
-
Асинхронные операции: Используйте
FutureBuilderили другие подходы для асинхронной загрузки данных и отображения индикаторов загрузки. -
Пагинация: Если планируете работать с большим количеством репозиториев, рассмотрите возможность реализации пагинации для улучшения производительности и UX.
-
Тестирование: Создавайте тесты для ваших моделей, сервисов и виджетов, чтобы обеспечить надежность приложения.
-
Стилизация и Темизация: Используйте тему приложения для согласованного стиля и легкой настройки внешнего вида.
Пример использования структуры:
-
Получение данных:
github_service.dartотвечает за запросы к GitHub API и получение данных о репозиториях. -
Модели данных:
repository.dartопределяет структуру данных репозитория, получаемых от API. -
Управление состоянием:
repository_provider.dartуправляет состоянием списка репозиториев и уведомляет виджеты об изменениях. -
Отображение данных:
repository_list_screen.dartотображает список репозиториев, используя виджетRepositoryItemдля каждого элемента списка. -
Переиспользуемые компоненты:
repository_item.dartотвечает за отображение информации об отдельном репозитории.
Следуя данной структуре, вы сможете легко масштабировать приложение, добавлять новые функции и поддерживать чистоту кода. Такая организация помогает разделить ответственность между различными частями приложения, что упрощает разработку и поддержку.
-