eclipse插件开发：实现创建自定义项目_eclipse plugin project

原文地址：https://www.xuebuyuan.com/2963957.html

（也不知道这个是不是原文地址，只是我从这复制的）

基本概念

Eclipse开发平台提供资源插件（org.eclipse.core.resources），插件提供对项目（Project）、文件（File）、文件夹（Folder）的相关管理和操作。

工作区（workspace）是用户数据文件在平台中的组织和保存区，工作区中的文件通过资源的概念进行组织。工作台（Workbench）可以理解为用户浏览和操作工作区的一个工具。资源插件提供创建、导航、操作工作区中资源的API。工作台利用这些API提供对应功能给用户，这些API也允许用户进行扩展。

资源有三种类型：项目（Project）、文件（File）、文件夹（Folder）。项目中包含若干个文件和文件夹，作为一个表示特殊区域的资源单元和容器，项目之间不可嵌套。工作区中有若干个项目。文件和文件夹的概念和OS中的概念类似。

工作区中的资源以资源树的形式进行组织，文件和文件夹都是项目的后代结点。定义了一个工作区根作为一类特殊的资源存在，作为资源树的根节点。

 

资源的访问

在开发平台中，工作区由IWorkspace的实例进行表示，IWorkspace提供对工作区中的资源访问接口。具体的，通过如下语句获取工作区实例：

IWorkspace workspace = ResourcesPlugin.getWorkspace();

在文件系统中，工作区与一般的文件夹结构一致。但包含有两类隐藏文件（夹），.metadata存放于工作区根位置，是一个文件夹，文件夹中保存包含有工作区结构的信息文件，在开发平台中必须通过特殊的插件API进行访问；.project则存在于项目节点位置，是一文件，文件中保存着与IProjectDescription.一致的信息。

资源插件提供IProject, IFolder,
and IFile实现用户对这些资源类型的访问，IResource中则定义了扩展的通用操作接口，还可以使用org.eclipse.core.runtime中的接口IPath来表示工作区的资源或文件系统的访问路径。

对资源的访问与对java.io.File的访问类似，当调用对应API时，返回一个句柄，不需要在访问前确保资源是否存在。具体的，通过如下代码实现访问：

 

 

Java代码：

//获取工作区根  
  
IWorkspaceRoot myWorkspaceRoot = ResourcesPlugin.getWorkspace().getRoot();  
  
//从工作区根获得项目实例  
  
IProject myWebProject = myWorkspaceRoot.getProject("MyWeb");  
  
// open if necessary  
  
if (myWebProject.exists() && !myWebProject.isOpen()) myWebProject.open(null);  

 

在对项目进行操作前，必须执行打开操作。打开项目操作将从文件系统中读取项目结构并读入内存，创建对应的项目资源树，这是一个显式的操作。

获取项目实例的再下一层，就是对项目中的文件和文件夹进行访问：

 

 

Java代码  

//获取文件夹实例  
  
IFolder imagesFolder = myWebProject.getFolder("images");  
  
if (imagesFolder.exists()) {  
  
// create a new file  
  
IFile newLogo = imagesFolder.getFile("newLogo.png");  
  
    //文件系统的创建过程  
  
FileInputStream fileStream = new FileInputStream("c:/MyOtherData/newLogo.png");  
  
    newLogo.create(fileStream, false, null);  
  
    // create closes the file stream, so no worries.    
  
} 

 

 

 

上面的过程，首先获取images文件夹的句柄，在判断其存在后，在其中创建新文件newLogo。

 

资源与文件系统的关联

通过接口IResource.getLocationURI来获得资源的绝对文件系统路径。反过来，通过IWorkspaceRoot的findFilesForLocationURI或者findContainersForLocationURI来实现文件系统路径到工作区路径的mapping。

 

资源属性

用于保存资源相关的特殊信息，包含会话级和持久级。会话级当项目关闭后失效，用于在内存中方便以名值对形式保存属性，持久级则在文件系统中保留资源属性，有长度限制（不大于2kb，对用于对象的持久化似乎有难度），需要注意命名时不要出现冲突。

 

项目级参数

可以为运行时参数Runtime preferences定义项目级范围（Project-Scope）,用于在项目范围内对参数进行保存和操作：

 

Java代码  

//获取Context
IScopeContext projectScope = new ProjectScope(MyProject);
//获取对应项目的参数节点
Preferences projectNode = projectScope.node("com.example.myplugin");
if (projectNode != null) {
    value = node.getBoolean("MyPreference", "true");
    //do something with the value.
}  
//参数回写  
  
projectNode.flush();  

 

资源挂接

