淺談 Code-Review

淺談 Code-Review

前言

最近，有些朋友也在談論 Code-Review 以及 Code-Review 所遭遇到的困難等，今天我就來談談我自己對 Code-Review 的一些初淺的看法。

近年來我在各中小型企業執行顧問工作，有 API Framework 客製化的框架開發、也有 Redis 導入工作、也有日常維護（專案開發技術顧問角色/Trouble-Shooting/專案軟體架構設計角色/單元測試顧問/教育訓練.../etc），而不管我執行哪一種工作，協助解決 Bug 也好，很多時候的第一件事就是與該團隊成員一起 Code-Review，先來看看程式碼，了解出現問題的 Source Code，這是再稀鬆平常不過的事情了，今天，我就來分享我在各大企業，許多團隊實際進行顧問時的 Code-Review 所看到的一些現象，並分享給各位。

實務上 Code-Review 以我個人的經驗我覺得可以區分為以下兩種：

  1. 非正式的 Code-Review：

什麼叫做『非正式的 Code-Review』呢？以往，我在帶團隊做專案時，不管是我與同仁 pair-programming 時，或者相互討論需求時，我們會同時進行 Code-Review，這時你會說這也算？對!!! 我認為，當然算，當然有些決議會記錄下來在下一次正式討論時與團隊同步，但是我個人非常重視這個過程，而且這些討論一樣是在『有團隊開發共同規範的基礎下』進行的。這些通常在位子上就可以進行。

非正式的 Code-Review 其實也有己的進入點（其實非正式場合我不建議用 Code-Review 做為內容表達方式，一來讓人覺得它就是要來噹我的會議、二來就是有犯了什麼錯，所以準備被指正等。）

1). 當 Junior 工程師對需求有問題時 

2). 當 Commit 的 Source 或 Pull 下來的 Source 有問題時 

3). Merge 出錯時

以上 3). 點我統一說明，非正式場合不建議大費周章發會議通知 + 找所有人一起參與，一來花費過多時間也沒有效率，專案開發是分秒必爭的，本來就不建議有過多的浪費（敏捷也告訴我們要減少浪費）使用最少的資源，與該需求相關人等討論即可，甚至在位子上花 10-20 分即可進行，我個人是建議不要超過 30 分鐘。

Merge 出錯通常可能點出另一種問題，像是團隊成員沒有遵循每日簽入、一個需求做太久、或工作重疊等，這其實是團隊共同規範的問題，有些就需要正式的場合來讓團隊了解問題的嚴重性、範圍、影響範圍等，這我放在下方一起說明。

PS： 相較之下，我反而喜歡非正式的 Code-Review，因為它是一個較不嚴肅的場合，讓 Junior 比較沒有壓力，用比較輕鬆的方式傳達共通的思想、與交換意見 + 激盪新的火花。


  1. 正式的 Code-Review：

為什麼我用『正式的 Code-Review』這個標題，因為訪間書籍在談論 Code-Review 可能會告似你有許多前置作業，像是：

A. 規範團隊開發共同規範 關於規範，我覺得這幾乎可以另外開一個 Topic 來說明，因為從分析=>設計=>開發=>部署都應該有基本的規範，分析使用的語言、使用的 Modeling Language、甚至團隊之間使用的術語，撰寫的 Paper 等等，都應該是有共識下的產物，這部分在 DDD 裡的通用語言 (UBiquitous Language) 就解釋得非常好我覺得。很多人跟我說，包括最近外部演講也在討論 （工程師 == 藝術家）所以不要限制我？.. 但..我很抱歉地說，如果是團隊開發，很抱歉，它就應該有些限制，對！？你聽到的沒錯，很遺憾的，它就是必須要有些限制，根據經驗，軟體專案開發在使用平台與架構、甚至使用哪一種 Log 套件/SMTP/SMS 處理等，都有約定，在這個專案裡甚至程式碼 Coding Rule 到使用的 Patterns 都是有約束的，不是完全由 Members 自由發揮，如果你不希望技術債跟著使用技術一起發散的話，那麼最好在團隊開發共同規範裡制定好規則，遊戲規則講清楚，軟體專案開發才有可能順暢，才有可能 On-Schedule 的。

B. 開發人員可先使用工具進行基本(程式碼風格、命名規則) 等，的掃瞄 這是種工具上的落實，在相同 Coding Rule 下，團隊成員可使用掃描工具驗證自己符合團隊的 Naming Rule。

Code-Review 常見的幾個時機？

1). 當團隊有產出時 

