Flutter导出配置插件exports的使用

发布于 1周前 作者 phonegap100 来自 Flutter

Flutter导出配置插件exports的使用

Exports 是一个用于管理和自动生成Dart和Flutter项目导入语句的Dart包。它提供了一种简洁高效的方法来处理项目的依赖关系。

特性

  • 为指定路径内的每个文件和目录生成包含导出语句的.dart文件。
  • 可以通过glob模式轻松排除文件或目录。
  • 减少了Dart或Flutter文件中的大量导入语句。
  • 当文件结构发生变化时会自动更新。
  • 配置灵活，易于配置。

使用方法

步骤1：安装插件

运行以下命令来安装插件：

dart pub global activate exports

步骤2：创建配置文件（可选）

你可以在项目的根目录下创建一个名为 export.yaml 的配置文件来配置工具。更多信息请参阅配置部分。

步骤3：运行工具

运行以下命令：

exports

在这个示例中，该工具将扫描 lib 目录，并在每个目录中生成一个 .dart 文件，其中包含该目录内所有文件的导出语句。它不会包含任何与忽略列表中的模式匹配的文件。

配置

export:
  - lib/

ignore:
  - "**/*.g.dart"
  - "**/*.freezed.dart"
  - "**/*.gr.dart"
  - "**/_*.dart"

TODO

  • ❌ 添加监视文件更改模式
  • ❌ 添加从命令行导出的例子
    exports --export "models"
  • ❌ 添加从命令行忽略的例子
    exports --ignore "**/*.g.dart"
  • ❌ 支持dart包导出

许可证

MIT License

Copyright (c) 2023 masreplay

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

完整示例

下面是一个完整的示例，展示了如何使用 exports 插件。

示例代码

/// 测试flutter exports命令
///
library;

export 'src/example_base.dart';

export 'src/service/service.dart';

假设你的项目结构如下：

my_flutter_project/
├── lib/
│   ├── example.dart
│   ├── src/
│   │   ├── example_base.dart
│   │   └── service/
│   │       └── service.dart
└── export.yaml

示例配置文件 export.yaml

export:
  - lib/

ignore:
  - "**/*.g.dart"
  - "**/*.freezed.dart"
  - "**/*.gr.dart"
  - "**/_*.dart"

运行命令

dart pub global activate exports
cd my_flutter_project
exports

更多关于Flutter导出配置插件exports的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html

Harmonyos Next教程
1 回复

更多关于Flutter导出配置插件exports的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


在Flutter开发中，exports 通常用于在自定义包或插件中导出其他包的功能，使得这些功能可以在使用该包的应用中直接使用，而无需显式导入。这对于创建共享代码库或模块化架构非常有用。

以下是一个关于如何在Flutter插件中使用 exports 的示例代码案例：

1. 创建插件包

首先，假设你正在创建一个名为 my_utils 的Flutter插件包，这个包将包含一些实用工具函数，并且你希望这些函数能够被其他Flutter项目轻松使用。

文件结构

my_utils/
├── lib/
│   ├── my_utils.dart
│   └── string_utils.dart
├── pubspec.yaml

string_utils.dart

这是一个包含字符串处理函数的文件：

// lib/string_utils.dart

String capitalizeFirstLetter(String input) {
  if (input.isEmpty) return input;
  return input[0].toUpperCase() + input.substring(1);
}

my_utils.dart

这是主文件，它将导出 string_utils.dart 中的函数：

// lib/my_utils.dart

export 'string_utils.dart';

pubspec.yaml

插件的 pubspec.yaml 文件可能看起来像这样：

name: my_utils
description: A collection of utility functions.
version: 0.1.0
homepage: https://example.com

environment:
  sdk: ">=2.12.0 <3.0.0"

dev_dependencies:
  test: ^1.16.0

2. 在Flutter应用中使用插件

现在，假设你有一个Flutter应用，你想使用这个 my_utils 包。

文件结构

my_app/
├── lib/
│   └── main.dart
├── pubspec.yaml

pubspec.yaml

在你的Flutter应用的 pubspec.yaml 文件中，添加对 my_utils 包的依赖（假设它位于相对路径 ../my_utils）：

name: my_app
description: A new Flutter project.
version: 1.0.0+1

environment:
  sdk: ">=2.12.0 <3.0.0"

dependencies:
  flutter:
    sdk: flutter
  my_utils:
    path: ../my_utils

dev_dependencies:
  flutter_test:
    sdk: flutter

main.dart

在你的 main.dart 文件中，你可以直接使用 my_utils 包导出的函数，而无需显式导入 string_utils.dart：

// lib/main.dart

import 'package:flutter/material.dart';
import 'package:my_utils/my_utils.dart'; // 导入my_utils包

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

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    String capitalized = capitalizeFirstLetter('flutter');
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: Text('My Utils Demo'),
        ),
        body: Center(
          child: Text('Capitalized: $capitalized'),
        ),
      ),
    );
  }
}

在这个例子中，my_utils 包通过 exports 机制导出了 string_utils.dart 中的函数，使得这些函数可以在 my_app 中直接使用，而无需在 main.dart 中显式导入 string_utils.dart。这提高了代码的可维护性和可重用性。

回到顶部