[리뷰] 클린코드 clean code 8장 - 경계

책 내용 - 경계

시스템에 들어가는 모든 소프트웨어를 직접 개발하는 경우는 드물다.

때로는 패키지를 사고, 때로는 오픈 소스를 이용한다. 

어떤 식으로든 이 외부 코드를 우리 코드에 깔끔하게 통합해야만 한다.

 

*외부 코드 사용하기

패키지 제공자나 프레임워크 제공자는 적용성을 최대한 넓히려 애쓴다. 더 많은 환경에서 돌아가야 더 많은 고객이 구매하니까. 반면 사용자는 자신의 요구에 집중하는 인터페이스를 바란다. 이런 긴장으로 인해 시스템 경계에서 문제가 생길 소지가 많다.

 

  아래 java.util.Map을 살펴보자.

• Map은 굉장히 다양한 인터페이스로 수많은 기능을 제공한다.
• Map이 제공하는 기능성과 유연성은 확실히 유용하지만 그만큼 위험도 크다.
•  Map을 만들어 여기저기 넘긴다고 가정하자. 넘기는 쪽에서는 아무도 Map의 내용을 삭제하지 않으리라 믿을지도 모르겠다. 그런데 아래 목록 보면 첫째가 Clear() 메서드다. 즉, Map사용자라면 누구나 Map 내용을 지울 권한이 있다는 말이다.

clear() void - Map
containsKey(Object key) boolean – Map
containsValue(Object value) boolean – Map
clear() void – Map
containsKey(Object key) boolean – Map
containsValue(Object value) boolean – Map
entrySet() Set – Map
equals(Object o) boolean – Map
get(Object key) Object – Map
getClass() Class<? extends Object> – Object
hashCode() int – Map
isEmpty() boolean – Map
keySet() Set – Map
notify() void – Object
notifyAll() void – Object
put(Object key, Object value) Object – Map
putAll(Map t) void – Map
remove(Object key) Object – Map
size() int – Map
toString() String – Object
values() Collection – Map
wait() void – Object
wait(long timeout) void – Object
wait(long timeout, int nanos) void – Object

Sensor라는 객체를 담는 Map을 만들려면 다음과 같이 Map을 생성한다.

Map sensors = new HashMap();

Sensor 객체가 필요한 코드는 다음과 같이 Sensor 객체를 가져온다.

Sensor s = (Sensor)sensor.get(sensorId);

위와 같은 코드가 한 번이 아니라 여러 차례 나온다.

즉, Map이 반환하는 Object를 올바른 유형으로 변환할 책임은 Map을 사용하는 클라이언트에 있다.

다음과 같은 제너릭을 사용하면 코드 가독성이 크게 높아진다.

Map<String, Sensor> sensor = new HashMap<Sensor>();
...
Sensor s = sensors.get(sensorId);

그렇지만 위 방법도 "Map<String, Sensor>가 사용자에게 필요하지 않는 기능까지 제공한다."는 문제는 해결하지 못했다.

 

해결방법

 다음은 Map을 좀 더 깔끔하게 사용한 코드다.

Sensors 사용자는 제네릭스가 사용되었는지 여부에 신경 쓸 필요가 없다.

제네릭스의 사용 여부는 Sensors 안에서 결정한다.

public class Sensors {
	private Map sensors = new HashMap();
    
    public Sensor getById(String id) {
    	return (Sensor) sensors.get(id);
    }
    
    // 이하 생략
}

1. 경계 인터페이스인 Map을 Sensors 안에 숨긴다.

• Map 인터페이스 변하더라도 나머지 프로그램에는 영향을 끼치지 않는다.
• 제너릭을 사용하든 하지 않든 더 이상 문제가 안된다.  Sensors 클래스 안에서 객체 유형을 관리하고 변환하기 때문

2. Sensors 클래스는 프로그램에 필요한 인터페이스만 제공한다.

• 클래스 설계자가 제공해준 함수만 사용가능 하기때문에, 사용되고, 필요한 함수만 사용하게 된다.

3. Map 클래스를 사용할 때마다 위와 같이 캡슐화하라는 소리가 아니다.

• Map과 같은 경계 인터페이스를 이용할때 이를 이용하는 클래스나 클래스 계열 밖으로 노출되지 않도록 주의한다.
• Map 인스턴스를 공개 API의 인수로 넘기거나 반환 값으로 사용하지 않는다.

 

테스트 케이스를 통한 예제 log4j에 대해 나옵니다.

해당하는 부분은 공부한 후 이해된 내용을 바탕으로 추후에 작성하도록 하겠습니다.

결론

경계 인터페이스를 이용할때 클래스나 클래스 계열 밖으로 노출되지 않게 하고, 사용자가 원하는 기능만 사용 가능하게 설계해야 된다. 너무 많은 기능을 제공하게 되면 내가 원하지 않는 값까지 삭제하거나, 삭제할 수 있는 상황이 발생할 수 있다.