本文翻譯自Programming Principles(http://java-design-patterns.com/principles/)。
每個程序員都可以從理解編程原理和模式中受益。這篇概述用於我個人參考，同時我也把它放在這。也許這在設計、討論或複查中對你有所幫助。但請注意，這還遠遠不夠，你常常需要在相互矛盾的原則之間做出權衡。
本文受The Principles of Good Programming(http://www.artima.com/weblogs/viewpost.jsp?thread=331531)啓發。我覺得這份列表已經足夠了，但這並不完全符合我個人的想法。此外，我還需要更多的論證、細節以及其他資料的鏈接。
KISS
大多數系統如果保持簡單而不是複雜，效果最好。
爲什麼
-
更少的代碼可以花更少的時間去寫，Bug更少，並且更容易修改。 -
簡單是複雜的最高境界。 -
完美境地，非冗雜，而不遺。
相關資料
-
KISS principle(http://en.wikipedia.org/wiki/KISS_principle) -
Keep It Simple Stupid (KISS)(http://principles-wiki.net/principles:keep_it_simple_stupid)
YAGNI
YAGNI的意思是“你不需要它”：在必要之前不要做多餘的事情。
爲什麼
-
去做任何僅在未來需要的特性，意味着從當前迭代需要完成的功能中分出精力。 -
它使代碼膨脹；軟件變得更大和更復雜。
怎麼做
-
在當你真正需要它們的時候，才實現它們，而不是在你預見到你需要它們的時候。
相關資料
-
You Arent Gonna Need It(http://c2.com/xp/YouArentGonnaNeedIt.html) -
You’re NOT gonna need it!(http://www.xprogramming.com/Practices/PracNotNeed.html) -
You ain’t gonna need it(http://en.wikipedia.org/wiki/You_ain't_gonna_need_it)
做最簡單的事情
爲什麼
-
僅有當我們只解決問題本身時，才能最大化地解決實際問題。
怎麼做
-
捫心自問：“最簡單的事情是什麼？”。
相關資料
-
Do The Simplest Thing That Could Possibly Work(http://c2.com/xp/DoTheSimplestThingThatCouldPossiblyWork.html)
關注點分離
關注點分離是一種將計算機程序分離成不同部分的設計原則，以便每個部分專注於單個關注點。例如，應用程序的業務邏輯是一個關注點而用戶界面是另一個關注點。更改用戶界面不應要求更改業務邏輯，反之亦然。
引用Edsger W. Dijkstra(https://en.wikipedia.org/wiki/Edsger_W._Dijkstra) (1974)所說：
我有時將其稱爲“關注點分離”，即使這不可能完全做到，但它也是我所知道的唯一有效的思維整理技巧。這就是我所說的“將注意力集中在某個方面”的意思：這並不意味着忽略其他方面，只是對於從某一方面的視角公正地來看，另一方面是不相關的事情。
爲什麼
-
簡化軟件應用程序的開發與維護。 -
當關注點很好地分開時，各個部分可以被重用，並且可以獨立開發和更新。
怎麼做
-
將程序功能分成聯繫部分儘可能少的模塊。
相關資料
-
Separation of Concerns(https://en.wikipedia.org/wiki/Separation_of_concerns)
保持事情不再重複
在一個系統內，每一項認識都必須有一個單一的、明確的、權威的表示。
程序中的每一項重要功能都應該只在源代碼中的一個地方實現。相似的函數由不同的代碼塊執行的情況下，抽象出不同的部分，將它們組合爲一個函數通常是有益的。
爲什麼
-
重複（無意或有意的重複）會造成噩夢般的維護，保養不良和邏輯矛盾。 -
對系統中任意單個元素的修改不需要改變其他邏輯上無關的元素。 -
此外，相關邏輯的元素的變化都是可預測的和均勻的，因此是保持同步的。
怎麼做
-
只在一個處編寫業務規則、長表達式、if語句、數學公式、元數據等。 -
確定系統中使用的每一項認識的唯一來源，然後使用該源來生成該認識的適用實例（代碼、文檔、測試等）。 -
使用三法則（Rule of three）(http://en.wikipedia.org/wiki/Rule_of_three_(computer_programming)).
相關資料
-
Dont Repeat Yourself(http://c2.com/cgi/wiki?DontRepeatYourself) -
Don’t repeat yourself(http://en.wikipedia.org/wiki/Don't_repeat_yourself) -
Don’t Repeat Yourself(http://programmer.97things.oreilly.com/wiki/index.php/Don't_Repeat_Yourself)
相似資料
-
Abstraction principle(http://en.wikipedia.org/wiki/Abstraction_principle_(computer_programming)) -
Once And Only Once(http://c2.com/cgi/wiki?OnceAndOnlyOnce) is a subset of DRY (also referred to as the goal of refactoring). -
Single Source of Truth(http://en.wikipedia.org/wiki/Single_Source_of_Truth) -
A violation of DRY is WET(http://thedailywtf.com/articles/The-WET-Cart) (Write Everything Twice)
爲維護者寫代碼
爲什麼
-
到目前爲止，維護是任何項目中最昂貴的階段。
怎麼做
-
成爲維護者。 -
不論何時編寫代碼，要想着最後維護代碼的人是一個知道自己住在哪裏的暴力精神病人。 -
如果某個入門的人掌握了代碼，他們就會從閱讀和學習代碼中獲得樂趣，以這樣的想法去編寫代碼和註釋。 -
別讓我想（Don’t make me think）(http://www.sensible.com/dmmt.html). -
使用最少驚訝原則（Principle of Least Astonishment）(http://en.wikipedia.org/wiki/Principle_of_least_astonishment).
相關資料
-
Code For The Maintainer(http://c2.com/cgi/wiki?CodeForTheMaintainer) -
The Noble Art of Maintenance Programming(http://blog.codinghorror.com/the-noble-art-of-maintenance-programming/)
避免過早優化
引用Donald Knuth(http://en.wikiquote.org/wiki/Donald_Knuth)所說：
程序員浪費大量的時間來思考或擔心程序的非關鍵部分的速度，而考研嘗試這些優化實際上在調試和維護時有很強的負面影響。比如說在97%的開發時間，我們應該忽略低效率：過早的優化是萬惡之源。然而，我們不應該在關鍵的3%中放棄我們的機會。
當然，需要理解什麼是“過早”什麼不是“過早”。
爲什麼
-
瓶頸在哪是未知的。 -
優化後，閱讀和維護可能會更困難。
怎麼做
-
使它運作，使它正確，使它更快（Make It Work Make It Right Make It Fast）(http://c2.com/cgi/wiki?MakeItWorkMakeItRightMakeItFast) -
不要在你不需要的時候優化，只有在你發現一個瓶頸之後才能優化它。
相關資料
-
Program optimization(http://en.wikipedia.org/wiki/Program_optimization) -
Premature Optimization(http://c2.com/cgi/wiki?PrematureOptimization)
最小化耦合
模塊/組件之間的耦合是它們互相依賴的程度，較低的耦合更好。換句話說，耦合是代碼單元“B”在未知的代碼單元“A”更改後“被破壞”的機率。
爲什麼
-
一個模塊的更改通常會導致其他模塊的更改，產生漣漪效益。 -
由於模塊間的依賴性增加，模塊裝配可能需要更多的工作和/或時間。 -
特定的模塊可能難以重用和/或測試，因爲必須包含相關模塊。 -
開發人員可能害怕更改代碼，因爲他們不確定什麼會收到影響。
怎麼做
-
消除，最小化和降低必要關聯的複雜性。 -
通過隱藏實現細節，減少耦合。 -
使用迪米特法則(https://mouse0w0.github.io/2018/10/04/Programming-Principles/#迪米特法則)。
相關資料
-
Coupling(http://en.wikipedia.org/wiki/Coupling_(computer_programming)) -
Coupling And Cohesion(http://c2.com/cgi/wiki?CouplingAndCohesion)
迪米特法則
不要和陌生人說話。
爲什麼
-
這通常會導致更緊密的耦合。 -
可能會暴露過多的實現細節。
怎麼做
對象的方法只能調用以下方法：
-
對象自身的方法。 -
方法參數中的方法。 -
方法中創建的任何對象的方法。 -
對象的任何直接屬性或字段的方法。
相關資料
-
Law of Demeter(http://en.wikipedia.org/wiki/Law_of_Demeter) -
The Law of Demeter Is Not A Dot Counting Exercise(http://haacked.com/archive/2009/07/14/law-of-demeter-dot-counting.aspx/)
組合優於繼承
爲什麼
-
類之間的耦合減少。 -
使用繼承，子類很容易做出假設，並破壞里氏代換原則（LSP）。
怎麼做
-
測試LSP（可替換性）以決定何時繼承。 -
當存在“有”（或“使用”）的關係時使用組合，當存在“是”的關係時使用繼承。
相關資料
-
Favor Composition Over Inheritance(http://blogs.msdn.com/b/thalesc/archive/2012/09/05/favor-composition-over-inheritance.aspx)
正交性
正交性的基本概念是，概念上不相關的東西在系統中不應該相關。
來源：Be Orthogonal(http://www.artima.com/intv/dry3.html)
它越簡單，設計越正交，異常就越少。這使得用編程語言學習、讀寫程序變得更容易。正交特徵的含義是獨立於環境；關鍵參數是對稱性與一致性。
來源：Orthogonality
穩健性原則
堅持保守自己的作爲，自由接受他人的作爲。
合作的服務依賴於彼此的接口。通常，接口需要提升，導致另一端接收未指定的數據。如果接收到的數據沒有嚴格遵守規範，那麼簡單的實現將僅拒絕合作。更復雜的實現卻可以忽略它無法識別的數據。
爲什麼
-
爲了能夠提高服務，你需要確保提供者可以進行更改以支持新的需求，同時對現有客戶端造成最小的破壞。
怎麼做
-
向其他機器（或同一機器上的其他程序）發送指令或數據的代碼應該完全符合規範，但接受輸入的代碼應接受不一致的輸入，只要其意義明確。
相關資料
-
Robustness Principle in Wikipedia(https://en.wikipedia.org/wiki/Robustness_principle) -
Tolerant Reader(http://martinfowler.com/bliki/TolerantReader.html)
控制反轉
控制反轉又被稱爲好萊塢原則，“不要打電話給我們，我們會打電話給你”。它是一種設計原則，計算機程序的自定義編寫部分從通用框架接收控制流。控制反轉具有強烈的含義，即可重用代碼和特定於問題的代碼是獨立開發的，即使它們在應用程序中一同工作。
爲什麼
-
控制反轉用於提高程序的模塊性，使其具有可擴展性。 -
將任務的執行與實現分離。 -
將模塊集中在其設計任務上。 -
使模塊不受關於其他系統如何執行其任務的假設約束，而是依賴於約定。 -
以防止模塊更換時出現副作用。
怎麼做
-
使用工廠模式 -
使用服務定位器模式 -
使用依賴注入 -
使用依賴查找 -
使用模板方法模式 -
使用策略模式
相關資料
-
Inversion of Control in Wikipedia(https://en.wikipedia.org/wiki/Inversion_of_control) -
Inversion of Control Containers and the Dependency Injection pattern(https://www.martinfowler.com/articles/injection.html)
最大化聚合
單個模塊/組件的聚合性是其職責形成有意義的單元的程度，越高的聚合性越好。
爲什麼
-
增加了理解模塊的難度。 -
增加了維護系統的難度，因爲域中邏輯的更改會影響多個模塊，並且一個模塊的更改需要相關模塊的更改。 -
由於大多數應用程序不需要模塊提供的隨機操作集，因此重用模塊的難度增加。
怎麼做
-
與組相關的功能共享一項職責（例如在一個類中）。
相關資料
-
Cohesion -
Coupling And Cohesion(http://c2.com/cgi/wiki?CouplingAndCohesion)
里氏代換原則
里氏代換原則（LSP）完全是關於對象的預期行爲：
程序中的對象應該可以替換爲其子類型的實例，而不會改變該程序的正確性。
相關資源
-
Liskov substitution principle(http://en.wikipedia.org/wiki/Liskov_substitution_principle) -
Liskov Substitution Principle(http://www.blackwasp.co.uk/lsp.aspx)
開放/封閉原則
軟件實體（例如類）應對擴展是開放的，但對修改是封閉的。也就是說，這樣的實體可以允許在不改變其源代碼的情況下修改其行爲。
爲什麼
-
通過最小化對現有代碼的修改來提高可維護性和穩定性
怎麼做
-
編寫可以擴展的類（而不是可以修改的類） -
只暴露需要更換的活動部分，隱藏其他所有部分。
相關資源
-
Open Closed Principle(http://en.wikipedia.org/wiki/Open/closed_principle) -
The Open Closed Principle(https://8thlight.com/blog/uncle-bob/2014/05/12/TheOpenClosedPrinciple.html)
單一職責原則
一個類不應該有多個修改的原因。
長話版：每個類都應該有一個單獨的職責，並且該職責應該完全由該類封裝。職責可以定義爲修改的原因，一次類或模塊應該有且僅有一個修改的原因。
爲什麼
-
可維護性：僅有一個模塊或類中需要修改。
怎麼做
-
使用 科裏定律(https://mouse0w0.github.io/2018/10/04/Programming-Principles/#科裏定律).
相關資料
-
Single responsibility principle(http://en.wikipedia.org/wiki/Single_responsibility_principle)
隱藏實現細節
軟件模塊通過提供接口來隱藏信息（即實現細節），而不泄露任何不必要的信息。
爲什麼
-
當實現更改時，客戶端使用的接口不必更改。
怎麼做
-
最小化類和成員的可訪問性。 -
不要公開成員數據。 -
避免將私有實現細節放入類的接口中。 -
減少耦合以隱藏更多實現細節。
相關資料
-
Information hiding(http://en.wikipedia.org/wiki/Information_hiding)
科裏定律
科裏定律是關於爲任何特定代碼選擇一個明確定義的目標：僅做一件事。
-
Curly’s Law: Do One Thing(http://blog.codinghorror.com/curlys-law-do-one-thing/) -
The Rule of One or Curly’s Law(http://fortyplustwo.com/2008/09/06/the-rule-of-one-or-curlys-law/)
封裝經常修改的代碼
一個好的設計可以辨別出最有可能改變的熱點，並將它們封裝在API之後。當預期的修改發生時，修改會保持在局部。
爲什麼
-
在發生更改時，最小化所需的修改。
怎麼做
-
封裝API背後不同的概念。 -
將可能不同的概念分到各自的模塊。
相關資料
-
Encapsulate the Concept that Varies(http://principles-wiki.net/principles:encapsulate_the_concept_that_varies) -
Encapsulate What Varies(http://blogs.msdn.com/b/steverowe/archive/2007/12/26/encapsulate-what-varies.aspx) -
Information Hiding(https://en.wikipedia.org/wiki/Information_hiding)
接口隔離原則
將臃腫的接口減少到多個更小更具體的客戶端特定接口中。接口應該比實現它的代碼更依賴於調用它的代碼。
爲什麼
-
如果類實現了不需要的方法，則調用方需要了解該類的方法實現。例如，如果一個類實現了一個方法，但只是簡單的拋出異常，那麼調用方將需要知道實際上不應該調用這個方法。
怎麼做
-
避免臃腫的接口。類不應該實現任何違反單一職責原則(https://mouse0w0.github.io/2018/10/04/Programming-Principles/#單一職責原則)的方法。
相關資料
-
Interface segregation principle(https://en.wikipedia.org/wiki/Interface_segregation_principle)
童子軍軍規
美國童子軍有一條簡單的軍規，我們可以使用到我們的職業中：“離開營地時比你到達時更乾淨”。根據童子軍軍規，我們應該至終保持代碼比我們看到時更乾淨。
爲什麼
-
當對現有代碼庫進行更改時，代碼質量往往會降低，從而積累技術債務。根據童子軍軍規，我們應該注意每一個提交（Commit）的質量。無論規模有多小，技術債務都會受到不斷重構的抵制。
怎麼做
-
每次提交都要確保它不會降低代碼庫的質量。 -
任何時候，如果有人看到一些代碼不夠清楚，他們就應該抓住機會在那裏修復它。
相關資料
-
Opportunistic Refactoring(http://martinfowler.com/bliki/OpportunisticRefactoring.html)
命令查詢分離
命令查詢分離原則規定，每個方法都應該是執行操作的命令，或者是向調用者返回數據但不能同時做兩件事的查詢。提問不應該改變答案。
利用這個原則，程序員可以更加自信地進行編碼。查詢方法可以在任何地方以任何順序使用，因爲它們不會改變狀態。而使用命令，你必須更加小心。
爲什麼
-
通過將方法清晰地分爲查詢和命令，程序員可以在不瞭解每個方法的實現細節的情況下，更加自信地編碼。
怎麼做
-
將每個方法實現爲查詢或命令。 -
對方法名使用命名約定，該方法名錶示該方法是查詢還是命令。
相關資料
-
Command Query Separation in Wikipedia(https://en.wikipedia.org/wiki/Command–query_separation) Command Query Separation by Martin Fowler(http://martinfowler.com/bliki/CommandQuerySeparation.html)
作者 | Mouse
來源 | http://r6d.cn/N3Sz
個人博客網站：https://programmerblog.xyz
本文分享自微信公衆號 - IT技術分享社區（gh_a27c0758eb03）。
如有侵權，請聯繫 [email protected] 刪除。
本文參與“OSC源創計劃”，歡迎正在閱讀的你也加入，一起分享。