2). 當 QA 或甚至客戶有回饋 Bug 時 

3). 程式碼有些瑕疵、或者是效能不佳時


Code-Review 開始前，需要什麼準備工作嗎？

如果這個需求還在 ToDo 階段，先針對 ToDo 說明，通常可透過(Use Case/User Story/Scenario…)來說明需求，開始說明工作如何進行，程式碼架構如何分層，Patterns 使用時機等。

一般來說，Code-Review 那些東西：

  • 程式碼是否滿足業務與營運需求？
  • 程式架構與系統設計是否滿足未來擴充性？
  • 程式碼的可讀性，或者存在那些常見的程式碼壞味道（Code Smell or Bad Smell）
  • 程式碼效能問題 (Performance Issues)
  • 程式碼安全問題 (Security Issues)
  • Error handling (基本的錯誤處裡是否有達標？)

只要深入企業的專案團隊，穀倉就特別嚴重，但唯一不變的是專案時程 + 產出一定要有基本的品質，這些都是利用 Code-Review 把事情做得更快更好的切入點。

最後：

其實 Code-Review 的本質，絕對不是增加彼此對立、這與導入敏捷的精神基本上是一致的，所謂的 Code-Review 鼓勵小組們彼此溝通、凝聚共識、提升小組合作精神、與默契的最佳方法與方式。進而降低軟體開發的技術債，最終提升工作效率、因為有了合作默契 + 團隊開發共同規範，軟體品質自然提升、也因為浪費減少，工作效率自然提升。


延伸閱讀：

1). 團隊開發共同規範 - 適當的約束會有助於軟體產出的品質 (持續更新)

2). 從整潔架構 Clean Architecture 角度談 NuGet Packages 套件的規劃與使用 

3). 先前、我曾建議團隊透過 Project Templates 來減低人為的錯誤率、開發更加一致化 

4). 常見的程式碼壞味道（Code Smell or Bad Smell）

留言

張貼留言

這個網誌中的熱門文章

什麼是 gRPC ？

圖片
圖片取自： https://grpc.io/docs/guides/ gRPC 是什麼？能吃嗎？ 在安裝了 .NET Core 3.0 之後，眼尖的朋友應該會發現，在新增 ASP.NET Core 網頁類型專案裡，會看見一個 gRPC Service 類型的專案，其實它也不是什麼很新的東西，早在十多年前 Google 就使用這樣的 RPC 協定進行一些大量的可靠性微服務的存取，聽到這，難道現有的 Web API 不可靠嗎？其實不是的，它主要用在移動設備等提供高效簡單且跨平台的通訊與熱插拔的驗證機制。 gRPC 的運作原理 gRPC 顧名思義，是種基於 RPC 的通訊協定，不同於 Web API 走的傳統 HTTP 基礎協定，它有點像是 Socket ，但應該說是基於 Socket， 或精確地來說它是基於 HTTP/2 的協定 ，gRPC 是種協議緩衝協定，它必須事先定義 IDL (Interface Definition Language) 描述檔，看到 IDL 對於一些熟悉 COM／DCOM 的朋友一定非常的熟悉，對！沒錯！就是類似的東西！但，這邊的 IDL 是用一種副檔名為 .proto 檔案來是先定義在分散式環境中，要傳輸的序列化結構資訊，當然它也可以跟 JSON 一起使用。 也就是說，要使用 gRPC 您必須先定義 .proto 協議，然後透過 Compile 的支援，編譯成特定語言框架。而很高興的是，C# 也支援了，然而其實根據官方的資料顯示，C# 應該在 .NET Core 2.1 開始就支援了，只是到了 .NET Core 3.0 才有樣版的支援。 而使用 gRPC 的協議緩衝區的服務可以做到 Stub 的機制，也就是說，它就像是許多 RPC 一樣，Client 在呼叫 Server 端時，其實是對 Stub 進行叫用，Stub 在這就像個緩衝區一般，但更細部的說，應該是一個遠程服務的替身，這應該又讓許多熟悉 COM／RPC 通訊的朋友覺得熟悉了起來，是的！沒有錯。 在 .NET Core 3.0 裡使用 gRPC 目前支援 .proto 擴展為 gRPC 協議緩衝區的編譯器只有 .NET Core 了 ， 根據 Github 上的說明 .NET Framework 4.5+ 以上或 Mono 4+ 以上也可支援，而 gRPC 也完全的跨平台。要在 .
閱讀完整內容

什麼是 gRPC（二）- 來撰寫第一個 Hello World 吧！

