📂 JAVA

지역변수의 범위를 최소화하라 - [8장. 일반적인 프로그래밍 원칙(아이템57)]

지역변수의 유효 범위를 최소로 줄이면 코드 가독성과 유지보수성이 높아지고 오류 가능성은 낮아진다. 이번 글을 통해 지역변수의 범위를 최소하하는 방법을 알아보자. 📙 1. 지역변수를 가장 처음 쓰일 때 선언하라. 지역변수의 범위를 줄이는 가장 강력한 기법은 지역변수를 가장 처음 쓰일 때 선언하는 것이다. 선언을 미리 해두면 코드가 어수선해져 가독성이 떨어진다. 📙 2. 지역변수는 선언과 동시에 초기화하라. 초기화에 필요한 정보가 충분하지 않다면 충분해질 때까지 선언을 미뤄야 한다. try-catch 문의 경우 변수 값을 try 블록 바깥에서도 사용해야 할 수도 있으므로 예외다. 📙 3. 반복문을 사용하라. 반복문은 독특한 방식으로 변수 범위를 최소화해준다. 반복 변수의 값을 반복문이 종료된 뒤에도 써야 하..

공개된 API요소에는 항상 문서화 주석을 작성하라 - [8장. 메서드(아이템56)]

📙 1. 문서화 주석 작성 방법 자바에는 소스코드 파일에서 문서화 주석(doc comment; 자바독 주석)이라는 특수한 형태로 기술된 설명을 추려 API 문서로 변환하여 보여주는 자바독이 있다. 문서화 주석을 작성하는 규칙은 '문서화 주석 작성법(How to Write Doc Comments)'에 기술되어 있다. 해당 문서에 더해서 추가적으로 알아야 하는 내용은 아래와 같다. API를 올바로 문서화하려면 공개된 모든 클래스, 인터페이스, 메서드, 필드 선언에 문서화 주석을 달아야 한다. 직렬화할 수 있는 클래스라면 직렬화 형태에 관해서도 적어야 한다. 기본 생성자에는 문서화 주석을 달 방법이 없으니 공개 클래스는 절대 기본 생성자를 사용하면 안 된다. 유지보수까지 고려한다면 대다수의 공개되지 않은 클래..

옵셔널 반환은 신중히 하라 - [8장. 메서드(아이템55)]

📙 1. 옵셔널 개념 Optional는 null이 아닌 T 타입 참조를 하나 담거나, 혹은 아무것도 담지 않을 수 있다. 보통은 T를 반환해야 하지만 특정 조건에서는 아무것도 반환하지 않아야 할 때 T 대신 Optional를 반환하도록 선언하면 된다. 옵셔널을 반환하는 메서드는 예외를 던지는 메서드보다 유연하고 사용하기 쉬우며, null을 반환하는 메서드보다 오류 가능성이 작다. 컬렉션의 최댓값을 구하는 메서드를 다음과 같이 Optional로 표현할 수 있다. // Optional을 사용하지 않은 경우 public static E max(Collection c) { if(c.isEmpty()) throw new IllegalArgumentException("빈 컬렉션"); E result = null; ..

null이 아닌, 빈 컬렉션이나 배열을 반환하라 - [8장. 메서드(아이템54)]

