第1篇-如何編寫一個面試時能拿的出手的開源項目？

編寫一個不錯的開源項目至少有3個好處：

（1）練技術，長經驗

（2）面試時展示本身的Coding能力

（3）獲取成就感

練技術，長經驗是最實在的，不過若是本身有一個好的開源項目，還能夠在開源中國或github上開源，讓更多人受益，也許能得到許多的Star，讓自已得到知足，激勵本身完善項目功能。在面試時，也能夠在簡歷顯眼的位置給出開源項目名稱和Git地址。面試官通常都會去查看，這是程序員實力的最好見證，是本身Coding能力的最好見證。因此若是要編寫一個面試時拿的出手的項目，首先須要作到「規範」，下面談一下我眼中規範的開源項目。

1 項目規範

1.1 規範編寫README.md

README.md文件是一個項目的入門手冊，裏面介紹了整個項目的使用、功能等等。因此README文件寫得好很差，關係到這個項目能不能更容易的被其餘人瞭解和使用。

首先最起碼要作到的就是格式要清晰，讓人一眼能看出層次感，例如分幾個大標題對項目進行介紹，最簡單的就是分爲以下的4部分：

• 項目名及簡介：簡單介紹一下這個項目是作什麼的。有的話最好加上demo地址；
• 功能：你這個項目能夠實現的功能；
• 用法：這能夠說是最重要的，必定要讓別人看得懂你這項目是怎麼使用的；
• 其餘：做者或者是維護人列表、版權、鳴謝、貢獻、logo、聯繫方式等等，這些有的話固然會更加高大上。

讓面試官能在最短的時間內瞭解項目纔是最重要的，因此簡介要簡短，三言二語就把項目要作的事兒交待清楚。這樣面試官纔會想更多的瞭解這個項目，例如使用了什麼技術呀、具體源代碼的書寫邏輯呀等等。 

1.2 使用版本管理工具

最好使用版本管理工具，並且建議使用Git，而且是2個或多我的參與開發最好。許多面試官看到一個項目時一般都會問「這個項目是幾我的開發的？」，除了瞭解項目分工的細節，也能體現團隊合做的精神。另外在使用版本管理時，commit代碼時必定要認真書寫簡短的描述，描述這次開發了什麼功能或修復了什麼Bug等，不能敷衍了事，這是一種習慣，會讓本身之後受益。 

1.3 好的代碼書寫習慣

許多面試官司也會看具體的項目實現，因此項目模塊劃分要清晰，模塊名稱要見名之意，具體的代碼書寫要規範，如今許多大公司都有本身的代碼規範，咱們能夠好好學一下阿里的Java代碼規範。 

1.4 有完整的測試用例

這也是最容易被忽視的，可是倒是保證項目功能正確最不可或缺的一部分。項目簡單還好說，若是項目稍等複雜一點，沒有測試用例保證的項目很容易出問題。試想一下，假如咱們修復了一個系統Bug，可是沒有爲此Bug添加測試用例，那麼下一我的在修復其它Bug時，極可能會破壞以前修復Bug的代碼邏輯，致使一個Bug的修復引入了另外的Bug。因此要針對代碼重要功能及相關Bug有完整的測試用例，必要時還要添加詳細的註釋。 

2 Javac AST View插件的開發  

下面博主打算寫一個系列的博文，從零編寫一個「規範」的開源項目，好在之後面試中更多的展示本身的實力。今天先簡單介紹一下這個項目，而且爲這個項目作一些準備工做。

2.1 項目介紹

開發一個相似Eclipse AST View的插件，安裝的過程見以下博文： 

https://www.cnblogs.com/nettee/p/4463841.html

這個插件的詳細使用說明的連接以下：

https://www.eclipse.org/jdt/ui/astview/

安裝後就能夠直觀地查看抽象語法樹了，舉個例子，以下：

package com.compiler;

import java.util.List;

public class C {
　　public void test(List<String> list){
	list.add("a");
　　}
}

語法樹以下：

不過這個插件顯示的是基於Eclipse JDT中的增量式編譯器ECJ的抽象語法樹，而咱們常用的OpenJDK中的Javac編譯器的抽象語法樹與ECJ的抽象語法樹並不相同，不過絕大多數的語法樹節點劃分是同樣的，可是有少許的節點劃分不同，我打算開發一個相似Eclipse AST View的插件，用來顯示Javac編譯器的抽象語法樹。 

2.2 項目知識儲備 

開發這樣的插件須要瞭解JDT編譯器和Javac編譯器的抽象語法樹，同時還須要掌握Eclipse下的插件開發，參考的相關資源以下：

第一本就是《Eclipse插件開發學習筆記》，開發Eclipse插件必需要有插件開發相關基礎，這本書發版時間很早，可是插件開發的基本思想是不會變的。另外官方的Eclipse API也是開發中必不可少的資料。

 

有了插件開發基礎後就須要瞭解OpenJDK的Javac編譯器和Eclipse JDT中的增量式編譯器ECJ了，重點就是了解這兩個編譯器對抽象語法樹節點的表示。對Javac編譯器來講，還須要瞭解從Java源代碼解析爲抽象語法樹的過程，參考的資料爲《深刻解析Java編譯器：源碼剖析與實例詳解》。

 

