책 내용 - 클래스
•
클래스 체계
클래스를 정의하는 표준 자바의 관례
1.
변수 목록이 나온다.
2.
정적 static, 공개 public 상수가 있다면 맨 처음 나온다.
3.
정적 static, 비공개 private 변수가 나온다.
4.
비공개 인스턴스 변수가 나온다.
5.
공개 함수가 나온다.
6.
비공개 함수는 자신을 호출하는 공개 함수 직후에 넣는다.
즉, 추상화 단계가 순차적으로 내려간다. 그래서 프로그램은 신문 기사처럼 읽힌다.
여기서 정적 변수와 인스턴스 변수라는 말에서 어떤 부분을 말하는지 잘 와닿지 않았다.
•
정적 변수 static
◦
클래스 내에 satitc 키워드로 선언된 변수 static영역에 생성되면서, 모든 객체의 공유가 가능해진다.
◦
처음 JVM이 실행되어 클래스가 메모리에 할당될 때부터 프로그램이 종료될 때까지 메모리가 할당된 채 존재한다.
◦
클래스가 여러번 생성되어도 static 변수는 딱 한 번만 생성되고, 생성된 변수의 값만 수정된다.
•
인스턴스 변수
◦
클래스 내에 선언된 변수
◦
heap영역에서 생성되면서, GC(Garbage Colletor)의 관리를 받음
◦
정적 변수와 달리 객체가 공유가 되지 않는다.
결론
•
정적변수는 JVM이 실행되면 프로그램이 종료될 때까지 메모리를 할당받아 모든 영역에서 공유되는 변수
•
인서턴스 변수는 우리가 흔하게 사용하는 변수로써 static이 제외된 변수
•
클래스는 작아야 한다.!
클래스를 만들 때 첫 번째 규칙은 크기다. 클래스는 작아야 한다.
두 번째 규칙도 크기다. 더 작아야 한다. 클래스도 함수와 마찬가지로 '작게'가 기본 규칙이라는 의미다.
아래 예를 보자
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 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)
}
Java
복사
대다수 개발자는 클래스가 엄창나게 크다는 사실에 동의하리라.
SuperDashboard 클래스를 '만능 클래스'라 부르는 개발자가 있을지도 모르겠다.
하지만 만약 SuperDashboard가 아래와 같이 메서드 몇 개만 포함한다면?
public class SuperDashboard extends JFrame implements MetaDataUser {
public Component getLastFocusedComponent()
public void setLastFocused(Component lastFocused)
public int getMajorVersionNumber()
public int getMinorVersionNumber()
public int getBuildNumber()
}
Java
복사
메서드 다섯 개 정도면 괜찮다. 안 그런가? 여기서는 아니다!.
SuperDashboard는 메서드 수가 작음에도 불구하고 책임이 너무 많다.
1) 클래스 이름은 해당하는 클래스 책임을 기술해야된다.
예를 들어 Processer, Manager, Super등과 같이 모호한 단어가 있다면 클래스에다 여러 책임을 떠 안겼다는 증거다.
2) 클래스 설명은 만일("if"), 그리고("and"), ~하며("or"), 하지만("but"), 을 사용하지 않고서 25 단어 내외로 가능해야 한다.
"SuperDashboard는 마지막으로 포커스를 얻었던 컴포넌트에 접근하는 방법을 제공하며, 버전과 비들 번화를 추적하는 메커니즘을 제공한다." 책임이 많다는 증거다.
•
단일 책임 원칙 (Single Responsibility Principle, SRP)
단일 책임 원칙은 클래스나 모듈을 변경할 이유가 하나, 단 하나뿐이어야 한다는 원칙이다.
SuperDashboard는 변경할 이유가 두 가지다.
•
SuperDashboard는 소프트웨어 버전 정보를 추적한다. 그런데 정보는 소프트웨어를 출시할 때마다 달라진다.
•
SuperDashboard는 자바 스윙 컴포넌트를 관리한다. 즉, 스윙 코드를 변경할 때마다 버전 번호가 달라진다
즉 변경할 이유를 파악하려 애쓰다 보면 코드를 추상화하기도 쉬워진다.
SuperDashboard에서 버전 정보를 다루는 메서드 세 개를 따로 빼내 독자적인 class를 만든다.
public class Version {
public int getMajorVersionNumber()
public int getMinorVersionNumber()
public int getBuildNumber()
}
Java
복사
'소프트웨어를 돌아가게 만드는 활동'과 '소프트웨어를 깨끗하게 만드는 활동'은 완전히 별개다.
문제는 우리들 대다수가 프로그램이 돌아가면 일이 끝났다고 여기는 데 있다.
•
'깨끗하고 체계적인 소프트웨어'라는 다음 관심사로 전환하지 않는다.
•
프로그램으로 되돌아가 만능 클래스를 단일 책임 클래스 여럿으로 분리하는 대신 다음 문제로 넘어간다.
많은 개발자는 자잘한 단일 책임 클래스가 많아지면 큰 그림을 이해하기 어려워진다고 우려한다.
하지만 작은 클래스가 많은 시스템이든 큰 클래스가 몇 개뿐인 시스템이든 돌아가는 부품은 그 수가 비슷하다.
도구 상자를 어떻게 관리하고 싶은가?
작은 서랍을 많이 두고 기능과 이름이 명확한 컴포넌트를 나눠 넣고 싶은가?
아니면 큰 서랍 몇 개를 두고 모두를 던져 놓고 싶은가?
큼직한 다목적 클래스 몇 개로 이뤄진 시스템은 당장 알 필요가 없는 사실까지 들이밀어 독자를 방해한다.
강조하는 차원에서 한 번 더 말하겠다. 큰 클래스 몇 개가 아니라 작은 클래스 여럿으로 이뤄진 시스템이 더 바람직하다.
•
응집도
일반적으로 메서드가 변수를 더 많이 사용할수록 메서드와 클래스는 응집도가 더 높다.
우리는 응집도가 높은 클래스를 선호한다.
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;
}
}
Java
복사
'함수를 작게, 매개변수 목록을 짧게'라는 전략을 따르다 보면 때때로 몇몇 메서드만이 사용하는 인스턴스 변수가 아주 많아진다. 이는 십중팔구 새로운 클래스로 쪼개야 한다는 신호다.
•
변경하기 쉬운 클래스
대다수 시스템은 지속적인 변경이 가해진다.
깨끗한 시스템은 클래스를 체계적으로 정리해 변경에 수반하는 위험을 낮춘다.
아래 예시를 보자
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)
}
Java
복사
문제 발생
•
새로운 SQL문을 지원하려면 반드시 sql 클래스에 손대야 한다.
•
select문에 내장된 select문을 지원하려면 sql클래스를 고쳐야 한다.
이렇듯 변경할 이유가 두 가지이므로 sql 클래스는 SRP를 위반한다.
아래 예시를 보자
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 String generate() {
}
public class ColumnList {
public ColumnList(Column[] columns) public String generate()
public String generate() {
}
Java
복사
각 클래스는 극도로 단순하다.
•
함수 하나를 수정했다고 다른 함수가 망가질 위험이 없다.
•
테스트 관점에서 모든 논리를 구석구석 증명하기 쉽다.
•
update문을 추가할 때 기존 클래스를 변경할 필요가 전혀 없다.
•
SRP를 지원한다.
•
OCP(open-closed-principle)도 지원한다. 클래스는 확장에 개방적이고 수정에 폐쇄적이어야 한다는 원칙
•
파생 클래스를 생성하는 방식으로 새 기능에 개방적인 동시에 다른 클래스를 닫아놓는 방식으로 수정에 폐쇄적이다.
•
변경으로부터 격리
요구사항은 변하기 마련이다. 따라서 코드도 변하기 마련이다.
•
상세한 구현에 의존하는 클라이언트 클래스는 구현이 바뀌면 위험에 빠진다.
•
상세한 구현에 의존하는 코드는 테스트가 어렵다.
아래 코드는 API를 사용해 포트폴리오 값을 계산한다. 따라서 우리 테스트 코드는 시세 변화에 영향을 받는다.
◦
portfolio 클래스에서 TokyoStckExchange API를 직접 호출하는 대신 StockExchange라는 인터페이스를 생성한 후 메서드 하나를 선언한다.
public interface StockExchange {
Money currentPrice(String symbol);
}
Java
복사
◦
다음으로 StockExchange 인터페이스를 구현하는 TokyoStockExchange 클래스를 구현한다.
◦
portfolio 생성자를 수정해 StockExchange 참조자를 인수로 받는다.
여기서 뭔가 빠진 느낌이 들어서 부연설명을 하도록 하겠다.
TokyoStockExchange 어떻게 구현하는데?
public class TokyoStockExchange implement StockExchange {
@Override public Money currentPrice(Stromg symbol) {
....구현
}
}
Java
복사
그리고 추가적으로 TokyoStockExchange 클래스를 흉내 내는 테스트용 클래스를 만들 수 있다.
여기서도 FixedStockExchangeStub() 클래스를 어떻게 구현하는지 안 나와있었다.
public class FixedStockExchangeStub implement StockExchange {
@Override public Money currentPrice(Stromg symbol) {
....구현
}
}
Java
복사
이제 고정된 주가를 반환하기 때문에 테스트 코드로 FixedStockExchangeStub 클래스를 사용하면 된다.
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());
}
}
Java
복사
위와 같이 테스트가 가능할 정도로 시스템의 결합도를 낮추면 유연성과 재사용 성도 더욱 높아진다.
결합도가 낮다는 소리는
◦
각 시스템 요소가 다른 요소로부터 그리고 변경으로부터 잘 격리되어 있다는 의미다.
◦
각 시스템의 요소가 서로 잘 격리되어 있으면 각 요소를 이해하기도 더 쉬워진다.
◦
결합도를 최소로 줄이면 다른 클래스 설계 원칙인 DIP(Dependency Inversion Priniciple)를 따르는 클래스가 나온다.
우리가 개선한 Portfolio 클래스는 TokyoStockExchange라는 상세한 구현 클래스가 아니라 StockExchange 인터페이스에 의존한다.
이와 같은 추상화로 실제로 주가를 얻어오는 출처나 얻어오는 방식 등과 같은 구체적인 사실을 모두 숨긴다.
결론
오늘은 자바의 클래스에 대해서 읽게 되었다. 변수 선언부터 함수 선언까지 모든 것이 순차적으로 이뤄줘야 깨끗한 코드라 할 수 있으며, 적절하게 추상 클래스를 이용해 변경과 이격 되게 설계해야 된다는 것을 알 수 있었다.물론 위에서 언급한 것처럼 '소프트웨어를 돌아가게 만드는 활동'과 '소프트웨어를 깨끗하게 만드는 활동' 동시에 해야 된다는 마음은 새기겠지만, 과현 현실에서 가능할지는 고민이 많이 되는 구문이었다.다시 한번 깨끗한 코드를 위해 마음을 다잡아야겠다.