📙 1. null을 반환하는 경우 매장 안의 치즈 목록을 반환하는 메서드를 살펴보자. private final List cheeseInStock = ...; /** * @return 매장 안의 모든 치즈 목록을 반환한다. * 단, 재고가 하나도 없다면 null을 반환한다. */ public List getCheeses() { return cheeseInStock.isEmpty() ? null : new ArrayList(cheeseInStock); } 컬렉션이나 배열 같은 컨테이너(container)가 비었을 때 null을 반환하는 메서드를 사용할 때면 항시 아래와 같은 방어 코드를 넣어줘야 한다. List cheeses = shop.getCheese(); if(cheeses != null && chee..

가변인수는 신중히 사용하라 - [8장. 메서드(아이템53)]

📙 1. 가변인수 인수 개수가 일정하지 않은 메서드를 정의할 때 가변인수(varargs)를 사용할 수 있다. 가변인수 메서드를 호출하면, 가장 먼저 인수의 개수와 길이가 같은 배열을 만들고 인수들을 이 배열에 저장하여 가변인수 메서드를 건네준다. 입력받은 int 인수들의 합을 계산해 주는 가변인수 메서드를 다음과 같이 만들 수 있다. static int sum(int... args) { int sum = 0; for (int arg : args) sum += arg; return sum; } 📙 2. 가변인수의 문제점과 그에 따른 해결책 가변인수를 아래와 같이 잘못 구현할 수도 있다. static int min(int... args) { if(args.length == 0) throw new Illega..

다중정의는 신중히 사용하라 - [8장. 메서드(아이템52)]

📙 1. 다중정의의 문제 컬렉션을 '집합, 리스트, 그 외'로 구분하는 프로그램이 있다고 하자. public class CollectionClassifier { public static String classify(Set s) { return "집합"; } public static String classify(List s) { return "집합"; } public static String classify(Collection s) { return "집합"; } public static void main(String[] args) { Collection [] collections = { new HashSet(), new ArrayList(), new HashMap().values() }; for (Coll..

메서드 시그니처를 신중히 설계하라 - [8장. 메서드(아이템51)]

이번 글을 통해 API 설계 요령들을 살펴보자. 이를 활용하면 배우기 쉽고, 쓰기 쉬우며, 오류 가능성이 적은 API를 만들 수 있을 것이다. 📙 1. 메서드 이름을 신중히 짓자. 메서드 이름을 신중히 짓는 것에 대해서는 너무나 많이 들어봤을 것이다. 알고 있는 것을 한번 더 상기시킨다는 생각으로 보고 넘어가자. 항상 표준 명명 규칙을 따라야 한다. 이해할 수 있고, 같은 패키지에 속한 다른 이름들과 일관되게 짓자. 개발자 커뮤니티에서 널리 받아들여지는 이름을 사용하자. 긴 이름을 피하자. 애매하면 자바 라이브러리의 API 가이드를 참조하자. 📙 2. 편의 메서드를 너무 많이 만들지 말자. 메서드가 너무 많은 클래스는 익히고, 사용하고, 문서화하고, 테스트하고, 유지보수하기 어렵다. 인터페이스도 마찬가지..

적시에 방어적 복사본을 만들라 - [8장. 메서드(아이템50)]

자바는 일반적으로 안전한 언어다. 하지만 아무리 자바라 해도 다른 클래스로부터의 침범을 아무런 노력 없이 다 막을 수 있는 것은 아니다. 그렇기 때문에 클라이언트가 우리의 불변식을 깨뜨리려 혈안이 되어 있다고 가정하고 방어적으로 프로그래밍해야 한다. 📙 1. 첫 번째 공격 - 생성자 이용 '시작 시각이 종료 시각보다 늦을 수 없다는 불변식'이 있는 다음과 같은 클래스가 있다고 하자. public final class Period { private final Date start; private final Date end; /** * @param start 시작 시각 * @param end 종료 시각; 시작 시각보다 뒤여야 하낟. * @throws IllegalArgumentException 시작 시각이 종..

매개변수가 유효한지 검사하라 - [8장. 메서드(아이템49)]

메서드나 생성자를 작성할 때면 그 매개변수들에 어떤 제약이 있을지 생각해야 한다. 이를 위한 원칙 2가지를 살펴보자. 📙 1. 원칙 1 : 오류는 가능한 한 빨리 (발생한 곳에서) 잡아야 한다. 오류를 발생한 즉시 잡지 못하면 해당 오류를 감지하기 어려워지고, 감지하더라도 오류의 발생 지점을 찾기 어려워진다. 매개변수 검사를 제대로 하지 못하면 아래와 같은 문제가 발생할 수 있다. 메서드가 수행되는 중간에 모호한 예외를 던지며 실패할 수 있다. 메서드가 잘 수행되지만 잘못된 결과를 반환할 수 있다. 메서드는 문제없이 수행됐지만, 어떤 객체를 이상한 상태로 만들어놓아서 미래의 알 수 없는 시점에 이 메서드와는 관련 없는 오류를 만들 수 있다. 이러한 문제를 예방하고자 public과 protected 메서드..

스트림 병렬화는 주의해서 적용하라 - [7장. 람다와 스트림(아이템48)]

📙 1. 자바의 동시성 프로그래밍 자바는 동시성 프로그래밍 측면에서 항상 앞서갔다. 처음 릴리스된 1996년 스레드, 동기화, wait/notify 지원 자바 5 동시성 컬렉션인 java.util.concurrent 라이브러리와 실행자(Executor) 프레임워크 지원 자바 7 고성능 병렬 분해(parallel decom-position) 프레임워크인 포크-조인(fork-join) 패키지 추가 자바 8 parallel 메서드만 한 번 호출하면 파이프라인을 병렬 실행할 수 있는 스트림 지원 이처럼 자바로 동시성 프로그램을 작성하기가 점점 쉬워지고 있다. 하지만, 동시성 프로그래밍을 할 때는 안전성(safety)과 응답 가능(liveness) 상태를 유지하기 위해 애써야 한다. 병렬 스트림 파이프라인 프로그..

반환 타입으로는 스트림보다 컬렉션이 낫다 - [7장. 람다와 스트림(아이템47)]

📙 1. 원소 시퀀스 반환 타입 비교 일련의 원소(원소 시퀀스)를 반환하는 메서드는 수없이 많다. 이런 메서드의 반환 타입으로 Collection, Set, List와 같은 인터페이스, Iterable, 배열, 스트림이 존재한다. 이 중 가장 적합한 타입은 컬렉션 인터페이스다. 만약, API를 스트림만 반환하도록 짜놓으면 반환된 스트림을 for-each로 반복하길 원하는 사용자는 당연히 불만을 토로할 것이다. 스트림을 반복하기 위해서는 아래와 같은 우회 방법을 선택해야 한다. for (ProcessHandle ph : (Iterable) ProcessHandle.allProcesses()::iterator) { ... } 작동은 하지만 실전에 쓰기에는 너무 난잡하고 직관성이 떨어진다. 그래서 아래와 같이..

스트림에서는 부작용 없는 함수를 사용하라 - [7장. 람다와 스트림(아이템46)]

📙 1. 스트림의 핵심 스트림은 그저 또 하나의 API가 아닌, 함수형 프로그래밍에 기초한 패러다임이다. 스트림 패러다임의 핵심은 계산을 일련의 변환(transformation)으로 재구성하는 부분이다. 이때 각 변환 단계는 가능한 한 이전 단계의 결과를 받아 처리하는 순수 함수여야 한다. 순수 함수란 오직 입력만이 결과에 영향을 주는 함수다. 다른 가변 상태를 참조하지 않고, 함수 스스로도 다른 상태를 변경하지 않아야 한다. 이를 위해서는 (중간 단계든 종단 단계든) 스트림 연산에 건네는 함수 객체는 모든 부작용(side effect)이 없어야 한다. 그렇다면 만약 부작용(side effect)이 발생하면 어떻게 될까? 아래와 같은 문제점이 발생하게 된다. 가독성 Stream을 사용한 순간 데이터의 변..