工作区中的资源可以来自文件系统的不同位置，通过资源挂接来实现。实例代码：

 

Java代码  

 IWorkspace workspace = ResourcesPlugin.getWorkspace();  
  
   IPathVariableManager pathMan = workspace.getPathVariableManager();  
  
   String name = "TEMP";  
  
   IPath value = new Path("c:\temp");  
  
   //定义path变量，实现资源挂接  
  
if (pathMan.validateName(name).isOK() && pathMan.validateValue(value).isOK()) {  
  
      pathMan.setValue(name, value);  
  
   } else {  
  
      //invalid name or value, throw an exception or warn user  
  
   }  
  
   IProject project = workspace.getProject("Project");//assume this exists  
  
   IFolder link = project.getFolder("Link");  
  
   IPath location = new Path("TEMP/folder");  
  
   //在资源操作前需要加入验证动作  
  
if (workspace.validateLinkLocation(location).isOK()) {  
  
      link.createLink(location, IResource.NONE, null);  
  
   } else {  
  
      //invalid location, throw an exception or warn user  
  
   }  
  
  

 //运行结果  
 link.getFullPath() ==> "/Project/Link"  
   link.getLocation() ==> "c:tempfolder"  
  
   link.getRawLocation() ==> "TEMP/folder"  
  
   link.isLinked() ==> "true"  
  
    
  
   IFile child = link.getFile("abc.txt");  
  
   child.create(...);  
  
   child.getFullPath() ==> "/Project/Link/abc.txt"  
  
   child.getLocation() ==> "c:tempfolderabc.txt"  
  
   child.getRawLocation() ==> "c:tempfolderabc.txt"  
  
   child.isLinked() ==> "false"  
 

 

 

 

Eclipse资源管理（二）

IProject中的Builder与Nature

 

 

1.创建一个新的工程

如下是创建一个新的工程的代码，但是此时工程就是一个文件夹，没有任何特性

 

 

Java代码  

public void createProject(String projectName) throws CoreException{  
        IWorkspace workspace = ResourcesPlugin.getWorkspace();  
        IWorkspaceRoot root = workspace.getRoot();  
          
        IProject project = root.getProject(projectName);  
        if(!project.exists()){  
            project.create(null);  
            project.open(null);  
        }  
          
        ProjectUtil.addNature2Project(project, new String[]{LengProjectNature.ID}, null);  
    }  

 

2.为project扩展相应的nature

nature是工程特性的一种标识，eclipse中有如此多种类的project，系统是如何识别他们的。IProject对象本身没有什么特别的标识，所以区分各种不同的project，主要是nature来进行区分。例如，如果两种不同的project对象，如果有同样的一种nature特性，如果我们只需要考虑这种nature特性的时候，这两种project其实是可以等同的。可以借鉴equals方法来进行理解。

 

Java代码  

<extension  
         id="com.leng.test.project.nature.LengProjectNature"  
         name="Leng Project Nature"  
         point="org.eclipse.core.resources.natures">  
      <runtime>  
         <run  
               class="com.leng.test.project.nature.LengProjectNature">  
         </run>  
      </runtime>  
      <builder  
            id="com.leng.test.project.nature.LengIncrementalProjectBuilder">  
      </builder>  
   </extension>  

1）一个nature里面可以包含多个builder，并且用builder的id进行识别

注意：com.leng.test.project.nature.LengIncrementalProjectBuilder是builder所在的插件的id+.+builderId

2）实现一个IProjectNature类

Java代码  

public class LengProjectNature implements IProjectNature {  
      
    private IProject project;    
      
    /** 
     * nature的ID为plugin的ID加上nature扩展的ID 
     */  
    public static final String ID = "com.leng.test.project.com.leng.test.project.nature.LengProjectNature";   
      
    @Override  
    public void configure() throws CoreException {  
        ProjectUtil.addBuilderToProject(project,    
                new String[] { LengIncrementalProjectBuilder.ID }, null);    
    }  
  
    @Override  
    public void deconfigure() throws CoreException {  
        ProjectUtil.removeBuilderFromProject(project,    
                new String[] { LengIncrementalProjectBuilder.ID }, null);    
    }  
  
    @Override  
    public IProject getProject() {  
        return project;  
    }  
  
    /** 
     * setProject()和configure()的调用顺序是先调setProject()后调configure(). 
     */  
    @Override  
    public void setProject(IProject project) {  
        this.project = project;  
    }  
  
}  

3.nature的img扩展：

Java代码  

<extension  
         point="org.eclipse.ui.ide.projectNatureImages">  
      <image  
            icon="com.leng.test.project.image1"  
            id="com.leng.test.project.image1"  
            natureId="com.leng.test.project.image1">  
      </image>  
   </extension>  

 

