Flutter网络请求代码生成插件flutter_http_generator的使用

Flutter网络请求代码生成插件flutter_http_generator的使用

flutter_http_generator 是一个基于注解的 HTTP 库。通过该库，您可以轻松地为您的 Flutter 应用程序生成网络请求代码。

示例

首先，确保您已经添加了 flutter_http_generator 到您的项目依赖中。在您的 pubspec.yaml 文件中添加以下依赖：

dependencies:
  flutter:
    sdk: flutter
  http: ^0.13.3
  flutter_http_generator: ^0.1.0

dev_dependencies:
  build_runner: ^2.1.7

然后运行 flutter pub get 来获取这些依赖项。

接下来，我们需要创建一个 Dart 文件来定义我们的 API 请求。例如，我们创建一个名为 api_service.dart 的文件，并在其中编写注解来描述我们的 API 请求。

// api_service.dart

import 'package:flutter_http_generator/flutter_http_generator.dart';

@HttpService(baseUrl: "https://jsonplaceholder.typicode.com")
abstract class JsonPlaceholderApi {
  @Get(path: "/posts")
  Future<List<Post>> fetchPosts();

  @Post(path: "/posts")
  Future<Post> createPost(@Body Post post);
}

class Post {
  final int userId;
  final int id;
  final String title;
  final String body;

  Post({required this.userId, required this.id, required this.title, required this.body});

  factory Post.fromJson(Map<String, dynamic> json) {
    return Post(
      userId: json['userId'],
      id: json['id'],
      title: json['title'],
      body: json['body'],
    );
  }

  Map<String, dynamic> toJson() {
    return {
      'userId': userId,
      'id': id,
      'title': title,
      'body': body,
    };
  }
}

上述代码中，我们定义了一个 JsonPlaceholderApi 类，该类继承自 HttpService 并包含两个方法：fetchPosts 和 createPost。这两个方法分别用于获取和创建帖子。

为了生成实际的实现代码，我们需要运行以下命令：

flutter pub run build_runner build

这将会在项目目录下生成一个 generated_api_service.dart 文件，该文件包含了具体的实现逻辑。

使用生成的代码

现在我们可以在其他 Dart 文件中使用生成的代码。例如，在 main.dart 中：

import 'package:flutter/material.dart';
import 'package:http/http.dart' as http;
import 'generated_api_service.dart';

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: Text("Http Generator Example")),
        body: Center(child: FetchPostButton()),
      ),
    );
  }
}

class FetchPostButton extends StatefulWidget {
  [@override](/user/override)
  _FetchPostButtonState createState() => _FetchPostButtonState();
}

class _FetchPostButtonState extends State<FetchPostButton> {
  List<Post> posts = [];

  Future<void> fetchPosts() async {
    var api = JsonPlaceholderApi(http.Client());
    posts = await api.fetchPosts();
    setState(() {});
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return ElevatedButton(
      onPressed: fetchPosts,
      child: Text('Fetch Posts'),
    );
  }
}