一些設計上的基本常識

来源:http://www.cnblogs.com/shengkejava/archive/2016/09/28/5916527.html
-Advertisement-
Play Games

好文轉載留存,轉至http://javatar.iteye.com/blog/706098 1. API與SPI分離 框架或組件通常有兩類客戶,一個是使用者,一個是擴展者, API(Application Programming Interface)是給使用者用的, 而SPI(Service Pro ...


好文轉載留存,轉至http://javatar.iteye.com/blog/706098

1. API與SPI分離 

框架或組件通常有兩類客戶,一個是使用者,一個是擴展者, 
API(Application Programming Interface)是給使用者用的, 
而SPI(Service Provide Interface)是給擴展者用的, 
在設計時,儘量把它們隔離開,而不要混在一起, 
也就是說,使用者是看不到擴展者寫的實現的, 
比如:一個Web框架,它有一個API介面叫Action, 
裡面有個execute()方法,是給使用者用來寫業務邏輯的, 
然後,Web框架有一個SPI介面給擴展者控制輸出方式, 
比如用velocity模板輸出還是用json輸出等, 
如果這個Web框架使用一個都繼承Action的VelocityAction和一個JsonAction做為擴展方式, 
要用velocity模板輸出的就繼承VelocityAction,要用json輸出的就繼承JsonAction, 
這就是API和SPI沒有分離的反面例子,SPI介面混在了API介面中, 
合理的方式是,有一個單獨的Renderer介面,有VelocityRenderer和JsonRenderer實現, 
Web框架將Action的輸出轉交給Renderer介面做渲染輸出。 


 


 

2. 服務域/實體域/會話域分離 

任何框架或組件,總會有核心領域模型,比如: 
Spring的Bean,Struts的Action,Dubbo的Service,Napoli的Queue等等 
這個核心領域模型及其組成部分稱為實體域,它代表著我們要操作的目標本身, 
實體域通常是線程安全的,不管是通過不變類,同步狀態,或複製的方式, 
服務域也就是行為域,它是組件的功能集,同時也負責實體域和會話域的生命周期管理, 
比如Spring的ApplicationContext,Dubbo的ServiceManager等, 
服務域的對象通常會比較重,而且是線程安全的,並以單一實例服務於所有調用, 
什麼是會話?就是一次交互過程, 
會話中重要的概念是上下文,什麼是上下文? 
比如我們說:“老地方見”,這裡的“老地方”就是上下文信息, 
為什麼說“老地方”對方會知道,因為我們前面定義了“老地方”的具體內容, 
所以說,上下文通常持有交互過程中的狀態變數等, 
會話對象通常較輕,每次請求都重新創建實例,請求結束後銷毀。 
簡而言之: 
把元信息交由實體域持有, 
把一次請求中的臨時狀態由會話域持有, 
由服務域貫穿整個過程。 

 

 

3. 在重要的過程上設置攔截介面 

如果你要寫個遠程調用框架,那遠程調用的過程應該有一個統一的攔截介面, 
如果你要寫一個ORM框架,那至少SQL的執行過程,Mapping過程要有攔截介面, 
如果你要寫一個Web框架,那請求的執行過程應該要有攔截介面, 
等等,沒有哪個公用的框架可以Cover住所有需求,允許外置行為,是框架的基本擴展方式, 
這樣,如果有人想在遠程調用前,驗證下令牌,驗證下黑白名單,統計下日誌, 
如果有人想在SQL執行前加下分頁包裝,做下數據許可權控制,統計下SQL執行時間, 
如果有人想在請求執行前檢查下角色,包裝下輸入輸出流,統計下請求量, 
等等,就可以自行完成,而不用侵入框架內部, 
攔截介面,通常是把過程本身用一個對象封裝起來,傳給攔截器鏈, 
比如:遠程調用主過程為invoke(),那攔截器介面通常為invoke(Invocation), 
Invocation對象封裝了本來要執行過程的上下文,並且Invocation里有一個invoke()方法, 
由攔截器決定什麼時候執行,同時,Invocation也代表攔截器行為本身, 
這樣上一攔截器的Invocation其實是包裝的下一攔截器的過程, 
直到最後一個攔截器的Invocation是包裝的最終的invoke()過程, 
同理,SQL主過程為execute(),那攔截器介面通常為execute(Execution),原理一樣, 
當然,實現方式可以任意,上面只是舉例。 

 

4. 重要的狀態的變更發送事件並留出監聽介面 

這裡先要講一個事件和上面攔截器的區別,攔截器是干預過程的,它是過程的一部分,是基於過程行為的, 
而事件是基於狀態數據的,任何行為改變的相同狀態,對事件應該是一致的, 
事件通常是事後通知,是一個Callback介面,方法名通常是過去式的,比如onChanged(), 
比如遠程調用框架,當網路斷開或連上應該發出一個事件,當出現錯誤也可以考慮發出一個事件, 
這樣外圍應用就有可能觀察到框架內部的變化,做相應適應。 

 

5. 擴展介面職責儘可能單一,具有可組合性 

比如,遠程調用框架它的協議是可以替換的, 
如果只提供一個總的擴展介面,當然可以做到切換協議, 
但協議支持是可以細分為底層通訊,序列化,動態代理方式等等, 
如果將介面拆細,正交分解,會更便於擴展者復用已有邏輯,而只是替換某部分實現策略, 
當然這個分解的粒度需要把握好。 

