코드 품질 개선 기법 8편: 실상과 허상

간단 소개

함수의 반환값이 조회 후 변경될 수 있는지를 명확히 밝혀 코드의 안정성을 확보해야 합니다.

AI Summary

UserNameMapLoader 클래스의 문제점
- loadedUserNameMap, loadedUserIds, decoratedUserNameMap의 가변성 차이로 인해 값의 일관성이 깨질 수 있음
- loadedUserNameMap과 loadedUserIds는 원본 Map에 대한 참조 또는 뷰이므로 loader에 의해 변경될 수 있음
- decoratedUserNameMap은 속성 접근 시 생성된 Map 복사본이므로 loader의 작업에 영향을 받지 않음
해결 방안
- 옵션 1: 요소에 대한 접근만 허용하고 Map이나 Set을 직접 반환하지 않음
- 옵션 2: 컬렉션 반환 시 복사본을 반환하고, 함수 이름에 복사본임을 명시
- 옵션 3: 원본 컬렉션에 대한 직접 참조를 반환하되, 변경 가능성에 대한 주의사항을 문서에 명시
핵심 권고 사항
- 함수의 반환값이 조회 후 변경될 수 있는지 명확히 밝혀야 함
- 컬렉션을 순회하는 함수는 호출자에서 수행하거나 유틸리티 함수로 구현하여 의존성을 정리