使用Tycho来构建你的RCP程序(二) —— Feature
在上一篇中,我们介绍了如何build一个plugin项目。但在实际的开发当中,一个大型的RCP项目往往有几十个甚至上百个插件,如果一plugin作为单元来管理项目,那工作量就会相当庞大。因此RCP引入了feature的概念。关于feature,网上有一段特别好的话来形容他:
Eclipse uses feature projects for the updates manager and for the build process. You can also supply a software license which a feature
翻译过来就是feature是一个可以包含若干个plugins和其他features的逻辑上的独立单元。Eclipse 的update mamager和build process都会使用feaure,而且我们可以为每个feautre都提供一个license。看到license是不是感觉似曾相识?没错,我们的Eclipse也是一个基于feature的项目product.
同样的,在开始介绍之前我们需要做一些准备工作:创建一个parent项目和一个feature项目。为什么要创建一个parent项目呢?我们想象一下,假设我们的RCP项目中有100个plugins项目和10个feature项目,为每个项目的POM文件都提供相同的Tycho插件的配置是一件极其不明智的行为。最好的做法就是我们把所有共用的配置都放到一个parent项目当中,这也是Maven推荐的做法。
所以,我们先来创建一个parent项目:
1. File -> New -> Project
2. 在弹出的对话框中选择 General -> Project -> Next
3. 在New Project对话框中输入项目名:com.chnic.tycho.mail.parent -> Finish
4. 右键项目名称 -> Configure -> Convert to Maven Project
5. 因为我们仍然会复用第一篇文章中我们创建的plugin,因此我们保持相同group id 和version. 打包方式 是pom,因为他是一个父类的Maven项目,如下图。
6. 把之前创建的plugin中POM文件里的Tycho信息剪切到parent的pom当中
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.chnic.tycho.mail</groupId> <artifactId>com.chnic.tycho.mail.parent</artifactId> <version>1.0.0-SNAPSHOT</version> <packaging>pom</packaging> <properties> <tycho.version>0.22.0</tycho.version> <luna-repo.url>http://download.eclipse.org/releases/luna</luna-repo.url> </properties> <repositories> <repository> <id>luna</id> <url>${luna-repo.url}</url> <layout>p2</layout> </repository> </repositories> <build> <plugins> <plugin> <groupId>org.eclipse.tycho</groupId> <artifactId>tycho-maven-plugin</artifactId> <version>${tycho.version}</version> <extensions>true</extensions> </plugin> </plugins> </build> </project>
7. 与此同时,plugin项目中的POM文件也需要更新,plugin项目会直接继承parent项目。
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <parent> <groupId>com.chnic.tycho.mail</groupId> <artifactId>com.chnic.tycho.mail.parent</artifactId> <version>1.0.0-SNAPSHOT</version> <relativePath>../com.chnic.tycho.mail.parent/pom.xml</relativePath> </parent> <artifactId>com.chnic.tycho.mail.plugin</artifactId> <packaging>eclipse-plugin</packaging> </project>
试着再build一下plugin项目,如果成功,则说明我们的parent项目已经成功创建成功。接下来就该创建feature项目。由于feature项目需要包含一个或者若干个plugin和feature项目,我们复用之前的plugin项目。因此在feature项目创建后,项目结构会是如下
com.chnic.tycho.mail RCP Project
|
|-------com.chnic.tycho.mail.parent
|-------com.chnic.tycho.mail.plugin
|-------com.chnic.tycho.mail.feature
创建feature项目
1. File -> New - > Other
2. 弹出的对话框中中选择 Plug-in Development -> Feature Project
3. 在New Feature的对话框中提供一个feature name。在这里我们用com.chnic.tycho.mail.feature-> Next
4. 在Referenced Plug-ins and Framgments对话框中,勾选上之前创建的com.chnic.tycho.mail.plugin
5. Finish 完成创建,这个时候workspace里会生成一个feature项目
feature项目完成之后,我们双击打开feature.xml,然后选择plug-ins tab,会发现之前的plugin项目已经被包含在这个feature里了。接下来我们还是把feauture项目convert成一个Maven项目。
和plugin项目的配置基本项目,artifact id 和version要和MANIFEST.MF的相关属性保持一致。唯一不同的是,针对于feature项目,packaging的方式已经变成了eclipse-feature。点击Finish生成POM之后,还需要把这个POM继承自我们刚刚创建的com.chnic.tycho.mail.parent项目,否则我们便会收到如下错误。
添加完继承关系之后,Ctrl+1 quick fix项目,上图的错误便会消失。你会发现feature的pom除了packaging的属性和plugin不一致之外,其他的都是一模一样的。
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <parent> <groupId>com.chnic.tycho.mail</groupId> <artifactId>com.chnic.tycho.mail.parent</artifactId> <version>1.0.0-SNAPSHOT</version> <relativePath>../com.chnic.tycho.mail.parent/pom.xml</relativePath> </parent> <artifactId>com.chnic.tycho.mail.feature</artifactId> <packaging>eclipse-feature</packaging> </project>
配置完成之后,我们依然运行Maven build并且把goals设置成为clean install。在控制台上我们会收到如下的信息。
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 16.600 s
[INFO] Finished at: 2015-04-13T18:30:07+08:00
[INFO] Final Memory: 61M/147M
[INFO] ------------------------------------------------------------------------
如果你在build feature的过程中出错并且提示缺少com.chnic.tycho.mail.plugin,这是因为feature项目依赖com.chnic.tycho.mail.plugin这个plugin项目,你需要先install plugin项目到repository当中。这个时候你也许会问,如果我的feature包含很多的plugins,那岂不是我每一个plugins都要先clean install一遍才行?答案显而易见:当然不是。具体的方法会在第三篇build product中告诉大家。
回头刷新我们的feautre项目,然后在target文件夹中是不是发现了com.chnic.tycho.mail.feature-1.0.0-SNAPSHOT.jar这个jar文件?如果有的话,恭喜你,你已经可以用Tycho来build一个feature项目了。