finder

package module
v0.0.15 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 30, 2026 License: Apache-2.0 Imports: 8 Imported by: 1

README

Finder

用 Go 模拟 Unix find 命令,递归扫描指定目录并把符合条件的文件 / 文件夹以绝对路径字符串切片的形式返回。

适合作为媒体库整理、文件迁移、批量转码等场景的基础组件:调用方只需要拿到路径列表,不需要关心遍历、隐藏目录或格式识别的细节。

特性

  • 纯 Go 实现,遍历基于 filepath.Walk / os.ReadDir,单文件错误会被忽略,不中断整体扫描
  • 同时提供「递归全部层级」和「仅当前目录」两种粒度的查询
  • 图片、音频通过文件头(magic number)识别,不依赖扩展名,可识别被改名的文件
  • 视频采用「扩展名 → 文件头 → ffprobe → ffmpeg」四级判断,兼顾速度与准确率
  • 返回结果均为绝对路径,便于直接交给后续处理流程

环境要求

  • Go 1.26.1 及以上
  • 依赖 github.com/h2non/filetype v1.1.3(仅用于文件头识别)
  • 视频识别兜底需要 ffprobe 或 ffmpeg,二选一即可,不安装也能正常工作(见下文「视频识别策略」)
go get github.com/zhangyiming748/finder

快速开始

package main

import (
	"fmt"

	"github.com/zhangyiming748/finder"
)

func main() {
	videos := finder.FindAllVideos("/path/to/media")
	for _, v := range videos {
		fmt.Println(v)
	}
}

返回示例:

/Users/zen/media/movie/01.mp4
/Users/zen/media/movie/02.mkv
/Users/zen/media/series/S01/E01.mov

API

函数 说明
FindAllFolders(root string) []string 递归查找所有层级的文件夹(包含 root 本身)
FindAllFoldersInRoot(root string) []string 仅查找 root 第一层的子文件夹,不包含 root 本身
FindAllFiles(root string) []string 递归查找所有层级的文件(结果包含 root 本身)
FindAllVideos(root string) []string 递归查找所有层级的视频文件
FindAllMkvVideos(root string) []string 递归查找所有层级的 .mkv 视频文件
FindAllVideosInRoot(root string) []string 仅查找 root 第一层的视频文件,不进入子目录
FindAllImages(root string) []string 递归查找所有层级的图片文件
FindAllImagesInRoot(root string) []string 仅查找 root 第一层的图片文件
FindAllAudios(root string) []string 递归查找所有层级的音频文件
FindAllAudiosInRoot(root string) []string 仅查找 root 第一层的音频文件

所有函数都不会返回 error;遍历过程中无权限的目录、读取失败的单个文件会被跳过,不影响整体扫描。

文件识别策略

图片
  1. .avif 通过扩展名直接判定(其 magic number 比较特殊,filetype 无法识别)
  2. 其余格式读取文件前 261 字节,交给 filetype.IsImage 判断 magic number
音频

读取文件前 261 字节,交给 filetype.IsAudio 判断 magic number。

视频(四级判断,按开销从小到大)
  1. 扩展名:忽略大小写匹配常见视频扩展名(.mp4、.mkv、.avi、.mov、.wmv、.flv、.rmvb、.ts、.m2ts、.webm 等 50 余种),命中即返回;若命中的是视频编码衍生的图片扩展名(.avif、.heic、.webp 等,见下文)则直接排除
  2. 文件头:读取前 261 字节,交给 filetype.IsVideo 判断 magic number;若识别为图片 / 音频 / 文档 / 压缩包 / 字体,或 ftyp 容器的 brand 属于 AVIF / HEIF 等静态图片,或内容为纯文本,则直接排除(见下文)
  3. ffprobe:执行 ffprobe -select_streams v:0,输出 video 即认为包含视频流
  4. ffmpeg:ffprobe 不存在时打印一次告警,改用 ffmpeg -i,从 stderr 中匹配 Video: 判断

之所以把扩展名放在第一步,是因为实际使用中遇到过文件头不规范的 AVI:magic number 识别失败,但文件本身确实可以正常播放。先看扩展名可以避免这类误判,同时这也是最廉价的一步。真正的流探测(3、4)计算和 IO 开销最大,放在最后,只有前两步都没命中时才会执行。

