建站
咨詢
售后
建站咨詢
新聞中心
CUPID出自Daniel的一篇名為《??CUPID—for joyful coding??》?的博文，即《CUPID-為了快樂編程》。CUPID是Composable/Unix philosophy/Predictable/Idiomatic/Domain based幾個單詞的縮寫，有經(jīng)驗的同學一看就知道這是好代碼的一些屬性。知道Cupid這個單詞的同學還能感受到這一組屬性所蘊含的對于軟件工程的熱情。Cupid的中文是丘比特，是指古羅馬的愛神，其意象是一個長有翅膀的小孩，拿著弓箭射向人們，以便人們可以相互愛上對方。
特質
Daniel老爺子回憶了自己三十多年的編程經(jīng)歷，他發(fā)現(xiàn)在修改代碼時，好的代碼會給人一種非常愉悅的感覺。你可以輕松找到需要修改的地方，而且，那個地方的代碼是如此的易于理解，以至于一眼就能看出來代碼在干什么。你可以很自信的完成修改，并且確信不會引入額外的副作用。代碼是那么的鮮活，它會主動的指引你去你想去的地方，并且熱情的歡迎你四處游覽，就像在你熟悉的家里一樣！
為什么好的代碼能有這樣的魅力？什么樣的代碼才是好代碼？提到這個問題，我們常常會想到SOLID（Single Responsibility/Open-close/Liskov Substitution/Interface Segregation/Dependency Injection）原則，Daniel老爺子認為應該存在比SOLID更好用的東西。
如何衡量代碼好壞？SOLID采用了一組原則來定義好的代碼，但是原則更像是規(guī)則，要么符合，要么不符合。而軟件開發(fā)過程非常復雜，其間充滿了平衡和妥協(xié)，事實上并沒有一種非黑即白的規(guī)則可以適用。有沒有比原則更好的選擇？它可能是特質（Properties/Characteristics）。
特質是事物本身所具備的，而不是靠一組規(guī)則去定義的；特質吸引我們?nèi)ド疃韧诰颍皇切湃我延械目偨Y；特質通常不是簡單的0或1的判斷，而是一種從低到高的程度；特質是從觀察者的角度給出的，更關注觀察者的體驗，而更少關注與體驗無關的其他方面。
之所以我們會覺得某樣東西是好的，常常是因為某樣東西具備了一些好的特質。比如藍天白云圖，它具備了干凈、純粹的特質。比如勾股定理和質能方程，它們具備簡潔、優(yōu)雅的特質。
如果說好的代碼是一個中心點，特質就像是定義了一些方向，通過這些方向的指引，就可以不斷向這個中心點靠攏。
CUPID就是從特質的角度來定義的，它嘗試用一組助記詞來指示好代碼所具備的一組特質，并希望這組特質是最重要的特質。
CUPID所指出的方向與SOLID定義的原則并不沖突，只是角度不同，CUPID更多站在代碼的用戶--將來修改代碼的人--的視角來看待代碼，并指出了好的代碼應該具備的特質。從這個角度來講，CUPID比SOLID的適用性更廣（SOLID事實上只是針對面向對象設計提出的）。比如，給出一段代碼，用SOLID可能并不能判斷好壞，因為這段代碼可能根本不涉及SOLID中提到的幾個原則（比如函數(shù)式風格的代碼）。但是很大可能可以從CUPID指明的幾個方向來得到一些結論。
CUPID是完備的嗎，很遺憾，也不是。但CUPID所指出的五種特質可能是按照重要程度排序之后取前五的特質。
理解CUPID
下面我們一起看看CUPID到底是什么，以及，如何用CUPID來幫助我們寫出好的代碼。
下面的內(nèi)容，部分來自Daniel老爺子的??原文??，部分結合了個人的心得體會，分享給大家。
1.可組合特質（C）
CUPID的第一個字母C是指Composable，即可組合特質。
近兩年，我們在討論面向對象程序設計的時候，越來越關注到“組合優(yōu)于繼承”這樣的原則。作為面向對象程序設計的三大特征之一的“繼承”，似乎正越來越受到挑戰(zhàn)，這一部分原因是很多繼承的設計是不合理的，比如不符合SOLID所指出的里氏代換原則。另一部分原因在于，過深的繼承樹帶來了代碼的可理解性問題，因為我們總是需要理解了基類才能理解子類。其實繼承也是很有用的，但其前提是設計合理的繼承。“組合優(yōu)于繼承”就是告訴我們優(yōu)先考慮用組合模式來進行設計。
可組合還體現(xiàn)在以下三個方面：
(1) 精巧的接口
接口太多時，讀者需要知道如何組合這些接口去完成某個功能，而接口較少時，讀者可以更容易學習并更少犯錯。只對外公開一個模塊來提供接口，比對外公開多個模塊提供接口更好。只對外公開一個類來提供接口，比對外公開多個類提供接口更好。
正確的接口粒度設計比較困難，最佳的粒度是接口既不顯得臃腫也不碎片化。
設計模式中有一種常見的模式Facade，即門面模式，其意圖正是將對外公開的接口放到一個類中去提供，以便減少接口面，從而讓接口更容易使用。
(2) 可體現(xiàn)意圖的代碼
可體現(xiàn)意圖的代碼是用業(yè)務語言編寫且能反映業(yè)務過程的代碼?？审w現(xiàn)意圖的代碼可以使讀者更容易弄清為什么代碼要這么寫，因此更容易組合使用。代碼中的各類命名（比如變量、函數(shù)等）都可以用于將意圖體現(xiàn)得更為明顯。
比如以下意圖不明的代碼：
def getTodos(todos, users):
todos = [todo for todo in todo if not todo.completed and todo.type == ‘HOME’]
todos = [{‘title’: todo.title, ‘user_name’: users[todo.userId].name} for todo in todo]
todos.sort(key=lambda todo: todo[’user_name’])
return todos
可以重構為以下意圖明確的代碼：
def get_todos(todos, users):
top_priority_todos = [todo for todo in todo if not todo.completed and todo.type == ‘HOME’]
todo_view_models = [{‘title’: todo.title, ‘user_name’: users[todo.userId].name} for todo in top_priority_todos]
todo_view_models.sort(key=lambda todo: todo[’user_name’])
return todo_view_models
或者：
def get_todos(todos, users):
is_top_priority = lambda todo: not todo.completed and todo.type == ‘HOME’
todos = [todo for todo in todo if is_top_priority(todo)]
to_view_model = lambda todo: {‘title’: todo.title, ‘user_name’: users[todo.userId].name}
todos = [to_view_model(todo) for todo in todo]
user_name = lambda todo: todo[’user_name’]
todos.sort(key=user_name)
return todos
(3) 最小依賴
擁有最小依賴的代碼是容易組合使用的。
當一個庫有大量的依賴時，一旦使用了這個庫就會間接引入這些依賴。這不僅使我們發(fā)布的二進制制品變得臃腫，也很容易引起一些依賴庫的版本沖突問題。大家如果做過Hadoop的MapReduce任務開發(fā)，應該對這個問題深有體會，因為Hadoop本身有大量的Java依賴，如果我們在MapReduce任務中不小心引入了一個和Hadoop本身的依賴不兼容的版本，在任務運行時就會出錯。
一個擁有最小依賴的庫是很容易使用的，上述包沖突問題會更少發(fā)生。
我常常在項目中見到有人為了實現(xiàn)一些很簡單的功能而引入沒必要的依賴。比如，當我們面對的問題只是簡單的查詢ElasticSearch服務中的數(shù)據(jù)時，就要評估一下是否有必要引入ElasticSearch的客戶端庫依賴，因為我們可以很容易的使用通用的HTTP工具庫來發(fā)送一個請求來實現(xiàn)數(shù)據(jù)查詢。
面向對象程序設計有一個重要的原則，即迪米特法則（Law of Demeter），又被稱為最小知識原則、不要和陌生人說話原則。其指導意義在于一個類不應該和與其不相關的類產(chǎn)生（依賴）關系。
2.Unix哲學（U）
CUPID的第二個特質U即是指Unix哲學。
Unix可以說是當今應用最廣泛的操作系統(tǒng)，不管是云服務器還是個人電腦抑或智能手機、IoT設備，都有Unix的影子。Unix廣泛的以Linux、MacOS、iOS、Android等等操作系統(tǒng)的形式存在著。為什么Unix可以如此成功？這得益于Unix的簡單而一致的設計哲學。
CUPID中的Unix哲學主要指其最重要的一個觀點：一個程序應該做一件事，并將其做好。Unix中的大量程序都很好的提現(xiàn)了這一特質，比如ls程序只做列舉文件的事，而要查看文件詳情，則需要使用lstat，查看文件內(nèi)容使用cat，搜索文件內(nèi)容使用grep等等。如果我們查看這些程序的使用手冊（Manual Page），將發(fā)現(xiàn)每一個程序都提供了很多的參數(shù)供選擇，事實上每個程序的功能都很強大，并處理了大量的異常情況。這就是把一件事做好的體現(xiàn)。
Unix操作系統(tǒng)中定義了一個強大的管道（Pipe）概念，一個程序的輸出可以通過管道傳輸給另一個程序，從而簡單而一致的實現(xiàn)了多個程序的組合使用。比如ls命令可以列舉出文件列表，然后將結果傳輸給wc程序統(tǒng)計數(shù)量，就可以簡單的計算出目錄中的文件數(shù)量。
只做好一件事與SOLID中的單一職責原則很像。但是Unix哲學的出發(fā)點是讀者，從讀者角度來看程序，得出程序應該只做好一件事的結論。單一職責原則則是從代碼的角度出發(fā)進行描述的。Unix哲學更多描述的是程序的目的，并指明一個程序應該只有一個目的。
與Unix原則描述很相似的還有關注點分離的原則。關注點分離是指不同的模塊應該關注不同的事情。比如分層設計，每一層的關注點應該不一樣：MVC中的M關注業(yè)務模型和業(yè)務邏輯，V關注展示，C關注交互邏輯；TCP/IP四層網(wǎng)絡模型中物理層關注物理鏈路，網(wǎng)絡層關心節(jié)點鏈路如何建立，傳輸層關注數(shù)據(jù)發(fā)送的可靠性，應用層關注在具體的應用協(xié)議。
3.可預測性（P）
CUPID的第三個特質P是指Predictable，可預測性。
程序的可預測性是指它應該做它看起來要做的事情，一致且可靠，不隱藏任何出乎意料的行為。
可預測性包括三個方面：1. 與期望一致的行為；2. 輸出確定的結果；3. 內(nèi)部行為可觀測。
(1) 與期望一致的行為
我們可以通過測試來定義所期望的程序的行為，但是并不是一定需要用測試來讓程序與期望的行為一致。精心的挑選名字，克制的編寫邏輯，正確的處理異常這些都能使得程序與期望的行為一致。
讀操作和寫操作常常被分開對待。讀操作不會對程序狀態(tài)產(chǎn)生影響，我們可以安全的調用，不用顧忌太多后果。寫操作用于修改程序狀態(tài)，因此，在使用時需要特別小心，比如如果有多線程訪問就需要考慮線程安全，同時操作多個狀態(tài)就需要考慮事務一致性。
如何在讀操作和寫操作中保持與期望一致的行為？那就是讀操作中不應該隱藏某些讓人意外的寫操作。
(2) 輸出確定性的結果
具備確定性的程序很容易讓人理解和使用，因為它在任何一次調用都會返回同樣的結果，我們可以明確的知道它將返回什么。
我們常說易于推理的代碼是好代碼，具備確定性的就具備易于推理的特性。
大概是由于Web前端技術的飛速發(fā)展，近些年函數(shù)式編程范式得到廣大開發(fā)者的親睞。函數(shù)式編程范式中最重要的一個概念就是純函數(shù)。純函數(shù)是指沒有任何副作用且可以輸出確定的結果的函數(shù)。
純函數(shù)是更容易測試的，我們對使用它的信心也更強。但是，在函數(shù)式編程范式中，對純函數(shù)的規(guī)范定義?顯得學院化，并加入了場景限定。事實上，我們主要需要的是程序的確定性。用面向對象范式編程，可以考慮把一個對象設計成值對象，這樣也可以增強程序的確定性。由于不確定性常常來自復雜且不確定的依賴（比如，某個依賴自己管理了復雜的狀態(tài)，就也會間接的使你的代碼充滿不確定性），在設計類時，嚴格控制其依賴的外部模塊，盡量做到無依賴，也可以增強程序的確定性。
具備確定性的代碼通常是健壯、可靠而具備彈性的。
(3) 內(nèi)部行為可觀測
如何預測程序的行為？觀察它的運行時輸出是一個很好的方法。如果程序可以在運行時打印關鍵的內(nèi)部狀態(tài)或行為就可以讓我們推測其當前狀態(tài)。
觀察程序內(nèi)部狀態(tài)可以分為以下幾個級別：
- 信息儀表（Instrumentation）: 程序告訴我們它正在干什么
- 遙測（Telemetry）: 將程序告訴我們的信息以一種接口暴露出來，使其可以被遠程訪問
- 監(jiān)控（Monitoring）: 將程序告訴我們的信息可視化出來
- 告警（Alerting）: 從監(jiān)控信息中識別異常，發(fā)出通知
- 預測（Predicting）: 利用監(jiān)控信息來預測即將發(fā)生的事件
- 自適應（Adapting）: 通過告警的或者預測的信息動態(tài)調整系統(tǒng)以適應變化
有一些工具可以自動提取程序運行時信息供分析，但是最佳的提升程序的可觀測性的方式還是通過有意識的設計來在關鍵處輸出程序的狀態(tài)或行為。
4.符合慣例的（I）
CUPID的第四個特質I是指Idiomatic，符合慣例的。
大家都有自己的編碼習慣，這些習慣包括空格和制表符的使用，變量命名規(guī)則，括號放置位置，代碼結構，提交的粒度和注釋等等。這些不一樣的習慣將顯著的增加不熟悉代碼庫的讀者的認知負載。讀者不僅需要理解問題空間和解空間，還需要不斷進行翻譯，以便識別當前的代碼是有意編寫的，還是無意的，或者只是作者的習慣而已。
編寫代碼時的最偉大的特質是同情心：對你的代碼的用戶的同情；對提供支持服務的同事的同情；對將來修改代碼的開發(fā)者的同情。事實上，他們中任意一個可能就是將來的你。編寫“人類可讀的代碼”意味著為別人編寫代碼。這正是“符合慣例”的意義。
編寫代碼時，可以假定你的用戶具備以下背景：
- 熟悉所使用的編程語言，及該語言對應的庫、工具鏈和生態(tài)
- 懂軟件開發(fā)的有經(jīng)驗的開發(fā)者
還有一條，他們正努力的完成某件事情。
(1) 語言慣例
代碼應該遵循編程語言的慣例。有些編程語言在代碼風格上態(tài)度鮮明，我們會更容易判斷代碼是否符合語言慣例。另一些編程語言則可以兼容多種不同風格，此時我們應該選擇一種風格，并始終堅持它。
Python是一門在代碼風格上態(tài)度鮮明的語言。當我們在Python的交互式命令行中輸入import this，或者運行命令python -m this時，就會發(fā)現(xiàn)輸出了Python所推薦的編程風格。這些編程風格組合成了”Python之禪”（The Zen of Python）。比如“應該有一種顯然的實現(xiàn)方式，而且最好只有一種”（There should be one-- and preferably only one --obvious way to do it）。
Go語言內(nèi)置了一個代碼格式化工具gofmt，它會處理縮進、括號位置等問題，可以使所有代碼變得風格一致。除此之外，還有一篇專門說明Go語言風格的文檔Effective Go來指導大家寫出風格一致的代碼。
語言慣例出現(xiàn)在各個級別的代碼中，函數(shù)名、類型、參數(shù)、模塊、代碼組織結構、模塊組織結構、工具鏈選擇、依賴選擇、管理依賴的方式等。如果你的代碼符合這些語言慣例，將會讀起來更讓人愉悅。
如何讓代碼遵循這些語言慣例？可能沒有什么更好的辦法，只有讓自己多去學習這些慣例。
(2) 團隊慣例
當編程語言本身沒有風格傾向，或者有多種風格可選的時候，用什么風格來寫代碼就由我們自己或者我們的團隊來決定了。通常團隊會自己定義一些慣例，比如用什么工具，如何縮進等。借助各種語言的代碼檢查工具，可以自動化的讓代碼保持一致的風格。
對于某些無法用工具覆蓋的慣例，利用架構設計決策記錄來文檔化這些慣例是一種好的實踐。這些慣例的重要性并不比其他的架構設計決策更低。
5.基于領域的（D）
CUPID的最后一個特質D是指Domain based，基于領域的。
近幾年，微服務的興起使得領域驅動設計（Domain Driven Design, 簡稱DDD）以新的面貌受到大家的廣泛關注。相對于其對于微服務設計的指導意義，DDD提出的以領域為中心的軟件開發(fā)思想或許具有更重大的意義。
(1) 基于領域的語言
由于代碼的讀者通常對問題是清楚的，所以，代碼應該用問題空間的語言來寫，這樣就能讓代碼的讀者更容易的理解。問題空間語言即領域語言。
編程語言和庫里面充滿了計算機技術術語。比如常用的數(shù)據(jù)結構，如數(shù)組、鏈表、哈希表、樹結構等。還比如數(shù)據(jù)庫表、網(wǎng)絡連接等。甚至基礎數(shù)據(jù)類型，如整型數(shù)值、浮點型數(shù)值、字符串等也都是技術術語。直接在代碼中使用這些術語不會告訴你的讀者你要解決什么問題，他們需要根據(jù)對問題的理解進行翻譯。
TDD可以用于幫助我們更多的用領域語言編寫代碼。TDD要求在還沒有實現(xiàn)代碼的時候寫出測試代碼。如何做到呢？其實，TDD是希望我們可以在看到問題后，先用自然語言描述測試過程，然后再將自然語言的測試過程翻譯為編程語言。由于描述測試過程時，會站在用戶的角度進行描述，所以將更多的使用領域語言。并且測試過程的描述將反映出程序應該有的公開接口，所以接口也會變成用領域語言描述的接口，這就很大程度上促進了用領域語言編寫代碼。
舉個例子，在電商場景中，如果要實現(xiàn)購物車的功能，則分析購物車的業(yè)務需求之后，可以將測試過程描述如下：
－ 準備一個空的購物車 － 向購物車添加商品1，數(shù)量1 － 向購物車添加商品2，數(shù)量2 － 購物車中應該有兩種商品，其中有1個商品1及2個商品2 － 向購物車添加商品1，數(shù)量1 － 購物車中應該有兩種商品，其中有2個商品1及2個商品2 － 從購物車取出商品1，數(shù)量2 － 購物車中應該有一種商品，即2個商品2
翻譯為Java語言的測試代碼示例如下（部分）：
...
void testCart() {
var cart = new Cart();
var product1 = new Product();
var product2 = new Product();
cart.add(product1, 1);
cart.add(product2, 2);
assertTrue(cart.contains(product1));
assertEquals(1, cart.productCount(product1));
assertTrue(cart.contains(product2));
assertEquals(2, cart.productCount(product2));
cart.add(product1, 1);
......
}
...
可以看到，通過編寫測試，我們用領域語言設計了Cart類，Product類，并且對Cart類設計了add contains productCount三個方法。除了促進使用領域語言編寫代碼，TDD還可以讓我們提供的接口剛剛夠用，不多不少，從而實現(xiàn)可組合性特質中的“精巧的接口”。
使用領域語言編寫代碼的最佳狀態(tài)是，我們的代碼可以讓沒有技術背景的業(yè)務人員也能輕松看懂，整個代碼讀起來就像業(yè)務分析師在講解業(yè)務邏輯一樣。
(2) 基于領域的結構
除了使用領域語言編寫代碼，在模塊的設計、代碼目錄結構（或包結構）也應該優(yōu)先使用領域語言命名。
很多使用Spring框架的Java程序員有個偏好，他們按照框架提供的概念來組織代碼，并且將不同的文件按照框架概念進行分類存放。一個可能的結構可能是：
app
|----controllers
|----assets
|----models
|----events
|----repositories
|----requests
|----responses
|----dtos
|----configurations
......
這帶來的問題是，當要修改一個API時，不得不在多個目錄中去查找和修改代碼。這不僅增加了認知負載，使代碼耦合在一起，還增加了修改代碼的負擔。
使用基于領域的結構，建議盡量將目錄按照領域進行劃分，而不是框架概念。比如，如果是一個電商的場景，目錄結構應該是user product order payment shipment等。
當前一個流行的架構模式是分層架構，如果按照分層架構進行設計，則頂層目錄可以是不同的分層名稱，分層以下，就應該是由領域概念組成的目錄。并且分層之間應該有嚴格的依賴順序，不應產(chǎn)生兩個分層循環(huán)依賴的情況。雖然看起來這是一個例外，但是這種拆分是有缺陷的。近兩年微服務架構非常流行，而微服務的拆分是按照業(yè)務領域進行拆分的，這可以理解為微服務是整體產(chǎn)品這個根目錄下的基于領域的子目錄。這個現(xiàn)象可以理解為大家對于分層架構的目錄劃分并不滿意，還是希望在更上層基于領域來劃分目錄。
(3) 基于領域的邊界
無論我們?nèi)绾谓M織代碼結構，目錄（或模塊）的邊界變成了事實上的領域邊界。一打開代碼庫就能看到目錄結構，目錄的層級和名字逐漸變成了大家最熟系的信息。所以，在設計上，一個重要的原則就是將領域劃分和目錄劃分保持一致。這將有效降低團隊的認知負載，開發(fā)者將因此而更不容易犯錯，團隊效率最終將得到提高。
這并不意味著需要組織成一個平坦（flat）的目錄結構。領域以下可以有子領域，目錄以下可以有子目錄，模塊以下可以有子模塊。重要的是這一個一個層級需要能對應上。
總結
到這里，我們應該了解了CUPID所指出的五種特質的內(nèi)涵?？梢悦黠@的看到，相比不符合CUPID特性的代碼，符合CUPID的代碼可以讓人更加愉悅地進行閱讀和修改。事實上，CUPID中的五個特質并不是相互獨立的，它們常?？梢曰ハ啻龠M。
可組合并符合Unix風格的代碼（做一件事，并把它做好）讓人感覺就像是一個可靠的老朋友。符合慣例的代碼讓從未看過此代碼的人也覺得非常熟悉?？深A測的代碼將我們從一系列“驚喜”中解脫出來。基于領域的代碼減少了從需求到方案之間的認知距離。
在每次修改代碼時，如果每個人都能將代碼向這幾個方向所指向的中心點靠近一點，那就可以讓代碼越來越好。
本文標題：好代碼的五個特質
瀏覽地址：http://m.5511xx.com/article/djjgcgi.html
