Java可以如何实现文件变动的监听

Java可以如何实现文件变动的监听

应用中使用logback作为日志输出组件的话,大部分会去配置 logback.xml 这个文件,而且生产环境下,直接去修改logback.xml文件中的日志级别,不用重启应用就可以生效

那么,这个功能是怎么实现的呢?

I. 问题描述及分析

针对上面的这个问题,首先抛出一个实际的case,在我的个人网站 Z+中,所有的小工具都是通过配置文件来动态新增和隐藏的,因为只有一台服务器,所以配置文件就简化的直接放在了服务器的某个目录下

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

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

  • 如何轮询?
  • 如何判断文件是否修改?
  • 配置异常,会不会导致服务不可用?(即容错,这个与本次主题关联不大,但又比较重要...)

II. 设计与实现

问题抽象出来之后,对应的解决方案就比较清晰了

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

那么一个很简单的实现就比较容易了:

public class FileUpTest {



    private long lastTime;



    @Test

    public void testFileUpdate() {

        File file = new File("/tmp/alarmConfig");



        // 首先文件的最近一次修改时间戳

        lastTime = file.lastModified();



        // 定时任务,每秒来判断一下文件是否发生变动,即判断lastModified是否改变

        ScheduledExecutorService scheduledExecutorService = Executors.newScheduledThreadPool(1);

        scheduledExecutorService.scheduleAtFixedRate(new Runnable() {

            @Override

            public void run() {

                if (file.lastModified() > lastTime) {

                    System.out.println("file update! time : " + file.lastModified());

                    lastTime = file.lastModified();

                }

            }

        },0, 1, TimeUnit.SECONDS);





        try {

            Thread.sleep(1000 \* 60);

        } catch (InterruptedException e) {

            e.printStackTrace();

        }

    }

}

上面这个属于一个非常简单,非常基础的实现了,基本上也可以满足我们的需求,那么这个实现有什么问题呢?

**定时任务的执行中,如果出现了异常会怎样?**

对上面的代码稍作修改

public class FileUpTest {



    private long lastTime;



    private void ttt() {

        throw new NullPointerException();

    }



    @Test

    public void testFileUpdate() {

        File file = new File("/tmp/alarmConfig");



        lastTime = file.lastModified();



        ScheduledExecutorService scheduledExecutorService = Executors.newScheduledThreadPool(1);

        scheduledExecutorService.scheduleAtFixedRate(new Runnable() {

            @Override

            public void run() {

                if (file.lastModified() > lastTime) {

                    System.out.println("file update! time : " + file.lastModified());

                    lastTime = file.lastModified();

                    ttt();

                }

            }

        }, 0, 1, TimeUnit.SECONDS);





        try {

            Thread.sleep(1000 \* 60 \* 10);

        } catch (InterruptedException e) {

            e.printStackTrace();

        }

    }

}

实际测试,发现只有首次修改的时候,触发了上面的代码,但是再次修改则没有效果了,即当抛出异常之后,定时任务将不再继续执行了,这个问题的主要原因是因为 ScheduledExecutorService 的原因了

直接查看ScheduledExecutorService的源码注释说明

If any execution of the task encounters an exception, subsequent executions are suppressed.Otherwise, the task will only terminate via cancellation or termination of the executor.

即如果定时任务执行过程中遇到发生异常,则后面的任务将不再执行。

**所以,使用这种姿势的时候,得确保自己的任务不会抛出异常,否则后面就没法玩了**

对应的解决方法也比较简单,整个catch一下就好

III. 进阶版

前面是一个基础的实现版本了,当然在java圈,基本上很多常见的需求,都是可以找到对应的开源工具来使用的,当然这个也不例外,而且应该还是大家比较属性的apache系列

首先maven依赖

<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;

    }

}

从上面基本上一目了然,整个的实现逻辑了,和我们的第一种定时任务的方法不太一样,这儿直接使用线程,死循环,内部采用sleep的方式来来暂停,因此出现异常时,相当于直接抛出去了,这个线程就跪了


JDK版本

jdk1.7,提供了一个WatchService,也可以用来实现文件变动的监听,之前也没有接触过,看到说明,然后搜了一下使用相关,发现也挺简单的,同样给出一个简单的示例demo

