登录
推荐 文章 Go 技术 课程 下载 专题 AI
首页 >  Golang >  Go教程

Go cover -func 怎样按函数查看覆盖率

来源:17golang原创

时间:2026-11-14 14:21:12 409浏览 收藏

想知道 Go 测试覆盖率到底落在哪些函数上,不必先打开 HTML 报告。先用 go test -coverprofile=cover.out 生成覆盖率档案,再执行 go tool cover -func=cover.out,就能按函数看到文件位置、函数名和覆盖百分比,最后一行还会给出整体语句覆盖率。

先生成 coverprofile,再把它交给 go tool cover -func。单个函数的百分比适合定位漏测点,total: 行适合看整个 profile 的总体结果;二者不要混为一个指标。

官方地址:https://pkg.go.dev/cmd/cover

下面只讨论 profile、函数汇总和结果解读,不展开 HTML 颜色标注,也不把函数覆盖率当成测试质量的唯一判断。

先生成 cover.out,再交给 -func

-func 不是测试参数,而是 go tool cover 读取已有 profile 的输出选项。最小组合如下,包路径可以按项目实际目录替换:

# 先运行测试,并把覆盖率数据写入 profile 文件
go test -coverprofile=cover.out ./...

# 再按函数打印覆盖率汇总
go tool cover -func=cover.out

这两个命令之间的契约很简单:前一个命令负责产生 cover.out,后一个命令只分析这个文件。若测试命令失败,通常不会得到可用的完整 profile;若 -func 报找不到文件,先检查当前目录和文件名,而不是修改覆盖率阈值。

Go 测试覆盖率 profile、go tool cover 和函数汇总之间关系的静态结构说明图
图1:结构说明图,查看 coverprofile 如何作为 go tool cover -func 的输入,以及结果怎样落到函数汇总。

输出里的三列分别看什么

典型输出形状类似下面这样。具体文件名、行号和百分比会随代码与测试变化,下面的内容只用于说明列的含义:

example.com/demo/math.go:12:        Add             100.0%
example.com/demo/math.go:18:        Divide           50.0%
example.com/demo/math.go:27:        unused           0.0%
total:                          (statements)    66.7%

每个函数行通常由源文件位置、函数名和覆盖百分比组成。百分比针对函数中的可计数语句,不是按字符数或代码行数简单相除。函数没有被测试路径触及时,常见结果是 0.0%;分支只覆盖了一部分时,会落在中间值。

total: 行聚合 profile 中的语句数,适合做一次整体观察。它不是所有函数百分比的简单平均:一个很短的函数和一个包含大量语句的函数,对 total 的权重不同。

Go cover 函数汇总中源文件位置、函数名、语句覆盖百分比和 total 关系的静态说明图
图2:字段关系说明图,查看单函数信息与 total 语句汇总之间的层级边界。

把函数汇总变成可执行的排查清单

先找 0.0% 或明显低于整体值的函数,再回到测试用例检查正常路径、错误路径和边界输入是否都有意覆盖。不要只盯着函数数量:一个函数可能包含多个条件区域,而 cover 的统计以它识别出的语句块为基础。

如果只想看某个包,可以把生成 profile 的目标收窄;如果要保留命令输出供 CI 归档,可使用 shell 重定向:

# 只分析指定包,减少无关函数混入结果
go test -coverprofile=cover.out ./internal/math

# 把函数汇总保存下来,便于 CI 作为普通文本归档
go tool cover -func=cover.out > coverage-by-function.txt

这里的重定向只保存文本,不会改变 profile 本身。若需要按源码位置查看颜色标注,再考虑 go tool cover -html=cover.out;它解决的是源码视图问题,不是 -func 输出的替代解析方式。

几个容易误读的边界

  • 函数覆盖率不等于分支覆盖率。 -func 给出的是函数内语句覆盖情况,不能单凭一个百分比证明所有逻辑分支都被验证。
  • 匿名函数会影响阅读。 cover 会为无法直接取得普通名字的函数字面量生成位置型名称,看到类似 func.Lxx.Cyy 时应回到文件位置定位。
  • profile 与源码要对应。 如果生成 profile 后又大幅修改源码,再拿旧文件解释当前代码,行号和函数范围可能不再匹配,应重新运行测试生成。
  • 不要把 total 当成质量门槛的全部。 覆盖率适合发现没有测试触达的区域,断言是否准确、错误路径是否合理,还要由测试内容和代码审查补足。

常见问题

为什么直接执行 go tool cover -func 没有结果? 因为 -func 需要一个已经生成的 profile 文件,先运行 go test -coverprofile=cover.out,再把同名文件传给它。

函数都是 100%,为什么 total 不是 100%? 先确认是否查看了同一个 profile,以及是否还有未触达的函数或语句块;total 统计的是整个 profile,不是当前屏幕上某一小段函数的平均值。

什么时候应该改用 HTML? 当你需要回到源码位置查看具体哪些语句被覆盖时使用 -html;当你只想在终端或 CI 中快速找低覆盖函数时,-func 更直接。

声明:本文转载于:17golang原创 如有侵犯,请联系study_golang@163.com删除
相关阅读
更多>
最新阅读
更多>
课程推荐
更多>