일급 컬렉션(First Class Collection)에 대해 알아보자 💡

tocoble을 보다가 일급 컬렉션을 알게 되었고 이에 대해 알게된 내용을 정리해두려고 합니다.

1. 일급 컬렉션 규칙

먼저, 일급 컬렉션의 규칙에 대해서 알아봅시다.

• 클래스는 컬렉션을 제외하고 다른 어떤 멤버 변수가 없어야 함

컬렉션을 Wrapping하면서 Wrapping한 Collection외 다른 멤버 변수가 없는 상태를 뜻함

 

2.  예시

SafariService

사파리서비스가 동물들을 List 자료구조로 직접 관리한다고 가정해봅시다.

 

만약 우리가 에버랜드의 사파리 서비스를 운영한다면 여러 동물들을 관리할 것입니다.

사파리에 있는 동물들은 정해진 최소 에너지를 가지고 있어야합니다.

 

이를 위해서 SafariService는 관리하는 동물들이 조건에 부합하는지 확인하는 로직이 필요합니다.

class SafariService {
    private static final int MINIMUM_ENERGY = 25;

    public void openSafari() {
        List<Animal> animals = createAnimals();
        validateLowEnergy(animals, MINIMUM_ENERGY);
        validateSize(animals);
    }

    public List<Animal> createAnimals() {
        Animal tiger = new Animal("호랑이", 30);
        Animal cat = new Animal("고양이", 20);
        Animal dog = new Animal("개", 10);
        return List.of(tiger, cat, dog);
    }

    private void validateSize(List<Animal> animals) {
        if (animals.size() >= 100) {
            throw new IllegalArgumentException("100마리 이상의 동물이 있을 수 없습니다.");
        }
    }

    private void validateLowEnergy(List<Animal> animals, int minimumEnergy) {
        for (Animal animal : animals) {
            if (animal.getEnergy() < minimumEnergy)
                throw new IllegalArgumentException("최소 에너지가 부족합니다.");
        }
    }
}

public class Animal {
    private String name;
    private int energy;

    public Animal(String name, int energy) {
        this.name = name;
        this.energy = energy;
    }

    public String getName() {
        return name;
    }

    public int getEnergy() {
        return energy;
    }
}

위 코드에서 사파리는 오픈 시 동물들의 최소 에너지 조건과 최대 동물 수 조건에 부합하는지 체크합니다.

-> 서비스 메서드에서 비즈니스 로직이 처리됨

 

우리는 동물 생성을 위해선 [최소 에너지, 최대 동물 수] 조건을 만족해야한다는 사실을 알고있기 때문에 문제가 없습니다.

하지만, 다른 곳에서 Animal을 생성하는 사람은 이를 모를 수도 있습니다.

 

이 문제를 해결하기 위해서는 객체 생성 시 원하는 조건을 체크하는 자료구조를 직접 만들 수 있습니다. (일급 컬렉션)

class AnimalsManager {
    private static final int MINIMUM_ENERGY = 25;
    
    private final List<Animal> animals;

    public AnimalsManager(List<Animal> animals) {
        validateLowEnergy(animals, MINIMUM_ENERGY);
        validateSize(animals);
        this.animals = animals;
    }

    private void validateSize(List<Animal> animals) {
        if (animals.size() >= 100) {
            throw new IllegalArgumentException("100마리 이상의 동물이 있을 수 없습니다.");
        }
    }

    private void validateLowEnergy(List<Animal> animals, int minimumEnergy) {
        for (Animal animal : animals) {
            if (animal.getEnergy() < minimumEnergy)
                throw new IllegalArgumentException("최소 에너지가 부족합니다.");
        }
    }
}

위 코드는 컬렉션을 Wrapping하고 있고 생성 시 필요한 검증 로직도 수행해줍니다.

Animal과 관련된 비즈니스로직을 포함한 자료구조가 일급 컬렉션으로 만들어졌다고 볼 수 있습니다.

 

