클린코드 (8) - 클래스
클래스
- 깨끗한 코드
- 코드 행, 코드 블록을 올바르게 작성한다
- 함수를 올바르게 구현하고, 함수가 서로 관련을 맺는 방식을 이해한다.
- 깨끗한 클래스를 작성한다.
올바른 코드, 올바른 함수, 깨끗한 클래스에 대해 잘 이해가 안되는 점이 있어 해당 절을 읽으면서 내용을 정리해보았습니다.
클래스 체계
- 클래스를 정의하는 표준 자바 관례에 따르면, 가장 먼저 변수 목록이 나온다.
- 정적(static) 공개(public) 상수
- 정적(static) 비공개(private) 변수
- private instance 변수
- 공개 변수(field)가 필요한 경우는 거의 없음
- 변수 목록 다음에는 공개 함수가 나온다.
- 비공개 함수는 자신을 호출하는 공개 함수 직후에 넣는다. (추상화 단계가 순차적으로 내려간다)
공개 변수가 필요한 경우가 거의 없음 의 의미를 public field로 선언하고 이를 직접 참조하여 사용하는 경우는 거의 없다는 것으로 이해하였습니다.
캡슐화
- 변수와 유틸리티 함수는 가능한 공개하지 않는 편이 낫지만 반드시 숨겨야 한다는 법칙도 없음
- 변수나 유틸리티 함수를 protected로 선언해 테스트 코드에 접근을 허용하기도 한다. (테스트 코드가 함수를 호출하거나 변수를 사용하기 위해)
- 캡슐화를 풀어주는 결정은 언제나 최후의 수단
- 비공개 상태를 유지할 온갖 방법을 강구해야 함
protected로 선언하면 현재 위치의 패키지와 그 하위 패키지에서 접근이 가능할 것이므로 test 패키지 내에서 생성한 class에 한해서 접근을 허용한다는 것으로 봐야 할 것 같습니다. (main 패키지에서 직접 변수에 접근하게 할 일은 없을 것입니다.)
클래스 작성 - 적절한 크기의 클래스
- 함수와 마찬가지로 클래스를 설계할 때도 '작게'가 기본 규칙
- 얼마나 작아야 하는가? ⇒ 맡은 책임을 기준으로 정한다.
- 물리적인 행 수를 기준으로 크기를 측정할 때 지나치게 길지 않도록 해야 한다.
- 너무 많은 책임의 예
public class SuperDashboard extends JFrame implements MetaDataUser {
public String getCustomizerLanguagePath();
public void setSystemConfigPath(String systemConfigPath);
public String getSystemConfigDocument();
public void setSystemConfigDocument(String systemConfigDocument);
public boolean getGuruState();
public boolean getNoviceState();
public boolean getOpenSourceState();
public void showObject(MetaObject object);
public void showProgress(String s);
public boolean isMetadataDirty();
public void setIsMetadataDirty(boolean isMetadataDirty);
public Component getLastFocusedComponent();
public void setLastFocused(Component lastFocused);
public void setMouseSelectState(boolean isMouseSelected);
public boolean isMouseSelected();
public LanguageManager getLanguageManager();
public Project getProject();
public Project getFirstProject();
public Project getLastProject();
public String getNewProjectName();
public void setComponentSizes(Dimension dim);
public String getCurrentDir();
public void setCurrentDir(String newDir);
public void updateStatus(int dotPos, int markPos);
public Class[] getDataBaseClasses();
public MetadataFeeder getMetadataFeeder();
public void addProject(Project project);
public boolean setCurrentProject(Project project);
public boolean removeProject(Project project);
public MetaProjectHeader getProgramMetadata();
public void resetDashboard();
public Project loadProject(String fileName, String projectName);
public void setCanSaveMetadata(boolean canSave);
public MetaObject getSelectedObject();
public void deselectObjects();
public void setProject(Project project);
public void editorAction(String actionName, ActionEvent event);
public void setMode(int mode);
public FileManager getFileManager();
public void setFileManager(FileManager fileManager);
public ConfigManager getConfigManager();
public void setConfigManager(ConfigManager configManager);
public ClassLoader getClassLoader();
public void setClassLoader(ClassLoader classLoader);
public Properties getProps();
public String getUserHome();
public String getBaseDir();
public int getMajorVersionNumber();
public int geWinorVersionNumber();
public int getBuildNumber();
public MetaObject pasting(MetaObject target, MetaObject pasted, MetaProject project);
public void processMenuItems(MetaObject metaObject);
public void processMenuSeparators(MetaObject metaObject);
public void processTabPages(MetaObject metaObject);
public void processPlacement(MetaObject object);
public void processCreateLayout(MetaObject object);
public void updateDisplayLayer(MetaObject object, int layerindex);
public void propertyEditedRepaint(MetaObject object);
public void processDeleteObject(MetaObject object);
public boolean getAttachedToDesigner();
public void processProjectChangedState(boolean hasProjectChanged);
public void processObjectNameChanged(MetaObject object);
public void runProject();
public void setAllowDragging(boolean allowDragging);
public boolean allowDragging();
public boolean isCustomizing();
public void setTitle(String title);
public IdeMenuBar getldeMenuBar();
public void showHelper(MetaObject metaObject, String propertyName);
// ... 그리고 많은 비공개 메서드가 이어진다 ...
}
// 함수를 작게 줄여본다면?
public class SuperDashboard extends JFrame implements MetaDataUser {
public Component getLastFocustedComponent()
public void setLastFocused(Component lastFocused)
public int getMajorVersionNumber()
public int getMinorVersionNumber()
public int getBuildNumber()
}
// SuperDashboard는 마지막으로 포커스를 얻었던 컴포넌트에 접근하는 방법을 제공하며, 버전과 빌드 번호를 추적하는 매커니즘을 제공한다.
- method 수를 5개로 줄였더라도 책임이 너무 많기 때문에 적절한 크기가 아니다.
- 클래스의 이름은 해당 클래스 책임을 기술해야 한다. (작명은 크기를 줄이는 첫 관문.)
- 간결한 이름이 떠오르지 않는다면 클래스 크기가 너무 큰 것.
- 클래스 이름이 모호하다면 클래스 책임이 너무 많은 것. (Processor, Manager, Super 등과 같은 모호한 단어는 클래스에 여러 책임이 있음을 나타내는 증거)
- 클래스 설명은 만일(if), 그리고(and), 또는(하며)("or"), 하지만("but")을 사용하지 않고서 25단어 내외로 가능해야 한다.
긴 클래스의 예로 책에 나와있는 method를 하나하나 적어보았는데도 저 클래스가 무엇을 하는지 이해를 못하겠습니다. ㅠ
method 수가 5개라도 적절한 크기가 아니라는 것은 결국 어떤 도메인의 행위(책임)이 여럿이라면 하나하나 수행할 수 있는 단위의 클래스로 분리하는 것이 낫다는 것으로 이해됩니다.
작명은 이래저래 정말로 어려운 것 같습니다. 25단어 내외라는 제한이 제시되지만 핵심은 글자 수보다는 '객체에 대해 명확히 이해될 수 있도록 명명할 수 있는가' 인 것 같습니다.
단일 책임 원칙 (SRP)
단일 책임 원칙(SRP, Single Responsibility Principle)은 클래스나 모듈을 변경할 이유가 단 하나뿐이어야 한다는 원칙
- '책임' 이라는 개념을 정의하며 적절한 클래스 크기를 제시한다.
- 책임, 즉 변경할 이유가 하나여야 한다는 의미
- 위의 예시인 SuperDashboard class는 변경할 이유가 두 가지가 있음
- SuperDashboard는 소프트웨어 버전 정보를 추적하는데, 버전 정보는 소프트웨어를 출시할 때마다 달라진다.
- Java Swing 컴포넌트를 관리한다. (최상위 GUI 윈도의 스윙 표현인 JFrame에서 파생한 클래스) 따라서 스윙 코드를 변경할 때마다 버전 번호가 달라진다
- 책임, 즉 변경할 이유를 파악하려 애쓰면 코드를 추상화하기도 쉬워진다.
- SuperDashboard 에서 버전 정보를 다루는 메서드를 빼냄
public class Version {
public int getMajorVersionNumber();
public int getMinorVersionNumber();
public int getBuildNumber();
}
- SRP는 클래스 설계자가 가장 무시하는 규칙 중 하나
- 소프트웨어를 돌아가게 만드는 활동과 소프트웨어를 깨끗하게 만드는 활동은 완전히 별개 (깨끗하고 체계적인 소프트웨어 보다는 돌아가는 소프트웨어에 초점을 맞춤)
- 관심사를 분리하는 작업은 프로그램만이 아니라 프로그래밍 활동에서도 마찬가지로 중요하다
- 단일 책임 클래스가 많아지면 큰 그림을 이해하기 어려워지지 않을까 하는 우려(큰 그림 이해를 위해 여러 클래스를 수없이 넘나들어야 한다는 걱정)
- 돌아가는 소프트웨어 → 깨끗하고 체계적인 소프트웨어 로의 전환이 이뤄지지 않는게 문제 (단일 책임 클래스 여럿으로 분리하지 않음)
- 작은 클래스가 많은 시스템이든 큰 클래스가 몇 개뿐인 시스템이든 돌아가는 부품은 그 수가 비슷하다. (어느 시스템이든 익힐 내용은 그 양이 비슷하다.)
- 규모가 어느 수준에 이르는 시스템은 논리가 많고도 복잡하다. 복잡성을 다루려면 체계적인 정리는 필수.
- 개발자가 무엇이 어디에 있는지 쉽게 찾음
- (변경을 가할 때) 직접 영향이 미치는 컴포넌트만 이해해도 충분
- 큼직한 다목적 클래스 몇 개로 이뤄진 시스템은 (변경을 가할 때) 당장 알 필요없는 사실까지 들이밀어 독자를 방해한다.
- 작은 클래스 여럿으로 이뤄진 시스템이 바람직
- 작은 클래스는 각자 맡은 책임이 하나
- 변경할 이유가 하나
- 다른 작은 클래스와 협력하여 시스템에 필요한 동작을 수행
확실히 잘 돌아가기만 하면 어느정도 유지하면서 서비스는 가능하겠지만 체계적이지 못해 생긴 기술부채는 언젠가는 처리해야 할 문제를 야기하고 해결을 위한 어마어마한 작업량으로 돌아온다고 생각합니다. (돌아옵니다.)
단일 책임이 아닌 클래스를 가지고 단위 테스트를 작성해보니 어떤 건 시도 조차 못했었고, 너무 어려운 작업이었습니다.
- 이전 절차에 종속된 부분을 찢어내고
- 클래스가 가지는 여러 행위(책임)을 단위로 쪼개기 위해 디버깅해가며 하나하나 파악해야 하고
- 해당 클래스를 참조하는 다른 클래스에 어떤 영향이 있을지 모두 파악하고 영향을 최소화해야 했습니다.
책에서 나오는대로 돌아가는 부품은 그 수가 비슷하다. (어느 시스템이든 익힐 내용은 그 양이 비슷하다.) 라고 한다면 클래스를 만들 때부터 하나의 책임을 갖도록 의식하면서 만들어야겠다는 생각이 들었습니다. 급할 때면 생각없이 클래스를 생성하곤 했기에 배운 개념을 실천하지 못하고 있는 제 자신을 반성하게 되는 내용이었습니다.
응집도 (Cohesion)
-
클래스는 인스턴스 변수 수가 작아야 한다.
-
각 클래스 메서드는 클래스 인스턴스 변수를 하나 이상 사용해야 한다.
-
일반적으로 메서드가 변수를 더 많이 사용할 수록 메서드와 클래스는 응집도가 더 높음.
- 모든 인스턴스 변수를 메서드마다 사용하는 클래스는 응집도가 가장 높다.
-
응집도가 높다 = 클래스에 속한 메서드와 변수가 서로 의존하며 논리적인 단위로 묶인다는 의미
-
응집도가 높은 클래스
public class Stack {
private int topOfStack = 0;
List<Integer> elements = new LinkedList<Integer>();
public int size() {
return topOfStack;
}
public void push(int element) {
topOfStack++;
elements.add(element);
}
public int pop() throws PoppedWhenEmpty {
if (topOfStack = 0) throw new PoppedWhenEmpty();
int element = elements.get(topOfStack);
elements.remove(topOfStack);
return element;
}
}
- 응집도가 아주 높음
- size() 를 제외한 다른 두 메서드는 두 변수를 모두 사용함.
- 응집도가 높아지도록 변수와 메서드를 적절히 분리해 새로운 클래스 두 세개로 쪼개준다.
- '함수를 작게, 매개변수 목록을 짧게' 전략을 따르자
- 몇몇 메서드만이 사용하는 인스턴스 변수가 많아진다면 새로운 클래스로 쪼개야 한다는 신호.
응집도가 높다는 것을 class 내 field 값을 대부분의 method에서 활용하도록 구성되어 있다는 것으로 이해하였습니다.
응집도를 유지하면 작은 클래스 여럿이 나온다
- 큰 함수를 작은 함수 여럿으로 나누기만 해도 클래스 수가 많아진다
- 클래스에 아주 큰 덩치의 함수가 있을 때, 빼내려는 코드가 큰 함수에 정의된 변수 넷을 사용한다면 변수 네 개를 새로 만드는 함수에 인수로 넘겨야 할까?
- 만약 네 변수를 클래스 인스턴스 변수로 승격한다면 새 함수는 인수가 필요 없다. (그만큼 함수를 쪼개기 쉬워짐)
- 다만, 이렇게 작업하면 클래스가 응집력을 잃어버림.
- 몇몇 함수만 사용하는 인스턴스 변수가 점점 더 늘어나기 때문
- 클래스가 응집력을 잃는다면 독자적인 클래스로 분리하여 쪼갤것!
- 큰 함수를 작은 함수 여럿으로 쪼개다보면 작은 클래스 여럿으로 쪼갤 기회가 생김
- 쪼개는 과정을 통해 프로그램에 점점 더 체계가 잡히고 구조가 투명해진다.
- 작은 함수로 쪼개는 리팩토링
- 프로그램이 길어질 수 있다.
- 리팩토링한 프로그램은 좀 더 길고 서술적인 변수 이름을 사용
- 리팩토링한 프로그램은 코드에 주석을 추가하는 수단으로 함수 선언과 클래스 선언을 활용
- 가독성을 높이고자 공백을 추가하고 형식을 맞췄기 때문
- 리팩토링은 재구현이 아니다. (프로그램을 처음부터 다시 짠 것이 아님)
- 원래 프로그램의 정확한 동작을 검증하는 테스트 슈트를 작성
- 그 다음, 한 번에 하나씩 여러 차례에 걸쳐 조금씩 코드를 변경해가는 것임.
- 코드를 변경할 때마다 변경한 단위에 대한 테스트를 수행해 원래 프로그램과 동일하게 동작하는지 확인함
- 조금씩 기존 코드를 정리한 결과 리팩토링 된 최종 결과물이 도출되는 것.
대상 method가 여러 행위를 수행하고 있고 field 변수 외에 별도의 변수를 선언하여야 동작되고 있다면 리팩토링 대상으로 생각해야겠습니다.
책에서도 소개되지만 리팩토링을 한번에, 그리고 바로 고칠 순 없기에 리팩토링은 별도의 시간이 확보되어야만 수행 할 수 있는 개념은 아닌거 같습니다.
변경하기 쉬운 클래스
-
대다수 시스템은 지속적인 변경이 가해짐
→ 변경할 때마다 시스템이 의도대로 동작하지 않을 위험이 따른다.
-
깨끗한 시스템은 클래스를 체계적으로 정리해 변경으로 인해 수반되는 위험을 낮춘다.
-
변경이 필요해 '수정해야 하는' 클래스
public 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);
public String select(Column column, String pattern);
public String select(Criteria criteria);
public String preparedlnsert();
private String columnList(Column[] columns);
private String valuesList(Object[] fields, final Column[] columns);
private String selectWithCriteria(String criteria);
private String placeholderList(Column[] columns);
}
- 새로운 SQL 문을 지원하려면 반드시 Sql 클래스에 손대야 한다
→ 코드를 '손대면' 반드시 위험이 생긴다.
→ 클래스는 테스트도 완전히 다시 해야 한다.
- 구조적인 관점에서도 Sql은 SRP를 위반한다.
- selectWithCriteria() 는 select 문을 처리할 때만 사용
- 클래스 일부에서만 사용되는 비공개 메서드는 코드를 개선할 잠재적인 여지를 시사한다.
- 실제로 개선에 뛰어드는 계기는 시스템이 변해서라야 한다. 클래스에 손대는 순간 설계를 개선하려는 고민과 시도가 필요하다.
-
공개 인터페이스를 각각 Sql 클래스에서 파생하는 클래스로 만든다면
// 닫힌 클래스 집합
abstract public class Sql {
public Sql(String table, Column[] columns){
}
abstract public String generate();
}
public class CreateSql extends Sql {
public CreateSql(String table, Column[] columns){
}
@Override
public String generate();
}
public class SelectSql extends Sql {
public SelectSql(String table, Column[] columns){
}
@Override
public String generate();
}
public class InsertSql extends Sql {
public InsertSql(String table, Column[] columns, Object[] fields){
}
@Override
public String generate();
private String valuesList(Object[] fields, final Column[] columns);
}
public class SelectWithCriteriaSql extends Sql {
public SelectWithCriteriaSql( String table, Column[] columns, Criteria criteria){
}
@Override
public String generate();
}
public class SelectWithMatchSql extends Sql {
public SelectWithMatchSql (String table, Column[] columns, Column column, String pattern){
}
@Override
public String generate();
}
public class FindByKeySql extends Sql {
public FindByKeySql( String table, Column[] columns, String keyColumn, String keyValue){
}
@Override
public String generate();
}
public class PreparedlnsertSql extends Sql {
public PreparedlnsertSql(String table, Column[] columns){
}
@Override
public String generate();
private String placeholderList(Column[] columns);
}
public class Where {
public Where(String criteria){
}
public String generate();
}
public class ColumnList {
public ColumnList(Column[] columns){
}
public String generate();
}
-
valueList와 같은 비공개 메서드는 해당하는 파생 클래스로 옮김
-
모든 파생 클래스가 공통으로 사용하는 비공개 메서드는 Where와 ColumnList라는 두 유틸 클래스에 넣음
-
클래스 집합으로 변경 시
- 각 클래스는 극도로 단순하다
- 코드는 순식간에 이해된다
- 함수 하나를 수정했다고 다른 함수가 망가질 위험도 사실상 사라졌다.
- (클래스가 서로 분리되었으므로) 테스트 관점에서 모든 논리를 구석구석 증명하기도 쉬워졌다.
- SRP를 지원한다
- OCP(Open-Closed Principle)도 지원한다. (새 기능에 개방적인 동시에 다른 클래스를 닫아놓는 형식으로 수정에 폐쇄적)
-
update 문을 추가할 때 기존 클래스를 변경할 필요가 전혀 없다는 사실 역시 중요!
- update문을 만드는 논리는 Sql 클래스에서 새 클래스 UpdateSql을 상속받아 거기에 넣으면 그만.
- update 문을 지원해도 다른 코드가 망가질 염려는 전혀 없다.
-
새 기능을 수정하거나 기존 기능을 변경할 때 건드릴 코드가 최소인 시스템 구조가 바람직하다.
-
이상적인 시스템이라면 새 기능을 추가할 때 시스템을 확장할 뿐 기존 코드를 변경하지는 않는다.
최근에 변경하기 어려운 클래스를 만들면서 프로그램을 구현한 경험이 있어 많은 생각이 들게 하는 내용으로 느껴졌습니다.
DB의 Transaction에 대한 책임을 구현한 Sql class에 대해 Sql의 파생 클래스로 각 책임을 분리하는 작업에서 나온 개념을 정리하면
- DB 기능으로 class를 구현하면 CRUD 별로 로직이 분리되는 편이 유지보수에 유용하다는 점.
- 단독으로 쓰이는 private method는 파생 class로 이동시키면 된다는 것.
- 공통으로 사용되는 private method는 DI를 통해 구현된 기능에 대한 의존성을 갖도록 설정하면 각 기능을 중복으로 구현하지 않아도 된다는 것.
변경으로부터 격리
-
요구사항은 변하기 마련
-
따라서, 코드도 변하기 마련
-
객체 지향 프로그래밍 입문에서 구체적인(concrete) 클래스와 추상(abstract) 클래스가 있다고 알려준다.
- 구체적인 클래스는 상세한 구현(코드)을 포함하며 추상 클래스는 개념만 포함한다.
- 상세한 구현에 의존하는 클라이언트 클래스는 구현이 바뀌면 위험에 빠진다.
- 인터페이스와 추상 클래스를 사용해 구현이 미치는 영향을 격리한다.
-
상세한 구현에 의존하는 코드는 테스트가 어렵다.
-
ex) 외부 TokyoStockExchange API를 사용해 포트폴리오 값을 계산하는 Portfolio 클래스를 테스트 하기
// TokyoStockExchange API를 직접 호출하는 대신 StockExchange라는 인터페이스를 생성한 후 메서드 하나를 선언
public interface StockExchange {
Money currentPrice(String symbol);
}
// 다음으로 StockExchange 인터페이스를 구현하는 TokyoStockExchange 클래스 구현
// Portfolio 생성자를 수정해 StockExchange 참조자를 인수로 받음
public Portfolio {
private StockExchange exchange;
public Portfolio(StockExchange exchange) {
this.exchange = exchange;
} // ...
}
// TokyoStockExchange 클래스를 흉내내는 테스트용 클래스를 만들 수 있음
// 테스트용 클래스는 StockExchange 인터페이스를 구현하며 고정된 주가를 반환한다.
// 테스트로 마이크로소프트 주식 다섯 주를 구입한다면 테스트용 클래스는 주가로 언제나 100불을 반환한다.
// 테스트용 클래스는 단순히 미리 정해놓은 표 값만 참조한다.
// 전체 포트폴리오 총계가 500불인지 확인하는 테스트 코드를 작성할 수 있다.
public class PortfolioTest {
private FixedStockExchangeStub exchange;
private Portfolio portfolio;
@Before
protected void setUp() throws Exception {
exchange = new FixedStockExchangeStub();
exchange.fix("MSFT", 100);
portfolio = new Portfolio(exchange);
}
@Test
public void GivenFiveMSFTTotalShouldBe500() throws Exception {
portfolio.add(5, "MSFT");
Assert.assertEquals(500, portfolio.value());
}
}
- 위의 테스트가 가능할 정도로 시스템 결합도를 낮추면 유연성과 재사용성도 더욱 높아진다.
- 결합도가 낮다 = 각 시스템 요소가 다른 요소로부터, 그리고 변경으로부터 잘 격리되어 있다는 의미
- 시스템 요소가 서로 잘 격리되어 있으면 각 요소를 이해하기도 더 쉬워진다
- 결합도를 최소로 줄이면 자연스레 DIP(Dependency Inversion Principle)를 따르는 클래스가 나온다
- 본질적으로 DIP 클래스가 상세한 구현이 아니라 추상화에 의존해야 한다는 원칙
- 개선한 Portfolio class는 상세 구현 클래스인 TokyoStockExchange 가 아니라 StockExchange 인터페이스에 의존한다.
- StockExchange 인터페이스는 주식 기호를 받아 현재 주식 가격을 반환한다는 추상적인 개념을 표현한다.
- 추상화를 통해 실제로 주가를 얻어오는 출처나 얻어오는 방식 등과 같은 구체적인 사실을 모두 숨긴다.
추후의 변경사항에 대비하기 위해 처음부터 기능을 구현할 때 잊지말고!
1. 책임을 수행할 역할을 추상화하여 정리해두도록 한다.
2. 도메인의 비즈니스 로직에 대해 수행할 객체는 구현class의 field로 설정하고 의존성을 전달받아 역할이 수행되도록 구성한다. (비즈니스 로직 구현 객체는 갈아끼우기 편하게 설정하기 위함)
3. 단위테스트를 작성할 때 로직 단위 점검(ex) 선물거래소 비즈니스 로직) 과 역할 수행 단위 점검(ex) 거래소 기본 기능)이 가능하다면 결합도가 낮은 것으로 이해할 수 있다.
라는 세 가지의 개념을 의식하면서 코딩할 수 있도록 노력해봐야겠습니다.
Author And Source
이 문제에 관하여(클린코드 (8) - 클래스), 우리는 이곳에서 더 많은 자료를 발견하고 링크를 클릭하여 보았다
https://velog.io/@gentledot/clean-code-about-class
저자 귀속: 원작자 정보가 원작자 URL에 포함되어 있으며 저작권은 원작자 소유입니다.
우수한 개발자 콘텐츠 발견에 전념
(Collection and Share based on the CC Protocol.)
- 코드 행, 코드 블록을 올바르게 작성한다
- 함수를 올바르게 구현하고, 함수가 서로 관련을 맺는 방식을 이해한다.
- 깨끗한 클래스를 작성한다.
올바른 코드, 올바른 함수, 깨끗한 클래스에 대해 잘 이해가 안되는 점이 있어 해당 절을 읽으면서 내용을 정리해보았습니다.
- 정적(static) 공개(public) 상수
- 정적(static) 비공개(private) 변수
- private instance 변수
- 공개 변수(field)가 필요한 경우는 거의 없음
- 비공개 함수는 자신을 호출하는 공개 함수 직후에 넣는다. (추상화 단계가 순차적으로 내려간다)
공개 변수가 필요한 경우가 거의 없음 의 의미를 public field로 선언하고 이를 직접 참조하여 사용하는 경우는 거의 없다는 것으로 이해하였습니다.
- 변수나 유틸리티 함수를 protected로 선언해 테스트 코드에 접근을 허용하기도 한다. (테스트 코드가 함수를 호출하거나 변수를 사용하기 위해)
- 비공개 상태를 유지할 온갖 방법을 강구해야 함
protected로 선언하면 현재 위치의 패키지와 그 하위 패키지에서 접근이 가능할 것이므로 test 패키지 내에서 생성한 class에 한해서 접근을 허용한다는 것으로 봐야 할 것 같습니다. (main 패키지에서 직접 변수에 접근하게 할 일은 없을 것입니다.)
- 물리적인 행 수를 기준으로 크기를 측정할 때 지나치게 길지 않도록 해야 한다.
public class SuperDashboard extends JFrame implements MetaDataUser {
public String getCustomizerLanguagePath();
public void setSystemConfigPath(String systemConfigPath);
public String getSystemConfigDocument();
public void setSystemConfigDocument(String systemConfigDocument);
public boolean getGuruState();
public boolean getNoviceState();
public boolean getOpenSourceState();
public void showObject(MetaObject object);
public void showProgress(String s);
public boolean isMetadataDirty();
public void setIsMetadataDirty(boolean isMetadataDirty);
public Component getLastFocusedComponent();
public void setLastFocused(Component lastFocused);
public void setMouseSelectState(boolean isMouseSelected);
public boolean isMouseSelected();
public LanguageManager getLanguageManager();
public Project getProject();
public Project getFirstProject();
public Project getLastProject();
public String getNewProjectName();
public void setComponentSizes(Dimension dim);
public String getCurrentDir();
public void setCurrentDir(String newDir);
public void updateStatus(int dotPos, int markPos);
public Class[] getDataBaseClasses();
public MetadataFeeder getMetadataFeeder();
public void addProject(Project project);
public boolean setCurrentProject(Project project);
public boolean removeProject(Project project);
public MetaProjectHeader getProgramMetadata();
public void resetDashboard();
public Project loadProject(String fileName, String projectName);
public void setCanSaveMetadata(boolean canSave);
public MetaObject getSelectedObject();
public void deselectObjects();
public void setProject(Project project);
public void editorAction(String actionName, ActionEvent event);
public void setMode(int mode);
public FileManager getFileManager();
public void setFileManager(FileManager fileManager);
public ConfigManager getConfigManager();
public void setConfigManager(ConfigManager configManager);
public ClassLoader getClassLoader();
public void setClassLoader(ClassLoader classLoader);
public Properties getProps();
public String getUserHome();
public String getBaseDir();
public int getMajorVersionNumber();
public int geWinorVersionNumber();
public int getBuildNumber();
public MetaObject pasting(MetaObject target, MetaObject pasted, MetaProject project);
public void processMenuItems(MetaObject metaObject);
public void processMenuSeparators(MetaObject metaObject);
public void processTabPages(MetaObject metaObject);
public void processPlacement(MetaObject object);
public void processCreateLayout(MetaObject object);
public void updateDisplayLayer(MetaObject object, int layerindex);
public void propertyEditedRepaint(MetaObject object);
public void processDeleteObject(MetaObject object);
public boolean getAttachedToDesigner();
public void processProjectChangedState(boolean hasProjectChanged);
public void processObjectNameChanged(MetaObject object);
public void runProject();
public void setAllowDragging(boolean allowDragging);
public boolean allowDragging();
public boolean isCustomizing();
public void setTitle(String title);
public IdeMenuBar getldeMenuBar();
public void showHelper(MetaObject metaObject, String propertyName);
// ... 그리고 많은 비공개 메서드가 이어진다 ...
}// 함수를 작게 줄여본다면?
public class SuperDashboard extends JFrame implements MetaDataUser {
public Component getLastFocustedComponent()
public void setLastFocused(Component lastFocused)
public int getMajorVersionNumber()
public int getMinorVersionNumber()
public int getBuildNumber()
}
// SuperDashboard는 마지막으로 포커스를 얻었던 컴포넌트에 접근하는 방법을 제공하며, 버전과 빌드 번호를 추적하는 매커니즘을 제공한다.- method 수를 5개로 줄였더라도 책임이 너무 많기 때문에 적절한 크기가 아니다.
- 간결한 이름이 떠오르지 않는다면 클래스 크기가 너무 큰 것.
- 클래스 이름이 모호하다면 클래스 책임이 너무 많은 것. (Processor, Manager, Super 등과 같은 모호한 단어는 클래스에 여러 책임이 있음을 나타내는 증거)
- 클래스 설명은 만일(if), 그리고(and), 또는(하며)("or"), 하지만("but")을 사용하지 않고서 25단어 내외로 가능해야 한다.
긴 클래스의 예로 책에 나와있는 method를 하나하나 적어보았는데도 저 클래스가 무엇을 하는지 이해를 못하겠습니다. ㅠ
method 수가 5개라도 적절한 크기가 아니라는 것은 결국 어떤 도메인의 행위(책임)이 여럿이라면 하나하나 수행할 수 있는 단위의 클래스로 분리하는 것이 낫다는 것으로 이해됩니다.
작명은 이래저래 정말로 어려운 것 같습니다. 25단어 내외라는 제한이 제시되지만 핵심은 글자 수보다는 '객체에 대해 명확히 이해될 수 있도록 명명할 수 있는가' 인 것 같습니다.
단일 책임 원칙(SRP, Single Responsibility Principle)은 클래스나 모듈을 변경할 이유가 단 하나뿐이어야 한다는 원칙- '책임' 이라는 개념을 정의하며 적절한 클래스 크기를 제시한다.
- 책임, 즉 변경할 이유가 하나여야 한다는 의미
- SuperDashboard는 소프트웨어 버전 정보를 추적하는데, 버전 정보는 소프트웨어를 출시할 때마다 달라진다.
- Java Swing 컴포넌트를 관리한다. (최상위 GUI 윈도의 스윙 표현인 JFrame에서 파생한 클래스) 따라서 스윙 코드를 변경할 때마다 버전 번호가 달라진다
- SuperDashboard 에서 버전 정보를 다루는 메서드를 빼냄
public class Version { public int getMajorVersionNumber(); public int getMinorVersionNumber(); public int getBuildNumber(); }
- 소프트웨어를 돌아가게 만드는 활동과 소프트웨어를 깨끗하게 만드는 활동은 완전히 별개 (깨끗하고 체계적인 소프트웨어 보다는 돌아가는 소프트웨어에 초점을 맞춤)
- 관심사를 분리하는 작업은 프로그램만이 아니라 프로그래밍 활동에서도 마찬가지로 중요하다
- 돌아가는 소프트웨어 → 깨끗하고 체계적인 소프트웨어 로의 전환이 이뤄지지 않는게 문제 (단일 책임 클래스 여럿으로 분리하지 않음)
- 작은 클래스가 많은 시스템이든 큰 클래스가 몇 개뿐인 시스템이든 돌아가는 부품은 그 수가 비슷하다. (어느 시스템이든 익힐 내용은 그 양이 비슷하다.)
- 개발자가 무엇이 어디에 있는지 쉽게 찾음
- (변경을 가할 때) 직접 영향이 미치는 컴포넌트만 이해해도 충분
- 큼직한 다목적 클래스 몇 개로 이뤄진 시스템은 (변경을 가할 때) 당장 알 필요없는 사실까지 들이밀어 독자를 방해한다.
- 작은 클래스는 각자 맡은 책임이 하나
- 변경할 이유가 하나
- 다른 작은 클래스와 협력하여 시스템에 필요한 동작을 수행
확실히 잘 돌아가기만 하면 어느정도 유지하면서 서비스는 가능하겠지만 체계적이지 못해 생긴 기술부채는 언젠가는 처리해야 할 문제를 야기하고 해결을 위한 어마어마한 작업량으로 돌아온다고 생각합니다. (돌아옵니다.)
단일 책임이 아닌 클래스를 가지고 단위 테스트를 작성해보니 어떤 건 시도 조차 못했었고, 너무 어려운 작업이었습니다.
- 이전 절차에 종속된 부분을 찢어내고
- 클래스가 가지는 여러 행위(책임)을 단위로 쪼개기 위해 디버깅해가며 하나하나 파악해야 하고
- 해당 클래스를 참조하는 다른 클래스에 어떤 영향이 있을지 모두 파악하고 영향을 최소화해야 했습니다.
책에서 나오는대로 돌아가는 부품은 그 수가 비슷하다. (어느 시스템이든 익힐 내용은 그 양이 비슷하다.) 라고 한다면 클래스를 만들 때부터 하나의 책임을 갖도록 의식하면서 만들어야겠다는 생각이 들었습니다. 급할 때면 생각없이 클래스를 생성하곤 했기에 배운 개념을 실천하지 못하고 있는 제 자신을 반성하게 되는 내용이었습니다.
클래스는 인스턴스 변수 수가 작아야 한다.
각 클래스 메서드는 클래스 인스턴스 변수를 하나 이상 사용해야 한다.
일반적으로 메서드가 변수를 더 많이 사용할 수록 메서드와 클래스는 응집도가 더 높음.
- 모든 인스턴스 변수를 메서드마다 사용하는 클래스는 응집도가 가장 높다.
응집도가 높다 = 클래스에 속한 메서드와 변수가 서로 의존하며 논리적인 단위로 묶인다는 의미
응집도가 높은 클래스
public class Stack {
private int topOfStack = 0;
List<Integer> elements = new LinkedList<Integer>();
public int size() {
return topOfStack;
}
public void push(int element) {
topOfStack++;
elements.add(element);
}
public int pop() throws PoppedWhenEmpty {
if (topOfStack = 0) throw new PoppedWhenEmpty();
int element = elements.get(topOfStack);
elements.remove(topOfStack);
return element;
}
}- 응집도가 아주 높음
- size() 를 제외한 다른 두 메서드는 두 변수를 모두 사용함.
- 응집도가 높아지도록 변수와 메서드를 적절히 분리해 새로운 클래스 두 세개로 쪼개준다.
- '함수를 작게, 매개변수 목록을 짧게' 전략을 따르자
- 몇몇 메서드만이 사용하는 인스턴스 변수가 많아진다면 새로운 클래스로 쪼개야 한다는 신호.
응집도가 높다는 것을 class 내 field 값을 대부분의 method에서 활용하도록 구성되어 있다는 것으로 이해하였습니다.
- 만약 네 변수를 클래스 인스턴스 변수로 승격한다면 새 함수는 인수가 필요 없다. (그만큼 함수를 쪼개기 쉬워짐)
- 다만, 이렇게 작업하면 클래스가 응집력을 잃어버림.
- 몇몇 함수만 사용하는 인스턴스 변수가 점점 더 늘어나기 때문
- 큰 함수를 작은 함수 여럿으로 쪼개다보면 작은 클래스 여럿으로 쪼갤 기회가 생김
- 쪼개는 과정을 통해 프로그램에 점점 더 체계가 잡히고 구조가 투명해진다.
- 프로그램이 길어질 수 있다.
- 리팩토링한 프로그램은 좀 더 길고 서술적인 변수 이름을 사용
- 리팩토링한 프로그램은 코드에 주석을 추가하는 수단으로 함수 선언과 클래스 선언을 활용
- 가독성을 높이고자 공백을 추가하고 형식을 맞췄기 때문
- 리팩토링은 재구현이 아니다. (프로그램을 처음부터 다시 짠 것이 아님)
- 원래 프로그램의 정확한 동작을 검증하는 테스트 슈트를 작성
- 그 다음, 한 번에 하나씩 여러 차례에 걸쳐 조금씩 코드를 변경해가는 것임.
- 코드를 변경할 때마다 변경한 단위에 대한 테스트를 수행해 원래 프로그램과 동일하게 동작하는지 확인함
- 조금씩 기존 코드를 정리한 결과 리팩토링 된 최종 결과물이 도출되는 것.
대상 method가 여러 행위를 수행하고 있고 field 변수 외에 별도의 변수를 선언하여야 동작되고 있다면 리팩토링 대상으로 생각해야겠습니다.
책에서도 소개되지만 리팩토링을 한번에, 그리고 바로 고칠 순 없기에 리팩토링은 별도의 시간이 확보되어야만 수행 할 수 있는 개념은 아닌거 같습니다.
대다수 시스템은 지속적인 변경이 가해짐
→ 변경할 때마다 시스템이 의도대로 동작하지 않을 위험이 따른다.
깨끗한 시스템은 클래스를 체계적으로 정리해 변경으로 인해 수반되는 위험을 낮춘다.
변경이 필요해 '수정해야 하는' 클래스
public 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);
public String select(Column column, String pattern);
public String select(Criteria criteria);
public String preparedlnsert();
private String columnList(Column[] columns);
private String valuesList(Object[] fields, final Column[] columns);
private String selectWithCriteria(String criteria);
private String placeholderList(Column[] columns);
} - 새로운 SQL 문을 지원하려면 반드시 Sql 클래스에 손대야 한다
→ 코드를 '손대면' 반드시 위험이 생긴다.
→ 클래스는 테스트도 완전히 다시 해야 한다. - 구조적인 관점에서도 Sql은 SRP를 위반한다.
- selectWithCriteria() 는 select 문을 처리할 때만 사용
- 클래스 일부에서만 사용되는 비공개 메서드는 코드를 개선할 잠재적인 여지를 시사한다.
- 실제로 개선에 뛰어드는 계기는 시스템이 변해서라야 한다. 클래스에 손대는 순간 설계를 개선하려는 고민과 시도가 필요하다.
공개 인터페이스를 각각 Sql 클래스에서 파생하는 클래스로 만든다면
// 닫힌 클래스 집합
abstract public class Sql {
public Sql(String table, Column[] columns){
}
abstract public String generate();
}
public class CreateSql extends Sql {
public CreateSql(String table, Column[] columns){
}
@Override
public String generate();
}
public class SelectSql extends Sql {
public SelectSql(String table, Column[] columns){
}
@Override
public String generate();
}
public class InsertSql extends Sql {
public InsertSql(String table, Column[] columns, Object[] fields){
}
@Override
public String generate();
private String valuesList(Object[] fields, final Column[] columns);
}
public class SelectWithCriteriaSql extends Sql {
public SelectWithCriteriaSql( String table, Column[] columns, Criteria criteria){
}
@Override
public String generate();
}
public class SelectWithMatchSql extends Sql {
public SelectWithMatchSql (String table, Column[] columns, Column column, String pattern){
}
@Override
public String generate();
}
public class FindByKeySql extends Sql {
public FindByKeySql( String table, Column[] columns, String keyColumn, String keyValue){
}
@Override
public String generate();
}
public class PreparedlnsertSql extends Sql {
public PreparedlnsertSql(String table, Column[] columns){
}
@Override
public String generate();
private String placeholderList(Column[] columns);
}
public class Where {
public Where(String criteria){
}
public String generate();
}
public class ColumnList {
public ColumnList(Column[] columns){
}
public String generate();
}valueList와 같은 비공개 메서드는 해당하는 파생 클래스로 옮김
모든 파생 클래스가 공통으로 사용하는 비공개 메서드는 Where와 ColumnList라는 두 유틸 클래스에 넣음
클래스 집합으로 변경 시
- 각 클래스는 극도로 단순하다
- 코드는 순식간에 이해된다
- 함수 하나를 수정했다고 다른 함수가 망가질 위험도 사실상 사라졌다.
- (클래스가 서로 분리되었으므로) 테스트 관점에서 모든 논리를 구석구석 증명하기도 쉬워졌다.
- SRP를 지원한다
- OCP(Open-Closed Principle)도 지원한다. (새 기능에 개방적인 동시에 다른 클래스를 닫아놓는 형식으로 수정에 폐쇄적)
update 문을 추가할 때 기존 클래스를 변경할 필요가 전혀 없다는 사실 역시 중요!
- update문을 만드는 논리는 Sql 클래스에서 새 클래스 UpdateSql을 상속받아 거기에 넣으면 그만.
- update 문을 지원해도 다른 코드가 망가질 염려는 전혀 없다.
새 기능을 수정하거나 기존 기능을 변경할 때 건드릴 코드가 최소인 시스템 구조가 바람직하다.
이상적인 시스템이라면 새 기능을 추가할 때 시스템을 확장할 뿐 기존 코드를 변경하지는 않는다.
최근에 변경하기 어려운 클래스를 만들면서 프로그램을 구현한 경험이 있어 많은 생각이 들게 하는 내용으로 느껴졌습니다.
DB의 Transaction에 대한 책임을 구현한 Sql class에 대해 Sql의 파생 클래스로 각 책임을 분리하는 작업에서 나온 개념을 정리하면
- DB 기능으로 class를 구현하면 CRUD 별로 로직이 분리되는 편이 유지보수에 유용하다는 점.
- 단독으로 쓰이는 private method는 파생 class로 이동시키면 된다는 것.
- 공통으로 사용되는 private method는 DI를 통해 구현된 기능에 대한 의존성을 갖도록 설정하면 각 기능을 중복으로 구현하지 않아도 된다는 것.
요구사항은 변하기 마련
따라서, 코드도 변하기 마련
객체 지향 프로그래밍 입문에서 구체적인(concrete) 클래스와 추상(abstract) 클래스가 있다고 알려준다.
- 구체적인 클래스는 상세한 구현(코드)을 포함하며 추상 클래스는 개념만 포함한다.
- 상세한 구현에 의존하는 클라이언트 클래스는 구현이 바뀌면 위험에 빠진다.
- 인터페이스와 추상 클래스를 사용해 구현이 미치는 영향을 격리한다.
상세한 구현에 의존하는 코드는 테스트가 어렵다.
ex) 외부 TokyoStockExchange API를 사용해 포트폴리오 값을 계산하는 Portfolio 클래스를 테스트 하기
// TokyoStockExchange API를 직접 호출하는 대신 StockExchange라는 인터페이스를 생성한 후 메서드 하나를 선언
public interface StockExchange {
Money currentPrice(String symbol);
}// 다음으로 StockExchange 인터페이스를 구현하는 TokyoStockExchange 클래스 구현
// Portfolio 생성자를 수정해 StockExchange 참조자를 인수로 받음
public Portfolio {
private StockExchange exchange;
public Portfolio(StockExchange exchange) {
this.exchange = exchange;
} // ...
}// TokyoStockExchange 클래스를 흉내내는 테스트용 클래스를 만들 수 있음
// 테스트용 클래스는 StockExchange 인터페이스를 구현하며 고정된 주가를 반환한다.
// 테스트로 마이크로소프트 주식 다섯 주를 구입한다면 테스트용 클래스는 주가로 언제나 100불을 반환한다.
// 테스트용 클래스는 단순히 미리 정해놓은 표 값만 참조한다.
// 전체 포트폴리오 총계가 500불인지 확인하는 테스트 코드를 작성할 수 있다.
public class PortfolioTest {
private FixedStockExchangeStub exchange;
private Portfolio portfolio;
@Before
protected void setUp() throws Exception {
exchange = new FixedStockExchangeStub();
exchange.fix("MSFT", 100);
portfolio = new Portfolio(exchange);
}
@Test
public void GivenFiveMSFTTotalShouldBe500() throws Exception {
portfolio.add(5, "MSFT");
Assert.assertEquals(500, portfolio.value());
}
}
- 위의 테스트가 가능할 정도로 시스템 결합도를 낮추면 유연성과 재사용성도 더욱 높아진다.
- 결합도가 낮다 = 각 시스템 요소가 다른 요소로부터, 그리고 변경으로부터 잘 격리되어 있다는 의미
- 시스템 요소가 서로 잘 격리되어 있으면 각 요소를 이해하기도 더 쉬워진다
- 결합도를 최소로 줄이면 자연스레 DIP(Dependency Inversion Principle)를 따르는 클래스가 나온다
- 본질적으로 DIP 클래스가 상세한 구현이 아니라 추상화에 의존해야 한다는 원칙
- 개선한 Portfolio class는 상세 구현 클래스인 TokyoStockExchange 가 아니라 StockExchange 인터페이스에 의존한다.
- StockExchange 인터페이스는 주식 기호를 받아 현재 주식 가격을 반환한다는 추상적인 개념을 표현한다.
- 추상화를 통해 실제로 주가를 얻어오는 출처나 얻어오는 방식 등과 같은 구체적인 사실을 모두 숨긴다.
- 본질적으로 DIP 클래스가 상세한 구현이 아니라 추상화에 의존해야 한다는 원칙
추후의 변경사항에 대비하기 위해 처음부터 기능을 구현할 때 잊지말고!
1. 책임을 수행할 역할을 추상화하여 정리해두도록 한다.
2. 도메인의 비즈니스 로직에 대해 수행할 객체는 구현class의 field로 설정하고 의존성을 전달받아 역할이 수행되도록 구성한다. (비즈니스 로직 구현 객체는 갈아끼우기 편하게 설정하기 위함)
3. 단위테스트를 작성할 때 로직 단위 점검(ex) 선물거래소 비즈니스 로직) 과 역할 수행 단위 점검(ex) 거래소 기본 기능)이 가능하다면 결합도가 낮은 것으로 이해할 수 있다.
라는 세 가지의 개념을 의식하면서 코딩할 수 있도록 노력해봐야겠습니다.
Author And Source
이 문제에 관하여(클린코드 (8) - 클래스), 우리는 이곳에서 더 많은 자료를 발견하고 링크를 클릭하여 보았다 https://velog.io/@gentledot/clean-code-about-class저자 귀속: 원작자 정보가 원작자 URL에 포함되어 있으며 저작권은 원작자 소유입니다.
우수한 개발자 콘텐츠 발견에 전념
(Collection and Share based on the CC Protocol.)
좋은 웹페이지 즐겨찾기