Eclipse JDT中的增量式編譯器ECJ的抽象語法樹能夠經過博文Eclipse AST抽象語法樹API來了解，沒有相關的書籍。不過因爲是在Eclipse中開發插件，因此直接調用Eclipse相關API來獲取抽象語法樹就能夠了，不須要自已編寫Java源代碼轉換爲抽象語法樹的代碼實現。因此Eclipse AST View整個項目的實現也相對簡單。 

把Eclipse AST View項目的源代碼導入到Eclipse中，這樣就能夠經過閱讀、調試的方式來學習這個插件了，而後參考這個插件來寫我本身的Javac AST View插件。項目源代碼結構以下：

不得不說，閱讀別人的代碼也是學習的最好方式之一。 

2.3 編寫項目框架 

編寫的插件中主要使用了樹插件，JFace爲樹控件提供了查看器Viewer。在查看器框架中，將模型稱爲輸入，查看器自己充當控制器的角色，而樹控件自己做爲視圖，當輸入改變時，查看器負責相應地改變控件的內容。

查看器框架主要由如下幾部分構成。

（1）模型和元素-存儲着要顯示在控件中的數據模型，咱們編寫的抽象語法樹節點模型以下：

package astview;

import java.util.ArrayList;
import java.util.List;

public class JavacASTNode {
	private int id;
	private String name;
	private List<JavacASTNode> children;
	private JavacASTNode parent = null;

	public JavacASTNode() {
		children = new ArrayList<JavacASTNode>();
	}

	public List<JavacASTNode> getChildren() {
		return children;
	}

	public void setChildren(List<JavacASTNode> children) {
		this.children = children;
	}

	public JavacASTNode getParent() {
		return parent;
	}

	public void setParent(JavacASTNode parent) {
		this.parent = parent;
	}

	public int getId() {
		return id;
	}

	public void setId(int id) {
		this.id = id;
	}

	public String getName() {
		return name;
	}

	public void setName(String name) {
		this.name = name;
	}

	public String toString() {
		return name;
	}
}

（2）內容提供者和標籤提供者-負責將數據模型轉化成能夠顯示的圖片和文字。我編寫的內容提供者以下：

class ViewContentProvider extends ArrayContentProvider implements ITreeContentProvider {

	public Object[] getChildren(Object parentElement) {
		JavacASTNode node = (JavacASTNode) parentElement;
		return node.getChildren().toArray();
	}

	public Object getParent(Object element) {
		JavacASTNode node = (JavacASTNode) element;
		return node.getParent();
	}

	public boolean hasChildren(Object element) {
		JavacASTNode node = (JavacASTNode) element;
		return node.getChildren().size() > 0 ? true : false;
	}

	public Object[] getElements(Object inputElement) {
		JavacASTNode compilatinUnitNode = new JavacASTNode();
		compilatinUnitNode.setId(001);
		compilatinUnitNode.setName("JCCompilationUnit");
		
		JavacASTNode importNode = new JavacASTNode();
		importNode.setId(002);
		importNode.setName("JCImport");
		
		JavacASTNode classNode = new JavacASTNode();
		classNode.setId(003);
		classNode.setName("JCClassDecl");

		compilatinUnitNode.getChildren().add(importNode);
		compilatinUnitNode.getChildren().add(classNode);
		importNode.setParent(compilatinUnitNode);
		classNode.setParent(compilatinUnitNode);
		
		return new JavacASTNode[] {compilatinUnitNode};
	}

}

這個類是JavacTreeViewer的內部類。咱們只簡單寫了一些測試用的數據，其實這些數據都是要從Javac編譯器中讀取的，而Javac編譯器分析的Java源代碼又須要從當前激活的編輯器中獲取，後面我會不斷完善更新這些功能。　　

編寫的標籤提供者以下： 

class ViewLabelProvider extends LabelProvider {
	public Image getColumnImage(Object element) {
		return null;
	}

	public String getColumnText(Object element) {
		return ((JavacASTNode) element).toString();
	}
}

這個類也一樣是JavacTreeViewer的內部類。　　

（3）控件，用來顯示內容，這裏用到的爲樹控件TreeViewer

（4）查看器

模型和元素以及內容提供者和標籤提供者須要本身編寫，控件和查看器不須要開發者本身編寫。

編寫JavacTreeViewer類，以下： 

package astview;

import org.eclipse.jface.viewers.ArrayContentProvider;
import org.eclipse.jface.viewers.ITreeContentProvider;
import org.eclipse.jface.viewers.LabelProvider;
import org.eclipse.jface.viewers.TreeViewer;
import org.eclipse.jface.viewers.Viewer;
import org.eclipse.jface.viewers.ViewerSorter;
import org.eclipse.swt.SWT;
import org.eclipse.swt.graphics.Image;
import org.eclipse.swt.widgets.Composite;
import org.eclipse.ui.part.ViewPart;


public class JavacASTViewer extends ViewPart {
	public static final String ID = "javacastviewer";
	
	private TreeViewer viewer;

	public void createPartControl(Composite parent) {
		viewer = new TreeViewer(parent, SWT.SINGLE);
		viewer.setLabelProvider(new ViewLabelProvider());
		viewer.setContentProvider(new ViewContentProvider());
		viewer.setInput(getSite());
	}

	public void setFocus() {
		// not supported
	}
        ...
}

最後運行後，查看JavacTreeViewer視圖，顯示效果以下：

最後就是上傳到github了，個人github倉庫地址爲：

https://github.com/mazhimazh/JavacASTViewer

接下來我會不斷開發完善這個項目，若是各位能給個「Star」是最好了，你的支持是我繼續開發的最大動力。