java 如何实现文件变动的监听

获取修改时间

long lastTime = file.lastModified();

原文链接：https://blog.csdn.net/liuyueyi25/article/details/79292971

现在的问题时，我需要在这个文件的内容发生变动时，应用可以感知这种变动，并重新加载文件内容，更新应用内部缓存

一个最容易想到的方法，就是轮询，判断文件是否发生修改，如果修改了，则重新加载，并刷新内存，所以主要需要关心的问题如下：

如何轮询？
如何判断文件是否修改？
配置异常，会不会导致服务不可用？（即容错，这个与本次主题关联不大，但又比较重要…）
II. 设计与实现
问题抽象出来之后，对应的解决方案就比较清晰了

如何轮询 ？ –》 定时器 Timer, ScheduledExecutorService 都可以实现
如何判断文件修改？ –》根据 java.io.File#lastModified 获取文件的上次修改时间，比对即可

进阶方法

<dependency>

  <groupId>commons-io</groupId>

 <artifactId>commons-io</artifactId>

 <version>2.6</version>

</dependency>

主要是借助这个工具中的 FileAlterationObserver, FileAlterationListener, FileAlterationMonitor 三个类来实现相关的需求场景了，当然使用也算是很简单了，以至于都不太清楚可以再怎么去说明了，直接看下面从我的一个开源项目quick-alarm中拷贝出来的代码

public class PropertiesConfListenerHelper {

    public static boolean registerConfChangeListener(File file, Function<File, Map<String, AlarmConfig>> func) {
        try {
            // 轮询间隔 5 秒
            long interval = TimeUnit.SECONDS.toMillis(5);


            // 因为监听是以目录为单位进行的，所以这里直接获取文件的根目录
            File dir = file.getParentFile();

            // 创建一个文件观察器用于过滤
            FileAlterationObserver observer = new FileAlterationObserver(dir,
                    FileFilterUtils.and(FileFilterUtils.fileFileFilter(),
                            FileFilterUtils.nameFileFilter(file.getName())));

            //设置文件变化监听器
            observer.addListener(new MyFileListener(func));
            FileAlterationMonitor monitor = new FileAlterationMonitor(interval, observer);
            monitor.start();

            return true;
        } catch (Exception e) {
            log.error("register properties change listener error! e:{}", e);
            return false;
        }
    }


    static final class MyFileListener extends FileAlterationListenerAdaptor {

        private Function<File, Map<String, AlarmConfig>> func;

        public MyFileListener(Function<File, Map<String, AlarmConfig>> func) {
            this.func = func;
        }

        @Override
        public void onFileChange(File file) {
            Map<String, AlarmConfig> ans = func.apply(file); // 如果加载失败，打印一条日志
            log.warn("PropertiesConfig changed! reload ans: {}", ans);
        }
    }
}

针对上面的实现，简单说明几点：

这个文件监听，是以目录为根源，然后可以设置过滤器，来实现对应文件变动的监听
如上面registerConfChangeListener方法，传入的file是具体的配置文件，因此构建参数的时候，捞出了目录，捞出了文件名作为过滤
第二参数是jdk8语法，其中为具体的读取配置文件内容，并映射为对应的实体对象
一个问题，如果 func方法执行时，也抛出了异常，会怎样？

实际测试表现结果和上面一样，抛出异常之后，依然跪，所以依然得注意，不要跑异常

那么简单来看一下上面的实现逻辑，直接扣出核心模块

public void run() {
    while(true) {
        if(this.running) {
            Iterator var1 = this.observers.iterator();

            while(var1.hasNext()) {
                FileAlterationObserver observer = (FileAlterationObserver)var1.next();
                observer.checkAndNotify();
            }

            if(this.running) {
                try {
                    Thread.sleep(this.interval);
                } catch (InterruptedException var3) {
                    ;
                }
                continue;
            }
        }

        return;
    }
}

IV. 小结
使用Java来实现配置文件变动的监听，主要涉及到的就是两个点

如何轮询： 定时器（Timer, ScheduledExecutorService）, 线程死循环+sleep
文件修改： File#lastModified
整体来说，这个实现还是比较简单的，无论是自定义实现，还是依赖 commos-io来做，都没太大的技术成本，但是需要注意的一点是：

千万不要在定时任务 or 文件变动的回调方法中抛出异常！！！
为了避免上面这个情况，一个可以做的实现是借助EventBus的异步消息通知来实现，当文件变动之后，发送一个消息即可，然后在具体的重新加载文件内容的方法上，添加一个 @Subscribe注解即可，这样既实现了解耦，也避免了异常导致的服务异常 （如果对这个实现有兴趣的可以评论说明）
————————————————
版权声明：本文为CSDN博主「一灰灰blog」的原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接及本声明。
原文链接：https://blog.csdn.net/liuyueyi25/article/details/79292971

————————————————
版权声明：本文为CSDN博主「一灰灰blog」的原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接及本声明。
原文链接：https://blog.csdn.net/liuyueyi25/article/details/79292971