开源代码应用之Eclipse篇

开写这篇的时候,恰逢Eclpse Mars(4.5)正式发布,终于由日蚀变登火星了,也离我开始基于Eclipse开发产品已经过去10年,这10年间,经历了Eclipse由私有核心框架到拥抱OSGi, 由单一Java IDE成长为巨无霸式的技术平台,由纯桌面到Web,嵌入式全面开花,个人也经历了从普通开发者成长为committer,又离开社区的过程,唯一不变的是:Eclipse依然是我开发Java唯一的选择。

对于这样一个由全世界最smart的一群人贡献和维护的开源项目(群),我相信任何热爱这个行业的工程师都能从中获得收益,这次就谈谈我基于Eclipse写的一个小工具。

不知道大家有没有类似的体会,每到产品发布期截止的时候,team就会开始忙乱的整理Java源代码中的license声明问题,严格统一的开发风格对所有的team来讲,基本都是一种奢望,从头开始不可能,那怎么办,不修复吧,不能发布,修复吧,这样的烂活没人愿意干,大概说来,修复Java源代码里面的license声明分为以下两个主流方式:

1. 既然是Java源代码,那就Java上啊,不就读出文件来,插入或替换吗?,定位吗,嗯,文件头的easy,成员变量型的,得想想…

2. 杀鸡焉用牛刀?,组合下Unix里面的小命令,分分钟搞定。

两种方式下的结果我都见过,实话说,的确不怎么样。

这件事情简单吗?说实话不难,但 Oracle依然把Java源代码里的license声明整成下面这个模样,就为了把以前Sun的license声明改成自己的。

这对很多有代码格式强迫症的工程师来讲,比杀了他们还难受啊。

其实我并没有接到这样的烂活,我只是思考了下,如果要处理好,该怎么办?嗯,这事要搞好,要是能操纵Java源代码的每一个部分不就行了?

哇靠,有人马上会跳起来说,这得懂编译器哪,对,就是编译器,不过也没有那么复杂,也就用了一丁丁点AST知识,不知道AST?哦,哪也没问题,有Eclipse替你做。

于是我开始动手实现这么一个能快速修复Java源代码中license声明的小工具,基本思路是基于Eclipse JDT里的AST实现,在Java语法这个粒度来修改,并做成一个Eclipse Plug-in,这下大家安装后,简单到点个button,就能完成工作。

具体实现步骤如下:

1. 生成一个Eclipse Plug-in项目,选个模版,最简单的那种,能点toolbar上面的button,弹出个"hello, world"对话框就可以。不知道怎么开发一个Eclipse Plug-in啊,没关系,看完这篇blog,你就会了。(别忘了好评!)

2. 在Action的回调方法里面,代码如下。

public void run(IAction action) {license = getLicenseContent(LICENSE_FILE_NAME);license_inline = getLicenseContent(LICENSE_INLINE_FILE_NAME);if (license_inline.endsWith("\n")) {license_inline = license_inline.substring(0, license_inline.length() – 1);}sum = 0;IWorkspace workspace = ResourcesPlugin.getWorkspace();IWorkspaceRoot root = workspace.getRoot();IProject[] projects = root.getProjects();for (IProject project : projects) {try {if (project.isOpen()) {processProject(project);}} catch (Exception e) {MessageDialog.openInformation(window.getShell(), "Fix License", "Exception happened, please check the console log.");e.printStackTrace();return;}}MessageDialog.openInformation(window.getShell(), "Fix License", "All java source files have been processed. Total = " + sum);}

首先获得license的内容,分为主license和行内license,具体内容这里就不显示了,然后获取Eclipse里面所有的项目,遍历每个项目并处理,这里只处理打开的项目,如果你有不想处理的项目,关闭就行。

3. 处理项目。

private void processProject(IProject project) throws Exception {if (project.isNatureEnabled("org.eclipse.jdt.core.javanature")) {IJavaProject javaProject = JavaCore.create(project);IPackageFragment[] packages = javaProject.getPackageFragments();for (IPackageFragment mypackage : packages) {if (mypackage.getKind() == IPackageFragmentRoot.K_SOURCE) {for (ICompilationUnit unit : mypackage.getCompilationUnits()) {sum = sum + 1;processJavaSource(unit);}}}}}

当然只修复Java项目,没有Java nature的,一律抛弃。

获得Java项目后,获取所有的package,这里的package和通常意义上Java的package不同,具体意义看API,就当课后作业。

再进一步,就可以获取Java源文件,并取得编译单元,有了这个,以后的路就有方向了。

4. 处理Java源文件。

private void processJavaSource(ICompilationUnit unit) throws Exception {ITextFileBufferManager bufferManager = FileBuffers.getTextFileBufferManager();IPath path = unit.getPath();try {bufferManager.connect(path, null);ITextFileBuffer textFileBuffer = bufferManager.getTextFileBuffer(path);IDocument doc = textFileBuffer.getDocument();if ((license !=null) && (license.length() > 0)) {processHeadLicense(doc);}if ((license_inline != null) && (license_inline.length() > 0)) {processInlineLicense(doc);}textFileBuffer.commit(null, false);} finally {bufferManager.disconnect(path, null);}}这里用到了一些Eclipse Jface text包里面的东西,和Java里面常见的文件读写API有些不一样,但基本思想是一致的。等取到了IDocument对象,就可以开始正式的license处理。

人生至少要有两次冲动,一为奋不顾身的爱情,一为说走就走的旅行。

开源代码应用之Eclipse篇

相关文章:

你感兴趣的文章:

标签云: