4 ~ 6 : 주석, 형식 맞추기, 객체와 자료구조

4장 : 주석

부정확한 주석은 아예 없는 주석보다 훨씬 더 나쁘다.

주석은 나쁜 코드를 보완하지 못한다.

표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가, 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다.

코드로 의도를 표현하라!

// 직원에게 복집 혜택을 받을 자격이 있는지 검사한다.
if ((employee.flags & HOURLY_FLAG) && emploeyy.age > 65)

if (employee.isEligibleForFullBenefits())

좋은 주석

• 법적인 주석

• 정보를 제공하는 주석

• 의도를 설명하는 주석

• 의미를 명료하게 밝히는 주석

• 결과를 경고하는 주석

• TODO 주석

• 중요성을 강조하는 주석

• 공개 API에서 Javadocs

나쁜주석

• 주절거리는 주석

• 같은 이야기를 중복하는 주석

• 오해할 여지가 있는 주석

• 의무적으로 다는 주석

• 이력을 기록하는 주석

• 무서운 잡음

• 함수나 변수로 표현할 수 있다면 주석을 달지 마라

• 위치를 표시하는 주석

• 닫는 괄호에 다는 주석

• 공로를 돌리거나 저자를 표시하는 주석

• 주석으로 처리한 코드

• HTML 주석

• 전역 정보 - 주석을 달아야 한다면 근처에 있는 코드만 기술하라.

• 너무 많은 정보 - 주석에다 흥미로운 역사나 관련 없는 정보를 장황하게 늘어놓지 마라.

• 모호한 관계 - 주석과 주석이 설명하는 코드는 둘 사이 관계가 명백해야 한다.

• 함수 헤더

• 비공개 코드에서 Javadocs

5장 : 형식 맞추기

형식을 맞추는 목적

코드 형식은 중요하다. 왜냐하면 오랜 시간이 지나 원래 코드의 흔적을 더 이상 찾아보기 어려울 정도로 코드가 바뀌어도 맨 처음 잡아놓은 구현 스타일과 가독성 수준은 유지보수 용이성가 확장성에 계속 영향을 미친다.

적절한 행 길이를 유지하라

• 신문 기사처럼 작성하라 - 이름은 간단하면서도 설명이 가능하게 짓는다. 소스 파일 첫 부분은 고차원 개념과 알고리즘을 설명하고 아래로 내려갈수록 의도를 세세하게 묘사한 후 마지막에 가장 저차원 함수와 세부 내역이 나온다.

• 개념은 빈 행으로 분리하라 - 거의 모든 코드는 왼쪽에서 오른쪽으로 그리고 위에서 아래로 읽힌다. 빈 행은 새로운 개념을 시작한다는 시각적 단서다.

• 세로 밀집도 - 줄바꿈이 개념을 분리한다면 세로 밀집도는 연관성을 의미한다. 즉, 서로 밀집한 코드 행은 세로로 가까이 놓여야 한다.

• 수직 거리 - 서로 밀접한 개념은 세로로 가까이 둬야 한다.

  • 변수 선언 - 변수는 사용하는 위치에 최대한 가까이 선언한다.

  • 인스턴스 변수 - 인스턴스 변수는 클래스 맨 처음에 선언한다.

  • 종속 함수 - 한 함수가 다른 함수를 호출한다면 두 함수는 세로로 가까이 배치한다. 또한 가능하다면 호출하는 함수를 호출되는 함수보다 먼저 배치한다.

  • 개념적 유사성 - 친화도가 높을수록 코드를 가까이 배치한다.

가로 형식 맞추기

• 가로 공백과 밀집도 - 가로로는 공백을 사용해 밀접한 개념과 느슨한 개념을 표현한다.

• 들여쓰기 - 범위로 이뤄진 계층을 표현하기 위해 코드를 들여쓴다.

• 가짜 범위

팀 규칙

프로그래머라면 각자 선호하는 규칙이 있지만 팀에 속한다면 자신이 선호해야 할 규칙은 바로 팀 규칙이다.

좋은 소프트웨어 시스템은 읽기 쉬운 문서로 이뤄진다는 사실을 기억해야 한다. 스타일은 일관적이고 매끄러워야 한다.

밥 아저씨의 형식 규칙

코드 자체가 최고의 구현 표준 문서가 되는 예,

public class CodeAnalyzer implements JavaFileAnalysis {
	private int lineCount;
	private int maxLineWidth;
	private int widestLineNumber;
	private LineWidthHistogram lineWidthHistogram;
	private int totalChars;

	public CodeAnalyzer() {
		lineWidthHistogram = new LineWidthHistogram();
	}

	public static List<File> findJavaFiles(File parentDirectory) {
		List<File> files = new ArrayList<File>();
		findJavaFiles(parentDirectory, files);
		return files;	
	}

	private static void findJavaFiles(File parentDirectory, List<File> files) {
		for (File file : parentDirectory.listFiles()) {
			if (file.getName().endsWith(".java"))
				files.add(file);
			else if (dile.isDirectory())
				findJavaFiles(file, files);
		}
	}

