点击右上方,关注开源中国OSC头条号,获取最新技术资讯
fileboy,文件变更监听通知系统,使用 Go 编写。
适用于 Hot Reload (典型的如开发go项目,无需每次手动执行 go build;又比如前端 node 打包) 或者 系统监控的场景。
v1.5 版本更新日志:
- 增加 http 通知
- 增加 callUrl 参数
- 优化 command 稳定性
- 增加 command -> delayMillSecond 参数
- 优化 文案
- 增加 在指定时间内堆叠的任务自动丢弃
- 增加 version 信息
- 优化 代码逻辑
下载(Giteee源): Windows | Linux | Darwin
下载(Giteee源): Windows | Linux | Darwin
特性
- 极简的用法和配置
- 支持多平台,Windows/Linux/MacOS
- 支持自定义文件监听范围,监听指定文件夹/不监听指定文件夹/指定后缀文件
- 支持设置多条命令
- 命令支持变量占位符
- 支持冗余任务丢弃,自定义冗余任务范围
- 支持 http 通知
- 更多...
编译环境
go version >=1.10,推荐 1.11
更新日志
CHANGELOG
运行
下载已经编译好的对应平台二进制文件,重命名为fileboy, 加入系统 Path 中即可。
源码编译
clone 该项目,进入主目录,运行命令:
## 安装依赖go get -u gopkg.in/fsnotify/fsnotify.v1go get -u gopkg.in/yaml.v2## 编译go build## 运行./fileboy
使用
fileboy 的正常运行依赖于 filegirl.yaml 配置,所以首次在项目中使用需要初始化 filegirl.yaml。
- 进入你想要 hot reload 的项目主目录下;
- 运行 fileboy init,会在该目录下生成 filegirl.yaml文件;
- 查看 filegirl.yaml,修改为适合自己项目的配置项;
- 运行 fileboy即可.
- 如果你定义了 command -> exec命令,想事先确认是否能正常执行,可以运行 fileboy exec命令,系统会尝试运行你的自定义命令。
你可以使用 fileboy help查看使用帮助。
filegirl.yaml 配置文件说明
# 主配置core: # 配置版本号 version: 1# 监控配置monitor: # 要监听的目录 # test1 监听当前目录下 test1 目录 # test1/test2 监听当前目录下 test1/test2 目录 # test1,* 监听当前目录下 test1 目录及其所有子目录(递归) # .,* 监听当前目录及其所有子目录(递归) includeDirs: - .,* # 不监听的目录 # .idea 忽略.idea目录及其所有子目录的监听 exceptDirs: - .idea - .git - .vscode - node_modules - vendor # 监听文件的格式,此类文件更改会执行 command 中的命令 # .go 后缀为 .go 的文件更改,会执行 command 中的命令 # .* 所有的文件更改都会执行 command 中的命令 types: - .go# 命令command: # 监听的文件有更改会执行的命令 # 可以有多条命令,会依次执行 # 如有多条命令,每条命令都会等待上一条命令执行完毕后才会执行 # 如遇交互式命令,允许外部获取输入 # 支持变量占位符,运行命令时会替换成实际值: # {{file}} 文件名(如 a.txt 、test/test2/a.go) # {{ext}} 文件后缀(如 .go) # {{changed}} 文件更新的本地时间戳(纳秒,如 1537326690523046400) # 变量占位符使用示例:cp {{file}} /root/sync -rf 、 myCommand --{{ext}} {{changed}} exec: - go version - go env # 文件变更后命令会在xx毫秒后才会执行,单位为毫秒 # 一个变更事件(A)如果在定义的延迟时间(t)内,又有新的文件变更事件(B),那么A会取消执行。 # B及以后的事件均依次类推,直到事件Z在t内没有新事件产生,Z 会执行 # 合理设置延迟时间,将有效减少冗余和重复任务的执行 # 如果不需要该特性,设置为 0 delayMillSecond: 1000# 通知器notifier: # 文件更改会向该 url 发送请求(POST 一段 json 文本数据) # 触发请求的时机和执行 command 命令是一致的 # 请求超时 15 秒 # POST 格式: # Content-Type: application/json;charset=UTF-8 # User-Agent: FileBoy Net Notifier v1.5 # Body: {"project_folder":"/watcher-dirs