依赖插件org.eclipse.ui.ide，此扩展点为特点的nature项目提供特点的图像标记，如java工程中的文件中“J”。

 

4.为nature扩展相应的builder

 

刚才说到nature是用来标识project的特性的，但是特性不能当饭吃。new一个工程里面那么多东西，而且算不是new，是其他改变工程里面资源的操作。如果说nature只是标识，那么builder就是实实在在的构建了。

当然，构建器本身是独立的，出来跟nature绑定使用，还可以直接添加到project中

 

 

Java代码  

<extension  
         id="com.leng.test.project.nature.LengIncrementalProjectBuilder"  
         point="org.eclipse.core.resources.builders">  
      <builder  
            callOnEmptyDelta="false"  
            hasNature="true"  
            isConfigurable="true">  
         <run  
               class="com.leng.test.project.nature.LengIncrementalProjectBuilder">  
         </run>  
      </builder>  
   </extension>  

 

hasNature：该构建器是否跟nature关联，默认为false，如果为true则必须nature存在才会触发构建

isConfigurable：设定构建器是否可以通过特定的构建触发器运行，如果为true，则可以通过ICommand.setBuilding

callOnEmptyDelta：当增量构建的增量为null时，如果设置此属性为true则始终构建，不会关构建内容是否为null。

 

 

Java代码  

public class LengIncrementalProjectBuilder extends IncrementalProjectBuilder {  
  
    public static final String ID = "com.leng.test.project.nature.LengIncrementalProjectBuilder";  
      
    public LengIncrementalProjectBuilder() {  
    }  
  
    @Override  
    protected IProject[] build(int kind, Map args, IProgressMonitor monitor)  
            throws CoreException {  
        getCommand();  
        getDelta(getProject());  
          
        switch (kind) {    
        case FULL_BUILD:    
//          processFullBuild(monitor);    
            break;    
        case CLEAN_BUILD:  
            break;  
        default:    
            IResourceDelta delta = getDelta(getProject());     
            break;    
        }    
        return null;  
    }  
  
      
    @Override  
    protected void startupOnInitialize() {  
        super.startupOnInitialize();  
    }  
  
    /** 
     * 清除一些保留且无用的东西 
     */  
    @Override  
    protected void clean(IProgressMonitor monitor) throws CoreException {  
        super.clean(monitor);  
    }  
}  

 

 kind：构建类型，FULL_BUILD（全量构建），INCREMENTAL_BUILD（增量构建），

 

 AUTO_BUILD（自动构建，也是增量的），CLEAN_BUILD（在调用build方法前调用clean方法）

 

getDelta：获取指定工程里面增量改变的资源内容

 

派生资源：派生资源就是完全由build构建出来的资源，由某一种源派生出来。

 

 

5.构建器的触发

构建器的触发有两种方式：一种是自动触发，系统资源改变时，由eclipse自动增量构建。另一种是手动构建，IWorkspace和IProject里面都有构建方法，只要获取到相关对象就可以进行构建。

 

 

Eclipse资源管理（三）

 

 

关于marker的使用

 

描述：在eclipse中marker是用来代码级别的各种状态信息的一个框架，使用marker可以轻松的浏览和定位文件中的错误或其他的一些信息。

 

1.定义marker，在eclipse中已经定义了一些marker，但是在我们使用的时候，也有可能需要定义自己marker。

如下是eclipse中已经存在的marker：

 

org.eclipse.core.resources.marker —— 记号层次结构的根。

org.eclipse.core.resources.problemmarker —— 表示问题或错误消息，出现在问题列表中。

org.eclipse.core.resources.taskmarker —— 表示待办事项，出现在任务列表中。

org.eclipse.core.resources.bookmark —— 表示文件，比如搜索结果。

org.eclipse.core.resources.textmarker —— 表示文件的位置，比如出现错误的位置。

 

 

Java代码  

<extension  
         id="my.marker"  
         name="My Marker"  
         point="org.eclipse.core.resources.markers">  
      <persistent  
            value="true">  
      </persistent>  
      <super  
            type="org.eclipse.core.resources.problemmarker">  
      </super>  
   </extension>  

 

super：通过super进行继承已有的marker的能力。

persistent：为true的时候，marker信息被持久，下次打开的时候记录依然会出现

定义一个marker只是原则上这个这种marker类型存在了，但是还需要进行真正的使用

 

 

2.创建marker

 

1）marker是为了描述资源的，所以也应该是在IResource中进行增加marker

2）针对某一个文件，每一次重新加载marker的时候，先把旧的marker清理掉