@Test

public void testFileUpWather() throws IOException {

    // 说明,这里的监听也必须是目录

    Path path = Paths.get("/tmp");

    WatchService watcher = FileSystems.getDefault().newWatchService();

    path.register(watcher, ENTRY\_MODIFY);



    new Thread(() -> {

        try {

            while (true) {

                WatchKey key = watcher.take();

                for (WatchEvent<?> event : key.pollEvents()) {

                    if (event.kind() == OVERFLOW) {

                        //事件可能lost or discarded 

                        continue;

                    }

                    Path fileName = (Path) event.context();

                    System.out.println("文件更新: " + fileName);

                }

                if (!key.reset()) { // 重设WatchKey

                    break;

                }

            }

        } catch (Exception e) {

            e.printStackTrace();

        }

    }).start();





    try {

        Thread.sleep(1000 \* 60 \* 10);

    } catch (InterruptedException e) {

        e.printStackTrace();

    }

}

IV. 小结

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

  • 如何轮询: 定时器(Timer, ScheduledExecutorService), 线程死循环+sleep
  • 文件修改: File#lastModified

整体来说,这个实现还是比较简单的,无论是自定义实现,还是依赖 commos-io来做,都没太大的技术成本,但是需要注意的一点是:

  • 千万不要在定时任务 or 文件变动的回调方法中抛出异常!!!

为了避免上面这个情况,一个可以做的实现是借助EventBus的异步消息通知来实现,当文件变动之后,发送一个消息即可,然后在具体的重新加载文件内容的方法上,添加一个 @Subscribe注解即可,这样既实现了解耦,也避免了异常导致的服务异常 (如果对这个实现有兴趣的可以评论说明)

V. 其他

参考项目

声明

尽信书则不如,已上内容,纯属一家之言,因本人能力一般,见解不全,如有问题,欢迎批评指正

扫描关注,java分享

QrCode

原创声明,本文系作者授权云+社区发表,未经许可,不得转载。

如有侵权,请联系 yunjia_community@tencent.com 删除。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏开发 & 算法杂谈

Zookeeper C API学习总结

客户端使用C语言开发,zookeeper提供了两个库,zookeeper_st(单线程库)以及zookeeper_mt(多线程库)。

9895
来自专栏Petrichor的专栏

git: .gitignore文件 (忽略文件)

Note: 切记目录名后面 一定要加 反斜杠 / ,不然会当成 单文件 处理。

1812
来自专栏IT杂记

Java Socket Timeout总结

1. Socket timeout     Java socket有如下两种timeout: 建立连接timeout,暂时就叫 connect timeout;...

7409
来自专栏ImportSource

学会一个JVM插件:使用HSDIS反汇编JIT生成的代码

HSDIS是一个Java官方推荐 HotSpot虚拟机JIT编译代码的反汇编插件。我们有了这个插件后,通过JVM参数-XX:+PrintAssembly就可以加...

86711
来自专栏calmound

hust The mell hell

http://acm.sdibt.edu.cn:8080/judge/contest/view.action?cid=573#problem/E 题意:每个人需...

3135
来自专栏UDNZ

记一次 .NET Framework 不兼容 HTTP COOKIE 协议标准的问题跟踪

我们在后端系统实现了 HTTP 请求的代理类,用于请求其他第三方系统。

3218
来自专栏Android 开发学习

Android内存泄漏分析总结

1914
来自专栏北京马哥教育

linux bash环境变量简单总结

一.环境变量简介 Linux是一个多用户的操作系统。每个用户登录系统后,都会有一个专用的运行环境。通常每个用户默认的环境都 是相同的,这个默认环境实际...

3546
来自专栏逸鹏说道

Python3 与 C# 并发编程之~ 进程实战篇

之前说过 Queue:在 Process之间使用没问题,用到 Pool,就使用 Manager().xxx, Value和 Array,就不太一样了:

1744
来自专栏企鹅号快讯

Python编写渗透工具学习笔记二

1 用pxssh暴力破解ssh密码 因为默认情况下只有linux有ssh服务,所以此脚本只适用于在linux下使用 靶机 10.10.10.128 kali6...

2026

扫码关注云+社区

领取腾讯云代金券