Flutter日志记录与CURL请求插件log_curl_request的使用

简介

LogCurlRequest 是一个用于 Flutter 的插件，旨在通过 HTTP 请求详情生成 cURL 命令。该插件为开发者提供了一种简单有效的方式来将 HTTP 请求记录为 cURL 命令，便于调试和分享 API 调用。

目录

• 简介
• 功能
• 安装
• 使用
• 示例
• 配置
• 依赖项
• 问题排查
• 贡献者
• 许可证

功能

• 为 HTTP 请求生成 cURL 命令。
• 支持添加 HTTP 头、正文数据（JSON 或纯文本）和查询参数。
• 可选地使用 Flutter 的 debugPrint 记录生成的 cURL 命令。
• 易于集成到现有的 Flutter 项目中。

安装

要使用此插件，请在 pubspec.yaml 文件中添加以下依赖项：

dependencies:
  log_curl_request: ^0.0.5

然后运行以下命令来获取依赖项：

flutter pub get

使用

首先，在 Dart 文件中导入该包：

import 'package:log_curl_request/log_curl_request.dart';

生成 cURL 命令：

String curlCommand = LogCurlRequest.create(
  "POST",
  "https://api.example.com/resource",
  parameters: {"key": "value"},
  data: {"field": "value"},
  headers: {"Authorization": "Bearer YOUR_TOKEN"},
  showDebugPrint: true,
);

这将生成并可选地记录如下的 cURL 命令：

curl -X POST -H "Authorization: Bearer YOUR_TOKEN" --data '{"field":"value"}' "https://api.example.com/resource?key=value"

示例

以下是如何使用该插件生成 cURL 命令的示例：

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

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'cURL Example',
      theme: ThemeData(
        colorScheme: ColorScheme.fromSeed(seedColor: Colors.blue),
        useMaterial3: true,
      ),
      home: const MyHomePage(title: 'cURL Generator Example'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({super.key, required this.title});

  final String title;

  [@override](/user/override)
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  String _curlCommand = '';

  void _generateCurl() {
    // 创建一个 POST 请求的 cURL 命令
    final command = LogCurlRequest.create(
      'POST',
      'https://api.example.com/data',
      headers: {'Content-Type': 'application/json'},
      data: {'name': 'Flutter', 'version': '3.0'},
      parameters: {'lang': 'dart'},
    );

    setState(() {
      _curlCommand = command;
    });

    debugPrint(_curlCommand); // 将 cURL 命令打印到调试控制台
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        backgroundColor: Theme.of(context).colorScheme.inversePrimary,
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            const Text(
              '生成的 cURL 命令：',
              style: TextStyle(fontSize: 18),
            ),
            const SizedBox(height: 20),
            Container(
              padding: const EdgeInsets.all(16),
              decoration: BoxDecoration(
                border: Border.all(color: Colors.grey),
                borderRadius: BorderRadius.circular(8),
              ),
              child: SelectableText(
                _curlCommand.isEmpty ? '点击按钮生成' : _curlCommand,
                style: const TextStyle(fontFamily: 'monospace'),
              ),
            ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _generateCurl,
        tooltip: '生成 cURL',
        child: const Icon(Icons.code),
      ),
    );
  }
}