共同編寫 Smart 2.0 開發指南

1         工具

1.1    準備開發工具

描述開發 Smart 應用所須要的開發工具及其安裝步驟，包括：IDE、JDK、Maven、Git 等。 有必要時可以使用截圖，但不要大量使用。 需突出開發工具的版本號，以避免誤導用戶使用不兼容的軟件。

1.2    搭建開發環境

描述搭建開發環境的操做步驟及其注意事項。 對於操做步驟可以使用截圖與文字進行描述。 分別針對 Eclipse 與 IDEA 進行說明。

 

2         入門

用一個 Hello World 示例讓讀者學會如何使用 Smart 開發應用。 前端使用認識度較高的 JSP 技術進行展示，使用 jQuery 與 Bootstrap，可參考 Smart Bootstrap 項目。 不要大量使用的 Smart 功能特性，目標僅在於讓讀者能夠跟着步驟自行搭建 Smart 應用開發框架。

 

3         架構

3.1    技術選型

使用表格的方式展示 Smart 框架使用到的開源項目。 簡要說明每項選型的選擇緣由。

3.2    項目依賴

經過一張圖來展示 Smart 框架所使用的程序包之間的依賴關係。 經過一張表格來展示依賴程序包的詳細狀況，包括：文件大小、版本號、最後更新日期等。 在表格下方需給出依賴程序包的總文件大小。

3.3    系統架構

給出一張系統架構圖，列舉出最重要特性，以及框架與插件之間的關係。 使用「類圖」描繪框架的靜態結構。 使用「時序圖」描繪一個請求的生命週期。 經過一張圖來展示插件的生命週期，並簡要描述插件的開發過程。

 

4         特性

經過代碼片斷與文字描述的方式，分別對框架的每種特性進行說明。 可以使用   Smart   Sample 中相關代碼。 可在代碼片斷中增長必要性的代碼註釋。 可在文字描述中引用外部連接，如：博客地址、相關參考文檔等。

4.1    MVC

4.2    IOC

4.3    AOP

4.4    ORM

4.5    DAO

4.6    事務控制

4.7    異常處理

4.8    單元測試

 

5         插件

代碼片斷加文字描述的方式，分別對每一個插件的基本用法進行說明。 可以使用   Smart   Sample 中相關代碼。 需對插件所使用的開源技術進行說明。 可引用相關參考資料，如：博客地址、開源項目官網等。

5.1    Cache

5.2    WebService

5.3    Mail

5.4    I18N

5.5    Job

5.6    Hessian

 

6         附錄

6.1    經常使用 API

對平常開發過程當中用戶使用較爲頻繁的 API 進行描述。 使用表格的方式對 API 進行彙總。 使用 Cookbook 的方式展現 API 的使用方法。

6.1.1        Result

6.1.2        Page

6.1.3        DataSet

6.1.4        DataContext

6.2    代碼生成器

描述 Smart 代碼生成器的安裝與使用方法。