이 블로그 글은 박우빈님의 인프런 강의: Readable Code: 읽기 좋은 코드를 작성하는 사고법
를 참조하여 작성한 글입니다.

1. 아래 코드와 설명을 보고, [섹션 3. 논리, 사고의 흐름]에서 이야기하는 내용을 중심으로 읽기 좋은 코드로 리팩토링해 봅시다.

AS-IS

public boolean validateOrder(Order order) {
    if (order.getItems().size() == 0) {
        log.info("주문 항목이 없습니다.");
        return false;
    } else {
        if (order.getTotalPrice() > 0) {
            if (!order.hasCustomerInfo()) {
                log.info("사용자 정보가 없습니다.");
                return false;
            } else {
                return true;
            }
        } else if (!(order.getTotalPrice() > 0)) {
            log.info("올바르지 않은 총 가격입니다.");
            return false;
        }
    }
    return true;
}

Readable 하지 못한 점 파악

• if-else 가 중첩되어 있다. → 사고의 depth 를 줄이자!
  • early return 을 하자!
• 부정 연산자(!)의 가독성이 떨어진다.
• getter 의 연속 사용 → 메서드화 하자!

TO-BE

@Service
@RequiredArgsConstructor
public class OrderService {
	...
	public boolean validateOrder(Order order) {
    if (order.hasNoItems()) {
        throw new OrderException("주문 항목이 없습니다.");
    } 
    if (order.hasNotCustomerInfo()) {
		    throw new OrderException("사용자 정보가 없습니다.");
    }
    if (order.isInValidTotalPrice())) {
        throw new OrderException("올바르지 않은 총 가격입니다.");
    }
    return true;
	}
}

@Entity
@Table(name = "orders")
@Where(clause = "deleted_at IS NULL")
@SQLDelete(sql = "UPDATE orders SET deleted_at = NOW() WHERE id = ?")
public class Order {
	...
	private boolean hasNoItems() {  
    return this.items.isEmpty();  
	}
	
	private boolean hasNotCustomerInfo() {  
    return this.customInfo.isEmpty();  
	}  
  
	private boolean isTotalPriceLessThanZero() {  
		return this.items.stream().mapToInt(Item::getPrice).sum() <= 0;
	}  
}

public class OrderException extends RuntimeException {
	public OrderException(String message) { 
		super(message); 
	} 
}

• if-else 중첩문을 if 문 3개로 변환했다.
• order.getItems().size() == 0 getter 의 연속적 사용을 메서드화하여 Order 객체 안으로 숨겨서 캡슐화했다.
• !order.hasCustomerInfo() 과 같은 부정 연산자를 없애고, hasNotCustomerInfo 처럼 부정어도 메서드화 하여 가독성을 높였다.
• 추가적으로 if 문 조건에 들어가는 메서드들을 Order class 안으로 옮기고,
• 단순히 log 처리만 하는 것을 넘어서 RuntimeException 인 OrderException 으로 예외처리를 하였다.

2. SOLID에 대하여 자기만의 언어로 정리해 봅시다.

• SRP : 단일 책임 원칙(single responsibility principle)
• OCP : 개방-폐쇄 원칙 (Open/closed principle)
• LSP : 리스코프 치환 원칙 (Liskov substitution principle)
• ISP : 인터페이스 분리 원칙 (Interface segregation principle)
• DIP : 의존관계 역전 원칙 (Dependency inversion principle)

SRP(단일 책임 원칙)

• 한 클래스는 하나의 책임만 가져야 한다.
• 중요한 기준은 변경이다. 변경이 있을 때 파급 효과가 적으면 단일 책임 원칙을 잘 따른 것

OCP(개방-폐쇄 원칙)

• 소프트웨어 요소는 확장에 열려 있으나 변경에는 닫혀 있어야 한다.
• 다형성을 활용해보자
• 인터페이스를 구현한 새로운 클래스를 하나 만들어서 새로운 기능을 구현하면 코드에 변경이 없다.

LSP(리스코프 치환 원칙)

• 프로그램의 객체는 프로그램의 정확성을 깨뜨리지 않으면서 하위 타입의 인스턴스로 바꿀 수 있어야 한다.
• 다형성에서 하위 클래스는 인터페이스 규약을 다 지켜야 한다는 것

ISP(인터페이스 분리 원칙)

• 특정 클라이언트를 위한 인터페이스 여러 개가 범용 인터페이스 하나보다 낫다
• 덩어리가 크면 그걸 다 구현하기가 힘들다. 덩어리가 작으면 작은 기능만 구현하면 되니까 훨씬 쉬워진다.
• 인터페이스가 명확해지고, 대체 가능성이 높아진다.

DIP(의존관계 역전 원칙)

• 프로그래머는 추상화(역할)에 의존해야지, 구체화(구현)에 의존하면 안된다. 의존성 주입은 이 원칙을 따르는 방법 중 하나다.
• 쉽게 이야기해서 구현 클래스에 의존하지 말고, 인터페이스에 의존하라는 뜻
• 앞에서 이야기한 역할(Role)에 의존하게 해야 한다는 것과 같다.
• 객체 세상도 클라이언트가 인터페이스에 의존해야 유연하게 구현체를 변경할 수 있다. 구현체에 의존하게 되면 변경이 아주 어려워진다.