	public void analyzeFile(File javaFile) throws Excpetion {
		BufferedReader br = new BufferedReader(new FileReader(javaFile));
		String line;
		while ((line = br.readLine()) != null)
			measureLine(line);
	}

	private void measuredLine(String line) {
		lineCount++;
		int lineSize = line.length();
		totalChars += lineSize;
		lineWidthHistogram.addLine(lineSize, lineCount);
		recordWidestLine(lineSize);
	}

	private void recordWidestLine(int lineSize) {
		if (lineSize > maxLineWidth) {
			maxLineWidth = lineSize;
			widestLineNumber = lineCount;
		}
	}

	public int getLineCount() {
		return lineCount;
	}

	public int getLineWidth() {
		return maxLineWidth;
	}

	public int getWidestLineNumber() {
		return widestLineNumber;
	}

	public LineWidthHistogram getLineWidthHistogram() {
		return lineWithHistogram;	
	}

	public double getMeanLineWidth() {
		return (double)totalChars/lineCount;
	}

	public int getMedianLineWidth() {
		Integer[] sortedWidths = getSortedWidths();
		int cumulativeLineCount = 0;
		for (int width : sortedWidths) {
			cumulativaLineCount += lineCountForWidth(width);
			if (cumulativLineCount > lineCount/2)
				return width;
		}
		throw new Error("Cannot get here");
	}

	private int lineCountForWidth(int width) {
		return lineWidthHistogram.getLinesforWidth(width).size();
	}

	private Integer[] getSortedWidths() {
		Set<Integer> widths = lineWidthHistogram.getWidths();
		Integer[] sortedWidths = (widths.toArray(new Integer[0]));
		return sortedWidths;
	}
}

6장 : 객체와 자료구조

변수를 비공개(private)로 정의하는 이유는 남들이 변수에 의존하지 않게 만들고 깊어서다. 충동이든 변덕이든, 변수 타입이나 구현을 맘대로 바꾸고 싶어서다. 그렇다면 어째서 수많은 프로그래머가 조회(get) 함수와 설정(set) 함수를 당연하게 공개(public)해 비공개 변수를 외부에 노출할까 ?

자료 추상화

구체적인 Point 클래스

public class Point {
    public double x;
    public double y;
}

추상적인 Point 클래스

public interface Point {
    double getX();
    double getY();
    void setCartesian(double x, double y);
    double getR();
    double getTheta();
    void setPolar(double r, double theta);
}
s

• 자료 구조 이상을 표현한다.

변수 사이에 함수라는 계층을 넣는다고 구현이 저절로 감춰지지 않는다. 구현을 감추려면 추상화가 필요하다 !

구체적인 Vehicle 클래스

public interface Vehicle {
    double getFuelTankCapacityGallons();
    double getGallonsOfGasoline();
}

추상적인 Vehicle 클래스

public intergace Vehicle {
    double getPercentFuelRemaining();
}

자료를 세세하게 공개하기보다는 추상적인 개념으로 표현하는 편이 좋다. 인테페이스나 조회/설정 함수만으로는 추상화가 이뤄지지 않는다. 개발자는 객체가 포함하는 자료를 표현할 가장 좋은 방법을 심각하게 고민해야 한다. 아무 생각 없이 조회/설정 함수를 추가하는 방법이 가장 나쁘다.

자료/객체 비대칭

앞서 소개한 두 가지 예제는 객체와 자료 구조 사이에 벌어진 차이를 보여준다. 객체는 추상화 뒤 자료를 숨긴 채 자료를 다루는 함수만 공개한다. 자료 구조는 자료를 그대로 공개하며 별다른 함수는 제공하지 않는다.

절차적인 도형

public class Square {
    public Point toLeft;
    public double side;
}

public class Rectangle {
    public Point topLetf;
    public double height;
    public double width;
}

public class Circle {
    public Point center;
    public double radius;
}

public class Geometry {
    public final double PI = 3.141592653589793;
    
    public double area(Object shape) throws NoSuchShapeException {
        if (shape instanceof square) {
            Square s = (Square) shape;
            return s.side*s.side;
        }
        else if (shape instanceof Rectangle) {
            Rectangle r = (Rectangle) shape;
            return r.height*r.width;
        }
        else if (shape instanceof Circle) {
            Circle c = (Circle)shape;
            return PI*c.radius*c.radius;
        }
        throw new NoSuchShapeException();
    }
}

다형적인 도형

public class Square implements Shape {
    private Point topLeft;
    private double side;
    
    public double area() {
        return side*side;
    }
}

public class Rectangle implements Shape {
    private Point topLedft;
    private double hegith;
    private double width;
    
    public double area() {
        return height*width;
    }
}

public class Circle implements Shape {
    private Point center;
    private double radius;
    public final double PI = 3.141592653589793;
    
    public double area() {
        return PI*radius*radius;
    }
}

