1 通用库

(1) Entity

  1. /// 新闻分页 response
  2. class NewsPageListResponseEntity {
  3.   int? counts;
  4.   int? pagesize;
  5.   int? pages;
  6.   int? page;
  7.   List<NewsItem>? items;
  9.   NewsPageListResponseEntity({
  10.     this.counts,
  11.     this.pagesize,
  12.     this.pages,
  13.     this.page,
  14.     this.items,
  15.   });
  17.   factory NewsPageListResponseEntity.fromJson(Map<String, dynamic> json) =>
  18.       NewsPageListResponseEntity(
  19.         counts: json["counts"],
  20.         pagesize: json["pagesize"],
  21.         pages: json["pages"],
  22.         page: json["page"],
  23.         items:
  24.             List<NewsItem>.from(json["items"].map((x) => NewsItem.fromJson(x))),
  25.       );
  27.   Map<String, dynamic> toJson() => {
  28.         "counts": counts,
  29.         "pagesize": pagesize,
  30.         "pages": pages,
  31.         "page": page,
  32.         "items": items != null
  33.             ? List<dynamic>.from(items!.map((x) => x.toJson()))
  34.             : [],
  35.       };
  36. }
  38. class NewsItem {
  39.   String id;
  40.   String title;
  41.   String category;
  42.   String thumbnail;
  43.   String author;
  44.   DateTime addtime;
  45.   String url;
  47.   NewsItem({
  48.     required this.id,
  49.     required this.title,
  50.     required this.category,
  51.     required this.thumbnail,
  52.     required this.author,
  53.     required this.addtime,
  54.     required this.url,
  55.   });
  57.   factory NewsItem.fromJson(Map<String, dynamic> json) => NewsItem(
  58.         id: json["id"],
  59.         title: json["title"],
  60.         category: json["category"],
  61.         thumbnail: json["thumbnail"],
  62.         author: json["author"],
  63.         addtime: DateTime.parse(json["addtime"]),
  64.         url: json["url"],
  65.       );
  67.   Map<String, dynamic> toJson() => {
  68.         "id": id,
  69.         "title": title,
  70.         "category": category,
  71.         "thumbnail": thumbnail,
  72.         "author": author,
  73.         "addtime": addtime.toIso8601String(),
  74.         "url": url,
  75.       };
  76. }
  78. /// 新闻推荐 request
  79. class NewsRecommendRequestEntity {
  80.   String categoryCode;
  81.   String channelCode;
  82.   String tag;
  83.   String keyword;
  85.   NewsRecommendRequestEntity({
  86.     required this.categoryCode,
  87.     required this.channelCode,
  88.     required this.tag,
  89.     required this.keyword,
  90.   });
  92.   Map<String, dynamic> toJson() => {
  93.         "categoryCode": categoryCode,
  94.         "channelCode": channelCode,
  95.         "tag": tag,
  96.         "keyword": keyword,
  97.       };
  98. }

(2) BaseProvider

继承自GetConnect

  1. class BaseProvider extends GetConnect {
  2.   static const SERVER_API_URL = "101.42.134.18:8000";
  3.   @override
  4.   void onInit() {
  5.     httpClient.baseUrl = SERVER_API_URL;
  7.     // 请求拦截
  8.     httpClient.addRequestModifier<void>((request) {
  9.       request.headers['token'] = '12345678';
  10.       return request;
  11.     });
  13.     // 响应拦截
  14.     httpClient.addResponseModifier((request, response) {
  15.       return response;
  16.     });
  17.   }
  18. }

2 法一(最麻烦)

  • Provider 提供者模式, 由它决定从哪里、提供什么
  • Repository 用来处理拉取数据细节
  • Controller 控制器层 只要处理业务就行

image.png

(1) Provider

  1. import 'package:fltest/common/utils/base_provider.dart';
  2. import 'package:get/get.dart';
  4. abstract class INewsProvider {
  5.   Future<Response<NewsPageListResponseEntity>> getNews();
  6. }
  8. class NewsProvider extends BaseProvider implements INewsProvider {
  9.   // 新闻分页
  10.   // @override
  11.   // Future<Response<NewsPageListResponseEntity>> getNews() => get("/news");
  12.   @override
  13.   Future<Response<NewsPageListResponseEntity>> getNews() async {
  14.     var response = await get("/news");
  15.     var data = NewsPageListResponseEntity.fromJson(response.body);
  16.     return Response(
  17.       statusCode: response.statusCode,
  18.       statusText: response.statusText,
  19.       body: data,
  20.     );
  21.   }
  22. }

