[Study][CleanCode - 1] 1. 깨끗한 코드

📋 목차.

0. 들어가면서
    .5S 원칙

1. 깨끗한 코드
    .르블랑의 법칙
    .깨끗한/나쁜 코드란
    .단순 코드 규칙 구현의 중요 순서
    .중복 제거와 표현력에 집중하기 위한 아이디어
    .작게 추상화 하기
    .보이스카우트 규칙

---

✔️ 내용.

 

0. 들어가면서

 

• 대다수의 프로그래머의 활동은 80% 이상이 유지보수라고 볼 수 있다. 
• 유지보수에 초점을 맞춘 TPM(Total Productive Management) 품질 관리론이 등장하게 되었는데 TPM을 지탱하는 기둥 하나인 5S 원칙은 다음과 같다.

 

원칙	내용
정리(Seiri) or 조직(정렬(Sort))	적절한 명명법 등과 같은 방법을 사용해 무엇이 어디에 있는지 알아야 한다.
정돈(Seidon) or 단정함(체계화)	코드는 누구나 예상하는 위치에 있어야 한다. 그렇지 않으면 다시 정돈해 누구나 예상하는 위치로 옮겨야 한다.
청소(Seisoh) or 정리(광내기)	과거 이력이나 미래 바람을 기억한 주석 혹은 주석으로 처리한 코드는 제거한다.
청결(Seiketsu) or 표준화	그룹 내에서 일관적인 구현 스타일과 기법의 필요성을 가진다.
생활화(Shitsuke) or 규율	관례를 따르고, 자기 작품을 자주 돌아보고, 기꺼이 변경하는 규율을 뜻한다.

 

• 애자일이 추구하는 핵심적인 가치 
  • 코드에 정직하고
  • 코드의 상태에 관해 동료들에게 정직하고
  • 자기 코드에 대해 자신에게 정직하라. 

 

• 아키텍처도, 깨끗한 코드도, 완벽을 주장하지는 않는다. 단지 최선을 다해 정직하라 요구할 뿐이다.

---

 

1. 깨끗한 코드

 

르블랑의 법칙
나중은 결코 오지 않는다.

 나쁜 코드를 작성 후 '나중에 다시 돌아와 정리하겠다.' 라는 생각을 많이 하지만 돌아오지 않는 경우가 대다수였다.

기한을 맞추기 위해 나쁜 코드를 양산하게 된다. 하지만 진짜 전문가는 나쁜 코드를 양산하면 기한을 맞추지 못하게 되리라는 것을 알고 있다.

 기한을 맞추는 유일한 방법 즉, 빨리가는 방법은 언제나 코드를 최대한 깨끗하게 유지하는 습관이다.

 

---

 

.깨끗한 코드

 

 

 깨끗한 코드를 작성하려면 '청결'이라는 힘겹게 습득한 감각을 활용해 자잘한 기법들을 적용하는 절제와 규율이 필요하다.

• '코드 감각' 이 없는 프로그래머는 때로는 나쁜 모듈을 알아본다. 하지만 그것으로 끝이다.
• '코드 감각' 이 있는 프로그래머는 나쁜 모듈을 보면 좋은 모듈로 개선할 방안을 떠올린다.

 

.깨끗한 코드란

• 세세한 사항까지 꼼꼼하게 처리하는 코드
• 한 가지를 잘하는 코드. 한 가지에 '집중' 한다
• 잘 쓴 문장처럼 읽혀야 한다.
• 작성자가 아닌 다른 사람도 읽기 쉽고 고치기 쉽다.
• 단위 테스트 케이스와 인수 테스트 케이스가 존재한다.
• 의미 있는 이름으로 작성된다.
• 특정 목적을 달성하는 방법을 여러가지가 아닌 하나만 제공한다.
• 의존성은 최소이며 각 의존성을 명확히 정의한다.
• 추측이 아닌 사실에 기반한 코드로, 반드시 필요한 내용만 담겨있다.
• 즉, 누군가 시간을 들여 깔끔하고 단정하게 정리한 주의 깊게 작성한 코드

 

.나쁜 코드란

• 너무 많은 일을 하려 애쓰다 의도가 뒤섞이고 목적이 흐려진 코드

 

---

 

.단순 코드 규칙 구현의 중요 순서

 

1. 모든 테스트를 통과한다.
2. 중복이 없다.
3. 시스템 내 모든 설계 아이디어를 표현한다.
4. 클래스, 메서드, 함수 등을 최대한 줄인다.

---

 

.중복 제거와 표현력에 집중하기 위한 아이디어

 

• 객체가 여러 기능을 수행한다면 여러 객체로 나눈다.
• 메서드가 여러 기능을 수행한다면 메서드 추출(Extract Method) 리펙터링 기법을 적용한다
  • 메서드 추출(ExtractMethod) 사용 -> 기능을 명확히 기술하는 메서드 하나와 기능을 실제로 수행하는 메서드 여러개로 나눈다.

 

 중복과 표현력만 신경 써도 깨끗한 코드라는 목표에 다가설 수 있다.

 

---

 

.작게 추상화 하기

 

 모든 프로그램이 아주 유사한 요소로 이루어진다.

예로 '집합에서 항목 찾기'의 경우 Key/Value의 맵이든, 배열 등의 집합에서 항목 찾기를 자주 접하게 된다.

이러한 상황에서 추상 메서드나 추상 클래스를 만들어 실제 구현을 감싸게 되면 여러가지 장점이 생긴다.

 

• 다른 코드는 추상 클래스나 추상 메서드가 제공하는 기능을 사용하므로 실제 구현은 언제든지 바꿔도 괜찮다.
• 집합 기능을 구현할 필요가 없어지므로 '진짜' 문제에 신경 쓸 여유가 생긴다.

---

보이스카우트 규칙
캠프장은 처음 왔을 때보다 더 깨끗하게 해 놓고 떠나라.

 체크아웃할 때보다 좀 더 깨끗한 코드를 체크인한다면 코드는 절대 나빠지지 않는다.

한꺼번에 많은 시간과 노력을 투자에 정리할 필요가 없다. 간단한 정리로도 충분하다.

• 변수 이름 하나 개선
• 조금 긴 함수 하나 분할
• 약간의 중복 제거
• 복잡한 if문 하나 정리

 

지속 적인 개선으로 깨끗한 코드의 유지가 가능할 것이다.

---

📝 느낀점.

- 나쁜 코드를 만들며 코드 개선을 나중으로 미루지 않고 언제나 깨끗한 코드를 유지하기 하도록 노력한다.
- 한 번에 많은 것을 개선하려 하기보다는 작은 것을 꾸준히 이루어 나가자.