本教程详细介绍了在Eclipse插件开发中，如何利用`IResourceChangeListener`和`IResourceDelta`机制来高效追踪工作区中已被修改但尚未保存（即“脏”）的文件。文章将提供核心代码示例，并阐述如何构建自定义文件状态跟踪器，以及应对文件保存后状态变化的策略，旨在帮助开发者实现精准的文件状态监控，以支持各种自动化或辅助功能开发。
在Eclipse插件开发中，经常需要监控工作区中文件的状态，特别是那些已经被用户修改但尚未保存的文件，我们通常称之为“脏”文件。这些文件在Eclipse UI中通常会在其名称旁显示一个星号（*）。准确获取并管理这些“脏”文件的列表，对于实现诸如自动保存、代码分析、版本控制集成等高级功能至关重要。
1. 理解“脏”文件与Eclipse资源模型
Eclipse平台通过其资源模型（Resource Model）管理工作区中的文件、文件夹和项目。任何对这些资源的修改都会触发相应的事件。一个文件被称为“脏”文件，意味着其内存中的内容与磁盘上的内容不一致。当用户执行“保存”或“全部保存”操作时，这些“脏”文件的内容会被写入磁盘，从而恢复到“干净”状态。
要追踪这些状态变化，我们需要利用Eclipse提供的核心API：IResourceChangeListener和IResourceDelta。
2. 核心机制：IResourceChangeListener与IResourceDelta
IResourceChangeListener是Eclipse提供的一个接口，允许插件监听工作区资源的各种变化事件。当工作区中的资源发生创建、删除、修改、移动等操作时，系统会触发一个IResourceChangeEvent。这个事件对象中包含了IResourceDelta，它是一个描述自上次事件以来工作区资源变化情况的树形结构。
为了检测文件内容的修改，我们需要在POST_CHANGE事件中注册监听器。POST_CHANGE事件在所有资源变更处理完成后触发，此时工作区已处于一致状态，适合进行后续处理。
以下是注册IResourceChangeListener并处理资源变化的示例代码：
import org.eclipse.core.resources.IResourceChangeEvent;
import org.eclipse.core.resources.IResourceChangeListener;
import org.eclipse.core.resources.IResourceDelta;
import org.eclipse.core.resources.IResourceDeltaVisitor;
import org.eclipse.core.resources.IResource;
import org.eclipse.core.resources.ResourcesPlugin;
import org.eclipse.core.runtime.CoreException;
// 假设在一个插件的启动类或服务中注册
public class DirtyFileTracker implements IResourceChangeListener {
// 使用一个集合来存储当前“脏”文件的路径或IResource对象
private Set<IResource> dirtyFiles = Collections.synchronizedSet(new HashSet<>());
public void startTracking() {
ResourcesPlugin.getWorkspace().addResourceChangeListener(this, IResourceChangeEvent.POST_CHANGE);
// 可以在这里初始化dirtyFiles，例如扫描当前所有打开的编辑器
}
public void stopTracking() {
ResourcesPlugin.getWorkspace().removeResourceChangeListener(this);
}
public Set<IResource> getDirtyFiles() {
return Collections.unmodifiableSet(dirtyFiles);
}
@Override
public void resourceChanged(final IResourceChangeEvent event) {
IResourceDelta delta = event.getDelta();
if (delta == null) {
return; // 没有变化
}
IResourceDeltaVisitor visitor = new IResourceDeltaVisitor() {
@Override
public boolean visit(IResourceDelta delta) throws CoreException {
IResource resource = delta.getResource();
// 只关心文件类型
if (resource.getType() != IResource.FILE) {
return true; // 继续访问子元素
}
switch (delta.getKind()) {
case IResourceDelta.CHANGED:
// 检测文件内容是否被修改
if ((delta.getFlags() & IResourceDelta.CONTENT) != 0) {
// 文件内容已改变，将其视为“脏”文件
dirtyFiles.add(resource);
System.out.println("文件内容被修改 (脏): " + resource.getFullPath());
}
// 此外，还需要处理文件保存的情况，这会在后面讨论
break;
case IResourceDelta.REMOVED:
// 文件被删除，从脏文件列表中移除
dirtyFiles.remove(resource);
System.out.println("文件被删除: " + resource.getFullPath());
break;
case IResourceDelta.ADDED:
// 新增文件，通常不是“脏”文件，除非创建时就有内容且未保存
// 根据需求决定是否添加到dirtyFiles
System.out.println("文件被添加: " + resource.getFullPath());
break;
default:
break;
}
return true; // 继续访问子元素
}
};
try {
delta.accept(visitor);
} catch (CoreException e) {
// 记录错误
System.err.println("Error checking IResourceDelta visitor: " + e.getMessage());
}
}
}代码解释：
- ResourcesPlugin.getWorkspace().addResourceChangeListener(this, IResourceChangeEvent.POST_CHANGE);: 这是注册监听器的关键行。this指的是DirtyFileTracker实例本身，因为它实现了IResourceChangeListener接口。IResourceChangeEvent.POST_CHANGE确保我们监听的是所有资源变化处理完毕后的事件。
- IResourceDelta delta = event.getDelta();: 从事件中获取资源变化的增量信息。
- IResourceDeltaVisitor: 这是一个内部类，用于遍历IResourceDelta树。visit方法会对每个发生变化的资源节点被调用。
- delta.getResource(): 获取当前delta节点对应的IResource对象。
- resource.getType() != IResource.FILE: 过滤掉非文件资源，我们主要关注文件的内容变化。
- delta.getKind() == IResourceDelta.CHANGED: 判断资源是否是“改变”状态。
- (delta.getFlags() & IResourceDelta.CONTENT) != 0: 这是检测文件内容是否被修改的关键。IResourceDelta.CONTENT是一个标志位，如果设置了此标志，则表示文件内容发生了变化。如果检测到此变化，我们将对应的IResource添加到dirtyFiles集合中。
3. 构建自定义“脏”文件跟踪器
上述代码片段已经包含了一个基本的Set
- 存储文件的路径（IPath或String）而不是IResource对象：因为IResource对象在某些情况下可能会失效或被替换。
- 记录文件的修改时间戳：以便进行更精细的控制或判断。
- 提供查询特定项目或文件夹下“脏”文件的方法。
- 线程安全：确保在多线程环境下对dirtyFiles集合的操作是安全的。Collections.synchronizedSet提供了一个简单的同步包装。
4. 处理文件保存后的状态转换
一个重要的考虑点是：当用户保存一个“脏”文件时，它就不再是“脏”的了。上述的IResourceChangeListener机制在文件保存时也会触发IResourceDelta.CHANGED事件，但此时IResourceDelta.CONTENT标志可能不会被设置（因为内容已经从内存写入磁盘，磁盘内容与内存内容再次一致）。
要准确地从“脏”文件列表中移除已保存的文件，我们需要一个额外的机制来检测“保存”操作。一种常见且有效的方法是：
- 利用编辑器状态：Eclipse的编辑器模型提供了ISaveablesSource和ISaveablePart接口，它们能指示一个编辑器是否包含未保存的修改。当你打开一个文件并在其中输入内容时，相应的编辑器会变为“脏”状态。当保存时，编辑器会变为“干净”状态。你可以通过监听IWorkbenchPage的IPartListener2来跟踪编辑器的生命周期和状态变化。
- 结合IResourceChangeListener的上下文：当一个文件从“脏”状态变为“干净”状态时，这意味着它被保存或被撤销了修改。IResourceChangeListener可以帮助你确认文件确实被修改过（即之前在dirtyFiles列表中），然后通过其他方式（例如，检查编辑器状态）判断它是否被保存。如果一个文件之前在dirtyFiles中，并且现在它的编辑器不再显示为脏，那么它很可能被保存了。
示例：在IResourceChangeListener中处理保存操作的思路
在resourceChanged方法中，当检测到IResourceDelta.CHANGED事件时，除了检查IResourceDelta.CONTENT，还需要考虑文件从“脏”变为“干净”的情况。这通常意味着文件内容已经被写入磁盘。
// ... 在 resourceChanged 方法的 switch (delta.getKind()) 内部 ...
case IResourceDelta.CHANGED:
boolean wasDirty = dirtyFiles.contains(resource); // 检查文件之前是否在脏文件列表中
if ((delta.getFlags() & IResourceDelta.CONTENT) != 0) {
// 文件内容被修改，将其标记为“脏”
dirtyFiles.add(resource);
System.out.println("文件内容被修改 (脏): " + resource.getFullPath());
} else if (wasDirty) {
// 文件之前是脏的，但现在内容标志没有变化，
// 这可能是文件被保存（或撤销）的情况。
// 在这里可以进一步结合编辑器状态来判断是否是保存操作。
// 例如，检查对应的IEditorPart是否isDirty()返回false。
// 简化处理：如果之前是脏的，现在没有内容变化，则认为是干净了
dirtyFiles.remove(resource);
System.out.println("文件被保存或撤销 (干净): " + resource.getFullPath());
}
break;
// ... 其他 case ...这种方法虽然简化，但在许多情况下是足够的：如果一个文件之前被标记为“脏”（通过CONTENT标志），而现在又发生了CHANGED事件但没有CONTENT标志，那么它很可能已经不再“脏”了。
5. 高级应用与注意事项
- 程序化保存：如果你需要程序化地保存“脏”文件，可以使用IFile接口的save(IProgressMonitor monitor, boolean force)方法。在保存后，你的dirtyFiles跟踪器也应该相应地更新。
- 用户不活动检测：一些插件会检测用户对某个文件的长时间不活动，然后自动保存该文件。这可以通过计时器和上述的“脏”文件列表来实现。
- 性能考量：IResourceChangeListener会在工作区发生大量变化时频繁触发。IResourceDeltaVisitor的visit方法应该尽可能高效，避免执行耗时的操作。
- 错误处理：在IResourceDeltaVisitor中捕获CoreException并进行适当的日志记录非常重要，以防止插件崩溃。
- 初始化：在插件启动时，dirtyFiles集合可能需要根据当前打开的编辑器状态进行初始化，以反映启动前已存在的“脏”文件。
总结
通过IResourceChangeListener和IResourceDelta机制，Eclipse插件可以有效地监控工作区中文件的修改状态。关键在于正确地注册监听器、遍历IResourceDelta并利用IResourceDelta.CONTENT标志来识别文件内容的实际变更。同时，建立一个可靠的自定义跟踪器，并处理文件保存后从“脏”到“干净”的状态转换，是构建健壮且功能丰富的Eclipse插件的核心实践。理解并掌握这些机制，将极大地提升你在Eclipse平台进行开发的能力。
