Flutter插件可视化分析工具pubviz的使用

pubviz 是一个用于 Dart 项目的依赖关系可视化工具。它可以帮助开发者直观地查看项目中各个包之间的依赖关系，从而更好地管理和优化项目的依赖结构。

安装 pubviz

首先，确保你已经在目标项目目录中运行了 pub get 或 pub upgrade 命令来获取最新的依赖包信息。

然后，激活 pubviz 工具：

$ dart pub global activate pubviz

使用 pubviz

如果你已经正确配置了 PATH 环境变量，你可以直接运行 pubviz：

$ pubviz

否则，可以使用 dart pub global run 命令来运行 pubviz：

$ dart pub global run pubviz

示例：生成并打开当前路径下包的 HTML 文件

$ pubviz open

这将打开默认浏览器，并显示类似如下的页面：

示例：打印指定路径下包的 GraphViz dot 格式输出

$ pubviz --format=dot print /path/to/http_package

你应该会看到类似以下的输出：

digraph G {
  node [fontname=Helvetica];
  edge [fontname=Helvetica, fontcolor=gray];

  http [label="http\n0.9.2+3",fontsize=18,style=bold,shape=box,margin="0.25,0.15"];
  http -> path [label=">=0.9.0 <2.0.0",penwidth=2];
  http -> stack_trace [label=">=0.9.1 <0.10.0",penwidth=2];
  http -> unittest [label=">=0.9.0 <0.10.0",penwidth=2,style=dashed];

  path [label="path\n1.0.0",shape=box,margin="0.25,0.15",style=bold];

  stack_trace [label="stack_trace\n0.9.1",shape=box,margin="0.25,0.15",style=bold];
  stack_trace -> path [label=">=1.0.0-rc.1 <2.0.0"];

  unittest [label="unittest\n0.9.3",style=bold];
  unittest -> stack_trace [label=">=0.9.0 <0.10.0",color=gray];
}

生成 PDF、PNG 和其他文件

GraphViz 工具允许将 dot 格式的文件转换为各种类型的输出，如 PNG、PDF 或 SVG。为了将 pubviz 数据导出为 PNG 文件，你需要在本地机器上安装 GraphViz 包（详见安装说明）。

macOS 安装命令：

brew install graphviz

Windows 安装命令：

winget install graphviz

安装完成后，你可以将 pubviz 的输出保存到文件中，并使用 dot 命令将其转换为你所需的输出类型，例如：

pubviz --format=dot print > output.dot
dot -Tpdf output.dot -o output.pdf

完整的输出类型列表可以在 GraphViz 官网 查看。

打印帮助信息

$ pubviz -?
Usage: pubviz [<args>] <command> [<package path>]

Commands:
  open   Populate a temporary file with the content and open it.
  print  Print the output to stdout.

Arguments:
  -f, --format=<format>
            [dot]                  Generate a GraphViz dot file
            [html] (default)       Wrap the GraphViz dot format in an HTML template which renders it.

  -i, --ignore-packages            A comma separated list of packages to exclude in the output.
  -o, --[no-]flag-outdated         Check pub.dev for lasted packages and flag those that are outdated.
  -d, --direct-dependencies        Include only direct dependencies.
  -p, --production-dependencies    Include only production (non-dev) dependencies.
  -v, --version                    Print the version of pubviz and exit.
  -?, --help                       Print this help content.

If <package path> is omitted, the current directory is used.

示例 Demo

假设我们有一个简单的 Flutter 项目，包含一些常见的依赖包。我们可以使用 pubviz 来可视化这些依赖关系。

步骤：

1. 创建一个新的 Flutter 项目：

   $ flutter create my_project
   

2. 进入项目目录并添加一些依赖包：

   $ cd my_project
   $ flutter pub add http
   $ flutter pub add provider
   

3. 运行 pub get 获取依赖包：

   $ flutter pub get
   

4. 使用 pubviz 生成依赖关系图：

   $ pubviz open