Flutter网络注解插件simple_http_annotation的使用

Flutter网络注解插件simple_http_annotation的使用

在开发Flutter应用时，处理HTTP请求是一个常见的任务。simple_http_annotation 插件可以帮助我们简化HTTP请求的过程。通过使用注解，我们可以生成用于HTTP请求的代码，从而减少手动编写代码的工作量。

安装依赖

首先，我们需要在 pubspec.yaml 文件中添加 simple_http_annotation 和 simple_http_gen 依赖：

dependencies:
  flutter:
    sdk: flutter
  simple_http_annotation: ^x.y.z
  simple_http_gen: ^x.y.z

dev_dependencies:
  build_runner:
  simple_http_builder:

创建API接口

接下来，我们需要定义一个API接口类，并使用 @Get, @Post, @Put, @Delete 等注解来描述HTTP请求的方法和路径。

import 'package:simple_http_annotation/simple_http_annotation.dart';

// 定义API接口类
class ApiService {
  // 定义GET请求
  @Get('/users')
  Future<List<dynamic>> getUsers();

  // 定义POST请求
  @Post('/users')
  Future<dynamic> createUser(Map<String, dynamic> user);

  // 定义PUT请求
  @Put('/users/{id}')
  Future<dynamic> updateUser(String id, Map<String, dynamic> user);

  // 定义DELETE请求
  @Delete('/users/{id}')
  Future<void> deleteUser(String id);
}

生成代码

为了生成实际的HTTP请求代码，我们需要运行构建命令。打开终端并执行以下命令：

flutter packages pub run build_runner build

这将会在 lib 目录下生成一个名为 api_service.g.dart 的文件，该文件包含了我们之前定义的API接口的实际实现。

使用API接口

现在，我们可以在应用中使用生成的API接口了。以下是一个简单的示例：

import 'package:flutter/material.dart';
import 'package:your_project_name/api_service.g.dart'; // 导入生成的API服务类

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

class MyApp extends StatelessWidget {
  final ApiService apiService = ApiService();

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: Text('简单HTTP请求示例'),
        ),
        body: Center(
          child: Column(
            mainAxisAlignment: MainAxisAlignment.center,
            children: [
              ElevatedButton(
                onPressed: () async {
                  // 调用getUsers方法获取用户列表
                  List<dynamic> users = await apiService.getUsers();
                  print(users);
                },
                child: Text('获取用户列表'),
              ),
              SizedBox(height: 20),
              ElevatedButton(
                onPressed: () async {
                  // 调用createUser方法创建新用户
                  Map<String, dynamic> newUser = {'name': 'John Doe'};
                  dynamic response = await apiService.createUser(newUser);
                  print(response);
                },
                child: Text('创建新用户'),
              ),
              SizedBox(height: 20),
              ElevatedButton(
                onPressed: () async {
                  // 调用updateUser方法更新用户信息
                  String userId = '123';
                  Map<String, dynamic> updatedUser = {'name': 'Jane Doe'};
                  dynamic response = await apiService.updateUser(userId, updatedUser);
                  print(response);
                },
                child: Text('更新用户信息'),
              ),
              SizedBox(height: 20),
              ElevatedButton(
                onPressed: () async {
                  // 调用deleteUser方法删除用户
                  String userId = '123';
                  await apiService.deleteUser(userId);
                  print('用户已删除');
                },
                child: Text('删除用户'),
              ),
            ],
          ),
        ),
      ),
    );
  }
}