Flutter性能监控与分析插件canary的使用详解

Flutter性能监控与分析插件canary的使用详解

在Flutter开发过程中，插件canary是一种用于测试Dart包生态系统兼容性的工具。它可以在发布之前，通过将包升级到新的版本，并运行一系列应用来检查是否引入了潜在的破坏性更改。这有助于确保包的更新能够无缝集成到整个生态系统中。

Canary的作用是什么？

canary的主要作用是检测包的升级是否会引发生态系统的故障。其实现逻辑可以通过以下伪代码表示：

for (final app in applicationSuite) {
  if (app.dependencies.contains(package)) {
    pubGet(app); // 更新依赖
    analyze(app); // 分析代码
    test(app);   // 运行测试

    upgradePackage(app); // 升级包

    pubGet(app); // 再次更新依赖
    analyze(app); // 再次分析代码
    test(app);   // 再次运行测试
  }
}

如何使用canary？

以下是使用canary的具体步骤及示例代码：

1. 创建一个测试仓库集合

在.github/test_repos/repos.json文件中定义一组需要测试的应用程序仓库。每个仓库可以设置不同的测试级别（analyze或test），并支持排除某些包的测试。

{
    "https://github.com/mosuem/my_app_old_web": {
        "level": "analyze"
    },
    "https://github.com/mosuem/my_app_new_web": {
        "level": "test",
        "packages": {
            "exclude": "intl4x"
        }
    }
}
2. 添加canary工作流文件

在项目根目录下创建一个名为canary.yaml的工作流文件，并配置触发规则和任务。

name: Canary

on:
  pull_request:
    branches: [ main ]
    types: [opened, synchronize, reopened, labeled, unlabeled]
        
jobs:
  test_ecosystem:
    uses: dart-lang/ecosystem/.github/workflows/canary.yaml@main
    with:
      repos_file: .github/test_repos/repos.json
3. 添加结果展示的工作流文件

为了在拉取请求中展示Markdown格式的结果，还需要添加另一个工作流文件post_summaries.yaml。

name: Comment on the pull request

on:
  # 触发此工作流在Health工作流完成后执行
  workflow_run:
    workflows: 
      - Canary
    types:
      - completed

jobs:
  upload:
    uses: dart-lang/ecosystem/.github/workflows/post_summaries.yaml@main
    permissions:
      pull-requests: write
4. 开始使用

完成上述配置后，提交代码即可触发canary的工作流，自动测试你的包对生态系统的兼容性。

示例代码完整DEMO

以下是一个完整的DEMO示例，展示了如何配置canary插件以进行性能监控与分析。

# .github/workflows/canary.yaml
name: Canary

on:
  pull_request:
    branches: [ main ]
    types: [opened, synchronize, reopened, labeled, unlabeled]
        
jobs:
  test_ecosystem:
    uses: dart-lang/ecosystem/.github/workflows/canary.yaml@main
    with:
      repos_file: .github/test_repos/repos.json

// .github/test_repos/repos.json
{
    "https://github.com/mosuem/my_app_old_web": {
        "level": "analyze"
    },
    "https://github.com/mosuem/my_app_new_web": {
        "level": "test",
        "packages": {
            "exclude": "intl4x"
        }
    }
}

# .github/workflows/post_summaries.yaml
name: Comment on the pull request

on:
  workflow_run:
    workflows: 
      - Canary
    types:
      - completed

jobs:
  upload:
    uses: dart-lang/ecosystem/.github/workflows/post_summaries.yaml@main
    permissions:
      pull-requests: write

更多关于Flutter性能监控与分析插件canary的使用详解的实战教程也可以访问 https://www.itying.com/category-92-b0.html

1 回复

更多关于Flutter性能监控与分析插件canary的使用详解的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


canary 这个名称在软件开发中通常与“金丝雀”（Canary）有关，金丝雀在历史上被用于检测矿井中的有毒气体。类似地，在软件开发中，canary 通常用于指代一种早期预警系统，用于检测潜在的问题或性能瓶颈。因此，基于名称推测，canary 可能是一个用于 Flutter 应用的性能监控与分析插件，帮助开发者检测和优化应用的性能。

推测的功能

  1. 性能监控：实时监控 Flutter 应用的性能指标，如帧率（FPS）、内存使用、CPU 占用率等。
  2. 异常检测：检测应用中的异常行为，如卡顿、内存泄漏、崩溃等。
  3. 日志记录：记录应用的运行日志，帮助开发者分析问题。
  4. 报告生成：生成详细的性能报告，帮助开发者识别和解决性能瓶颈。
  5. 集成与扩展：可能支持与其他监控工具（如 Firebase、Sentry 等）的集成，或者提供 API 供开发者自定义监控逻辑。

使用步骤（假设）

由于 canary 的具体功能未定义，以下是一个假设的使用步骤：

  1. 添加依赖： 在 pubspec.yaml 文件中添加 canary 插件的依赖：

    dependencies:
  canary: ^1.0.0

  2. 初始化插件： 在 main.dart 文件中初始化 canary 插件：

    import 'package:canary/canary.dart';

void main() {
  Canary.initialize();
  runApp(MyApp());
}

  3. 监控性能： 在应用的关键部分添加性能监控代码：

    Canary.startMonitoring('HomeScreen');
// 你的代码
Canary.stopMonitoring('HomeScreen');

  4. 查看报告： 在应用运行过程中，canary 可能会生成性能报告，开发者可以通过控制台或集成的监控工具查看这些报告。

  5. 优化应用： 根据 canary 提供的性能数据，优化应用的代码和资源使用，提升用户体验。

示例代码

以下是一个简单的示例，展示如何使用 canary 监控应用的帧率：

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

void main() {
  Canary.initialize();
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: Text('Canary Example')),
        body: HomeScreen(),
      ),
    );
  }
}

class HomeScreen extends StatefulWidget {
  [@override](/user/override)
  _HomeScreenState createState() => _HomeScreenState();
}

class _HomeScreenState extends State<HomeScreen> {
  [@override](/user/override)
  void initState() {
    super.initState();
    Canary.startMonitoring('HomeScreen');
  }

  [@override](/user/override)
  void dispose() {
    Canary.stopMonitoring('HomeScreen');
    super.dispose();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Center(
      child: Text('Hello, Canary!'),
    );
  }
}
回到顶部