圖片
前言 上一篇 什麼是 gRPC ，筆者大致介紹了 gRPC Service 的基本概念，這一次，我們就來小試一下身手，撰寫一個 Hello World （迷之音：嘗試新技術時，總是得先來一個 Hello World ～我不想違背這良好傳統阿阿阿阿） 使用環境 Visual Studio 2019 .NET Core 3.0.100-preview3-010431 開始進行 撰寫 gRPC 除了先準備好基礎環境、選定一種 作業系統／ 程式語言 Language 外、（Framework／SDK／Runtime）等環境備妥後，就可以開始撰寫， (1). 開始撰寫 gRPC 第一步就是先定義 .proto 協議了 上一篇筆者提到，gRPC 的 Server 與 Client 必須使用相同的協議才可進行溝通，一般來說，你應該使用 protoc.exe 編譯器先行編譯過 greet.proto 協議檔，並產出 C# 程式碼檔案後才可繼續，而在 Visual Studio 2019 裡，拜 MSBuild 之賜，已經有人預先寫好 .Target 檔案了 （什麼是 MSBuild ？什麼是附檔名 .Target 檔案可參考： MSBuild .targets 檔案 ） 筆者先撰寫一個 SayHelloWorld 方法如下： 在協議裡，除了在 service Class 撰寫要公開存取的方法外， 必須在提供『傳入訊息型態』、『回傳訊息型態』 ，這邊我先定義兩個 message，一個是『 HelloMyFirstgRPC 』、另一個是『 HelloMyReply 』 在撰寫 proto 協議檔時，建議先決定 message 回傳型態與傳入的型態，那麼 Visual Studio 2019 會有 InteillSense 的完整支援。不得不說 Visual Studio 2019 在 .proto 協議編輯上的支援已經算不錯了。 注意： 一般來說，Visual Studio 2019 會在背景裡自動編譯 .proto 協議檔案，但始有可能不會有任何提示，所以您也可以自行使用命令列工具進行手動編譯，如下圖，若編譯失敗會出現錯誤訊息，如下圖顯示 return 關鍵字錯誤： protoc.exe 編譯器 & 相關 MSBuild Tools 會隨著 NuGet 套件在 Vis
閱讀完整內容

常見的程式碼壞味道（Code Smell or Bad Smell）

圖片
常見的程式碼壞味道（Code Smell or Bad Smell） 圖片取自：https://www.slideshare.net/ElMahdiBenzekri/art-of-refactoring-code-smells-and-microservices-antipatterns 前言 究竟重複的程式碼要不要共用它？傳統的軟體開發上，重複的程式碼幾乎被視為罪惡的來源，但是它真的有多可怕？ 常見的 Code Smells The Dispensable （一些可有可無的） Lazy Class (冗員類別） 如果一個類很少使用它會增加代碼庫的複雜性，從而阻礙開發。這樣的類可能是不必要的，它的功能可以成為另一個類的一部分。 Data Class (只有資料的類別） 一個類別只有包含『資料』未包含Methods，也就是說並未包含行為，不具行為模式的類別代表該『實例』容易被【其他類別所操控】。 Duplicate Code (重複的程式碼) 如描述，這也是上次有分享在我的 FB 社團 軟體開發之路［德國資深架構師給新手的建議］ 中有產生非常熱烈討論，這在社團朋友提醒下想起 Refactor 重構一書裡曾提過 rule of three 法則， 這個法則的定義是這樣的，有時部分程式碼重複其實是允許的（不是說重複一定是是被允許的）而是在某些 Context 情境下，該程式碼有一段時間不會衍伸別的功能 或 需求一段時間不會異動、且如要將它 DRY 會產生的『複雜度』或『花費時間』遠高於預估的時間 或 不值得在目前這個專案的節骨眼上花費這個時間來做這件事，加上它 DRY 產生的複雜度偶後產生的維護成本【遠高於】不 DRY 的情況下的維護本，那麼，在這個時候，這個異動頻率【極低】的程式碼就不需要花費這個時間來 DRY 了！！ 因為重點在於，重構是需要『成本』的。(迷之音：DRY 是種抽象化阿~😎) 這讓我想起之前，大約在 2016 年左右，在 101 的樓上某金融業客戶，曾經做過一個專案，這個專案就是因為客戶 DMZ 環境的因素，我讓內網的 Webside 與 DMZ 的網站保留了部分重複的程式碼，因為這段程式碼終年不需要異動，我也懶得花這個時間，而我居然也忘了這記件事情了.. 哈哈 Orz 不過原歸正傳，我個人還是認為，其實適當
閱讀完整內容