클린 코드: 디미터 법칙

디미터 법칙은 잘 알려진 휴리스틱으로 모듈은 자신이 조작하는 객체의 속사정을 몰라야 한다는 법칙이다. 습관적 getter, setter 문단에서 봤듯이, 객체는 자료를 숨기고 함수를 공개한다.

좀 더 정확히 표현하면, 디미터 법칙은 “클래스 C의 메서드 f는 다음과 같은 객체의 메서드만 호출해야 한다”고 주장한다.

• 클래스 C
• f가 생성한 객체
• f 인수로 넘어온 객체
• C 인스턴스 변수에 저장된 객체

하지만 위 객체에서 허용된 메서드가 반환하는 객체의 메서드는 호출하면 안 된다. 다시 말해, 낯선 사람은 경계하고 친구랑만 놀라는 의미이다. 아래는 예시이다.

final String outputDir = ctxt.getOptions().getScratchDir().getAbsolutePath();

흔히 위와 같은 코드를 기차 충돌이라 부른다. 여러 객차가 한 줄로 이어진 기차처럼 보이기 때문이다. 일반적으로 조잡하다 여겨지는 방식이기 때문에 피하는 것이 좋다. 따라서 다음과 같이 나누는 편이 좋다.

Options opts = ctxt.getOptions();
File scratchDir = opts.getScratchDir();
final String outputDir = scratchDir.getAbsolutePath();

그럼 위 코드는 디미터 법칙을 위반할까? 그건 ctxt, Options, ScratchDir이 객체인지 아니면 자료 구조인지에 달렸다. 객체라면 내부 구조를 숨겨야 하므로 확실히 디미터 법칙을 위반한다. 반면, 자료 구조라면 당연히 디미터 법칙이 적용되지 않는다.

휴 쉽지 않네!

이런 혼란으로 말미암아 때때로 절반은 객체, 절반은 자료 구조인 잡종 구조가 나온다. 잡종 구조는 중요한 기능을 수행하는 함수도 있고, 공개 변수나 공개 조회/설정 함수도 있다. 공개 조회/설정 함수는 비공개 변수를 그대로 노출한다.

이런 잡종 구조는 새로운 함수는 물론이고 새로운 자료 구조도 추가하기 어렵다. 양쪽 세상에서 단점만 모아놓은 구조다. 프로그래머가 어중간하게 내놓은 설계에 불과하다.

구조체 감추기

만약 ctxt, options, scratchDir이 진짜 객체라면? 그렇다면 임시 디렉터리의 절대 경로는 어떻게 얻어야 좋을까?

1) ctxt.getAbsolutePathOfScratchDirectoryOption();
2) ctxt.getScratchDirectoryOption().getAbsolutePath();

1번 방법은 ctxt 객체가 공개해야 하는 메서드가 너무 많아진다. 2번 방법은 getScratchDirectoryOption()이 객체가 아니라 자료 구조를 반환한다고 가정한다. 그렇지만 다소 아쉬운 방법이다.

ctxt가 객체라면 뭔가를 하라고 말해줘야지, 속을 드러내라(뭔가를 내놓아라)라고 말하면 안된다. 임시 디렉터리의 절대 경로가 왜 필요할까? 절대 경로를 얻어 어디에 쓰려고? 다음은 같은 모듈에서 가져온 코드이다.

String outFile = outputDir + "/" + className.replace('.', '/') + ".class";
FileOutputStream fout = new FileOutputStream(outFile);
BufferedOutputStream bos = new BufferedOutputStream(fout);

추상화 수준을 뒤섞어 놓아 다소 불편하다. 점, 슬래시, 파일 확장자, File 객체를 부주의하게 마구 뒤섞어 두면 안된다. 어쨌거나, 위 코드를 살펴보면, 임시 디렉터리의 목적은 결국 임시 파일을 생성하기 위한 목적이라는 것이 드러난다.

그렇다면 ctxt 객체에 임시 파일을 생성하라고 시키면 어떨까?

BufferedOutputStream bos = ctxt.createScratchFileStream(classFileName);

객체에게 맡기기에 적당한 임무로 보인다. 내부 구조를 드러내지도 않고, 모듈에서 해당 함수는 자신이 몰라야 하는 여러 객체를 탐색할 필요가 없다(디미터 법칙을 위반하지 않는다).

💡 여기서 중요한 점은, 필자의 사고 방식을 따라가는 것 같다. 필자는 난잡한 추상화 수준을 하나의 목적을 가지는 함수로 다시 추상화하기 위해서 객체가 알아야 하는 것과 해야하는 것을 분명하게 하고 이를 적절하게 추상화함으로써 목적을 달성했다.

DTO

DTO는 자료 전달 객체로 데이터베이스와 통신하거나 소켓에서 받은 메시지를 분석할 때 유용하다. 일반적인 형태는 빈 구조로, 비공개 변수를 조회/설정 함수로 조작한다. 그러나 딱히 “자료구조”와 다를 바가 없는 사이비 캡슐화로, 일부 OO 순수주의자나 만족시킬 뿐 별다른 이익을 제공하지 않는다.

활성 레코드

활성 레코드는 DTO의 특수한 형태다. DTO에 save나 find 같은 탐색 함수도 제공하는 것이다. 불행히도 활성 레코드에 비즈니스 로직을 추가해 이런 자료구조를 객체로 취급하는 개발자가 흔하다. 이는 잡종 구조에 불과하다.

해결책은 활성 레코드를 자료구조로 취급하며, 비즈니스 로직을 담으면서 내부 자료를 숨기는 객체를 따로 생성하는 것이다. (여기서 내부 자료는 활성 레코드의 인스턴스일 가능성이 높다)