フロントエンドクラスメイトのVueプロジェクトをgitにpushするたびに内々に教えてもらってコードを更新したりリビルドしたりするのが面倒ですが、ローカル環境のIPはパブリックIPではないので, webhook に到達できないため、crontab しか使用できません。コードを定期的にプルし、inotifywait と連携してファイルの変更を監視し、コードを自動的にビルドします。そこで、今後のために inotifywait のインストールと基本的な使用方法を記録するためにこの記事を書きました参照。
転載元: https://blog.csdn.net/qq_37788558/article/details/104985262
1. inotifywait の概要
Inotify
さまざまなファイル監視ニーズを満たし、ファイル システムのアクセス属性、読み取りおよび書き込み属性、権限属性、削除、作成、移動、その他の操作を監視できる、強力できめの細かい非同期ファイル システム監視メカニズム。ファイルを監視できます。
inotify-tools
これは C ライブラリと一連のコマンド ライン作業であり、Linux での inotify にシンプルなインターフェイスを提供します。インストール後、次の2 つのコマンドinotify-tools
が表示されます。inotifywait
inotifywatch
inotifywait
このコマンドは、ファイル アクセスに関する情報を収集するために使用できます。通常、Linux ディストリビューションにはこのコマンドが含まれていないため、インストールする必要があります。inotify-tools
このコマンドには、inotify サポートが Linux カーネルにコンパイルされることも必要です。幸いなことに、ほとんどの Linux ディストリビューションでは、inotify が有効になっています。カーネル。inotifywatch
このコマンドは、各 inotify イベントが発生した回数など、監視されているファイル システムに関する統計を収集するために使用されます。
また、同様のツールとして fswatch などがあります。
//@Todo 類似ツールの選択を比較します。
2. インストール
2.1 開始する前に、システム カーネルが inotify をサポートしているかどうかを確認する必要があります
-
方法 1:
uname -r
コマンドを使用して Linux カーネルを確認し、値が値より低い場合は2.6.13
、カーネルを再コンパイルして inotify サポートを追加する必要があります。 -
方法 2:
ll /proc/sys/fs/inotify
コマンドを使用して以下の 3 つのメッセージが出力されるかどうかを確認し、出力されない場合はサポートされていません。
$ ll /proc/sys/fs/inotify
total 0
-rw-r--r-- 1 root root 0 Jan 4 15:41 max_queued_events
-rw-r--r-- 1 root root 0 Jan 4 15:41 max_user_instances
-rw-r--r-- 1 root root 0 Jan 4 15:41 max_user_watches
2.2 インストール手順
Linux システムに付属のパッケージ管理ツールを直接使用してインストールすることも、ソース コードから手動でコンパイルしてインストールすることもできます。
2.2.1 パッケージ管理ツールを使用したインストール
centos システムに付属の yum を例に挙げてみましょう。
他の Linux ディストリビューションのインストール方法については、https://github.com/rvoicilas/inotify-tools/wiki#wiki-getting を参照してください。
$ yum search inotify-tools
$ yum info inotify-tools
$ sudo yum install inotify-tools
2.2.2 ソースコードのコンパイルとインストール
$ wget http://github.com/downloads/rvoicilas/inotify-tools/inotify-tools-3.14.tar.gz
$ tar zxf inotify-tools-3.14.tar.gz
$ cd inotify-tools-3.14/
$ ./configure && make && make install
次のエラーが発生した場合
inotifywait: error while loading shared libraries: libinotifytools.so.0: cannot open shared object file: No such file or directory
解決:
yum install -y gcc*
32位系统:ln -s /usr/local/lib/libinotifytools.so.0 /usr/lib/libinotifytools.so.0
64位系统:ln -s /usr/local/lib/libinotifytools.so.0 /usr/lib64/libinotifytools.so.0
3. inotifywait の基本的な使用法
インストールが完了したら、単純に試してみて、次のコマンドを実行して log.txt ファイルを監視できます。
$ inotifywait -m log.txt
# 这里 -m 参数指明持续监听,不加的话会在一个事件后退出
Setting up watches.
Watches established.
# 此时持续监听,有事件出发会输出到屏幕
次に、別のウィンドウで次のコマンドを実行して、内容を log.txt ファイルに書き込みます。
$ echo >> log.txt
ファイルのオープン、変更、クローズのイベントが監視されているため、前の画面が出力されていることがわかります。
log.txt OPEN
log.txt MODIFY
log.txt CLOSE_WRITE,CLOSE
3.1. パラメータの説明
3.1.1 よく使用されるパラメータ
--timefmt 时间格式
%y年 %m月 %d日 %H小时 %M分钟
--format 输出格式
%T时间 %w路径 %f文件名 %e状态
-m 始终保持监听状态,默认触发事件即退出
-r 递归查询目录
-q 减少不必要的输出(只打印事件信息)
-e 定义监控的事件,可用参数:
open 打开文件
access 访问文件
modify 修改文件
delete 删除文件
create 新建文件
attrib 属性变更
--exclude <pattern> 指定要排除监控的文件/目录
3.1.2 すべてのパラメータ
コマンドを使用して man inotifywait
ドキュメント内のすべてのパラメータを表示することをお勧めします。
-h,–help
输出帮助信息
@
排除不需要监视的文件,可以是相对路径,也可以是绝对路径。
–fromfile
从文件读取需要监视的文件或排除的文件,一个文件一行,排除的文件以@开头。
-m, –monitor
接收到一个事情而不退出,无限期地执行。默认的行为是接收到一个事情后立即退出。
-d, –daemon
跟–monitor一样,除了是在后台运行,需要指定–outfile把事情输出到一个文件。也意味着使用了–syslog。
-o, –outfile
输出事情到一个文件而不是标准输出。
-s, –syslog
输出错误信息到系统日志
-r, –recursive
监视一个目录下的所有子目录。
-q, –quiet
指定一次,不会输出详细信息,指定二次,除了致命错误,不会输出任何信息。
–exclude
正则匹配需要排除的文件,大小写敏感。
–excludei
正则匹配需要排除的文件,忽略大小写。
-t , –timeout
设置超时时间,如果为0,则无限期地执行下去。
-e , –event
指定监视的事件。
-c, –csv
输出csv格式。
–timefmt
指定时间格式,用于–format选项中的%T格式。
–format
指定输出格式。
%w 表示发生事件的目录
%f 表示发生事件的文件
%e 表示发生的事件
%Xe 事件以“X”分隔
%T 使用由–timefmt定义的时间格式
3.2 監視可能なイベント
access 访问,读取文件。
modify 修改,文件内容被修改。
attrib 属性,文件元数据被修改。
move 移动,对文件进行移动操作。
create 创建,生成新文件
open 打开,对文件进行打开操作。
close 关闭,对文件进行关闭操作。
delete 删除,文件被删除。
3.3 使用例
npm run build
vue プロジェクトを監視し、ファイルの変更を検出した後にコマンドを実行してコードをビルドします。
vue プロジェクト ファイル ディレクトリが /production/sites/vue-program であると仮定します。
vue プロジェクトの基本的なディレクトリ構造に従って、このディレクトリの下にある src ディレクトリを監視し、ファイル変更イベントのみを監視する必要があります。
inotifywait /production/sites/vue-program/src #只监听src目录,因为package.json等文件在构建完成后也会被修改
-r #监听所有子目录文件
--timefmt '%d/%m/%y %H:%M' #时间输出格式,如果--format设置了%f,则必须指明
--format "%T %f" #输出格式
-e MODIFY #只监听文件修改事件
--exclude '^.*.swp$' #如果直接使用vim等编辑工具改动文件,会触发 .swp 临时文件的修改事件,所以我们需要排除所有正则形如 /^\.((?!\.swp$).)*$/ 的文件,但此表达式在linux中貌似不行,所以用的.*.swp
読みやすくするために、各パラメータはラップされてコメント化されており、次のように 1 行にまとめられています。
inotifywait /production/sites/vue-program/src -r --timefmt '%d/%m/%y %H:%M' --format "%T %f" -e MODIFY --exclude '^.*.swp$'
必要な効果は実行時に観察できるようにすることであり、イベントをリッスンした後、ビルド コードを命令に追加してシェル ファイルを作成します。 auto_build.sh
#!/bin/bash
projectDir=/production/sites/vue-program;
while inotifywait $projectDir/src -r --timefmt '%d/%m/%y %H:%M' --format "%T %f" -e MODIFY --exclude '^.*.swp$'
do
cd $projectDir && git pull && npm run build
done
ここのパラメータは -m
複数のファイルを監視するため、1 つの git commit で複数の変更イベントがトリガーされる可能性があるため、これは使用されません。代わりに、 inotifywait 監視を-m
トリガーしwhile
てここで待機し、イベントがトリガーされた後に再度実行します git pull
。変更イベントがトリガーされると、git はすべてのファイルを完全に置き換えることはできませんがnpm run build
、命令の実行時にすべてのコードが確実に更新される ように、ここで再度アクティブに実行されます。git pull
その後、スクリプトを開始できます
nohup /bin/bash auto_build.sh >> /tmp/auto_build.log 2>&1
このように、crontab が定期的にコードを取得すると、フロントエンドのコード ファイルが変更された後にコードが自動的にビルドされるため、毎回手動で操作する煩わしさや省略がなくなります。
詳細については、公式ドキュメントを参照してください。