Flutter如何通过注解解析网络请求

在Flutter开发中，如何通过注解来简化网络请求的解析过程？目前手动解析JSON响应比较繁琐，想了解是否有类似Retrofit的注解库可以直接将网络请求结果映射到Dart模型类。具体需要怎样的代码实现？是否有推荐的三方库或最佳实践？

2 回复

Flutter可通过json_annotation和json_serializable库处理网络请求数据。先定义模型类并用@JsonSerializable注解，再运行build_runner生成序列化代码，最后用fromJson和toJson方法解析JSON数据。

更多关于Flutter如何通过注解解析网络请求的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


在Flutter中，可以通过自定义注解和代码生成库（如source_gen、json_annotation）来解析网络请求。以下是实现步骤：

1. 添加依赖

在 pubspec.yaml 中添加：

dependencies:
  dio: ^5.0.0    # 网络请求库
  injectable: ^2.0.0  # 依赖注入（可选）

dev_dependencies:
  build_runner: ^2.0.0
  injectable_generator: ^2.0.0
  source_gen: ^1.0.0

2. 创建自定义注解

// http_method.dart
class HttpMethod {
  final String method;
  final String path;

  const HttpMethod(this.method, this.path);
}

class GET extends HttpMethod {
  const GET(String path) : super('GET', path);
}

class POST extends HttpMethod {
  const POST(String path) : super('POST', path);
}

3. 定义API接口

// api_service.dart
part 'api_service.g.dart';  // 生成的代码文件

@Injectable()
abstract class ApiService {
  @GET('/users')
  Future<List<User>> getUsers();

  @POST('/users')
  Future<User> createUser(@Body() User user);
}

4. 创建代码生成器

// api_generator.dart
import 'package:source_gen/source_gen.dart';
import 'package:build/build.dart';

class ApiGenerator extends GeneratorForAnnotation<HttpMethod> {
  @override
  generateForAnnotatedElement(
    Element element,
    ConstantReader annotation,
    BuildStep buildStep,
  ) {
    // 解析注解并生成Dio请求代码
    final method = annotation.peek('method')?.stringValue;
    final path = annotation.peek('path')?.stringValue;
    
    return '''
      // 生成具体实现代码
      return dio.$method('$path');
    ''';
  }
}

5. 运行代码生成

在项目根目录执行：

flutter pub run build_runner build

6. 使用生成的API

final apiService = getIt<ApiService>(); // 通过依赖注入获取实例
final users = await apiService.getUsers();

关键说明：

  1. 注解解析：通过source_gen库扫描代码中的注解
  2. 代码生成：根据注解信息生成具体的Dio请求实现
  3. 依赖注入：使用injectable管理服务实例

推荐方案：

实际开发中建议直接使用成熟的三方库：

这些库已经实现了完整的注解解析网络请求功能，无需重复造轮子。

回到顶部