fileboy

文件变更监听通知系统
授权协议 MIT
开发语言 Google Go
所属分类 管理和监控、 日志分析和统计
软件类型 开源软件
地区 国产
投 递 者 华欣怡
操作系统 跨平台
开源组织
适用人群 未知
 软件概览

fileboy 是一个文件变更监听通知系统,使用 Go 编写。

适用于 Hot Reload (典型的如开发go项目,无需每次手动执行 go build;又比如前端 node 打包) 或者 系统监控的场景。

特性

  • 极简的用法和配置
  • 支持多平台,Windows/Linux/MacOS
  • 支持自定义文件监听范围,监听指定文件夹/不监听指定文件夹/指定后缀文件
  • 支持自定义监控事件(write/rename/remove/create/chmod)
  • 支持设置多条命令
  • 命令支持变量占位符
  • 支持冗余任务丢弃,自定义冗余任务范围
  • 支持 http 通知
  • 更多...

编译环境

go version 1.13

更新日志

CHANGELOG

运行

下载二进制文件

Github: download v1.12
Gitee: dowmload v1.12

下载已经编译好的对应平台二进制文件,重命名为fileboy, 加入系统 Path 中即可。

源码编译

clone 该项目,进入主目录,运行命令:

## 安装依赖
go get -u gopkg.in/fsnotify/fsnotify.v1
go 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 中的命令
    # 没有该配置默认监听所有事件
    # write   写入文件事件
    # rename  重命名文件事件
    # remove  移除文件事件
    # create  创建文件事件
    # chmod   更新文件权限事件(类unix)
    events:
        - write
        - rename
        - remove
        - create
        - chmod

# 命令
command:
    # 监听的文件有更改会执行的命令
    # 可以有多条命令,会依次执行
    # 如有多条命令,每条命令都会等待上一条命令执行完毕后才会执行
    # 如遇交互式命令,允许外部获取输入
    # 支持变量占位符,运行命令时会替换成实际值:
    #    {{file}}    文件名(如 a.txt 、test/test2/a.go)
    #    {{ext}}     文件后缀(如 .go)
    #    {{event}}   事件(上面的events, 如 write)
    #    {{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: 2000

# 通知器
notifier:
    # 文件更改会向该 url 发送请求(POST 一段 json 文本数据)
    # 触发请求的时机和执行 command 命令是一致的
    # 请求超时 15 秒
    # POST 格式:
    #    Content-Type: application/json;charset=UTF-8
    #    User-Agent: FileBoy Net Notifier v1.12
    #    Body: {"project_folder":"/project/path","file":"main.go","changed":1576567861913824940,"ext":".go","event":"write"}
    # 例: http://example.com/notifier/fileboy-listener
    # 不启用通知,请留空 ""
    callUrl: ""

TODO

  •  命令支持变量占位符
  •  支持多命令
  •  支持监听指定文件夹
  •  支持不监听指定文件夹
  •  支持监听指定后缀文件
  •  支持自定事件监听
  •  支持 http 通知
  •  支持冗余任务丢弃
  •  支持 http 合并任务的通知
  • fileboy,文件变更监听通知系统,使用 Go 编写。 适用于 Hot Reload (典型的如开发go项目,无需每次手动执行 go build;又比如前端 node 打包) 或者 系统监控的场景。 v1.9 版本更新日志: 优化 文件夹监听效率,减少大量深层文件夹遍历的时间 优化 代码逻辑 增加 readme 英文说明 修复 偶现监听项目主目录无效的问题 增加 includeDirs 参数规则

 相关资料
  • 问题内容: 我遇到的情况是有两个领域。field1和field2。field2当field1更改时,我只想做空,反之亦然。因此,最后只有一个字段具有内容。 如果仅附加addTextChangedListener到它,效果很好field1,但是当我对两个字段都执行此操作时,应用程序将崩溃。显然是因为它们试图无限期地改变彼此。一旦field1更改,field2此刻 清除就会field2被更改,因此它将

  • 问题内容: 我的任务是在每次日期更改时(每12am)触发一种刷新或重置我的应用程序的方法。我试图在网上搜索答案,但找不到任何东西。我可以使用Android中的任何方法/或侦听器吗?或任何方法?有什么建议吗? 问题答案: 是的,您可以在Android上收听日期/时间更改。为此,请在您的Activity中显式注册以下意图过滤器的BroadcastReceiver: 此意图每分钟发送一次。您 不能通过

  • 我使用一个JTextField,其中我过滤输入进来通过REGEXs和通知用户(背景颜色变化),然后推动更新出一个套接字(字符的字符,而不是一个'点击进入当你完成'的行为,按规格) 问题是,由于没有保证DocumentListener通知的顺序,我不能将更新的传输和更新的验证放在同一种侦听器上。不同类型的监听器(KeyListener vs DocumentListener vs…)之间是否有任何保

  • 由来 很多时候我们需要监听一个文件的变化或者目录的变动,包括文件的创建、修改、删除,以及目录下文件的创建、修改和删除,在JDK7前我们只能靠轮询方式遍历目录或者定时检查文件的修改事件,这样效率非常低,性能也很差。因此在JDK7中引入了WatchService。不过考虑到其API并不友好,于是Hutool便针对其做了简化封装,使监听更简单,也提供了更好的功能,这包括: 支持多级目录的监听(Watch

  • 需要一点帮助--这把我累坏了! 我是ReadItToMe的开发人员,这是一款可以读出你的留言并让你通过语音回复的应用程序。去年我一直面临的问题是重复的通知。我将以WhatsApp为例。 我尝试过的解决方案: > 在通知到达时使用通知的标题、消息和包名称创建通知的哈希代码,然后在通知被解除时将其从列表中删除(onNotificationRemoved),从而保持通知列表的读取状态。但我知道什么!在上

  • Blade 中提供一个方法帮助开发者可以自定义的监听应用程序运行中的一些生命周期。比如 Session 的创建与销毁,应用启动结束后等。 支持的事件类型有如下: public enum EventType { SERVER_STARTING, // 服务准备启动 SERVER_STARTED, // 服务启动成功 SERVER_STOPPING, //