Clean Code - 為什麼要看Clean Code?

-

Total Productive Maintenance, TPM (全面生產維護)

在過往日本泡沫前就是依照了TPM的概念讓工廠的產能大幅領先美國，而為什麼我們要提到TPM呢?

在過往的工廠都是有訂單就趕快用土法煉鋼的方式改裝目前的產線與機器為了能產出客戶需要的產品。在這樣的情況下，整個工廠的運作機制其實已經變成渾沌狀態，因為頻繁改變的情形下當產線掛掉停擺時要花許多時間去找到原因，而日本提出了TPM的概念後將工廠變得井然有序進而超越了美國，所以才有豐田生產管理等等專們以日本企業命名的工廠管理方法出現。

而現在的軟體設計其實也是一樣的道理，軟體迭代速度越來越快，如果開發人員只顧著往前衝刺不斷地改變，如果缺乏了有效的管理以及人員的紀律，那就可能像是滾雪球一般造成雪崩也說不定。相同類型的故事也可以透過鳳凰專案這本書一窺究竟。

回歸正題，Clean Code裡面提到的概念與方法其實就是TPM中的5S原則

5S (日語)

  • Seiri (整理) - 好好地整理每個方法和class的命名，這樣才能讓每個團隊成員明確的知道問題在哪
  • Seiton (整頓) - 一段程式碼他應該出現在你所期待他出現的地方，如果不是那就是要重構了
  • Seiso (清掃) - 刪除那些根本沒意義的註解還有程式碼吧，讓程式碼們更好閱讀
  • Seiketsu (清潔) - 每天都要讓自己的工作環境標準化更清潔，讓每個成員的程式碼都用上check style吧
  • Shutsuke (身美) - 這也是最重要的一點，其實就是自律與反省，好好誠實的面對以前自己寫的程式碼吧

若是每次工作時都有好好遵從這5S原則，那未來產品業務大爆發或是要開發更前衛的功能時，你偷偷藏起來的雪球才不會造成雪崩讓產品一夕崩潰。

那接下來就會是我一系列的Clean Code文章(讀書心得)，其實這本書我已經看過兩次，一次是碩士還在讀書時一次是工作第一年的時候，第一次看的時候其實可以說是完全看不懂(哈哈)，內心想的都是為什麼要搞那麼麻煩?而第二次看的時候開始有感覺了，因為自己寫的程式碼也開始要接受挑戰已經被其他同事的程式碼挑戰，但是還是有些不得要領的地方，而這一次我決定要改變讀書行為，每到一個段落就記錄與分享，希望自己可以到另一個境界。

留言

張貼留言

這個網誌中的熱門文章

Java Lambda Map篇

-
目的 主要介紹Map中的新方法，包含如下 forEach() getOrDefault() putIfAbsent() remove() replace() replaceAll() merge() 有些是Lambda有些則是我覺得比以前使用Map更方便而介紹 forEach Map的forEach方法與List不大依樣，因為Map主要的迭代方法是以Entry為主，所以需要Key-Value Pair去迭代 原始碼解說 可以看到forEach的傳入參數BiConsumer介面，必須傳入Key與Val，裡面的實作就如同我們使用Java8版本以前的寫法，需要使用for迴圈去迭代抓出每個Value 原始碼 default void forEach(BiConsumer<? super K, ? super V> action) { Objects.requireNonNull(action); for (Map.Entry<K, V> entry : entrySet()) { K k; V v; try { k = entry.getKey(); v = entry.getValue(); } catch(IllegalStateException ise) { // this usually means the entry is no longer in the map. throw new ConcurrentModificationException(ise); } action.accept(k, v); } } 範例 private void forEachExample() { Map<Integer, String> map = new HashMap<>(); map.put(1, "test1"); map.put(2, "test2"); m
閱讀完整內容

(InterviewBit) System Design - Design Cache System

-
圖片
前言 這是InterviewBit中Storage Scalabiliy第一題，設計一個快取系統。 我希望可以透過InterviewBit中的文章與題目，打開自己系統設計的視野，並且重裡面中得到關鍵詞彙，透過這些關鍵詞彙補足自己知識的不足。 其中會參考許多 jyt0532神 的許多文章 題目 替Twitter或是google設計快取系統，概念圖如下: 分析步驟 列出需求情境 估算 立定設計目標 深入探討設計方法 需求情境 需要多大的快取 我們的快取清除策略要如何 因為快取大小所以必須將舊資料刪掉 快取的寫入策略 Write through cache 當資料寫入時，同時寫入DB和Cache中 寫入因為需要寫入兩個系統(DB/Cache)所以有較高的延遲 Write around cache 當資料寫入時先寫入DB，當快取被讀取發現遺失資料時，再將資料從DB同步到快取中 因為讀取是從快取中讀取，但是在讀取時判斷到有新增資料沒進入快取，會有較高的讀延遲。 但寫和重複讀不會有特別的延遲 Write back cache 直接將資料寫入到快取中，在同步到資料庫裡 風險 - 畢竟快取是in-memory會有遺失風險 優點 - 高寫入效率(寫得快可附合的流量大) 可以透過replica快取降低memory消失的風險 評估 預先知識 QPS - Queries Per Second TPS - Transactions Per Second UV - Unique Visitor RPS - Requests Per Secornd 獲取設計前條件 目前得知的條件 快取大小會是30TB QPS會是10M(每秒一千萬) 估算機器數量 假設我們每台機器都有72G的記憶體，則要存入30TB的資料則需要 30TB / 72G = 420(大約)，而這是剛剛好的數目，有可能需要增加，因為我們每秒要附和10M的搜尋流量。 設計目標 設計目標三巨頭 Latency(延遲) Consistency(一致性) Availability(可使用性) 快取系統的設計目標 快取的用意就在於降低延遲，DB的寫入是依靠硬碟的而快取是依靠記憶體，有基本計算機常識的話就可以知道
閱讀完整內容

設計模式 - 享元模式 (Structural Patterns - Flyweight Design Pattern)

-
圖片
前言 甚麼是Flyweight Pattern? 幫助你節省記憶體開銷 透過共享物件的方式 最常見的例子 String : 每次新增一個String的時候，都會將String丟進String pool，再讓物件指向這個String memory。 String str1 = "test"; String str2 = "test"; System.out.println(str1 == str2) // true 實踐方式 撰寫Flyweight介面與物件 撰寫Flyweight工廠(主要節省記憶體邏輯在此)，負責管理和創建Flyweight 類別圖 範例 我們可以思考一下，在英雄遊戲中有那些東西可以使用享元模式。 重複製造 同物件的性質一樣 我想武器添加物系統可以使用享元模式，因為武器中插的寶石不管插在哪種類的武器裡，他們的功效都是一樣的，而如果為每把武器都創建新的寶石物件，那太消耗記憶體了。 程式行為 為武器加上寶石 若是已經存在的寶石則不在new 物件 透過DiamondFactory去控制要不要new新物件的邏輯 import java.util.ArrayList; import java.util.HashMap; import java.util.Map; abstract class Weapon { ArrayList<Diamond> diamonds = new ArrayList<>(); public void addDiamond(Diamond diamond) { diamonds.add(diamond); } abstract void attack(); } class Sword extends Weapon { @Override void attack() { System.out.println("Sword attack"); diamonds.forEach((x) -> { System.out.println("Use "
閱讀完整內容