올바른 코드, 올바른 함수, 깨끗한 클래스에 대해 잘 이해가 안되는 점이 있어 해당 절을 읽으면서 내용을 정리해보았습니다.
공개 변수가 필요한 경우가 거의 없음
의 의미를 public field로 선언하고 이를 직접 참조하여 사용하는 경우는 거의 없다는 것으로 이해하였습니다.
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를 하나하나 적어보았는데도 저 클래스가 무엇을 하는지 이해를 못하겠습니다. ㅠ
method 수가 5개라도 적절한 크기가 아니라는 것은 결국 어떤 도메인의 행위(책임)이 여럿이라면 하나하나 수행할 수 있는 단위의 클래스로 분리하는 것이 낫다는 것으로 이해됩니다.
작명은 이래저래 정말로 어려운 것 같습니다. 25단어 내외라는 제한이 제시되지만 핵심은 글자 수보다는 '객체에 대해 명확히 이해될 수 있도록 명명할 수 있는가' 인 것 같습니다.
단일 책임 원칙(SRP, Single Responsibility Principle)
은 클래스나 모듈을 변경할 이유가 단 하나뿐이어야 한다는 원칙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;
}
}
응집도가 높다는 것을 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 클래스에서 파생하는 클래스로 만든다면
// 닫힌 클래스 집합
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라는 두 유틸 클래스에 넣음
클래스 집합으로 변경 시
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());
}
}
추후의 변경사항에 대비하기 위해 처음부터 기능을 구현할 때 잊지말고!
1. 책임을 수행할 역할을 추상화하여 정리해두도록 한다.
2. 도메인의 비즈니스 로직에 대해 수행할 객체는 구현class의 field로 설정하고 의존성을 전달받아 역할이 수행되도록 구성한다. (비즈니스 로직 구현 객체는 갈아끼우기 편하게 설정하기 위함)
3. 단위테스트를 작성할 때 로직 단위 점검(ex) 선물거래소 비즈니스 로직) 과 역할 수행 단위 점검(ex) 거래소 기본 기능)이 가능하다면 결합도가 낮은 것으로 이해할 수 있다.
라는 세 가지의 개념을 의식하면서 코딩할 수 있도록 노력해봐야겠습니다.