이제 SafariService 뿐만 아니라 다른 서비스에서도 동일한 검증로직과 함께 동물을 생성할 수 있습니다.

 

3. 불변

• 일급 컬렉션은 컬렉션의 불변을 보장

만약, Service에 List 형태로 컬렉션이 바로 노출된다면 final로 선언해도 재할당만 못하게 될 것입니다.

List에 새로 추가하고 삭제하는 것은 final만으로 막을 수 없습니다.

 

이러한 문제는 '일급 컬렉션'과 같은 방법으로 해결해야합니다.

class AnimalsManager {
    private final List<Animal> animals;
    private static final int MINIMUM_ENERGY = 25;

    public AnimalsManager(List<Animal> animals) {
        validateLowEnergy(animals, MINIMUM_ENERGY);
        validateSize(animals);
        this.animals = animals;
    }
    
	...
    
    public long overSpecificEnergySum(int energy) {
        return animals.stream()
                .filter(animal -> animal.getEnergy() >= energy)
                .mapToLong(Animal::getEnergy)
                .sum();
    }
}

AnimalManger는 Animal 리스트에 대한 정보를 외부에 노출하지 않습니다.

또한, 컬렉션의 값을 변경하거나 추가할 수 있는 메서드를 제공하지 않으므로 '불변 컬렉션'이 보장됩니다.

-> '일급 컬렉션'을 통해 '불변 컬력션' 만들기

 

 

그럼 이제 SafariService에서 Animal 리스트를 그대로 노출하는 코드를 살펴봅시다.

class SafariService {
    private static final int MINIMUM_ENERGY = 25;

    public void openSafari() {
        List<Animal> animals = createAnimals();
        validateLowEnergy(animals, MINIMUM_ENERGY);
        validateSize(animals);

		// animals에 바로 접근해서 추가/삭제 내부 필드 접근 가능
        animals.add(new Animal("사자", 100));
        long sum = animals.stream()
                .filter(animal -> animal.getEnergy() >= 20)
                .mapToLong(Animal::getEnergy)
                .sum();
    }
    
    ...
    
 }

위 코드처럼 SafariService에서는 animals가 추가/삭제/변경될 수 있습니다. (불변 컬렉션이 아님)

 

4. 상태와 행위를 한곳에서 관리

 

다시한번 아래의 Service 코드를 보면 [특정에너지 이상 동물의 에너지 총합]을 구하고 있습니다.

이를 Service에서 관리하면 다른 서비스에서 [특정에너지 이상 동물의 에너지 총합]을 구할 때 1. 중복 로직이 생기게 됩니다.

또한, 2. 계산로직 변경 시 관리해야할 포인트가 증가합니다.

3. 서비스마다 계산로직이 서로 달라질 수 있습니다.

class SafariService {
    private static final int MINIMUM_ENERGY = 25;

    public void openSafari() {
        List<Animal> animals = createAnimals();
        validateLowEnergy(animals, MINIMUM_ENERGY);
        validateSize(animals);

		// animals에 바로 접근해서 추가/삭제 내부 필드 접근 가능
        animals.add(new Animal("사자", 100));
        long sum = animals.stream()
                .filter(animal -> animal.getEnergy() >= 20)
                .mapToLong(Animal::getEnergy)
                .sum();
    }
    
    ...
    
 }

그렇기 때문에 코드를 '일급 컬렉션'처럼 상태와 로직을 함께 두는 형식으로 만들어야 변경 또는 유지보수 시 관리 포인트가 줄어듭니다.

 

오늘은 jojoldu님이 정리해주신 블로그를 읽고 어디에 적용할 수 있을 지 생각하면서 글을 적어보았습니다. Enum과 일급 컬렉션은 객체 지향 코드로 가기 위해 중요한 부분이므로 꼭 익히고 가야할 것 같습니다.