클린 코드 Chapter 10. 클래스

Jeongmin Yeo (Ethan)·2021년 3월 11일
3

Clean Code

목록 보기
10/14
post-thumbnail

클린 코드 Chapter 10. 클래스에 대해 정리합니다.

학습할 내용은 다음과 같습니다.

  • Principle 1. 클래스는 작아야 한다
  • Principle 2. 변경하기 쉬운 클래스

Reference


Intro

지금까지 우리는 코드행과 코드 블록을 올바르게 작성하는 방법에 초점을 맞췄고 함수를 올바르게 구현하는 방법을 알았다.

하지만 차원 높은 단계인 클래스까지 신경 쓰지 않으면 깨끗한 코드를 얻기 어렵다.

클래스 체계를 먼저 살펴보면 클래스 체계는 가장 먼저 변수 목록이 나온다.

static public 변수가 있다면 맨 처음에 나오고 그 다음 static private 변수가 나온다.

그 다음 public 변수가 나오고 그 다음 private 변수가 나온다.

변수 목록 다음에는 public 메소드가 나오고 private 메소드는 자신을 호출한 public 메소드 다음에 나온다.

이렇게 추상화는 단계적으로 내려간다.

변수와 유틸리티 함수는 공개하지 않는 편이 낫지만 항상 숨겨야 하는 것도 아니다. 우리에게 테스트 코드는 아주 중요하다

테스트 코드가 함수를 호출하거나 변수를 사용해야한다면 그 함수나 변수를 protected로 선언하거나 패키지 전체로 공개해야한다.


Principle 1. 클래스는 작아야 한다

클래스의 규칙도 함수와 유사하다. 클래스는 작아야 한다.

그럼 함수와 마찬가지로 얼마나 작아야 하는가? 클래스는 책임이 많으면 안된다.

클래스는 단일 책임 원칙인 SRP(Single Responsibility Principle)를 따라야 하고 클래스나 모듈을 변경할 이유는 단 하나 뿐이어야 한다.

그리고 클래스 이름은 이 클래스 책임을 기술해야 한다.

클래스 이름이 딱 떠오르지 않거나 모호하다면 분명 클래스 책임이 너무 많아서 그런 것이다.

예를들어 Processor, Manager, Super 등과 같이 모호한 단어가 있다면 클래스에다 여러 책임을 떠안겼다는 증거다.

그리고 클래스 설명에 만일(if) 그리고(and) ~하며(or), 하지만(but) 등이 기술된다면 그것도한 책임이 많다는 것이다.

대부분의 개발자가 이 원칙을 알면서도 가장 무시한다. 왜 그럴까?

깨끗하고 체계적인 소프트웨어보다 돌아가는 소프트웨어에 초점이 맞춰저서 그렇다.

대다수가 프로그램이 돌아가면 일을 끝난다고 여긴다. 깨끗하고 체계적인 소프트웨어라는 다음 관심사로 전환하지 않는다.

프로그램으로 되돌아가 만능 클래스를 단일 책임 클래스 여럿으로 분리하지 않는다.

그리고 일부 개발자는 단일 책임 클래스가 많아지면 큰 그림을 이해하기 어려워진다고도 생각한다.

하지만 작은 클래스가 많은 시스템이든 큰 클래스가 많은 시스템이든 시스템이 들어가는 부품은 그 수가 비슷하다.

어느 시스템이든 큰 클래스 몇 개가 아니라 작은 클래스 여럿으로 이뤄진 시스템이 더 낫다.

응집도(Cohesion)

클래스는 인스턴스 변수 수가 작아야 한다. 클래스 메소드는 클래스 인스턴스 변수를 하나 이상 사용해야 한다.

일반적으로 메소드가 변수를 더 많이 사용할수록 메소드와 클래스는 응집도가 높다.

모든 인스턴스 변수를 메소드마다 사용한다면 응집도가 가장 높다.

응집도는 높은게 좋지만 응집도가 가장 높은것은 마냥 좋지는 않다. 응집도가 높다는 말은 클래스가 속한 메소드와 인스턴스 변수가 서로 의존하며 논리적인 단위로 묶인다는 의미다.

묶안다는 건 결국 다른 클래스로도 뺼 수도 있다.

함수를 작게, 매개변수 목록을 짧게라는 전략을 따르다 보면 때떄로 몇몇 메소드만 사용하는 인스턴스 변수가 아주 많아지고 이는 분리가 가능할수도 있다.

그리고 큰 함수를 작은 함수 여럿으로 나누기만 해도 클래스 수가 많아진다.

예를 들어 변수가 아주 많은 큰 함수 하나가 있다. 큰 함수 일부를 작은 함수 하나로 빼내고 싶은데, 빼내려는 코드가 큰 함수에 정의된 변수 넷을 사용한다.

그렇다면 변수 네 개를 함수 인자로 넣어서 사용해야할까?

아니다. 네 변수를 클래스의 인스턴스 변수로 승격한다면 새 함수는 인자가 필요없다.

클래스에서 함수로 빼내는게 아니라 새 클래스로 빼낸다면 응집력을 잃으므로 걱정할 수 있다. 하지만 이렇게 몇몇 함수만 사용하는 인스턴스 수가 있다면

독자적인 클래스로 분리해도 된다.


Principle 2. 변경하기 쉬운 클래스

대다수 시스템은 지속적인 변경이 가해진다. 그리고 뭔가 변경할 때마다 시스템이 의도하는대로 동작하지 않을 위험이 따른다.

깨끗한 시스템은 클래스를 체계적으로 정리해 변경에 수반되는 위험을 낮춘다.

어떤 변경이든 클래스에 손대면 다른 코드를 망가뜨릴 가능성이 생긴다. 그러므로 다시 테스트를 돌려야한다.

다음과 같은 SQL 클래스가 있다.

class SQL{
    
    public SQL(String table, Column[] columns)
    public String create()
    public String insert(Object[] fields)
    public String selectAll()
    public String findByKey(String keyColumn, String keyValue)
    private String selectWithCriteria(String criteria)

    ...
}

이 클래스의 경우에는 새로운 SQL 문을 지원하려면 Sql 클래스에 손대야한다.

그리고 기존 SQL 문을 수정하려고 할때도 Sql 클래스에 손대야한다. 즉 이렇게 변경할 이유가 두개이므로 SRP를 위반한다.

그리고 메소드를 살펴보면 selectWithCriteria 라는 비공개 메소드가 있는데 이는 select 문을 처리할 때만 사용한다.

select문에만 사용하므로 비공개 메소드는 코드를 개선할 여지가 있다.

이 예제의 경우 그러므로 각 SQL 문마다 Sql 클래스를 상속받는 클래스를 만들어야 해결할 수 있다.

그러므로 Update 문을 추가하더라도 기존 클래스를 변경할 이유가 없다. 새로운 UpdateSql 클래스에 추가하면 되기 떄문이다.

변경으로 부터의 격리

상세한 구현에 의존하는 코드는 테스트하기 어렵다.

예를들어서 Portfolio 클래스를 만든다고 가정해보자. 이 클래스가 외부 TokyoStockExchange 클래스의 API를 사용하는걸로 결합되어있으면

테스트하기가 어렵다. 이런 경우 결합도를 낮추기 위해 세부 구현에 의존하는 클래스보다

StockExchange라는 인터페이스를 만들어서 즉 역할에 의존하도록 하면 테스트하기가 더 쉽다.


profile
좋은 습관을 가지고 싶은 평범한 개발자입니다.

0개의 댓글