Flutter依赖检查插件pubspec_checker的使用

Flutter依赖检查插件pubspec_checker的使用

1. 简介

pubspec_checker 是一个用于检查 pubspec.yaml 文件中所有依赖项在指定平台上的兼容性的简单 Dart/Flutter 包。它会读取 pubspec.yaml 文件，从 pub.dev 获取包信息，并验证这些包是否支持指定的平台（如 Android、iOS、Web、macOS、Windows 和 Linux）。

2. 功能特性

• 平台兼容性检查：指定平台（如 android、ios、web 等），检查哪些包支持这些平台。
• 详细报告：列出所有包及其支持的平台，可选显示包的链接以获取更多信息。
• 易于使用：通过命令行参数快速执行和灵活配置。

3. 使用步骤

3.1 添加依赖

在 pubspec.yaml 文件中添加 pubspec_checker 作为开发依赖：

dev_dependencies:
  pubspec_checker: ^1.0.4

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

flutter pub get

3.2 命令行使用

使用命令行界面 (CLI) 运行 pubspec_checker：

dart run pubspec_checker <platforms> [options]

• 参数：

  • <platforms>：要检查兼容性的平台。支持的值包括 android、ios、web、windows、linux 和 macos。

• 选项：

  • -s 或 --show：显示包及其支持的平台列表。
  • -l 或 --links：显示包的详细链接。

示例命令

• 检查 android 和 ios 平台的兼容性：

  dart run pubspec_checker android ios
  

• 检查 android 和 ios 平台的兼容性并显示包链接：

  dart run pubspec_checker android ios -l
  

• 检查 web 平台的兼容性：

  dart run pubspec_checker web
  

  或者：

  dart run pubspec_checker:web
  

示例输出

PS D:\Repository\pubspec_checker\example> dart run pubspec_checker windows ios
Building package executable...
Built pubspec_checker:pubspec_checker.
------- Started checking compatibility for "windows" -------
(2) Supported:
  ✅  file_picker
  ✅  connectivity_plus
(5) Not Supported:
  ❌  pusher_client
  ❌  disk_space
  ❌  open_file_plus
  ❌  sqflite_sqlcipher
  ❌  flutter_pdfview
------- Compatibility check completed for "windows" --------

4. 代码示例

下面是一个完整的 Flutter 示例应用，展示了如何在代码中使用 pubspec_checker 来检查依赖项的平台兼容性。

import 'package:flutter/material.dart';
import 'package:pubspec_checker/pubspec_checker.dart';

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

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

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Pubspec Checker Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const MyHomePage(title: 'Pubspec Checker Demo'),
    );
  }
}

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> {
  bool checking = false;
  Map<String, Map<String, dynamic>> results = {};

  // 要检查的平台列表
  List<String> platformsToCheck = ["windows"];
  PlatformChecker? checker;

  [@override](/user/override)
  void initState() {
    super.initState();
    // 初始化时进行检查
    check();
  }

  Future<void> check() async {
    setState(() {
      checking = true; // 设置为正在检查状态
    });

    // 创建 PlatformChecker 实例
    checker = PlatformChecker(platformsToCheck);
    final reader = PubspecReader();

    // 获取 pubspec.yaml 中的所有依赖项
    final dependencies = reader.getDependencies();
    
    // 检查依赖项的平台兼容性
    results = await checker!.checkPackageCompatibility(dependencies);

    // 打印每个包的支持平台
    for (var package in results.entries) {
      print(
          'Package: ${package.key}, Supported Platforms: ${package.value['platforms'].join(", ")}');
    }

    setState(() {
      checking = false; // 检查完成，设置为非检查状态
    });
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        backgroundColor: Colors.blue,
        title: Column(
          crossAxisAlignment: CrossAxisAlignment.start,
          children: [
            Text(widget.title),
            const Text(
              '请确保您已连接到互联网',
              style: TextStyle(fontSize: 12, color: Colors.white),
            ),
          ],
        ),
      ),
      body: Center(
        child: Column(
          children: <Widget>[
            Container(
              width: MediaQuery.sizeOf(context).width,
              color: Colors.amber,
              padding: const EdgeInsets.all(12.0),
              child: const Text('仅检查 Windows 平台的兼容性'),
            ),
            checking
                ? const Padding(
                    padding: EdgeInsets.all(16.0),
                    child: Column(
                      children: [
                        CircularProgressIndicator(), // 显示加载动画
                        Text('正在检查包的平台兼容性')
                      ],
                    ),
                  )
                : Expanded(
                    child: ListView.builder(
                      itemCount: results.entries.length,
                      itemBuilder: (BuildContext context, int index) {
                        var package = results.entries.elementAt(index);
                        var supportedPlatforms =
                            package.value['platforms'] as List<String>;

                        bool isSupportedToWindows = false;
                        if (supportedPlatforms.isNotEmpty) {
                          // 检查是否兼容 Windows
                          if (checker!.isCompatible(supportedPlatforms)) {
                            isSupportedToWindows = true;
                          }
                        }

                        return ListTile(
                          leading: const Icon(Icons.public),
                          title: Text(package.key),
                          subtitle: Row(
                            crossAxisAlignment: CrossAxisAlignment.start,
                            mainAxisAlignment: MainAxisAlignment.start,
                            children: [
                              Text(
                                package.value['version'],
                                style: const TextStyle(color: Colors.grey),
                              ),
                              const SizedBox(width: 10),
                              isSupportedToWindows
                                  ? const Icon(
                                      Icons.check_circle,
                                      color: Colors.green,
                                      size: 16,
                                    )
                                  : const Icon(
                                      Icons.cancel,
                                      color: Colors.red,
                                      size: 16,
                                    ),
                            ],
                          ),
                          trailing: Text(
                              '${supportedPlatforms.isNotEmpty ? supportedPlatforms.join(", ") : '未知'}'),
                        );
                      },
                    ),
                  ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        backgroundColor: Colors.blue,
        onPressed: check, // 点击按钮重新检查
        tooltip: '检查',
        child: const Icon(Icons.refresh),
      ),
    );
  }
}