Flutter清理未使用图片插件delete_unused_image的使用

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

Flutter清理未使用图片插件 delete_unused_image 的使用

随着Flutter项目的增长，项目中的图片资源会越来越多，其中很多可能并没有被实际使用。为了减少项目的大小，有必要编写一个脚本来删除这些未使用的图片资源。delete_unused_image 插件可以帮助我们实现这一目标。

安装

首先需要全局安装 delete_unused_image 插件：

dart pub global activate delete_unused_image

快速使用（TLDR）

这是基础版本，作为全局库使用时可能需要进一步优化。当前文档仅描述参数的使用方法。

基本用法

该命令会删除所有在 lib 和根目录中未被引用的图片，并且会检测图片名称并移除其后缀以进行模糊查询：

dart pub global run delete_unused_image

严格匹配图片后缀

如果你只想严格删除带有图片后缀的文件，可以使用以下命令：

dart pub global run delete_unused_image --ignore-dynamic
# 或者简写为：
dart pub global run delete_unused_image -i

指定路径

你还可以指定根目录、lib 目录和 assets 目录的路径：

dart pub global run delete_unused_image --root-path='./'
# 或者：
dart pub global run delete_unused_image --root-path './'

dart pub global run delete_unused_image --assets-path='./assets'
# 或者：
dart pub global run delete_unused_image --assets-path './assets'

dart pub global run delete_unused_image --lib-path='./lib'
# 或者：
dart pub global run delete_unused_image --lib-path './lib'

示例 Demo

下面是一个简单的示例项目结构，展示如何使用 delete_unused_image 清理未使用的图片资源：

项目结构

my_flutter_project/
│
├── lib/
│   └── main.dart
│
├── assets/
│   ├── images/
│   │   ├── logo.png
│   │   ├── unused_image.png
│   │   └── icon.png
│   └── fonts/
│       └── roboto.ttf
│
└── pubspec.yaml

使用 delete_unused_image 清理未使用的图片

假设在 main.dart 中只引用了 logo.png 和 icon.png，而 unused_image.png 并没有被引用。我们可以运行以下命令来清理未使用的图片：

dart pub global run delete_unused_image --root-path='./' --lib-path='./lib' --assets-path='./assets/images'

更多关于Flutter清理未使用图片插件delete_unused_image的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html

Harmonyos Next教程
1 回复

更多关于Flutter清理未使用图片插件delete_unused_image的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


当然，以下是如何在Flutter项目中集成并使用 delete_unused_image 插件来清理未使用的图片资源的示例代码和步骤。delete_unused_image 插件可以帮助你自动检测和删除项目中未使用的图片资源，从而优化应用的包大小。

步骤 1: 添加依赖

首先，你需要在 pubspec.yaml 文件中添加 delete_unused_image 插件的依赖：

dependencies:
  flutter:
    sdk: flutter
  # 其他依赖...
  delete_unused_image: ^最新版本号 # 替换为最新版本号

dev_dependencies:
  build_runner: ^x.y.z # 确保你有 flutter_pub_get 和其他构建工具
  # 其他开发依赖...

然后运行 flutter pub get 来获取依赖。

步骤 2: 配置插件

接下来，你需要配置插件以便它能够识别你的图片资源。通常，图片资源会放在 assets 文件夹中。确保你的图片资源路径被正确配置在 pubspec.yaml 的 flutter 部分下的 assets 字段。

flutter:
  assets:
    - assets/images/used_image_1.png
    - assets/images/used_image_2.jpg
    # 列出所有你正在使用的图片资源

步骤 3: 使用插件

你可以通过命令行工具使用 delete_unused_image 插件。首先，确保你的项目根目录下有一个 pubspec.yaml 文件，并且你已经添加了所有正在使用的图片资源。

打开终端，导航到你的 Flutter 项目根目录，然后运行以下命令：

flutter pub run delete_unused_image:main

这个命令将会扫描你的项目并删除 assets 文件夹中未在 pubspec.yaml 文件中声明的图片资源。

注意事项

  1. 备份你的图片资源：在运行清理命令之前，最好备份你的图片资源，以防万一误删。
  2. 检查代码：确保你的代码中没有通过硬编码路径引用图片资源，因为这样的资源不会被 delete_unused_image 插件检测到。
  3. 插件限制：插件可能无法检测到所有动态加载的图片资源，特别是通过网络加载的图片。

示例代码（自动化脚本）

如果你希望将这个过程自动化，可以创建一个自定义脚本。例如，在 scripts 文件夹下创建一个 clean_unused_images.sh 文件：

#!/bin/bash

# 导航到项目根目录
cd /path/to/your/flutter/project

# 运行 delete_unused_image 插件
flutter pub run delete_unused_image:main

echo "未使用的图片资源已被清理。"

然后，你可以通过运行 bash scripts/clean_unused_images.sh 来执行这个脚本。

总结

通过上述步骤，你可以有效地使用 delete_unused_image 插件来清理 Flutter 项目中未使用的图片资源。这不仅有助于减少应用包大小，还可以提高应用的加载速度和性能。记得在运行清理命令之前备份你的图片资源，并确保你的图片资源路径在 pubspec.yaml 文件中正确配置。

回到顶部