ffmpeg 在没有输出文件时会以非 0 退出码结束,所以第四步只解析输出内容,不依赖退出码。 两个告警通过 sync.Once 只输出一次,避免扫描大目录时刷屏。

为什么图片不会被误判成视频

开启流探测后出现过误报:目录里只有 1 个视频和 2 张 JPG,FindAllVideos 却返回了 3 个路径。原因是 ffprobe / ffmpeg 会把静态图片当成视频流:

ffprobe -select_streams v:0 -show_entries stream=codec_type -of csv=p=0 photo.jpg
# video   ← image2 解复用器 + mjpeg 编码

ffprobe -select_streams v:0 -show_entries stream=codec_type -of csv=p=0 photo.avif
# video   ← AV1 静帧,ftyp 容器被识别为 mov/mp4

由视频编码衍生的图片同样是这个行为:AVIF(AV1)、HEIC/HEIF(HEVC)、WebP(VP8/VP9)、JPEG XL、JPEG 2000,以及单帧 MJPEG、动画 PNG(APNG)和动画 GIF,都会得到 codec_type=video;带封面图的 MP3 还会多出一条 attached_pic 视频流。只靠流探测无法区分「真正的视频」和「图片 / 音频封面」,所以需要三层排除:

  1. 扩展名排除:videoBasedImageExtensions 覆盖 .avif、.avifs、.heic、.heif、.heics、.heifs、.webp、.jxl、.jp2、.jpx、.mjpg、.mjpeg、.mpo、.apng、.gif,命中即返回 false,连文件头都不用读。
  2. 文件头排除:读取前 261 字节后,若 filetype.IsImage / filetype.IsAudio 命中则返回 false,用于兜住扩展名被改掉的文件。
  3. ftyp brand 排除:isStillImageContainer 自行解析 ISO-BMFF 的 ftyp 头,major brand 或 compatible brand 命中 avif、avis、heic、heix、heim、heis、hevm、hevs、mif1、msf1 即返回 false。

第 2 层有个关键盲区:filetype v1.1.3 只识别 ftyp 中带 heic brand 的 HEIF,识别不了 AVIF 的 avif brand,更不会去验证 brand 位。所以一张扩展名被改成 .jpg 的 AVIF,第一层看扩展名、第二层看文件头都会漏掉,直接进入 ffprobe 后就被判成视频——这正是「目录里明明只有 JPG,却仍被当成视频」的原因。第 3 层不依赖扩展名和 filetype 的图片表,直接从字节里读 brand,才能挡住这类文件:

# 判断一个 .jpg 到底是真 JPEG,还是伪装成 .jpg 的 AVIF / HEIF
ffprobe -v error -show_entries format=format_name -of csv=p=0 photo.jpg
# image2      → 真 JPEG(每帧一张图)
# avif/heif   → 改名后的静态图片
判定位置 结果 处理
扩展名命中视频列表 视频 返回 true
扩展名命中衍生图片列表 图片 / 动画 返回 false
文件头 filetype.IsVideo 视频 返回 true
文件头 filetype.IsImage / IsAudio 图片 / 音频 返回 false
文件头 ftyp brand 属静态图片 AVIF / HEIF 等 返回 false
文件头为纯文本 / 文档 / 压缩包 / 字体 TXT、PDF、ZIP 等 返回 false
以上均无法识别 未知 进入 ffprobe / ffmpeg 兜底

对应的回归测试是 TestFindAllVideosIgnoresImages:目录内放入 1 个 .mp4、两张真实 JPEG(含大写 .JPG)、一张 .avif,以及一张内容为 AVIF 但扩展名是 .jpg 的文件,断言只返回 1 个视频。

为什么 TXT 不会触发 ffprobe / ffmpeg

前三步都没命中的文件会进入 ffprobe 兜底。TXT、CSV、Markdown、字幕、源码这类文本文件因此也会被当成「未知类型」送去探测——结果虽然仍是 false(ffprobe 对纯文本直接报 Invalid data found when processing input,不会产生输出),但每个文本文件都白起一个子进程,大目录扫描时开销可观。

现在在文件头阶段增加了一道纯文本判定(isTextContent):只要头部字节都是可打印 ASCII、常见空白或 UTF-8 多字节字符,就判定为文本并直接返回 false。加上 filetype.IsDocument / IsArchive / IsFont 的同级排除,PDF、Office 文档、压缩包、字体和空文件都不会再进入外部工具探测。对应的回归测试是 TestFindAllVideosIgnoresTextFiles。

