클린 코드 8대 규칙

개요

이번에는 제가 추구하는 덕목 중 하나인 클린 코드의 8대 규칙을 알아보겠습니다.

1. 객체 생성에도 유의미한 이름을 사용하라

잘못된 예시입니다. 이는 두 번째 인자가 어떤 값을 나타내는지 파악하기 어렵기 때문입니다.

Product product = new Product("사과", 10000);

이는 다음과 같이 변경할 수 있습니다.

Product product = Product.withPrice("사과", 10000);

2. 비즈니스 로직을 담는 변수 명을 사용하라

프로젝트를 하다보면 매개변수의 값들을 하나의 객체에 담는 경우가 많습니다. 특히나 새로운 유저 정보를 받아 이를 저장할 때 다음과 같은 코드를 사용하는데요.

User user = new User(userId, username);
userRepository.save(user);

이는 다음과 같이 변경할 수 있습니다.

User newUser = new User(userId, username);

3. 메소드는 하나의 역할만 해야한다.

예를 들어, 입력된 숫자들의 합과 곱을 출력하는 기능을 만들고자 합니다. 이 때, 다음과 같은 코드는 두 역할을 동시에 수행하고 있습니다.

public void SumAndMultiply(int num1, int num2){
	System.out.println(num1 + num2);
	System.out.println(num1 * num2);
}

이는 로직을 각각 따로 분리하여 구현하는 것이 좋습니다.

public void printSum(int num1, int num2);
public void printMultiply(int num1, int num2);

4. for 문을 사용하지 않는다 (Stream 메소드로 대체)

5. if 문을 중첩해서 사용하지 않는다

6. return을 사용하지 않는다

이는 early return을 사용하여 해결가능합니다.

예를 들어 다음과 같은 코드는

if (a == 0)
	...
else 
	...

early return을 사용하여 다음과 같이 표현 가능합니다.

if (a == 0){
	...
	return
}
return 

7. 의미를 파악하기 힘든 어려운 숫자를 사용하지 않는다

readFeed(20);

위 코드 보다는 다음과 같이 상수를 사용하여 표현하는 것이 바람직합니다.

static final int FEED_SIZE = 20;
readFeed(FEED_SIZE);

8 한 줄에 120자 까지만 허용한다.