(2) Repository

  1. import 'package:fltest/pages/get_connect/provider.dart';
  3. abstract class INewsRepository {
  4.   Future<NewsPageListResponseEntity> getNews();
  5. }
  7. class NewsRepository implements INewsRepository {
  8.   NewsRepository({required this.provider});
  9.   final INewsProvider provider;
  11.   @override
  12.   Future<NewsPageListResponseEntity> getNews() async {
  13.     final response = await provider.getNews();
  14.     if (response.status.hasError) {
  15.       return Future.error(response.statusText!);
  16.     } else {
  17.       return response.body!;
  18.     }
  19.   }
  20. }

(3) Controller

  1. class NewsController extends SuperController<NewsPageListResponseEntity> {
  2.   NewsController({required this.repository});
  4.   final INewsRepository repository;
  6.   @override
  7.   void onInit() {
  8.     super.onInit();
  10.   }
  12.   // 拉取新闻列表
  13.   Future<void> getNewsPageList() async {
  14.     append(() => repository.getNews);
  15.   }
  17.   @override
  18.   void onReady() {
  19.     print('The build method is done. '
  20.         'Your controller is ready to call dialogs and snackbars');
  21.     super.onReady();
  22.   }
  24.   @override
  25.   void onClose() {
  26.     print('onClose called');
  27.     super.onClose();
  28.   }
  30.   @override
  31.   void didChangeMetrics() {
  32.     print('the window size did change');
  33.     super.didChangeMetrics();
  34.   }
  36.   @override
  37.   void didChangePlatformBrightness() {
  38.     print('platform change ThemeMode');
  39.     super.didChangePlatformBrightness();
  40.   }
  42.   @override
  43.   Future<bool> didPushRoute(String route) {
  44.     print('the route $route will be open');
  45.     return super.didPushRoute(route);
  46.   }
  48.   @override
  49.   Future<bool> didPopRoute() {
  50.     print('the current route will be closed');
  51.     return super.didPopRoute();
  52.   }
  54.   @override
  55.   void onDetached() {
  56.     print('onDetached called');
  57.   }
  59.   @override
  60.   void onInactive() {
  61.     print('onInative called');
  62.   }
  64.   @override
  65.   void onPaused() {
  66.     print('onPaused called');
  67.   }
  69.   @override
  70.   void onResumed() {
  71.     print('onResumed called');
  72.   }
  73. }

(4) GetView

  1. class NewsView extends GetView<NewsController> {
  2.   NewsView({Key? key}) : super(key: key);
  4.   _buildListView(NewsPageListResponseEntity? state) {
  5.     return ListView.separated(
  6.       itemCount: state != null ? state.items!.length : 0,
  7.       itemBuilder: (context, index) {
  8.         final NewsItem item = state!.items![index];
  9.         return ListTile(
  10.           onTap: () => null,
  11.           title: Text(item.title),
  12.           trailing: Text("分类 ${item.category}"),
  13.         );
  14.       },
  15.       separatorBuilder: (BuildContext context, int index) {
  16.         return Divider();
  17.       },
  18.     );
  19.   }
  21.   @override
  22.   Widget build(BuildContext context) {
  23.     return Scaffold(
  24.       appBar: AppBar(
  25.         title: Text("GetConnect Page"),
  26.       ),
  27.       body: controller.obx(
  28.         (state) => _buildListView(state),
  29.         onEmpty: Text("onEmpty"),
  30.         onLoading: Center(
  31.           child: Column(
  32.             children: [
  33.               Text("没有数据"),
  34.               ElevatedButton(
  35.                 onPressed: () {
  36.                   controller.getNewsPageList();
  37.                 },
  38.                 child: Text('拉取数据'),
  39.               ),
  40.             ],
  41.           ),
  42.         ),
  43.         onError: (err) => Text("onEmpty" + err.toString()),
  44.       ),
  45.     );
  46.   }
  47. }

(5) Bindings

  1. class NewsBinding implements Bindings {
  2.   @override
  3.   void dependencies() {
  4.     Get.lazyPut<INewsProvider>(() => NewsProvider());
  5.     Get.lazyPut<INewsRepository>(() => NewsRepository(provider: Get.find()));
  6.     Get.lazyPut(() => NewsController(repository: Get.find()));
  7.   }
  8. }

(6) Route

  1. GetPage(
  2.   name: AppRoutes.GetConnect,
  3.   binding: NewsBinding(),
  4.   page: () => NewsView(),
  5. ),

3 法二(适中)

使用StateMixin可以节省一些代码, 不用写Repository

(1) provider

  1. import 'package:fltest/common/utils/base_provider.dart';
  2. import 'package:get/get.dart';
  4. abstract class INewsProvider {
  5.   Future<Response> getNews();
  6. }
  8. class NewsStateMixinProvider extends BaseProvider implements INewsProvider {
  9.   @override
  10.   Future<Response> getNews() => get("/news");
  11. }