3）marker里面有很多属性可以进行设置，都是通过setAttribute方式进行设置的。而具体有哪些属性可以参考IMarker，自己也可以创建自己的属性。

4）由于继承了problemmarker，所以marker会在problem视图中显示

 

 

Java代码  

public static void addMarker(IResource resource, String message,  
            int lineNumber, int severity, int priority) throws CoreException {  
        if (resource != null) {  
            IMarker marker = resource.createMarker(PROBLEMS_MARKER_ID);  
            if (message != null)  
                marker.setAttribute(IMarker.MESSAGE, message);  
            if (lineNumber >= 0)  
                marker.setAttribute(IMarker.LINE_NUMBER, lineNumber);  
            marker.setAttribute(IMarker.SEVERITY, severity);  
            marker.setAttribute(IMarker.PRIORITY, priority);  
        }  
    }  

 

 

3.删除marker

 

 

Java代码  

ResourcesPlugin.getWorkspace().getRoot().deleteMarkers(  
           MARKER_ID, false, IResource.DEPTH_INFINITE); //(在工程上添加marker)  
ifile.deleteMarkers( MARKER_ID, false, IResource.DEPTH_INFINITE); //(在file上添加marker)  

 

 

 

Eclipse资源管理（四）

 

eclipse资源监听

 

1.资源监听必须实现IResourceChangeListener接口

 

 

Java代码  

IWorkspace workspace = ResourcesPlugin.getWorkspace();  
   IResourceChangeListener listener = new IResourceChangeListener() {  
      public void resourceChanged(IResourceChangeEvent event) {  
         System.out.println("Something changed!");  
      }  
   };  
   workspace.addResourceChangeListener(listener);  
  
   //... some time later one ...  
   workspace.removeResourceChangeListener(listener);  

 

添加资源监听：IWorkspace.addResourceChangeListener(Listener)

删除资源监听：IWorkspace.removeResourceChangeListener(Listener)

 

 

2.创建资源的样本

 

 

Java代码  

IWorkspace workspace = ResourcesPlugin.getWorkspace();  
   final IProject project = workspace.getRoot().getProject("My Project");  
   IWorkspaceRunnable operation = new IWorkspaceRunnable() {  
      public void run(IProgressMonitor monitor) throws CoreException {  
         int fileCount = 10;  
         project.create(null);  
         project.open(null);  
         for (int i = 0; i < fileCount; i++) {  
            IFile file = project.getFile("File" + i);  
            file.create(null, IResource.NONE, null);  
         }  
      }  
   };  
   workspace.run(operation, null);  

 

 

3.一个简单的完整的资源监听实现类

 

 

Java代码  

public class DocIndexUpdater implements IResourceChangeListener {  
      private TableViewer table; //assume this gets initialized somewhere  
      private static final IPath DOC_PATH = new Path("MyProject/doc");  
      public void resourceChanged(IResourceChangeEvent event) {  
         //we are only interested in POST_CHANGE events  
         if (event.getType() != IResourceChangeEvent.POST_CHANGE)  
            return;  
         IResourceDelta rootDelta = event.getDelta();  
         //get the delta, if any, for the documentation directory  
         IResourceDelta docDelta = rootDelta.findMember(DOC_PATH);  
         if (docDelta == null)  
            return;  
         final ArrayList changed = new ArrayList();  
         IResourceDeltaVisitor visitor = new IResourceDeltaVisitor() {  
            public boolean visit(IResourceDelta delta) {  
               //only interested in changed resources (not added or removed)  
               if (delta.getKind() != IResourceDelta.CHANGED)  
                  return true;  
               //only interested in content changes  
               if ((delta.getFlags() & IResourceDelta.CONTENT) == 0)  
                  return true;  
               IResource resource = delta.getResource();  
               //only interested in files with the "txt" extension  
               if (resource.getType() == IResource.FILE &&   
                "txt".equalsIgnoreCase(resource.getFileExtension())) {  
                  changed.add(resource);  
               }  
               return true;  
            }  
         };  
         try {  
            docDelta.accept(visitor);  
         } catch (CoreException e) {  
            //open error dialog with syncExec or print to plugin log file  
         }  
         //nothing more to do if there were no changed text files  
         if (changed.size() == 0)  
            return;  
         //post this update to the table  
         Display display = table.getControl().getDisplay();  
         if (!display.isDisposed()) {  
            display.asyncExec(new Runnable() {  
               public void run() {  
                  //make sure the table still exists  
                  if (table.getControl().isDisposed())  
                     return;  
                  table.update(changed.toArray(), null);  
               }  
            });  
         }  
      }  
   }