Kerry 的筆記本
  • Table of contents
  • Kerry的Mac裝機必要
  • ASP.NET Core 教育訓練文件
    • .NET 9 OpenAPI 介紹與教學
    • 目錄
    • ASP.NET Core Authentication系列(一)理解Claim, ClaimsIdentity, ClaimsPrincipal
    • ASP.NET Core Authentication系列(三)Cookie選項
    • ASP.NET Core Authentication系列(二)實現認證、登錄和註銷
    • ASP.NET Core Authentication系列(四)基於Cookie實現多應用間單點登錄(SSO)
    • ASP.NET Core Consul 教學
    • ASP.NET Core Hangfire 排程管理
    • ASP.NET Core KeyCloak 實作
    • ASP.NET Core NLog-依照Environment使用Nlog.Config檔案
    • ASP.NET Core NLog-如何使用 NLog 將 log 寫到檔案
    • ASP.NET Core Nlog-發送訊息到ElasticSearch
    • 目錄
    • ASP.NET Core Quartz.NET 管理介面
    • ASP.NET Core RDLC 報表設計
    • ASP.NET Core SFTP (使用第三方套建 SSH.Net) - 類別庫為案例
    • ASP.NET Core 中使用 HttpReports 進行接口統計,分析, 可視化, 監控,追踪等
    • ASP.NET 使用 MassTransit 與 RabbitMQ,實現事件發佈、訂閱
    • Asp.Net Core 分散式Session – 使用 Redis
    • ASP.NET Core 前台會員修改個人資料
    • ASP.NET Core 前台會員忘記密碼與重設密碼
    • ASP.NET Core 前台會員登入
    • ASP.NET Core 前台會員註冊
    • ASP.NET Core 呼叫 API 發生 CORS 錯誤
    • ASP.NET Core 如何套網頁設計樣版
    • ASP.NET Core 客製化Model Validation 預設錯誤訊息
    • ASP.NET Core 後台查詢頁面教學
    • ASP.NET Core 網站生命週期
    • ASP.NET Feature Management 使用說明與教學
    • ASP.NET RulesEngine 介紹
    • ASP.NET WinForms APP 程式安裝檔
    • LinePay 支付完成後返回 LINE 應用而不跳出外部瀏覽器
    • EntityFramework
      • EF Core Migrations 完整教學手冊
      • EntityFramework Core DB Migrations
      • 使用 Entity Framework Core (EF Core) 的 Migrations 功能進行版本控制
    • NET 6
      • .NET 6 Autofac範例
      • .NET 6 Automapper範例
      • .NET 6 BenchmarkDotNet範例
      • .NET 6 Bogus範例
      • .NET 6 Dapper範例
      • .NET 6 Dapper語法說明
      • .NET 6 EFCore範例
      • .NET 6 EFCore語法說明
      • .NET 6 EPPlus圖表範例
      • .NET 6 EPPlus範例
      • .NET 6 Hangfire範例
      • .NET 6 HttpClient單元測試範例
      • .NET 6 MailKit前置作業
      • .NET 6 MailKit範例
      • .NET 6 Moq範例
      • .NET 6 NLog範例
      • .NET 6 NLog進階範例
      • .NET 6 Serilog範例
      • .NET 6 Serilog進階範例
      • .NET 6 Telegram.Bot前置作業
      • .NET 6 Telegram.Bot範例
      • .NET 6 Text.Json範例
      • .NET 6 swagger授權
      • .NET 6 swagger範例
      • .NET 6 xUnit範例
      • .NET 6 取得appsettings檔案內容
      • .NET 6 更改回傳Json時為大駝峰命名
      • .NET 6 解決System.Text.Json序列化後會將所有非ASCII轉為Unicode
    • WDMIS
      • CORS
      • FeatureManagement
      • Serilog
      • Spectre.Console
      • 資料模型實戰:從 MSSQL 設計到 .NET 8 WebAPI 實作(以刀具管理為例)
  • Azure
    • 如何在 ASP.NET CORE 5.0 WEB 應用程序中實現 AZURE AD 身份驗證
    • Azure App Configuration 使用教學
    • Azure Blob Storage
    • Azure DevOps 持續整合(CI) + Artifacts
  • CSharp
    • ASP.NET await 與 wait 的差異
    • AutoMapper —— 類別轉換超省力
    • C# 中的 HTTPClient — 入門指南
    • C# 正則表達式:從零到英雄指南
    • C# 集合, List<> 取交集、差集、聯集的方法
    • C#單元測試教學
    • CORS 介紹與設定方式
    • CSharp Coding Conventions
    • Using jQuery Unobtrusive AJAX in ASP.NET Core Razor Pages
    • 深入Dapper.NET源碼
    • 菜雞與物件導向
      • 菜雞與物件導向 (0): 前言
      • 菜雞與物件導向 (1): 類別、物件
      • 菜雞與物件導向 (10): 單一職責原則
      • 菜雞與物件導向 (11): 開放封閉原則
      • 菜雞與物件導向 (12): 里氏替換原則
      • 菜雞與物件導向 (13): 介面隔離原則
      • 菜雞與物件導向 (14): 依賴反轉原則
      • 菜雞與物件導向 (15): 最少知識原則
      • 菜雞與物件導向 (2): 建構式、多載
      • 菜雞與物件導向 (3): 封裝
      • 菜雞與物件導向 (4): 繼承
      • 菜雞與物件導向 (5): 多型
      • 菜雞與物件導向 (6): 抽象、覆寫
      • 菜雞與物件導向 (7): 介面
      • 菜雞與物件導向 (8): 內聚、耦合
      • 菜雞與物件導向 (9): SOLID
      • 菜雞與物件導向 (Ex1): 小結
  • DBeaver
    • 如何強制讓 DBeaver 在 Mac 上使用英文介面
  • DesignPattern
    • OAuth
    • Repository 模式 (Repository Pattern)
    • Single Sign On 實作方式介紹 (CAS)
    • 【SOP製作教學】新手適用,SOP範例、流程圖、製作流程全公開!
    • 【SOP製作教學】流程圖教學、重點範例、BPMN符號介紹!
    • 【SOP製作教學】流程圖符號整理、BPMN2.0進階符號教學!
    • 多奇數位 C# 程式碼撰寫規範 (C# Coding Guideline)
    • 軟體分層設計模式 (Software Layered Architecture Pattern)
    • 開源程式碼檢測平台 SonarQube
    • 菜雞新訓記
      • 菜雞新訓記 (0): 前言
      • 菜雞新訓記 (1): 使用 Git 來進行版本控制吧
      • 菜雞新訓記 (2): 認識 Api & 使用 .net Core 來建立簡單的 Web Api 服務吧
      • 菜雞新訓記 (3): 使用 Dapper 來連線到資料庫 CRUD 吧
      • 菜雞新訓記 (4): 使用 Swagger 來自動產生可互動的 API 文件吧
      • 菜雞新訓記 (5): 使用 三層式架構 來切分服務的關注點和職責吧
      • 菜雞新訓記 (6): 使用 依賴注入 (Dependency Injection) 來解除強耦合吧
      • 菜雞新訓記 (7): 使用 Fluent Validation 來驗證參數吧
  • DevOps
    • Repository 模式 (Repository Pattern)
    • pipeline工具研究
    • 單例模式 (Singleton Pattern)
    • 單元測試
    • 軟體分層設計模式 (Software Layered Architecture Pattern)
    • 雙重檢查鎖定模式 (Double-Checked Locking Pattern)
  • Docker
    • Docker 中部署 .NET 8 Web App 並支援 HTTPS
    • Docker指令大全
    • 第七章 安裝Nomad
    • Docker - 第三章 | 安裝 MSSQL
    • Docker - 第九章 | 安裝 datalust seq
    • 第二章 docker-compose 教學
    • Docker - 第五章 | 安裝 Redis
    • 第八章 安裝SonarQube
    • Docker - 第六章 | 安裝RabbitMQ
    • 第十一章 安裝 VtigerCRM
    • 第十二章 安裝KeyCloak
    • Docker - 第十章 | 安裝 Redmine
    • 第四章 安裝MySQL
    • Docker Desktop (含更改 Docker Image 路徑)
  • Git
    • Git Flow 指令大全(完整指令整理) 🚀
    • Git 安裝及配置SSH Key
    • Git 建立到上傳
    • 將現有專案的遠端儲存庫直接更改為新的儲存庫
    • Git 流程規劃
    • Git 語法大全
    • 30 天精通 Git 版本控管
      • 30 天精通 Git 版本控制
        • 第 01 天:认识 Git 版本控制
        • 第 02 天:在 Windows 平台必装的三套 Git 工具
        • 第 03 天:建立仓库
        • 第 04 天:常用的 Git 版本控制指令
        • 第 05 天:了解仓库、工作目录、物件与索引之间的关系
        • 第 06 天:解析 Git 资料结构 - 物件结构
        • 第 07 天:解析 Git 资料结构 - 索引结构
        • 第 08 天:关于分支的基本观念与使用方式
        • 第 09 天:比对文件与版本差异
        • 第 10 天:认识 Git 物件的绝对名称
        • 第 11 天:认识 Git 物件的一般参照与符号参照
        • 第 12 天:认识 Git 物件的相对名称
        • 第 13 天:暂存工作目录与索引的变更状态
        • 第 14 天: Git for Windows 选项设定
        • 第 15 天:标签 - 标记版本控制过程中的重要事件
        • 第 16 天:善用版本日志 git reflog 追踪变更轨迹
        • 第 17 天:关于合并的基本观念与使用方式
        • 第 18 天:修正 commit 过的版本历史记录 Part 1
        • 第 19 天:设定 .gitignore 忽略清单
        • 第 20 天:修正 commit 过的版本历史记录 Part 2
        • 第 21 天:修正 commit 过的版本历史记录 Part 3
        • 第 22 天:修正 commit 过的版本历史记录 Part 4 (Rebase)
        • 第 23 天:修正 commit 过的版本历史记录 Part 5
        • 第 24 天:使用 GitHub 远端仓库 - 入门篇
        • 第 25 天:使用 GitHub 远端仓库 - 观念篇
        • 第 26 天:多人在同一个远端仓库中进行版控
        • 第 27 天:通过分支在同一个远端仓库中进行版控
        • 第 28 天:了解 GitHub 的 fork 与 pull request 版控流程
        • 第 29 天:如何将 Subversion 项目汇入到 Git 仓库
        • 第 30 天:分享工作中几个好用的 Git 操作技巧
      • zh-tw
        • 第 01 天:認識 Git 版本控管
        • 第 02 天:在 Windows 平台必裝的三套 Git 工具
        • 第 03 天:建立儲存庫
        • 第 04 天:常用的 Git 版本控管指令
        • 第 05 天:了解儲存庫、工作目錄、物件與索引之間的關係
        • 第 06 天:解析 Git 資料結構 - 物件結構
        • 第 07 天:解析 Git 資料結構 - 索引結構
        • 第 08 天:關於分支的基本觀念與使用方式
        • 第 09 天:比對檔案與版本差異
        • 第 10 天:認識 Git 物件的絕對名稱
        • 第 11 天:認識 Git 物件的一般參照與符號參照
        • 第 12 天:認識 Git 物件的相對名稱
        • 第 13 天:暫存工作目錄與索引的變更狀態
        • 第 14 天: Git for Windows 選項設定
        • 第 15 天:標籤 - 標記版本控制過程中的重要事件
        • 第 16 天:善用版本日誌 git reflog 追蹤變更軌跡
        • 第 17 天:關於合併的基本觀念與使用方式
        • 第 18 天:修正 commit 過的版本歷史紀錄 Part 1
        • 第 19 天:設定 .gitignore 忽略清單
        • 第 20 天:修正 commit 過的版本歷史紀錄 Part 2
        • 第 21 天:修正 commit 過的版本歷史紀錄 Part 3
        • 第 22 天:修正 commit 過的版本歷史紀錄 Part 4 (Rebase)
        • 第 23 天:修正 commit 過的版本歷史紀錄 Part 5
        • 第 24 天:使用 GitHub 遠端儲存庫 - 入門篇
        • 第 25 天:使用 GitHub 遠端儲存庫 - 觀念篇
        • 第 26 天:多人在同一個遠端儲存庫中進行版控
        • 第 27 天:透過分支在同一個遠端儲存庫中進行版控
        • 第 28 天:了解 GitHub 的 fork 與 pull request 版控流程
        • 第 29 天:如何將 Subversion 專案匯入到 Git 儲存庫
        • 第 30 天:分享工作中幾個好用的 Git 操作技巧
  • Hands-On Labs - LineBotSDK 實作手札 (C#, .net core)
    • 00. 如何申請LINE Bot
    • CLI
      • 使用CLI來發送新的Channel Access Token(LINE Bot)
      • 使用CLI免費發送LINE Notify通知
    • basic
      • 如何發送LINE訊息(Push Message)
      • 如何發送LINE Template Messages
      • 如何發送ImageMap訊息
      • 如何發送Flex Message
      • 如何在訊息後面加上QuickReply快捷選項
    • liff
      • Lab 21: 建立第一個LIFF應用
    • webhook
      • 如何建立可Echo的基本LINE Bot
      • 如何在WebHook中取得用戶個人資訊(名稱、頭像、狀態)
      • 如何在WebHook中取得用戶上傳的圖片(Bytes)
  • Markdown
    • Markdown Cheatsheet 中文版
    • Markdown語法大全
    • 使用HackMD建立書本目錄
    • 使用HackMD建立簡報
  • SAP ABAP
    • ABAP開發環境和總體介紹
    • SAP MM模塊常用表總結
    • SAP QM數據庫表清單
    • SAP欄位與表的對應關係
  • SQL Server
    • [SQL SERVER] Like in
    • SQL Server 中,移除資料庫中所有的關聯限制
    • SQL Server 刪除資料庫中所有資料表
    • SQL Server View、Function 及 Stored Procedure 定義之快速備份
    • SSMS v18 清除登入畫面中,下拉選單歷史紀錄
    • [MS SQL]如何透過Database Mail進行郵件發送
    • [SQL SERVER]撰寫Stored Procedure小細節
    • 使用 Data Migration Assistant 移轉 SQL Server 資料庫與帳戶
    • 使用SSIS創建同步資料庫數據任務
  • Tools
    • 免費 FTP 伺服器 FileZilla Server 安裝教學 (新版設定)
  • VisualStudio
    • .NET CLI 指令碼介紹
    • Visual Studio 使用 Git 版本控制
    • 使用 Visual Studio 2022 可透過 .editorconfig 鎖定文字檔案的儲存編碼格式分享
  • Web API
    • ASP.NET Core 6 Web API 進行 JWT 令牌身份驗證
    • [ASP.NET Core]如何使用SwaggerAPI說明文件
    • ASP.NET Core Web Api實作JWT驗證筆記
    • ECFIT API 範例
    • JWT Token Authentication And Authorizations In .Net Core 6.0 Web API
    • 微服務架構 - 從狀態圖來驅動 API 的設計
  • Windows
    • [C#] 伺服器監控常用語法 (事件檢視器、CPU 硬碟使用率、程式執行狀況)
    • Configure IIS Web Server on Windows Server 2019
    • Log Paser Studio 分析 IIS W3C Log
    • Windows Server 2019 如何安裝 IIS 運行 ASP.NET 專案
    • 如何檢查安裝在 IIS 上的 .NET Core Hosting Bundle 版本
    • [IIS] 如何解決網站第一個請求 Request 特別慢 ?
    • IIS 不停機更版設置
    • SQL Server 2019 Standard 繁體中文標準版安裝
    • WINDOWS共用資料夾的網路認證密碼放在哪?如何清除?
    • 如何設定 ASP.NET CORE 網站應用程式持續執行在 IIS 上
  • 專案管理
    • SSDLC (Secure Software Development Life Cycle)
    • 系統開發原則
    • MIS及專案管理-使用Redmine
      • 第10章 - [日常管理]MIS部門週會工作進度追蹤
      • 第11章 - [日常管理]MIS部門主管月會報告管理
      • 第12章 - [日常管理]機房工作日誌
      • 第13章 - [日常管理]MIS部門耗用工時及工作進度檢討
      • 第14章 - [日常管理]MIS文件知識庫
      • 第15章 - [日常管理]整理及管理分享
      • 第16章 - [異常管理]使用者問題回報系統
      • 第17章 - [異常管理]資安事件及異常紀錄
      • 第18章 - [異常管理]整理及管理分享
      • 第19章 - [變革管理]MIS的專案及專案管理五大階段
      • 第1章 - [MIS及專案管理]中小企業MIS的鳥事
      • 第20章 - [變革管理]MIS的新專案管理:起始階段
      • 第21章 - [變革管理]MIS的新專案管理:規劃階段
      • 第22章 - [變革管理]MIS的新專案管理:執行階段
      • 第23章 - [變革管理]MIS的新專案管理:監控階段
      • 第24章 - [變革管理]MIS的新專案管理:結束階段
      • 第25章 - [變革管理]整理及管理分享
      • 第26章 - [ISMS管理]ISMS平台整體規劃
      • 第27章 - [ISMS管理]ISMS文管中心
      • 第28章 - [ISMS管理]ISMS表單紀錄的管理
      • 第29章 - [ISMS管理]整理及管理分享
      • 第2章 - [MIS及專案管理]專案管理的概念及MIS應用
      • 第30章 - 初心、來時路及感謝:系列文章總結回顧
      • 第3章 - [MIS及專案管理]管理工具的選擇
      • 第4章 - [Redmine]Redmine的安裝及設定
      • 第5章 - [Redmine]Redime系統邏輯說明
      • 第6章 - [Redmine]自行建立及維護表單
      • 第7章 - [Redmine]專案版面的規劃
      • 第8章 - [日常管理]AR管理
      • 第9章 - [日常管理]資訊服務申請
  • 微服務架構
    • DDD + CQRS + MediatR 專案架構
    • 微服務架構 #2, 按照架構,重構系統
    • 淺談微服務與網站架構的發展史
    • API First Workshop 設計概念與實做案例
      • API First #1 架構師觀點 - API First 的開發策略 - 觀念篇
      • API First #2 架構師觀點 - API First 的開發策略 - 設計實做篇
    • 基礎建設 - 建立微服務的執行環境
      • Part #1 微服務基礎建設 - Service Discovery
      • Part #2 微服務基礎建設 - 服務負載的控制
      • Part #3 微服務基礎建設 - 排隊機制設計
      • Part #4 可靠的微服務通訊 - Message Queue Based RPC
      • Part #5 非同步任務的處理機制 - Process Pool
    • 實做基礎技術 API & SDK Design
      • API & SDK Design #1, 資料分頁的處理方式
      • API & SDK Design #2, 設計專屬的 SDK
      • API & SDK Design #3, API 的向前相容機制
      • API & SDK Design #4, API 上線前的準備 - Swagger + Azure API Apps
      • API & SDK Design #5 如何強化微服務的安全性 API Token JWT 的應用
    • 建構微服務開發團隊
      • 架構面試題 #1, 線上交易的正確性
      • 架構面試題 #2, 連續資料的統計方式
      • 架構面試題 #3, RDBMS 處理樹狀結構的技巧
      • 架構面試題 #4 - 抽象化設計;折扣規則的設計機制
    • 架構師觀點 - 轉移到微服務架構的經驗分享
      • Part #1 改變架構的動機
      • Part #2 實際改變的架構案例
    • 案例實作 - IP 查詢服務的開發與設計
      • 容器化的微服務開發 #1 架構與開發範例
      • 容器化的微服務開發 #2 IIS or Self Host
  • 系統評估
    • RPA 與 WebAPI 評估
    • 數位轉型:從現有系統到數位化的未來
    • 數位轉型:從現有系統到數位化的未來
  • 面試
    • CV_黃子豪_2024
    • HR 問題集
    • .NET 工程師 面試問題集
    • 資深工程師 問題集
    • 資深開發人員 / 技術主管
    • 題目
Powered by GitBook
On this page
  • 單一職責原則 (Single Responsibility Principle)
  • 走向單一職責
  • 展現你的意圖
  • 參考資料
  • 同系列文章
  • 其他文章
  1. CSharp
  2. 菜雞與物件導向

菜雞與物件導向 (10): 單一職責原則

Previous菜雞與物件導向 (1): 類別、物件Next菜雞與物件導向 (11): 開放封閉原則

Last updated 1 year ago

img

我們在前面的 有提到過,內聚並不是無腦把相關的程式碼都封在一起就好了,也有分成健康的和不健康的。但我們要怎麼知道這個類別是否足夠健康呢?單一職責原則就是很好的檢驗方式,這篇就讓我們來紀錄一下。

單一職責原則 (Single Responsibility Principle)

「單一職責」原則顧名思義,就是一個類別應該只負責一個職責。

但是這樣太過籠統了,「職責」相當容易產生誤會,容易變成各說各話。畢竟咱們工程師最愛戰定義了嘛。

「你這類別不優,它有兩個職責!登入跟登出!」

『沒有啦,我這個類別就是負責帳戶管理的啊』

『……你存心來找碴的是不是?』

為了避免像這樣產生職場糾紛,我們需要先定義一下什麼是「職責」。經過前輩們的努力(解釋)之後,單一職責的定義就成了:

就一個類別而言,應該只有一個引起它變化的原因

另外,我也看過「一個類別應該只對一個角色負責」的說法,這兩者的核心概念是一樣的。

這邊讓我們簡單舉個例子。如果在訂單管理的類別中有一個新增訂單的方法,在收到訂單之後,會依序處理訂單、並取出會員的聯絡資訊,再依靠聯絡資訊寄送通知信件給會員。但它的實作全靠自己來,如下:

新增訂單()
{
   // 收到訂單
   /*
     一些訂單的商業邏輯
   */

   // 寫入訂單
   /*
     一些和資料庫連線寫入資料的處理
   */

   // 取得聯絡資訊
   /*
     一些連到資料表或服務拿會員資料的處理
   */

   // 寄送通知
   /*
     一些寄送信件的處理,如寄送者和寄送方式等等
   */
}

這樣一路就是流水帳打完收工,這樣的一個函式參雜了一堆不相干的邏輯,可能動輒數百行,每一段都處理各種不同的工作,一看就很明顯違反單一職責原則。

當訂單處理的商業邏輯、查詢會員資料的邏輯或是通知會員的方式有變更的時候,這個函式都會受到影響,也就是說這個函式同時對多個不同對象負責。這樣的類別或函式就是不穩定的。

遇到這種情況,我們可以將其拆分。讓上帝的歸上帝,讓凱薩的歸凱薩。

例如說會員的處理一律封裝回會員管理類別,我們再藉由會員管理類別去調用其方法取回資料;寄送信件也封裝到通知管理類別,不用去管用什麼方法通知的,我們只需要去要求其通知即可。

新增訂單(訂單)
{
    處理訂單商業邏輯(訂單)

    訂單資料存取服務.儲存訂單() // 可能由資料存取層或連線管理等該職責的地方去實現

    通知服務.寄送訂單通知(訂單.訂購人編號)
}

處理訂單商業邏輯(訂單)
{
   // 專注在處理商業邏輯,不用管其他事
}

// 其他的職責拆分出去給負責該工作的類別
通知服務 { 寄送訂單通知(編號); }
訂單資料存取服務 { 儲存訂單(); }

我們把工作交給負責該職責的類別去做,自己只需要關注在自己正在處理的職責即可。聰明的朋友可能已經注意到了,這就是封裝的體現。封裝得夠舒服,我們就能舒服地處理自己的事情就好,這就是分工合作的偉大呀。

(2022-01-23) 補充:

前面提到的「職責」的部分,雖然我們前面提過了是「引起變化的原因」,但可能還是太過模糊,畢竟咱們工程師真的最愛戰定義了嘛。

影片中用實例來說明什麼時候該切分職責和其重點,例如 「業務耦合造成的問題就是職責不明確」、「不要讓類別去碰它不該做的事情等等」 ,我個人覺得非常不錯,推薦給想更了解單一職責原則或 SOLID 的朋友

雖然文章中的例子相對簡單。但有一個部份我個人覺得要特別注意:單一職責當然也可以用在函式上。甚至資料表或任何需要管理、分類抽象事物的東西上。

既然是封裝邏輯這種抽象的東西,必然也會有其職責,自然也得好好注意單一職責囉。

走向單一職責

我們可以從上面的差別重新思考,遵守與不遵守單一職責原則會有哪些顯著的差異。

當我們並未遵守單一職責原則時,同個類別裡面充斥著不同工作的處理邏輯。也就是不健康的內聚:完全不夠聚,就只是盤散沙。

  • 容易產生意外的重複。每個類別每個方法都自己去查詢會員資料,當查詢會員資料的方式或規則有變更的時候,影響範圍就會非常大,同樣的事情有一大堆地方要改,還得要先全部找出來,想到就頭痛。

  • 同時我們在修改時也無法界定邊界,無法確定這次修改影響到的範圍,我們並不知道這些放在一起的東西,或是同一段做的所有事之間是否會相互影響,這將導致每次修改的時候都在挑戰我們自己的心臟負荷量,讓維護變成試膽大會,類別變成危樓改建。

  • 承上,我們為了要確保修改沒有問題,我們必須大量閱讀不相關的程式碼,無形中造成開發負擔,降低開發效率。

如果你曾經有閱讀別人的程式碼,卻始終看不懂這東西到底在幹嘛,每分鐘髒話數筆直上升的經驗。答應我,我們不要讓別人經歷相同的悲劇,我們要斬斷仇恨的鎖鏈。我們,今天就開始走向單一職責。

當我們終於選擇單一職責,我們的類別才能真的擁有健康的高內聚。以上的這些問題,也都變成:

  • 每個類別都專注在自己職責上,需要這個功能的其他類別就能來使用。大大提高了程式碼的重複使用程度,同時也降低了程式碼的重複性。並且因為類別內都是朝同樣職責前進的成員,彼此關聯性相當高,因此也提高了內聚。這兩點讓我們能迴避掉「要改的地方太多了,就改天吧」的悲傷結局。

  • 同時,當我們要修改時,只需要找到負責的類別修改。因為已經把不屬於職責的工作交給其他類別了,達到了封裝和隔離,所以我們就能輕鬆看出修改的區域和邏輯,並較少地被不相干的東西影響、馬上掌握修改的目標和影響範圍,使得架構和類別更容易管理。也就是說,單一職責可以達到降低耦合的效果。

展現你的意圖

寫程式也是如此,如果你的類別或方法裡什麼都要,彼此間又甚無關連,那就沒人看得懂這到底是幹嘛的。

如果團隊的其他人不能瞭解這個類別的職責,那後續協助修改的時候就會沒辦法把相同工作的程式碼歸類在一起,甚至難以修改,做起事綁手綁腳,新增個方法都會陷入混亂。整個架構就會開始腐敗。這也就是為什麼我們需要保持程式碼的可讀性,並且盡力實踐單一職責。

如同我在先問為什麼文中所引用的「你的一言一行,都要能證明你的信念」。在這裡,你的類別、方法,甚至是程式碼中的每一區塊,都必須要能夠展現你的意圖。

因此,單一職責不只能用來檢驗類別。從一整個服務,到單一個函式,都可以用它的意圖來問問自己。這一段是否只有一個職責?是否只有一個原因造成改變?職責是否清晰?

當然,從模組到函式每一層級的抽象概念是不一樣的,模組有模組關注的點,函式有函式關注的點,其規模有所差異,請不要用函式的職責大小去要求整個類別,我個人覺得這中間的差異還是挺吃經驗的,但不去嘗試思考,就沒得經驗可說嘛。這邊還是鼓勵大家多多利用單一職責去檢驗任何片段的程式碼。

當我們利用單一職責原則去檢驗,或是思考方向的時候,如果列得出兩項以上的變更原因,且這些原因彼此關聯很薄弱的時候,就是警訊。

反過來說,即使有兩個原因引起變化,但這些原因之間的關聯很強,例如總是一起變化,那其實就不必分離,或是可以暫緩分離,避免過度設計所引起的不必要的複雜性。(白話文來說就是走火入魔)

如果能做到撰寫功能當下,或是重構的時候不斷自我檢驗,那寫出來的程式碼品質相信也能展現出一定的水準了吧!共勉之。

本文整理時主要參考了這兩篇,寫得相當不錯,想更瞭解的朋友可以參考一下:

看到這篇覺得很不錯,從另一個角度切入單一職責,回來補充給各位朋友:

參考資料

同系列文章

其他文章

「。乾脆你全部放一起,然後說是負責網站管理算了,呵」

有些朋友可能會有疑問,這樣不就會和會員處理類別、通知管理類別之類的其他類別有了耦合關係嗎?有這樣的疑問是很合理的,這也就是為什麼我們會需要介面來讓類別之間不要直接彼此依賴,這部份我們在 有詳細介紹。

今天在群組裡有前輩分享了講解單一職責原則的影片:,其中單一職責的部份,將前述的「引起變化」從業務需求變更的方式切入

有些朋友可能跟我前陣子一樣,覺得函式就是用來消除重複的程式碼,直到我看了 和一句「難道只有重複才需要做成 Function 嗎?」才明白:函式真正的工作其實是封裝邏輯。

單一職責讓我想到前陣子看的中的芹菜測試:當你在超市結帳時,手上拿著巧克力、豆漿、餅乾跟芹菜,沒有人看得出來你到底要幹嘛。

本系列下一篇:

Ch3. 拍攝UFO --單一職責原則

Ch.7 SRP --單一職責原則

Ch.8 SRP --單一職責原則

OSSO
介面
Fred 聊聊 SOLID 設計原則
可不可以不要寫糙 code
《先問為什麼》
再談物件導向設計原則: 單一職責原則,定義、解析與實踐 - WadeHuang的學習迷航記
深入淺出單一職責原則 Single Responsibility Principle - jyt0532’s Blog
工程師的簡單觀念 – Ruddy Lee 分享空間 (wordpress.com)
菜雞與物件導向 (11): 開放封閉原則
再談物件導向設計原則: 單一職責原則,定義、解析與實踐 - WadeHuang的學習迷航記
SOLID 之 單一職責原則(Single responsibility principle)- Miles - iT邦幫忙
深入淺出單一職責原則 Single Responsibility Principle - jyt0532’s Blog
Fred 聊聊 SOLID 設計原則
Object Oriented 物件導向設計原則 SOLID-1:Single Responsibility Principle(SRP) 單一職責 - Sian
SOLID-I 單一職責原則(Single Responsibility Principle) - 黃子源 - Medium
《大話設計模式》
《無瑕的程式碼:整潔的軟體設計與架構篇》
《無瑕的程式碼:物件導向原則、設計模式與C#實踐》
菜雞與物件導向 (0): 前言
菜雞與物件導向 (1): 類別、物件
菜雞與物件導向 (2): 建構式、多載
菜雞與物件導向 (3): 封裝
菜雞與物件導向 (4): 繼承
菜雞與物件導向 (5): 多型
菜雞與物件導向 (6): 抽象、覆寫
菜雞與物件導向 (7): 介面
菜雞與物件導向 (8): 內聚、耦合
菜雞與物件導向 (9): SOLID
菜雞與物件導向 (10): 單一職責原則
菜雞與物件導向 (11): 開放封閉原則
菜雞與物件導向 (12): 里氏替換原則
菜雞與物件導向 (13): 介面隔離原則
菜雞與物件導向 (14): 依賴反轉原則
菜雞與物件導向 (15): 最少知識原則
菜雞與物件導向 (Ex1): 小結
菜雞與物件導向 (9): SOLID
菜雞與物件導向 (8): 內聚、耦合
菜雞與物件導向 (7): 介面
菜雞與物件導向 (6): 抽象、覆寫
菜雞與物件導向 (5): 多型
內聚和耦合