[Clean Code] Clean Code & Meaningful Names

정리한 내용 중 잘못된 내용이 있을 수 있습니다. 잘못된 내용이 있다면 꼭 알려주세요.

01.나쁜코드

나쁜 코드란 무엇일까?

성능이 나쁜 코드

• 불필요한 연산이 들어가서 개선의 여지가 있는 코드

의미가 모호한 코드

• 이해하기 어려운 코드 네이밍과 그 내용이 다른 코드

중복된 코드

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

나쁜 코드가 나쁜 이유

1.깨진 유리창 법칙

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

2.생산성 저하

나쁜 코드는 팀 생산성을 저하시킨다. 기술부채를 만들어 수정을 더 어렵게 한다.

3.새로운 시스템을 만들어야 한다.

현시스템을 유지보수하며 대체할 새로운 시스템 개발은 현실적으로 매우 어렵다.

나쁜 코드를 짜는 이유

1.일정이 촉박해서

일정 안에 새로운 기능을 완성해야하기 때문에 나쁜코드를 짜게 된다.
하지만 나쁜 코드는 생산성을 저하하기 때문에 오히려 일정을 맞추기 어려워진다.

2.영향 범위가 넓어서

생각보다 영향 범위가 넓어서 건드렸다가 다른 부분에 버그가 발생할까봐
하지만 기술부채는 부메랑처럼 우리에게 돌아온다.

02.클린코드

책에 여러 사람들이 자신이 생각하는 클린코드에 대한 의견을 다룬 부분이 있다.
그중에 몇가지만 살펴보자면

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

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

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

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

그래서 클린코드를 3가지로 표현해보자면

1.성능이 좋은 코드

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

3.중복이 제거된 코드

라고 얘기해볼 수 있을 것 같다.

책 속에 저자가 언급한 이야기 중 보이스카우트 원칙(The Boy Scout Rule)이 나온다.

보이스카우트 원칙(The Boy Scout Rule) 이란?

보이스카우트가 오기 전보다 돌아갈 때 그 자리를 더 깨끗하게 한다는 규칙. 소프트웨어 개발에서는 모듈을 체크인 할 때, 반드시 체크아웃할 때 보다 아름답게 한다는 규칙을 의미한다.

03.의미 있는 이름 짓기

03-1.의미가 분명한 이름 짓기

int a;
String b;

//..

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

위 코드처럼 의미 없이 변수명을 사용하지 말아야 한다.
아래 코드처럼 구체적으로 내용으로 변수를 지어주어야 한다.

int itemCount;
String itemName;

//..

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

더 나아가 아래와 같이 클래스를 사용한다면 의미에 맞게 사용할 수 있다

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

//..

SalesItem salectedItem = salesItemRepository.getItemByCode(purchaseRequest.getItemCode())

System.out.printf("User Requested %s. count = %d",
				selectedItem.getName(), selectedItem.getCount());

03-2.루프 속 ijk 사용하지 않기

i를 사용하지 않을 수 있다.

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

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

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

messages.stream().forEach(
	message -> //..
)

또한 i,j,k 대신 맥락에 맞는 의미를 찾아서 사용한다.

i,j -> row, col / width, height
i,j,k -> roe, col, depth

03-3.통일성 있는 단어 사용하기

똑같은 의미에 대해서는 똑같은 단어를 사용하는것은 중요하다.

흔히 비슷비슷한 단어는 아래와 같다.

Member / Customer / User
Service / Manager
Repository / Dao

같은의미가 있는 단어를 여러 단어로 사용할 경우 혼란을 야기할 수 있다.

03-4.변수명에 타입 넣지 않기

String nameString(👎🏻) -> name
int itemPriceAmount(👎🏻) -> itemPrice

Account[] accountArray(👎🏻) -> accounts
List<Account> accountList(👌🏻) -> accounts, accountList
Map<Account> accountMap(👌🏻)

public interface IshapeFactory(👎🏻) -> ShapeFactory
public class ShapeFactoryImpl(🔺) -> CircleFactory

03-5.Google Java Naming Guide

https://google.github.io/styleguide/javaguide.html

Package Naming Guide

All lower case, no underscores

com.example.deepspace(👍🏻)
com.example.deepSpace(👍🏻)
com.example.deep_space(👎🏻)

Class Naming Guide

UpperCamelCase(대문자로 시작)

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

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

// 테스트 클래스는 Test로 끝나기
HaseTest, HashIntegerationTest

Mathod Naming Guide

LowerCamelCase(소문자로 시작)

// 메서드는 동사, 동사구
sendMessage, stop

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