一、概述
FileObserver主要用来提供对文件或者文件夹的监控,一个FileObserver实例监控一个文件,能够监控的文件或者文件夹的event type
包括下表中的几种。
类型值 | 类型名称 | 含义 |
---|---|---|
1 | ACCESS | 从文件中读取数据 |
2 | MODIFY | 从文件中编辑数据 |
4 | ATTRIB | 文件元数据(权限,拥有者,时间戳)被明确改变 |
8 | CLOSE_WRITE | 有人打开文件或者目录进行书写,并且关闭它 |
16 | CLOSE_NOWEITTE | 有人打开文件或者目录没有编辑,并且关闭它 |
32 | OPEN | 一个文件或者目录被打开 |
64 | MOVE_FROM | 一个文件或者子目录从被监控目录被移出 |
128 | MOVE_TO | 一个文件或者子目录被移入到被监控的目录 |
256 | CREATE | 一个文件或者子目录在被监控的目录下被创建 |
512 | DELETE | 文件从监控目录被删除 |
1024 | DELETE_SELF | 监控的文件或者目录被删除,监控停止 |
2048 | MOVE_SELF | 监控的文件或者目录被移动,监控继续 |
另外,在调试的过程中,FileObserver
的onEvent
会返回未明确定义的event type
,经过调试,对应的含义如下表。
类型值 | 含义 |
---|---|
1073742080 | “文件夹”的创建(Create)操作 |
1073742336 | “文件夹”的删除(Delete)操作 |
1073741888 | “文件夹”的移出(MOVE_FROM) 操作 |
1073741952 | “文件夹”的移入(MOVE_TO) 操作 |
32768 | “文件夹” 的打开操作 (OPEN) 操作 |
如果发现新的类型,后期会进行完善。
二、FileObserver的使用
FileObserver
的API相对简单,可以继承FileObserver
实现自定义的MyFileObserver
,目的是监控onEvent
回调,然后执行startWatching
启动监控,在需要停止监控的时候执行stopWatching
。
三、FileObserver收不到onEvent回调
如果在开发的过程中,遇到onEvent
无法接收的问题,先确认对以下几种可能原因进行排除。
- FileObserver对象实例被回收 (思路:通过放在Application中进行测试)
- 初始化顺序问题 (思路:尽早的对FileObserver进行初始化)
- 没有读写文件权限问题 (思路: 文件监控需要文件读写权限)
- onEvent中做复杂操作 (思路: 先跑通,再实现逻辑)
- 妨碍 inotify的可能性
- 同一个进程中,如果有两个不同的FileObserver同时监控一个Path,只有后调用startWatching的FileObserver能够收到onEvent回调。(Android系统Bug)
我在开发的过程中,最终是最后一点导致的,这是Android framework的Bug,Android系统Bug地址,解决方案在地址中有提供。
四、FileObserver使用注意事项
因为FileObserver
的startWatching
和stopWatching
都存在加锁操作。拿startWatching
源码举例。
public int startWatching(String path, int mask, FileObserver observer) {
int wfd = startWatching(m_fd, path, mask);
Integer i = new Integer(wfd);
if (wfd >= 0) {
synchronized (m_observers) {
m_observers.put(i, new WeakReference(observer));
}
}
return i;
}
其中有m_observers
对象锁,所有在我们调用MyFileObserver
的 startWatching
时,尽量不要放在自己实现的对象锁中实现,可能会引发死锁操作,从而导致ANR。思路如下:
public class MyFileObserver extends FileObserver{
@Override
public void onEvent(int event0, String path) {
// TODO 处理自己的业务逻辑
}
}
public class FileObserverTest{
private static final Object ob_lock = new Object();
public void startWatching(String path){
MyFileObserver observer = new MyFileObserver(path)
observer.startWatching();
synchronized(ob_lock){
// TODO 这里去执行程序中需要枷锁进行同步的操作,不要将startWatching放在业务逻辑锁中,防止死锁。
}
}
}
五、FileObserver总结
文件操作相关的开发中,经常会用到FileObserver对文件的监控操作,从而去实现当文件有变化时,程序及时进行UI逻辑反馈给用户的能力,上面我列出了自己在使用过程中的一些经验和总结,如果有遗留的思路或者问题,欢迎进行留言反馈。