flutter-use-http-package

flutter-use-http-package

热门

使用 `http` 包发起 GET、POST、PUT 或 DELETE 请求。适用于需要从 REST API 获取数据或发送数据的场景。

2525Star
152Fork
更新于 2026/6/18
SKILL.md
只读
名称
flutter-use-http-package
描述

使用 `http` 包发起 GET、POST、PUT 或 DELETE 请求。适用于需要从 REST API 获取数据或发送数据的场景。

实现 Flutter 网络请求

目录

配置与权限

配置网络访问所需的开发环境及各平台特定权限。

  1. 在终端中添加 http 包依赖:
    flutter pub add http
    
  2. 在 Dart 文件中引入该包:
    import 'package:http/http.dart' as http;
    
  3. 配置 Android 权限:在 android/app/src/main/AndroidManifest.xml 中添加网络权限:
    <uses-permission android:name="android.permission.INTERNET" />
    
  4. 配置 macOS 授权:在 macos/Runner/DebugProfile.entitlementsmacos/Runner/Release.entitlements 中添加网络客户端配置项:
    <key>com.apple.security.network.client</key>
    <true/>
    

请求执行与响应处理

发起 HTTP 操作并将响应数据映射为强类型的 Dart 对象。

  • URIs: 务必使用 Uri.parse('your_url') 解析 URL 字符串。
  • Headers: 通过 headers 参数 Map 传入认证与内容类型等信息。使用 HttpHeaders.authorizationHeader 设置鉴权 Token。
  • Payloads: 对于 POST 和 PUT 请求,使用 dart:convert 中的 jsonEncode() 对请求体进行编码。
  • 状态码校验: 判断 response.statusCode 的值。将 200 OK(GET/PUT/DELETE)和 201 CREATED(POST)视为请求成功。
  • 错误处理: 当状态码指示失败时抛出明确的异常。切勿在失败时返回 null,否则会阻止 FutureBuilder 触发错误状态,导致页面一直显示加载动画。
  • 反序列化: 使用 jsonDecode(response.body) 解析原始字符串,并通过工厂构造函数(如 fromJson)将其映射为自定义的 Dart 对象。

后台解析

将高耗时的 JSON 解析任务交由独立的 Isolate 处理,防止 UI 界面卡顿(掉帧)。

  • 引入 package:flutter/foundation.dart
  • 使用 compute() 函数在后台 Isolate 中运行解析逻辑。
  • 确保传给 compute() 的解析函数是顶级函数(top-level function)或静态方法(static method),因为闭包或实例方法无法跨 Isolate 传递。

工作流:执行网络操作

使用以下清单指导网络操作的实现与验证。

任务进度:

  • [ ] 1. 定义强类型的 Dart 模型类,并包含 fromJson 工厂构造函数。
  • [ ] 2. 实现网络请求方法,返回 Future<Model>
  • [ ] 3. 根据操作类型应用不同的分支逻辑:
    • 获取数据 (GET): 将查询参数拼接至 URI。
    • 修改数据 (POST/PUT): 设置 'Content-Type': 'application/json; charset=UTF-8' 并附带 jsonEncode 后的请求体。
    • 删除数据 (DELETE): 成功 (200 OK) 时返回空模型实例。
  • [ ] 4. 校验 statusCode,请求失败时抛出 Exception
  • [ ] 5. 使用 FutureBuilderFuture 接入 UI。
  • [ ] 6. 处理 snapshot.hasDatasnapshot.hasError 状态,默认展示 CircularProgressIndicator 加载控件。
  • [ ] 7. 反馈循环: 运行应用 -> 触发网络请求 -> 查看控制台是否有未处理异常 -> 修复解析错误或权限配置问题。

示例

完整实现:后台获取与解析数据

import 'dart:async';
import 'dart:convert';
import 'dart:io';
import 'package:flutter/foundation.dart';
import 'package:flutter/material.dart';
import 'package:http/http.dart' as http;

// 1. 用于后台 Isolate 解析的顶级函数
List<Photo> parsePhotos(String responseBody) {
  final parsed = (jsonDecode(responseBody) as List<Object?>)
      .cast<Map<String, Object?>>();
  return parsed.map<Photo>(Photo.fromJson).toList();
}

// 2. 执行网络请求并在后台解析数据
Future<List<Photo>> fetchPhotos() async {
  final response = await http.get(
    Uri.parse('https://jsonplaceholder.typicode.com/photos'),
    headers: {
      HttpHeaders.authorizationHeader: 'Bearer your_token_here',
      HttpHeaders.acceptHeader: 'application/json',
    },
  );

  if (response.statusCode == 200) {
    // 将耗时的解析任务放到后台 Isolate 中执行
    return compute(parsePhotos, response.body);
  } else {
    throw Exception('Failed to load photos. Status: ${response.statusCode}');
  }
}

// 3. 强类型模型
class Photo {
  final int id;
  final String title;
  final String thumbnailUrl;

  const Photo({
    required this.id,
    required this.title,
    required this.thumbnailUrl,
  });

  factory Photo.fromJson(Map<String, dynamic> json) {
    return Photo(
      id: json['id'] as int,
      title: json['title'] as String,
      thumbnailUrl: json['thumbnailUrl'] as String,
    );
  }
}

// 4. UI 接入
class PhotoGallery extends StatefulWidget {
  const PhotoGallery({super.key});

  @override
  State<PhotoGallery> createState() => _PhotoGalleryState();
}

class _PhotoGalleryState extends State<PhotoGallery> {
  late Future<List<Photo>> _futurePhotos;

  @override
  void initState() {
    super.initState();
    // 仅初始化一次 Future,防止页面重构(rebuild)时重复请求
    _futurePhotos = fetchPhotos();
  }

  @override
  Widget build(BuildContext context) {
    return FutureBuilder<List<Photo>>(
      future: _futurePhotos,
      builder: (context, snapshot) {
        if (snapshot.hasData) {
          final photos = snapshot.data!;
          return ListView.builder(
            itemCount: photos.length,
            itemBuilder: (context, index) => ListTile(
              leading: Image.network(photos[index].thumbnailUrl),
              title: Text(photos[index].title),
            ),
          );
        } else if (snapshot.hasError) {
          return Center(child: Text('Error: ${snapshot.error}'));
        }
        
        // 默认加载状态
        return const Center(child: CircularProgressIndicator());
      },
    );
  }
}