• (자료 구조를 사용하는) 절차적인 코드는 기존 자료 구조를 변경하지 않으면서 새 함수를 추가하기 쉽다. 반면, 객체 지향 코드는 기존 함수를 변경하지 않으면서 새 클래스를 추가하기 쉽다.

• 절차적인 코드는 새로운 자료 구조를 추가하기 어렵다. 그러려면 모든 함수를 고쳐야 한다. 객체 지향 코드는 새로운 함수를 추가하기 어렵다. 그러려면 모든 클래스를 고쳐야 한다.

• 객체 지향 코드에서 어려운 변경은 절차적인 코드에서 쉬우며, 절차적인 코드에서 어려운 변경은 객체 지향 코드에서 쉽다.

복잡한 시스템을 짜다 보면 새로운 함수가 아니라 새로운 자료 타입이 필요한 경우가 생기는데, 이때는 클래스와 객체 지향 기법이 적합한다. 반면 새로운 자료 타입이 아니라 새로운 함수가 필요한 경우에는 절차적인 코드와 자료 구조가 좀 더 적합하다.

디미터 법칙

디미터의 법칙은 다른 객체가 어떠한 자료를 갖고 있는지 속사정을 몰라야 한다는 것을 의미한다. 즉, 객체는 조회 함수로 내부 구조를 공개하면 안 된다는 의미다. 그러면 내부 구조를 노출하는 셈이기 때문이다.

디미터 법칙은 "클래스 C의 메서드 f는 다음과 같은 객체의 메서드만 호출해야 한다"고 주장한다.

• 클래스 C

• f가 생성한 객체

• f 인수로 넘어온 객체

• C 인스턴스 변수에 저장된 객체

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

기차 충돌

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

위와 같은 코드를 기차 충돌이라 부른다. 위 코드는 다음과 같이 나누는 편이 좋다.

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

위 예제가 디미터 법칙을 위반하는지 여부는 ctxt, Options, ScratchDir이 객체인지 아니면 자료 구조인지에 달렸는데, 객체라면 내부 구조를 숨겨야 하므로 확실히 디미터 법칙을 위반한다. 반면, 자료 구조라면 당연히 내부 구조를 노출하므로 디미터 법칙이 적용되지 않는다.

위 예제는 조회 함수를 사용하는 바람에 혼란을 일으킨다. 코드를 다음과 같이 구현했다면 디미터 법칙을 거론할 필요가 없어진다.

final String outputDir = ctxt.options.scratchDir.absolutePath;

자료 구조는 무조건 함수 없이 공개 변수만 포함하고 객체는 비공개 변수와 공개 함수를 포함한다면 문제는 훨씬 간단하다. 하지만 단순한 자료 구조에도 조회 함수와 설정 함수를 정의하라 요구하는 프레임워크와 표준(ex. bean)이 존재한다.

잡종 구조

• 절반은 객체, 절반은 자료 구조인 구조로 중요한 기능을 수행하는 함수도 있고, 공개 변수나 공개 조회/설정 함수도 있다.

• 공개 조회/설정 함수는 비공개 변수를 그대로 노출한다. 덕택에 다른 함수가 절차적인 프로그램이의 자료 구조 접근 방식처럼 비공개 변수를 사용하고픈 유혹에 빠지기 십상이다.

• 이러한 잡종 구조는 새로운 함수는 물론, 새로운 자료 구조도 추가하기 어려우므로 되도록 피하는 편이 좋다.

구조체 감추기

• 객체라면 무언가를 하라고 말해야지 속을 드러내라고 말하면 안된다.

ref

• https://mangkyu.tistory.com/147

자료 전달 객체

• 자료 구조체의 전형적인 형태는 공개 변수만 있고 함수가 없는 클래스. 이런 자료 구조체를 때로는 자료 전달 객체(Data Transfer Object, DTO)라 한다.

• DTO는 특히 데이터베이스와 통신하거나 소켓에서 받은 메시지의 구문을 분석할 때 유용하다. 흔히 DTO는 데이터베이스에 저장된 가공되지 않은 정보를 애플리케이션 코드에서 사용할 객체로 변환하는 일련의 단계에서 가장 처음으로 사용하는 구조체다.

• 좀 더 일반적인 형태는 '빈(bean)' 구조다. 빈은 비공개(private) 변수를 조회/설정 함수로 조작한다. 일부 OO 순수주의자나 만족시킬 뿐 별다른 이익을 제공하지 않는다.

활성 레코드

• DTO의 특수한 형태다.

• 공개 변수가 있거나 비공개 변수에 조회/설정 함수가 있는 자료 구조지만, 대게 save나 find같은 탐색 함수도 제공한다. 활성 레코드는 데이터베이스 테이블이나 다른 소스에서 자료를 직접 변환한 결과다.

• 활성 레코드는 자료 구조로 취급한다. 비즈니스 규칙을 담으면서 내부 자료를 숨기는 객체는 따로 생성한다.

image

• https://weheartit.com/entry/300652990