6. 微核插件式,平等對待第三方 

大凡發展的比較好的框架,都遵守微核的理念, 
Eclipse的微核是OSGi, Spring的微核是BeanFactory,Maven的微核是Plexus, 
通常核心是不應該帶有功能性的,而是一個生命周期和集成容器, 
這樣各功能可以通過相同的方式交互及擴展,並且任何功能都可以被替換, 
如果做不到微核,至少要平等對待第三方, 
即原作者能實現的功能,擴展者應該可以通過擴展的方式全部做到, 
原作者要把自己也當作擴展者,這樣才能保證框架的可持續性及由內向外的穩定性。 

7. 不要控制外部對象的生命周期 

比如上面說的Action使用介面和Renderer擴展介面, 
框架如果讓使用者或擴展者把Action或Renderer實現類的類名或類元信息報上來, 
然後在內部通過反射newInstance()創建一個實例, 
這樣框架就控制了Action或Renderer實現類的生命周期, 
Action或Renderer的生老病死,框架都自己做了,外部擴展或集成都無能為力, 
好的辦法是讓使用者或擴展者把Action或Renderer實現類的實例報上來, 
框架只是使用這些實例,這些對象是怎麼創建的,怎麼銷毀的,都和框架無關, 
框架最多提供工具類輔助管理,而不是絕對控制。 

8. 可配置一定可編程,並保持友好的CoC約定 

因為使用環境的不確定因素很多,框架總會有一些配置, 
一般都會到classpath直掃某個指定名稱的配置,或者啟動時允許指定配置路徑, 
做為一個通用框架,應該做到凡是能配置文件做的一定要能通過編程方式進行, 
否則當使用者需要將你的框架與另一個框架集成時就會帶來很多不必要的麻煩, 
另外,儘可能做一個標準約定,如果用戶按某種約定做事時,就不需要該配置項。 
比如:配置模板位置,你可以約定,如果放在templates目錄下就不用配了, 
如果你想換個目錄,就配置下。 

9. 區分命令與查詢,明確前置條件與後置條件 

這個是契約式設計的一部分,儘量遵守有返回值的方法是查詢方法,void返回的方法是命令, 
查詢方法通常是冪等性的,無副作用的,也就是不改變任何狀態,調n次結果都是一樣的, 
比如get某個屬性值,或查詢一條資料庫記錄, 
命令是指有副作用的,也就是會修改狀態,比如set某個值,或update某條資料庫記錄, 
如果你的方法即做了修改狀態的操作,又做了查詢返回,如果可能,將其拆成寫讀分離的兩個方法, 
比如:User deleteUser(id),刪除用戶並返回被刪除的用戶,考慮改為getUser()和void的deleteUser()。 
另外,每個方法都儘量前置斷言傳入參數的合法性,後置斷言返回結果的合法性,並文檔化。 

10. 增量式擴展,而不要擴充原始核心概念 
參見:http://javatar.iteye.com/blog/690845 

 


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 感謝原作者:Vamei 出處:http://www.cnblogs.com/vamei 怎麼能快速地掌握Python?這是和朋友閑聊時談起的問題。 Python包含的內容很多,加上各種標準庫、拓展庫,亂花漸欲迷人眼。我一直希望寫一個快速的、容易上手的Python教程,而且言語簡潔,循序漸進,讓沒有背 ...
  • 感謝原作者:Vamei 出處:http://www.cnblogs.com/vamei Java是面向對象語言。這門語言其實相當年輕,於1995年才出現,由Sun公司出品。James Gosling領導了Java的項目小組。該項目的最初只想為家電設計一門容易移植的語言。然而,在獲得了Netscape ...
  • tail命令也是一個非常常用的文件查看類的命令,今天就為大家介紹下Linux tail命令的用法。 更多Linux命令詳情請看:Linux命令速查手冊 Linux tail命令主要用來從指定點開始將文件寫到標準輸出。很多人喜歡使用tail –f 來監控日誌文件。 一、Linux tail命令格式 L ...
  • 1.說明:Idea 下,項目對應於 Eclipse 下的 workspace,Module 對應於 Eclipse 下的項目。Idea 下,新添加的項目既可以單獨作為一個 Project,也可以作為一個 Project 下的 Module。 2.本篇文章介紹內容: (1)如何在 Project 新建 ...
  • 初學swift 但是網上只有很多swift用xib創建的cell,就算是有也不是我想要的。今天自己弄了一個不用xib純代碼寫的,來上代碼 自定義cell 下麵是controller 例外說一點懶載入 OC的懶載入 @property (nonatomic, strong) NSMutableArra ...
  • 裡面主要包含了一些與字元串關聯的函數的聲明,這些函數有如下的命名規則: 以"mem"開頭的函數操作任意的字元序列 以"strn"開頭的函數操作非空字元序列 以"str"開頭的函數操作空字元結尾的字元序列 數據類型 size_t 巨集 NULL 函數 複製 memcpy() memmove() strc ...
  • 有人常問,雲巴實時通信系統到底提供了一種怎樣的服務,與其他提供推送或 IM 服務的廠商有何本質區別。其實,從技術角度分析,雲巴與其它同類廠商都是面向開發者的通信服務,巨集觀的編程模型都是大同小異,真正差異則聚焦於產品定位,業務模式,基礎技術水平等諸多細節上。本文暫不討論具體產品形態上的差異,著重從技術... ...
  • ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...