[CleanCode] 01. 깨끗한 코드 & 의미 있는 이름

01. 나쁜코드

 1) 나쁜 코드란 ?

 - 성능이 나쁜코드 : 불필요한 연산이 들어가서 개선의 여지가 있는 코드.

 - 의미가 모호한 코드 : 이해하기 어려운 코드. 네이밍과 그 내용이 다른 코드.

 - 중복된 코드 : 비슷한 내용인데 중복되는 코드들은 버그를 낳는다.

 

2) 깨진 유리창 법칙

 - 깨진 유리창을 그대로 두면, 그 곳에 쓰레기를 버리고 낙서를 하고 점점 범죄의 현장이됨.

 - 나쁜 코드는 깨진 유리창 처럼 계속 나쁜 코드가 만들어지도록 한다.

 

3) 나쁜 코드가 나쁜 이유 ?

 - 생산성 저하 : 나쁜 코드는 팀 생산성을 저하 시킴. 기술부채를 만들어 수정을 더 어렵게함.

 - 새로운 시스템을 만들어야함 : 현 시스템을 유지보수하며 대체할 새로운 시스템 개발은 현실적으로 매우 어려움.

 

4) 나쁜 코드를 짜는 이유 ?

 - 일정이 촉박 : 일정 안에 새로운 기능을 완성해야함.

 But, 나쁜 코드는 생산성을 저하하기 때문에 오히려 일정을 못맞춤.

→ ex) 현 차세대 개발..

 

- 영향 범위가 넓어서 : 생각보다 영향범위가 넓어서 건드렸다가 다른 부분에 버그가 발생할까봐.

 But, 기술부채는 부메랑처럼 우리에게 돌아옴.

 

02. 클린코드

- 성능이 좋은 코드

- 의미가 명확한 코드 = 가독성이 좋은 코드

- 중복이 제거된 코드 

- 보이스카우트 룰 : 내가 오기 전보다 더 깨끗한 코드로 만든다.

나는 우아하고 효율적인 코드를 좋아한다.
논리가 간단해야 버그가 숨어들지 못한다.
의존성을 최대한 줄여야 유지보수가 쉬워진다.
오류는 명백한 전략에 의거해 철저히 처리한다.
성능을 최적으로 유지해야 사람들이 원칙없는 최적화로 코드를 망치려는 유혹에 빠지지 않는다.
깨끗한 코드는 한 가지를 제대로 한다. (SRP - 단일 책임 원칙)

- 비야네 스트롭스트룹(C++창시자)

깨끗한 코드는 단순하고 직접적이다.
깨끗한 코드는 잘 쓴 문장처럼 읽힌다.
깨끗한 코드는 결코 설계자의 의도를 숨기지 않는다.
오히려 명쾌한 추상화와 단순한 제어문으로 가득하가.

- 그래디 부치(객체지향의 대가)

 

03. 의미있는 이름 짓기

1) 의미가 분명한 이름 짓기

- 구체적인 내용을 넣어서 변수의 이름을 지어줌.

- 클래스를 사용해서 의미를 더 명확하게 묶어줌.

int a;
String b;

System.out.printf("User Requested %s. count = "%d", b, a);

int itemCount;
String itemName;

System.out.printf("User Requested %s. count = "%d", itemName, itemCount);

class SalesItem {
	ItemCode code;
    String name;
    int count;
}

SalesItem selectedItem = SalesItemRepository.getItemByCode(purchaseRequest.getItemCode());
System.out.printf("User Requested %s. count = %d",
					selectedItem.getName(), selectedItem.getCount());

 

2) 루프 속 i, j, k 사용하지 않기

 - 배열을 순회할때 index를 의미하는 i를 사용하지 않고 advanced for 문으로 대체할 수 있음.

 - i,j -> row, col / width, height

 - i,j,k -> row, col, depth

for (int i = 0; i < messages.size(); i++) {
	//...
}

for (String message : messages) {
	//..
}

//java8 lamda 사용
messages.stream().forEach(
	message -> //..
)

 

3) 통일성 있는 단어 사용하기

 - Member / Customer / User

 - Service / Manager

 - Repository / Dao

 

4) 변수명에 타입 넣지 않기

 - String nameString -> name

 - Int itemPriceAmount -> itemPrice

 - Account[] accountArray -> accounts

 - List<Account> accountList -> accounts, accountList

 - Map<Account> accountMap -> accountMap  (Map은 대체할만할 말이 딱히 없어서 씀)

 - public interface IShapeFactory -> ShapeFactory

 - public class ShapeFactoryImpl -> CircleFactory (명확하게 이름을 지어줌 - 팀에서 정한 방향으로)

 

04. Google Java Naming Guide

01) Google github 스타일 가이드

https://google.github.io/styleguide/javaguide.html#s5-naming

Google Java Style Guide

 

 

02) Package Naming Guide - 패키지 이름

 - All lower case, no underscores : 전부 소문자로 쓰고 _ 도 붙이지 마라

com.example.deepspace (ㅇ)
com.example.deppSpace ( x )
com.example.depp_space ( x )

 

 

03) Class Naming Guide - 클래스 이름

 - UpperCamelCase : 대문자로 시작

// 클래스는 명사, 명사구
Character, ImmutableList

//인터페이스는 명사, 명사구, (형용사)
List, Readable

//테스트 클래스는 Test로 끝나기
HashTest, HashIntegrationTest

 

 

04) Method Naming Guide - 메소드 이름

 - LowerCamelCase : 소문자로 시작

//메서드는 동사, 동사구로 시작
sendMessage, stop

// jUnit 테스트에 underscore 사용되기도 함
// <methodUnderTest>_<state> 패턴
pop_emptyStack

 

References

 zero-base 한달한권 CleanCode