[Nomad Coders Challenge] Clean Code - Assignment #13

 

📍 It is part of a book club challenge on a programming learning website called Nomad Coders. The challenge is to demonstrate what I have learned after reading Clean Code by Robert C. Martin.

 

📝 It will consist of the following sections over three weeks: the range of reading, the top quotes from the book, my review, and remaining questions. 

  🔗Challenge Schedule

---

💻 I plan to read Clean Code in JavaScript and Python, referring to the GitHub repositories shared by Nomad Coders with the challengers.

 

Assignment #13

• 📚 Chapter 10. Classes (Jeff Langr)
• ✔️ TIL 
  • Top quotes from the book
  • Case study in Python
  • Remaining questions

---

 

📝 Top quotes from the book

• 클래스는 작아야 한다.
  • 클래스를 설계할 때도, 함수와 마찬가지로 '작게' - 클래스가 맡은 책임이 적게
  • 클래스 설명 - if, and, or, but 사용 없이, 25단어 내외로 가능해야 한다. 
  • Single Responsibility Principle(단일 책임 원칙, SRP): 클래스나 모듈을 변경할 이유가 단 하나뿐이어야 한다.
    • Robert C. Martin writes: A class should have only one reason to change.
    • 작은 클래스가 많은 시스템이든 큰 클래스가 몇 개뿐인 시스템이든 돌아가는 부품은 그 수가 비슷하다. 어느 시스템이든 익힐 내용은 그 양이 비슷하다. "도구 상자를 어떻게 관리하고 싶은가? 작은 서랍을 많이 두고 기능과 이름이 명확한 컴포넌트를 나눠 넣고 싶은가? 아니면 큰 서랍 몇 개를 두고 모두를 던져 넣고 싶은가?"
  • Cohension(응집도): 클래스는 인스턴스 변수 수가 작아야 한다. 메서드 변수가 많을 수록 메서드와 클래스의 응집도가 높다. 응집도가 높은 클래스는 바람직하지 않다. 그렇지만 응집도가 높은 클래스를 선호한다. 클래스의 속한 메서드와 변수가 서로 의존하며 논리적인 단위로 묶이기 때문. '함수를 작게, 매개변수 목록을 짧게' -> 인스턴스 변수가 많아진다. -> 새로운 클래스로 쪼개야 한다는 신호다. 
  • OCP(Open-Closed Principle) - 객체 지향 설계에서 핵심 원칙 중 하나. 클래스는 확장에 개방적이고 수정에 폐쇄적이어야 한다는 원칙
    • “Incorporate new features by extending the system, not by making modifications (to it)”, Uncle Bob.  
    • 깨끗한 시스템은 클래스를 체계적으로 정리해 변경에 수반하는 위험을 낮춘다.

      

      위 코드는, 새로운 SQL문을 지원하하거나 기본 SQL문 하나를 수정할 때 sql 클래스를 고쳐야 하므로, 변경할 이유가 두 가지 -> SRP( Single Responsibility Principle, 단일책임원칙)을 위반한다. 
      

      

      - 공개 인터페이스를 -> sql 클래스에서 파생하는 클래스로 변경
      - 비공개 메서드 -> 해당 파생 클래스로 이동- 모든 파생 클래스에 공통되는 비공개 메서드 -> 유틸리티 클래스로 이동 
    • 함수 하나를 수정하더라도, 다른 함수가 망가질 위험이 사라짐. 클래스가 서로 분리되었기 때문. 
  • Dependency Inversion Principle(DIP): 클래스가 상세한 구현이 아니라 추상화에 의존해야 한다
    • 추상화로 - 실제로 주가를 얻어오는 출처, 얻어오는 방식 등의 구체적인 사실을 숨긴다.  
    • 최소 결합도: 각 시스템 요소가 다른 요소로부터, 변경으로부터 잘 격리되어 있다는 의미. 잘 격리될수록 요소를 이해하기 쉽다. 

 

🕵  Case study in Python based on @zedr 's Clean Code Python GitHub repository

• Single Responsibility Principle (SRP)

 

 

 

🔍 Remaining questions

• OCP(Open-Closed Principle) - 객체 지향 설계에서 핵심 원칙 중 하나. 클래스는 확장에 개방적이고 수정에 폐쇄적이어야 한다는 원칙