跨平台开发 / 系统课时

使用分析、格式化与 Lint

使用分析、格式化与 Lint

这一课把 dart format、dart analyze 和 Lint 串成一套提交前质量检查:先统一代码格式,再让分析器发现类型、API 使用和规则问题,最后把同一套命令固定到本地与 CI 中,避免“能运行但不规范”的代码进入仓库。

学习目标

  • 使用 dart format 检查并统一 Dart 源码格式。
  • 使用 dart analyze 读取 analysis_options.yaml 并定位静态分析问题。
  • 配置 package:lints,把格式化与分析固化为提交前质量门槛。

建立可复现的分析配置

纯 Dart 项目可以把 lints 作为开发依赖,再通过 analysis_options.yaml 引入推荐规则。规则只影响开发期分析,不会改变程序运行时行为。

yaml
include: package:lints/recommended.yaml

analyzer:
  exclude:
    - build/**

linter:
  rules:
    prefer_single_quotes: true

这份配置会启用推荐规则,并额外要求在可以使用单引号时优先使用单引号。build/** 被排除后,生成产物不会进入静态分析范围。验证方法是运行 dart analyze,确认项目能够读取该文件并报告对应规则。

如果项目还没有 lints 依赖,可以执行:

bash
dart pub add --dev lints

预期输出

text
Resolving dependencies...
Changed <N> dependencies!

依赖数量会随当前项目状态变化,因此这里用 <N> 表示实际值。

先格式化,再做静态分析

假设 bin/main.dart 当前内容如下,代码能表达意图,但格式不统一,并且双引号会触发前面启用的 prefer_single_quotes:

dart
void main(){final message="hello";print(message);}

先用检查模式判断仓库中是否存在需要格式化的文件,再真正写回格式,最后运行静态分析:

bash
dart format --output=none --set-exit-if-changed .
dart format .
dart analyze

预期输出

text
Changed bin/main.dart
Formatted <N> file(s) (<M> changed) in <TIME> seconds.
Analyzing <PROJECT>...

   info - bin/main.dart:<LINE>:<COLUMN> - Unnecessary use of double quotes. Try using single quotes. - prefer_single_quotes

1 issue found.

不同 Dart SDK 版本对格式化统计文字可能略有差异,耗时、项目名和位置也会不同。关键结果是:检查模式在发现格式差异时返回非零状态;真正执行 dart format . 后源码被重写;dart analyze 继续报告尚未解决的 Lint。

把字符串改为单引号后,文件应类似下面这样:

dart
void main() {
  final message = 'hello';
  print(message);
}

再次执行:

bash
dart format --output=none --set-exit-if-changed .
dart analyze

预期输出

text
Formatted <N> file(s) (0 changed) in <TIME> seconds.
Analyzing <PROJECT>...
No issues found!

这时格式检查与静态分析都通过,才适合继续提交代码。

理解格式化与分析的职责边界

dart format 只负责源码排版,例如缩进、换行和空格;它不会判断业务逻辑是否正确。dart analyze 则基于类型系统、SDK 诊断和启用的 Lint 规则检查代码,但它同样不能替代测试。

Lint 的价值在于把团队约定变成机器可执行规则。对于会产生大量争议或与现有代码冲突的规则,应先确认团队是否接受,再统一调整 analysis_options.yaml,不要让不同成员在本地使用彼此不同的配置。

固化提交前质量门槛

最小检查顺序可以固定为“格式检查 → 静态分析”。本地与 CI 使用完全相同的命令,才能避免本地通过而流水线失败。

bash
dart format --output=none --set-exit-if-changed .
dart analyze

预期输出

text
Formatted <N> file(s) (0 changed) in <TIME> seconds.
Analyzing <PROJECT>...
No issues found!

如果第一条命令失败,先执行 dart format . 并重新检查;如果第二条命令失败,就按诊断位置和规则名修正代码。这样格式与静态分析就从“开发习惯”变成了可重复执行的质量门槛。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

使用分析、格式化与 Lint

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通