开发过程记录

  • 从 find 命令出发:先把常用查询拆成「递归 / 仅当前层」× 「文件 / 文件夹 / 媒体类型」的组合,每个函数只做一件事,返回 []string 而不是流式回调,调用方组合起来更简单。
  • 遍历容错:filepath.Walk 回调中对 err 直接返回 nil,保证遇到无权限目录或损坏文件时继续扫描,而不是整体失败。
  • 为什么用 magic number:只信任扩展名会漏掉改名文件,也容易被误改后缀的文件骗过;读取文件头是成本较低的折中方案。filetype 只读取固定长度的头部,不需要完整加载文件。
  • 视频识别的演进:最初只靠 filetype + 少量无法识别的扩展名硬编码。遇到不规范 AVI 后改为「扩展名优先、文件头其次、外部工具兜底」的分层策略,既保证常见场景的速度,也覆盖了文件头异常的文件。
  • 外部工具兜底:ffprobe 是首选,因为输出结构化、易解析;考虑到存在只安装了 ffmpeg 的环境,增加了 ffmpeg 回退分支,并在 PATH 中找不到可执行文件时给出告警而不是静默跳过。
  • 流探测的误报修复:兜底上线后发现 JPG 也会被判成视频,原因是 ffprobe 把静态图片解码成视频流。由于 AVIF、HEIC 等由视频编码衍生的图片连文件头都无法被 filetype 识别,甚至改名成 .jpg 后扩展名也失效,最终采用「扩展名排除 + 文件头图片 / 音频排除 + ftyp brand 解析」三层防护,让流探测只处理真正未知的文件。
  • 避免对非媒体文件启动外部进程:兜底逻辑会把所有「前两步不认识」的文件送去 ffprobe,TXT 也在其中。虽然判定结果正确,但每个文本文件都要白起一个子进程。为此增加了纯文本检测以及文档 / 压缩包 / 字体排除,让兜底只作用于真正可能是媒体的文件。
  • 测试:module_test.go 使用 t.TempDir() 构造临时目录树,覆盖递归 / 仅当前层两种行为;媒体测试写入最小的真实文件头(PNG / JPEG / GIF、ID3 / RIFF-WAVE / OggS),保证 filetype 能真实识别;视频部分额外用真实 JPEG、真实 AVIF、改名成 .jpg 的 AVIF,以及 TXT / CSV 做误判回归。

项目结构

.
├── generic.go       # 文件夹、文件遍历
├── image.go         # 图片识别与查找
├── audio.go         # 音频识别与查找
├── video.go         # 视频识别与查找(含 ffprobe / ffmpeg 兜底)
├── module_test.go   # 单元测试
├── go.mod
└── go.sum

测试

go test ./...

许可证

Apache License 2.0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func FindAllAudios

func FindAllAudios(root string) []string

使用golang实现find <root> type f 命令

func FindAllAudiosInRoot

func FindAllAudiosInRoot(root string) []string

使用golang实现查找给定文件路径下的全部文件 不包含子目录

func FindAllFiles

func FindAllFiles(root string) []string

使用golang实现find <root> type f 命令,包含root文件夹本身

func FindAllFolders

func FindAllFolders(root string) []string

使用golang实现find <root> type d 命令

func FindAllFoldersInRoot added in v0.0.6

func FindAllFoldersInRoot(root string) []string

使用golang实现find <root> type d -maxdepth 1 命令 但不包含root文件夹本身

func FindAllImages

func FindAllImages(root string) []string

使用golang实现find <root> type f 命令

func FindAllImagesInRoot

func FindAllImagesInRoot(root string) []string

使用golang实现查找给定文件路径下的全部文件 不包含子目录

func FindAllMkvVideos added in v0.0.7

func FindAllMkvVideos(root string) []string

使用golang实现find <root> -type f -name "*.mkv" 命令

func FindAllVideos

func FindAllVideos(root string) []string

使用golang实现find <root> -type f 命令

func FindAllVideosInRoot

func FindAllVideosInRoot(root string) []string

使用golang实现查找给定文件路径下的全部文件 不包含子目录

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL