Skip to main content

박수완

1. 📌 핵심 개념 정리

✅ 요약하기

  1. 클래스 체계

    클래스를 정의하느 표준 자바 관례에 따르면, 가장 먼저 변수 목록이 나온다. 정적 공개 상수가 있다면 맨 처음에 나온다. 다음으로 정적 비공개 변수가 나오며 이어서 비공개 인스턴스 변수가 나온다.

  • 캡술화

    변수와 유탈리티 함수는 가능한 공개하지 않는 편이 낫지만 반드시 숨겨야한다는 법칙도 없다. 때로는 변수나 유틸리티 함수를 protected로 선언해 테스트 코드에 접근을 허용하기도 한다.

  1. 클래스는 작아야 한다

    클래스를 만들 때 첫 번째 규칙은 크기다. 클래스는 작아야 한다. 두 번째 규칙도 크기다. 더 작아야 한다. 앞서 함수 장에서 했던 이야기를 되풀이할 의도는 없더. 단지 클래스를 설계할 때도, 함수와 마찬가지로, 작게가 기본 규칙이라는 의미다.

    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 getMinorVersionNumber()
    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 setAçowDragging(boolean allowDragging) 
    public boolean allowDragging()
    public boolean isCustomizing()
    public void setTitle(String title)
    public IdeMenuBar getIdeMenuBar()
    public void showHelper(MetaObject metaObject, String propertyName) 

    // 많은 비공개 메서드가 이어진다.
}

    어느 개발자가 봐도 클래스가 상당히 길다는것에 동의한다.

     // 메소드를 5개로 줄인다고 하더라도 여전히 책임이 많다..

 public class SuperDashboard extends JFrame implements MetaDataUser {
 	public Component getLastFocusedComponent()
 	public void setLastFocused(Component lastFocused)
 	public int getMajorVersionNumber()
 	public int getMinorVersionNumber()
 	public int getBuildNumber() 
 }

    클래스 이름은 해당 클래스 책임을 기술해야 한다. 실제로 작명은 클래스 크기를 줄이는 첫 번째 관문이다. 간결한 이름이 떠오르지 않는다면 필경 클래스 크기가 너무 커서 그렇다.


    • 단일 책임 원칙

      단일 책임 원칙은 클래스나 모듈을 변경할 이유가 하나, 단 하나 뿐이여야 한다는 원칙이다. SRP는 책임이라는 개념을 정의하며 적절한 클래스 크기를 제시한다. 클래스는 책임, 즉 변경할 이유가 하나여야 한다는 의미다.

      
public class Version {
	public int getMajorVersionNumber() 
	public int getMinorVersionNumber() 
	public int getBuildNumber()
}

      책임, 변경할 이유를 파악하려 애쓰다 보면 코드를 추상화하기도 쉬워진다. 더 좋은 추상화가 더 쉽게 떠오른다. SuperDashboard에서 버전 정보를 다루는 메서드 세 개를 따로 빼내 Verstion이라는 독자적인 클래스를 만든다.


    큰 클래스가 몇 개가 아니라 작은 클래스 여럿으로 이뤄진 시스템이 더 바람직하다. 작은 클래스는 각자 맡은 책임이 하나며, 변경할 이유가 하나며, 다른 작은 클래스와 협력해 시스템에 필요한 동작을 수행한다.

    • 응집도

      클래스는 인스턴스 변수 수가 작아야 한다. 각 클래스 메서드는 클래스 인스턴스 변수를 하나 이상 사용해야 한다. 일반적으로 메서드가 변수를 더 많이 사용할수록 클래스 응집도가 가장 높다.

    // Stack을 구현한 코드, 응집도가 높은 편이다.

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;
	}
}

    함수를 작게, 매개변수 목록을 짧게라는 전략을 따르다 보면 때때로 몇몇 메서드만이 사용하는 인스턴스 변수가 아주 많아진다. 이는 십중팔구 새로운 클래스로 쪼개야 한다는 신호다.


    • 응집도를 유지하면 작은 클래스 여럿이 나온다

      큰 함수를 작은 함수 여럿으로 쪼개다 보면 종종 작은 클래스 여럿으로 쪼갤 기회가 생긴다. 그러면서 프로그램에 점점 더 체계가 잡히고 구조가 두명해진다.

       package literatePrimes;

 public class PrintPrimes {
 	public static void main(String[] args) {
 		final int M = 1000; 
 		final int RR = 50;
 		final int CC = 4;
 		final int WW = 10;
 		final int ORDMAX = 30; 
 		int P[] = new int[M + 1]; 
 		int PAGENUMBER;
 		int PAGEOFFSET; 
 		int ROWOFFSET; 
 		int C;
 		int J;
 		int K;
 		boolean JPRIME;
 		int ORD;
 		int SQUARE;
 		int N;
 		int MULT[] = new int[ORDMAX + 1];

 		J = 1;
 		K = 1; 
 		P[1] = 2; 
 		ORD = 2; 
 		SQUARE = 9;

 		while (K < M) { 
 			do {
 				J = J + 2;
 				if (J == SQUARE) {
 					ORD = ORD + 1;
 					SQUARE = P[ORD] * P[ORD]; 
 					MULT[ORD - 1] = J;
 				}
 				N = 2;
 				JPRIME = true;
 				while (N < ORD && JPRIME) {
 					while (MULT[N] < J)
 						MULT[N] = MULT[N] + P[N] + P[N];
 					if (MULT[N] == J) 
 						JPRIME = false;
 					N = N + 1; 
 				}
 			} while (!JPRIME); 
 			K = K + 1;
 			P[K] = J;
 		} 
 		{
 			PAGENUMBER = 1; 
 			PAGEOFFSET = 1;
 			while (PAGEOFFSET <= M) {
 				System.out.println("The First " + M + " Prime Numbers --- Page " + PAGENUMBER);
 				System.out.println("");
 				for (ROWOFFSET = PAGEOFFSET; ROWOFFSET < PAGEOFFSET + RR; ROWOFFSET++) {
 					for (C = 0; C < CC;C++)
 						if (ROWOFFSET + C * RR <= M)
 							System.out.format("%10d", P[ROWOFFSET + C * RR]); 
 					System.out.println("");
 				}
 				System.out.println("\f"); PAGENUMBER = PAGENUMBER + 1; PAGEOFFSET = PAGEOFFSET + RR * CC;
 			}
 		}
 	}
 }

      함수가 하나뿐인 위 프로그램은 엉망진창이다. 들여쓰기가 심하고 이상한 변수가 많고 구조가 빡빡하게 결합되었다. 최소한 여러 함수로 나눠야 마땅하다.

  1. 변경하기 쉬운 클래스

    대다수 시스템은 지속적인 변경이 가해진다. 그리고 뭔가 변경할 때마다 시스템이 의도대록 동작하지 않을 위험이 따른다. 깨끗한 시스템은 클래스를 체계적으로 정리해 변경에 수반한 위험을 낮춘다.

    • 개선 전
    
 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 preparedInsert()
 	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문을 수정할 때도 손대야 하므로 SRP위반한다.

    • 개선 후
       // 공개 인터페이스를 전부 SQL 클래스에서 파생하는 클래스로 만들고, 비공개 메서드는 해당 클래스로 옮기고,
 // 공통된 인터페이스는 따로 클래스로 뺐다.
 // 이렇게 하면 update문 추가 시에 기존의 클래스를 건드릴 이유가 없어진다.

 	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 PreparedInsertSql extends Sql {
 		public PreparedInsertSql(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()
 	}

    Update문을 추가할 때 기존 클래스를 변경할 필요가 전혀 없다는 사실 역시 중요하다. Updte문을 논리는 sql 클래스에서 새 클래스 UpdateSql을 상속받아 거기에 넣으면 그만이다. update문을 지원해도 다른 코드가 망가질 염려는 전혀 없다.

    • 변경으로부터 격리

      상세한 구현에 의존하는 클라이언트 클래스는 구현이 바뀌면 위험에 빠진다. 그래서 우리는 인터페이스와 추상 클래스를 사용해 구현이 미치는 영향을 격리한다.


       public interface StockExchange { 
 	Money currentPrice(String symbol);
 }

      public Portfolio {
	private StockExchange exchange;
	public Portfolio(StockExchange exchange) {
		this.exchange = exchange; 
	}
	// ... 
}

       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를 따르는 클래스가 나온다. 본질적으로 DIP 클래스가 상세한 구현이 아니라 추상화에 의존해야 한다는 원칙이다.

2. 🤔 이해가 어려운 부분

🔍 질문하기

책을 읽으며 이해하기 어려웠던 개념이나 명확하지 않았던 내용을 정리합니다.

  1. 개념 또는 원칙의 이름
    • 어려웠던 부분
      해당 개념이 헷갈리거나 명확하지 않았던 점을 구체적으로 설명합니다.
    • 궁금한 점
      해당 개념이 어떤 원리로 동작하는지, 실무에서 어떻게 활용되는지 등을 질문 형태로 정리합니다.
  1. 개념 또는 원칙의 이름
    • 어려웠던 부분
      .
    • 궁금한 점
      .
  1. 개념 또는 원칙의 이름
    • 어려웠던 부분
      .
    • 궁금한 점
      .

3. 📚 참고 사항

📢 논의하기

관련된 자료가 있다면 공유하고, 더 깊이 논의하고 싶은 아이디어나 의견을 정리합니다.

  1. 관련 자료 공유
    • 추가 자료
      관련 블로그 글이나 공식 문서 링크를 제공합니다.
  1. 논의하고 싶은 주제
    • 주제
      논의하고 싶은 내용을 간략히 정리합니다.
    • 설명
      논의하고 싶은 이유를 작성합니다.
Back to top