(2) controller

  1. class NewsStateMixinController extends GetxController
  2.     with StateMixin<NewsPageListResponseEntity> {
  3.   final NewsStateMixinProvider provider;
  4.   NewsStateMixinController({required this.provider});
  6.   // 拉取新闻列表
  7.   Future<void> getNewsPageList() async {
  8.     // 获取数据
  9.     final Response response = await provider.getNews();
  11.     // 判断，如果有错误
  12.     if (response.hasError) {
  13.       // 改变数据，传入错误状态，在ui中会处理这些错误
  14.       change(null, status: RxStatus.error(response.statusText));
  15.     } else {
  16.       // 否则，存储数据，改变状态为成功
  17.       var data = NewsPageListResponseEntity.fromJson(response.body);
  18.       change(data, status: RxStatus.success());
  19.     }
  20.   }
  21. }

3 法三(最简单)

(1) http

  1. import 'package:cookie_jar/cookie_jar.dart';
  2. import 'package:dio/dio.dart';
  3. import 'package:dio_cookie_manager/dio_cookie_manager.dart';
  5. const SERVER_API_URL = "101.42.134.18:8000";
  7. class HttpUtil {
  8.   static final HttpUtil _instance = HttpUtil._internal();
  9.   factory HttpUtil() => _instance;
  11.   late Dio dio;
  13.   HttpUtil._internal() {
  14.     // BaseOptions、Options、RequestOptions 都可以配置参数，优先级别依次递增，且可以根据优先级别覆盖参数
  15.     BaseOptions options = BaseOptions(
  16.       // 请求基地址,可以包含子路径
  17.       baseUrl: SERVER_API_URL,
  19.       // baseUrl: storage.read(key: STORAGE_KEY_APIURL) ?? SERVICE_API_BASEURL,
  20.       //连接服务器超时时间，单位是毫秒.
  21.       connectTimeout: 10000,
  23.       // 响应流上前后两次接受到数据的间隔，单位为毫秒。
  24.       receiveTimeout: 5000,
  26.       // Http请求头.
  27.       headers: {},
  29.       // 请求的Content-Type，默认值是"application/json; charset=utf-8".
  30.       // 如果您想以"application/x-www-form-urlencoded"格式编码请求数据,
  31.       // 可以设置此选项为 `Headers.formUrlEncodedContentType`,  这样[Dio]
  32.       // 就会自动编码请求体.
  33.       contentType: 'application/json; charset=utf-8',
  35.       // [responseType] 表示期望以那种格式(方式)接受响应数据。
  36.       // 目前 [ResponseType] 接受三种类型 `JSON`, `STREAM`, `PLAIN`.
  37.       //
  38.       // 默认值是 `JSON`, 当响应头中content-type为"application/json"时，dio 会自动将响应内容转化为json对象。
  39.       // 如果想以二进制方式接受响应数据，如下载一个二进制文件，那么可以使用 `STREAM`.
  40.       //
  41.       // 如果想以文本(字符串)格式接收响应数据，请使用 `PLAIN`.
  42.       responseType: ResponseType.json,
  43.     );
  45.     dio = Dio(options);
  47.     // Cookie管理
  48.     CookieJar cookieJar = CookieJar();
  49.     dio.interceptors.add(CookieManager(cookieJar));
  50.   }
  52.   // restful get 操作
  53.   Future get(
  54.     String path, {
  55.     dynamic queryParameters,
  56.     Options? options,
  57.   }) async {
  58.     var response = await dio.get(
  59.       path,
  60.       queryParameters: queryParameters,
  61.       options: options,
  62.     );
  63.     return response.data;
  64.   }
  65. }

(2) api

  1. /// 新闻
  2. class NewsAPI {
  3.   /// 翻页
  4.   static Future<NewsPageListResponseEntity> newsPageList(
  5.       {NewsRecommendRequestEntity? param}) async {
  6.     var response = await HttpUtil().get(
  7.       '/news',
  8.       queryParameters: param?.toJson(),
  9.     );
  10.     return NewsPageListResponseEntity.fromJson(response);
  11.   }
  12. }

(3) controller

  1. class NewsDioController extends GetxController {
  2.   var newsPageList =
  3.       Rx<NewsPageListResponseEntity>(NewsPageListResponseEntity());
  5.   @override
  6.   void onInit() {
  7.     super.onInit();
  8.     print("onInit");
  9.   }
  11.   @override
  12.   void onClose() {
  13.     super.onClose();
  14.     print("onClose");
  15.   }
  17.   getPageList() async {
  18.     newsPageList.value = await NewsAPI.newsPageList();
  19.   }
  20. }