在Eclipse插件开发中，一个常见的需求是需要实时了解哪些文件在项目中被修改过，即处于“脏”状态（文件内容已变更，但尚未保存）。这些文件通常在IDE中会以星号（*）标记在文件名旁。本文将详细介绍如何通过Eclipse的资源监听机制来实现这一功能，并提供一个实用的代码示例和相关注意事项。
一、理解Eclipse资源变更监听机制
Eclipse工作区（Workspace）提供了强大的资源变更监听机制，允许插件开发者在文件、文件夹或项目发生创建、修改、删除等操作时得到通知。核心接口是IResourceChangeListener，它通过ResourcesPlugin.getWorkspace().addResourceChangeListener()方法注册到工作区。
当资源发生变化时，resourceChanged方法会被调用，并传入一个IResourceChangeEvent对象。这个事件对象包含了关于变更的详细信息，特别是通过event.getDelta()方法可以获取到IResourceDelta，它是一个资源变更的树形结构，描述了自上次事件以来所有资源的变化。
二、实现“脏”文件检测
要检测文件内容的修改，我们需要关注IResourceChangeEvent.POST_CHANGE类型的事件，因为这类事件在工作区变更完成后触发，提供了完整的变更差异（delta）。然后，我们需要遍历IResourceDelta，查找那些类型为IResourceDelta.CHANGED且其标志位包含IResourceDelta.CONTENT的资源。
立即学习“Java免费学习笔记（深入）”；
本文档主要讲述的是Eclipse配置Tomcat教程；Eclipse IDE： eclipse IDE 用作 JSP 页面和 Java 文件的开发环境。Eclipse 是一个非常简单易用的 IDE 环境，它具有很多特性，可以帮助程序员快速编写并调试 Java 程序。加上 tomcat 插件之后，这个 IDE 就是管理整个 Web 项目（包括 HTML 和 JSP 页面、图标和 servlet）的一个非常优秀的工具。 Tomcat： 驱动 JSP 页面需要使用 Tomcat。Tomcat 引擎是非常好的一个
以下是一个实现文件内容修改检测的示例代码：
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;
import java.util.Set;
import java.util.HashSet;
public class DirtyFileTracker {
// 假设有一个Logger，这里简化为System.err
private static final java.util.logging.Logger LOGGER = java.util.logging.Logger.getLogger(DirtyFileTracker.class.getName());
// 用于存储当前“脏”文件的集合
private Set<IResource> dirtyFiles = new HashSet<>();
public DirtyFileTracker() {
// 注册资源变更监听器
ResourcesPlugin.getWorkspace().addResourceChangeListener(
new IResourceChangeListener() {
@Override
public void resourceChanged(final IResourceChangeEvent event) {
// 只处理POST_CHANGE事件，确保所有变更已完成
if (event.getType() != IResourceChangeEvent.POST_CHANGE) {
return;
}
IResourceDelta delta = event.getDelta();
if (delta == null) {
return;
}
IResourceDeltaVisitor visitor = new IResourceDeltaVisitor() {
@Override
public boolean visit(IResourceDelta delta) throws CoreException {
IResource res = delta.getResource();
// 仅处理文件资源
if (res.getType() != IResource.FILE) {
return true; // 继续访问子节点
}
switch (delta.getKind()) {
case IResourceDelta.CHANGED:
// 检查文件内容是否改变
if ((delta.getFlags() & IResourceDelta.CONTENT) != 0) {
// 文件内容已修改，将其添加到脏文件列表
addDirtyFile(res);
LOGGER.info("文件内容已修改: " + res.getFullPath());
}
// 检查文件是否被保存（例如，通过编辑器保存操作）
// 注意：直接通过IResourceDelta判断文件是否“不再脏”是复杂的
// 通常需要结合其他机制，如编辑器生命周期事件
// 这里的逻辑是如果文件内容变化，就标记为脏
break;
case IResourceDelta.REMOVED:
// 文件被删除，从脏文件列表中移除
removeDirtyFile(res);
LOGGER.info("文件已删除: " + res.getFullPath());
break;
// 可以根据需要处理其他类型的变更，例如ADDED
case IResourceDelta.ADDED:
// 新增文件，如果后续被修改，IResourceDelta.CONTENT会捕获
break;
default:
break;
}
return true; // 继续访问子节点
}
};
try {
delta.accept(visitor);
} catch (CoreException e) {
LOGGER.severe("遍历IResourceDelta时发生错误: " + e.getMessage());
}
}
}, IResourceChangeEvent.POST_CHANGE // 监听POST_CHANGE事件
);
}
/**
* 将文件添加到脏文件列表
* @param file 脏文件
*/
private synchronized void addDirtyFile(IResource file) {
dirtyFiles.add(file);
}
/**
* 将文件从脏文件列表中移除
* @param file 已保存或已删除的文件
*/
public synchronized void removeDirtyFile(IResource file) {
dirtyFiles.remove(file);
}
/**
* 获取当前所有“脏”文件的列表
* @return 脏文件集合的副本
*/
public synchronized Set<IResource> getDirtyFiles() {
return new HashSet<>(dirtyFiles);
}
// 可以在插件停止时移除监听器
public void dispose() {
ResourcesPlugin.getWorkspace().removeResourceChangeListener(this);
}
// 示例用法
public static void main(String[] args) throws InterruptedException {
// 在实际插件中，DirtyFileTracker会在插件启动时实例化
DirtyFileTracker tracker = new DirtyFileTracker();
System.out.println("DirtyFileTracker已启动，监听文件变更...");
// 模拟一些操作，等待变更发生
// 在真实的Eclipse环境中，你需要手动修改并保存文件来触发事件
Thread.sleep(60000); // 等待一分钟观察效果
System.out.println("当前脏文件列表:");
for (IResource res : tracker.getDirtyFiles()) {
System.out.println(" - " + res.getFullPath());
}
tracker.dispose(); // 在插件关闭时清理
}
}三、管理文件的“脏”与“已保存”状态
上述代码片段主要负责检测文件内容的修改，并将其标记为“脏”。然而，当用户点击“保存”或使用快捷键保存文件时，文件将不再是“脏”的。IResourceDelta本身并不能直接指示一个文件何时从“脏”状态变为“已保存”状态。
为了完整地跟踪文件状态，您需要：
-
维护一个自定义的“脏”文件集合：如示例中的dirtyFiles Set
。当IResourceDelta.CONTENT标志被检测到时，将文件添加到此集合。 -
监听保存操作：这通常比直接通过IResourceDelta检测更复杂。一种常见的方法是监听编辑器（IEditorPart）的生命周期事件，特别是当编辑器被保存时（例如，通过IEditorPart.isDirty()返回false后）。
- 您可以注册IPartListener2来监听视图和编辑器的激活、关闭、保存等事件。
- 当一个编辑器被保存时，您可以获取到其对应的IFile，然后从您的dirtyFiles集合中移除该IFile。
- 例如，在IPartListener2的partActivated或partDeactivated方法中，您可以检查IEditorPart是否isDirty()。
-
处理其他状态变更：
- 文件删除：当IResourceDelta.REMOVED被触发时，应从dirtyFiles集合中移除相应的文件。
- SCM操作（版本控制）：如果文件通过版本控制系统（如Git、SVN）被还原，它也可能不再是“脏”的。这通常会触发资源变更事件，可能需要特定的逻辑来处理。
四、注意事项与最佳实践
- 性能考虑：IResourceChangeListener在工作区发生任何变更时都会被调用。在visit方法中执行耗时操作时要小心，避免阻塞UI线程或影响Eclipse性能。
- 线程安全：如果您在多个线程中访问或修改dirtyFiles集合，请确保使用同步机制（如synchronized关键字或并发集合）。
- 生命周期管理：在插件启动时注册IResourceChangeListener，并在插件停止时务必移除它，以避免资源泄露。
- 精确性：IResourceDelta.CONTENT标志可以可靠地检测文件内容的修改。但是，判断文件何时“不再脏”可能需要结合编辑器状态、保存事件等多种信息。
- 错误处理：在IResourceDeltaVisitor中捕获CoreException，并进行适当的日志记录，以便调试。
总结
通过IResourceChangeListener和IResourceDelta机制，Eclipse插件能够有效地监听和响应工作区中的文件内容变更。结合自定义的文件状态跟踪器和对编辑器保存事件的监听，开发者可以构建一个健壮的系统来识别、管理和操作项目中所有“脏”文件。这种方法为各种需要处理文件修改的插件功能（如自动构建、代码分析、自定义保存行为等）奠定了基础。
