-
Notifications
You must be signed in to change notification settings - Fork 93
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
73 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,73 @@ | ||
# 아이템 12 - toString을 항상 재정의하라 | ||
|
||
### 1. toString의 규약: "모든 하위 클래스에서 이 메서드를 재정의하라" | ||
|
||
→ toString 메서드는 개발자가 직접 호출하지 않더라도, 객체를 println, printf, 문자열 연결 연산자(+), assert 구문에 넘길 때, 혹은 디버거가 객체를 출력하도록 할 때 자동으로 불린다 | ||
|
||
예를 들어, 객체를 참조하는 컴포넌트가 오류 메시지를 로깅할 때 자동으로 호출 할 수 있다 | ||
|
||
`System.out.println(phoneNumber + "에 연결할 수 없습니다.");` | ||
|
||
### 2. toString 기본 메서드 | ||
|
||
- Object의 기본 toString메서드는 `클래스_이름@16진수로_표시한_해시코드`를 반환한다 | ||
|
||
### 3. toString 작성 방법 | ||
|
||
- PhoneNumber@abcde~보다 707-867-5309처럼 전화번호를 문자열로 알려주는 등의 형태로 유익한 정보를 알려줄 수 있다 | ||
|
||
⇒ toString을 잘 구현한 클래스는 사용하기에 유용하고, 그 클래스를 사용한 시스템은 디버깅하기 쉽다 | ||
|
||
- 실전에서 toString은 그 객체가 가진 주요 정보 모두를 반환하는 게 좋다 | ||
- 객체가 거대하거나 객체의 상태가 문자열로 표현하기 적합하지 않다면 "맨해튼 거주자 전화번호부(총 14832423개)" 같은 요약 정보를 담아야한다 | ||
|
||
### 4. toString 반환값 문서화 | ||
|
||
- toString을 구현할 때 의도를 명확히 밝혀야한다 | ||
- 반환값의 포맷을 문서화할 수 있다 | ||
- 포맷 명시 여부와 상관없이 toString이 반환값에 포함된 정보를 얻어올 수 있는 API를 제공하자 | ||
- 포맷을 문서화했을 시, | ||
1. 그 값을 그대로 입출력에 사용하거나 CSV 파일처럼 사람이 읽을 수 있는 데이터 객체로 저장할 수 있다 | ||
2. 명시한 포맷에 맞는 문자열과 객체를 상호 전환할 수 있는 정적 팩터리나 생성자를 함께 제공해주면 좋다 | ||
3. 포맷을 한 번 명시하면 이를 사용하는 프로그래머들이 그에 맞춰 파싱하고 사용하기 때문에 포맷을 수정하기 어렵다 | ||
|
||
```java | ||
/** | ||
* 이 전화번호의 문자열 표현을 반환한다. | ||
* 이 문자열은 "XXX-YYY-ZZZZ" 형태의 12글자로 구성된다. | ||
* XXX는 지역 코드, YYY는 프리픽스, ZZZZ는 가입자 번호다. | ||
* 각각의 대문자는 10진수 숫자 하나를 나타낸다. | ||
* | ||
* 전화번호의 각 부분의 값이 너무 작아서 자릿수를 채울 수 없다면, | ||
* 앞에서부터 0으로 채워나간다. 예컨대 가입자 번호가 123이라면 | ||
* 전화번호의 마짐가 네 문자는 "0123"이 된다. | ||
*/ | ||
@Override | ||
public String toString() { | ||
return String.format("%3d-%03d-%04d", areaCode, prefix, lineNum); | ||
} | ||
|
||
/* | ||
* 이 약물에 관한 대략적인 설명을 반환한다. | ||
* 다음은 이 설명의 일반적인 형태이나, | ||
* 상세 형식은 정해지지 않았으며 향후 변경될 수 있다. | ||
* | ||
* "[약물 #9: 유형=사랑, 냄새=테레빈유, 겉모습=먹물]" | ||
*/ | ||
@Override | ||
public String toString() { ... } | ||
``` | ||
|
||
### 5. toString는 항상 재정의해야하는가? | ||
|
||
- 정적 유틸리티 클래스는 toString을 제공할 이유가 없다 | ||
- 대부분의 열거 타입도 자바가 이미 완벽한 toString을 제공하니 따로 재정의 할 필요가 없다 | ||
- 하위 클래스들이 공유해야 할 문자열 표현이 있는 추상 클래스라면 toString을 재정의해줘야 한다 | ||
- 각 클래스이 가진 데이터에 따라 자동 생성 toString이 적합할 수도 있고 그렇지 않을 수도 있다 | ||
- 하지만 객체의 값에 관해 알려주지 않는 Object의 toString보다는 자동 생성된 toString이 훨씬 유용하다 | ||
|
||
### 정리 | ||
|
||
- 모든 구체 클래스에서 Object의 toString을 재정의하자. 상위 클래스에서 이미 알맞게 재정의한 경우는 예외다. | ||
- toString을 재정의한 클래스는 사용하기도 즐겁고 그 클래스를 사용한 시스템을 디버깅하기 쉽게 해준다. | ||
- toString은 해당 객체에 관한 명확하고 유용한 정보를 읽기 좋은 형태로 반환해야 한다. |