Flutter构建缓存插件cached_build_runner的使用

Cached Build Runner简介

Cached Build Runner 是一个Dart包，它通过为未更改的.dart文件缓存生成的代码来优化build_runner。这个包可以作为一个开发依赖（dev_dependency）被添加到项目中，并提供了一个缓存版本的build_runner，该版本会缓存生成的文件而不是每次都重新生成。

使用方法

命令行用法

cached_build_runner <command> [arguments]

全局选项

• -h, --help：打印使用信息。

可用命令

• build：对指定的目标执行一次构建然后退出。
• watch：构建指定的目标，监视文件系统的变化并在适当的时候重新构建。

可用参数

• -h, --help：打印出使用说明。
• -q, --quiet：禁用构建期间的日志输出。
• -r, --redis：如果系统上安装了Redis数据库，则使用Redis。使用Redis允许多实例访问，非常适合在管道中使用。默认实现使用文件系统存储（Hive），非常适合本地系统的使用。
• -c, --cache-directory：提供工具存放缓存的目录。

安装步骤

在你的pubspec.yaml文件中添加以下内容作为开发依赖：

dev_dependencies:
  build_runner: ^latest_version
  cached_build_runner: ^latest_version

请注意，你需要将build_runner作为强制性依赖项添加到你的项目中，以确保cached_build_runner能够正常工作。

替换latest_version为你能获取到的最新版本号。

示例代码

下面是一个简单的Flutter应用程序示例，展示了如何使用cached_build_runner进行构建和运行：

import 'package:example/models/counter_model.dart';
import 'package:flutter/material.dart';

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

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

  // This widget is the root of your application.
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

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

  final String title;

  @override
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  final _counterModel = CounterModel(
    description: 'Model which can keep a count.',
  );

  void _incrementCounter() {
    setState(() {
      _counterModel.count++;
    });
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            const Text(
              'You have pushed the button this many times:',
            ),
            Text(
              '${_counterModel.count}',
              style: Theme.of(context).textTheme.headlineMedium,
            ),
            Text(
              '${_counterModel.toJson()}',
              style: Theme.of(context).textTheme.headlineMedium,
            ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _incrementCounter,
        tooltip: 'Increment',
        child: const Icon(Icons.add),
      ),
    );
  }
}

在这个示例中，我们创建了一个简单的计数器应用，其中包含一个按钮，每次点击按钮时，计数器的值会增加。CounterModel类用于保存计数器的状态，并且可以通过toJson方法将其转换为JSON格式。

为了使用cached_build_runner构建此项目，请按照以下步骤操作：

1. 确保已将cached_build_runner添加到项目的pubspec.yaml文件中。
2. 打开终端并导航到项目根目录。
3. 运行以下命令之一：
   • 单次构建：cached_build_runner build
   • 监视模式：cached_build_runner watch

这样，你就可以体验到cached_build_runner带来的构建速度提升效果了。