diff --git a/이펙티브 자바 (Effective Java)/src/chapter8/item49/Item49.java b/이펙티브 자바 (Effective Java)/src/chapter8/item49/Item49.java new file mode 100644 index 0000000..427ab63 --- /dev/null +++ b/이펙티브 자바 (Effective Java)/src/chapter8/item49/Item49.java @@ -0,0 +1,35 @@ +package chapter8.item49; + +import java.math.BigInteger; +import java.util.Objects; + +class Item49 { + + private String strategy; + + /** + * (현재 값 mod m) 값을 반환한다. 이 메서드는 + * 항상 음이 아닌 BigInteger를 반환한다는 점에서 remainder 메서드와 다르다. + * @param m 계수(양수여야 한다) + * @return 현재 값 mod m + * @throws ArithmeticException m이 0보다 작거나 같으면 발생한다. + */ + public BigInteger mod(BigInteger m) { + if (m.signum() <= 0) { + throw new ArithmeticException("계수(m)는 양수여야 합니다. " + m); + } + // 계산 수행 + return null; // 편의상 null을 리턴했다. + } + + public void changeStrategy(String strategy) { + this.strategy = Objects.requireNonNull(strategy, "전략"); + } + + private static void sort(long a[], int offset, int length) { + assert a != null; + assert offset >= 0 && offset <= a.length; + assert length >= 0 && length <= a.length - offset; + // 계산 수행 + } +} diff --git a/이펙티브 자바 (Effective Java)/src/chapter8/item49/item49.md b/이펙티브 자바 (Effective Java)/src/chapter8/item49/item49.md new file mode 100644 index 0000000..49ea134 --- /dev/null +++ b/이펙티브 자바 (Effective Java)/src/chapter8/item49/item49.md @@ -0,0 +1,138 @@ +# 아이템 49. 매개변수가 유효한지 검사하라 + +메서드와 생성자 대부분은 입력 매개변수의 값이 특정 조건(불변식)을 만족했을 때 제대로 동작해야 한다. 그리고 이런 제약은 반드시 문서화해야 하며 메서드 몸체가 시작되기 전에 검사해야 한다. +"오류는 가능한 한 빨리 (발생한 곳에서) 잡아야 한다"는 일반 원칙의 한 사례이기도 하다. 오류를 발생한 즉시 잡지 못하면 해당 오류를 감지하기 어려워지고, 감지하더라도 오류의 발생 지점을 찾기 어려워진다. + +## 매개변수 검사 + +### 매개변수 검사를 제대로 하지 못하면 문제가 생길 수 있다. + +- 메서드가 수행되는 중간에 모호한 예외를 던지며 실패할 수 있다. + - 메서드는 잘 수행되었지만 잘못된 결과를 반환하는 경우도 있는데, 미래에 이 메서드와는 관련 없는 오류를 낼 위험이 있다. + - 즉, 매개변수 검사에 실패하면 실패 원자성(failure atomicity)을 어기는 결과를 낳을 수 있다. +- public과 protected 메서드는 매개변수 값이 잘못됐을 때 던지는 예외를 문서화해야 한다(@throws 자바독 태그를 사용하면 된다). + - 매개변수의 제약을 문서화한다면 그 제약을 어겼을 때 발생하는 예외도 함께 기술해야 한다. 아래는 그 예시다. + +```java +public class Item49 { + /** + * (현재 값 mod m) 값을 반환한다. 이 메서드는 + * 항상 음이 아닌 BigInteger를 반환한다는 점에서 remainder 메서드와 다르다. + * @param m 계수(양수여야 한다) + * @return 현재 값 mod m + * @throws ArithmeticException m이 0보다 작거나 같으면 발생한다. + */ + public BigInteger mod(BigInteger m) { + if (m.signum() <= 0) { + throw new ArithmeticException("계수(m)는 양수여야 합니다. " + m); + } + // 계산 수행 + return null; // 편의상 null을 리턴했다. + } +} +``` + +- 이 메서드에서 m이 null이면 NullPointerException을 던진다는 말은 설명에 없다. 그 이유는 이 설명을 개별 메서드가 아닌 BigInteger 클래스 수준에서 기술했기 때문이다. + - 클래스 수준 주석은 그 클래스의 모든 public 메서드에 적용되므로 각 메서드에 일일이 기술하는 것보다 훨씬 깔끔한 방법이다. + - **자바 7에 추가된 java.util.Objects.requireNonNull 메서드는 유연하고 사용하기도 편하니, 더 이상 null 검사를 수동으로 하지 않아도 된다.** + - 원하는 예외 메시지도 지정할 수 있고, 입력을 그대로 반환하므로 값을 사용하는 동시에 null 검사를 수행할 수 있다. 아래는 Objects 클래스의 requireNonNull 메서드다. + +```java +public class Objects { + // ... + + /** + * Checks that the specified object reference is not {@code null}. This + * method is designed primarily for doing parameter validation in methods + * and constructors, as demonstrated below: + *
+ * public Foo(Bar bar) {
+ * this.bar = Objects.requireNonNull(bar);
+ * }
+ *
+ *
+ * @param obj the object reference to check for nullity
+ * @param