[TIL] 2025-01-15_LinkedHashMap

🔫 키오스크 과제를 구현하며 겪은 문제점과 해결방법, 새로 알게된 점을 기록합니다.

🧑‍🔧 키오스크 과제 리펙토링

장바구니 기능을 검증하던 중 주문 시 장바구니에 담긴 모든 항목을 출력할 때 주문 항목이 메뉴명 정렬 순서도 아니고 장바구니에 담은 순서도 아닌 알 수 없는 기준으로 출력되는 것을 확인하였다. 이를 해결하는 방법 2가지를 정리한다.

문제점

주문순서	메뉴명
1	ShackBurger
2	SmokeShack
3	Fresh Brewed Iced Tea
4	Fountain Soda
5	Cups & Cones

표와 같은 순서로 장바구니에 메뉴를 담고 주문

▶︎ 실행 결과

원인

주문 품목을 담는 cartItems는 HashMap<> 으로 구현되었다.

public class Cart {
    // menuItem(메뉴명, 가격정보)과 수량을 저장
    final Map<MenuItem, Integer> cartItems = new HashMap<>();
    
    // ...
}

HashMap

• 해시를 사용해서 요소를 저장한다. 키(key) 값은 해시 함수를 통해 해시 코드로 변환되고, 이 해시 코드는 데이터를 저장하고 검색하는 데 사용된다.
• 순서를 보장하지 않는다.

해결 방법

1. 메뉴명 정렬 순서로 출력

▶︎ 기존코드
printCart(): 장바구니의 모든 항목을 출력하는 메서드

// 장바구니 출력
private void printCart() {
    // TODO: 주문 목록 출력 시 메뉴명 오름차순 정렬
    for (Map.Entry<MenuItem, Integer> entry : cartItems.entrySet()) {
        MenuItem item = entry.getKey();
        String name = item.getName();
        double price = entry.getValue() * item.getPrice();
        String description = item.getDescription();
        System.out.printf("%-21s | W %.1f | %s%n", name, price, description);
    }
}

💭 Stream의 sorted()를 사용해서 정렬할 때 매개변수로 Comparator를 넘겨준다?

• comparingByKey[Value]: Map이 제공하는 메서드로 Comparator<Map.Entry<K, V>>를 반환한다.

Integer 를 담고 있는 value는 comparing 이 가능하지만, MenuItem 을 담고 있는 key로는 comparing 할 수 없다.

🚨 no instance(s) of type variable(s) U exist so that MenuItem conforms to Comparable<? super U>
→ MenuItem이 Comparable을 준수하도록 유형 변수 U의 인스턴스가 존재하지 않습니다.

MenuItem 안에는 여러 필드값들이 존재하고, MenuItem 는 개발자가 새롭게 정의한 참조 자료형이기 때문에 자바 입장에서는 어떤 기준으로 정렬할지 알 수 없다.

▶︎ 기준: Map<MenuItem, Integer>의 keySet()의 name 필드로 정렬한 후 출력

👉 기준을 자바에게 알려주자!

▶︎ 방법

1. Comparable 인터페이스 implements
2. compareTo() 오버라이딩: 어떤 기준으로 정렬할지 정의

public class MenuItem implements Comparable<MenuItem> {
	// ...
    
    // Comaparable 인터페이스 메서드
    @Override
    public int compareTo(MenuItem o) {
        // 길이 비교
        if (this.name.length() > o.name.length()) {
            return 1;
        } else if (this.name.length() < o.name.length()) {
            return -1;
        } else {
            // 길이가 같으면 사전순
            return this.name.compareTo(o.name);
        }
    }
}

MenuItem 객체를 비교할 때 compareTo()에 정의된 기준으로 정렬한다.

▶︎ 수정 코드

// 장바구니 출력
private void printCart() {
    // 주문 목록 출력 시 메뉴명 오름차순 정렬
    List<Map.Entry<MenuItem, Integer>> entryList = cartItems.entrySet().stream()
                    .sorted(Map.Entry.<MenuItem, Integer>comparingByKey())
                    .toList();

    for (Map.Entry<MenuItem, Integer> entry : entryList) {
        MenuItem item = entry.getKey();
        String name = item.getName();
        double price = entry.getValue() * item.getPrice();
        String description = item.getDescription();
        System.out.printf("%-21s | W %.1f | %s%n", name, price, description);
        }
    }

stream().sorted().toList()로 반환받은 entryList를 선언하고 해당 리스트를 순회하며 출력한다.

2. 장바구니에 담은 순서로 출력

cartItems을 HashMap<>이 아닌 LinkedHashMap<>으로 구현한다.

▶︎ 수정코드

public class Cart {
    // menuItem(메뉴명, 가격정보)과 수량을 저장
    final Map<MenuItem, Integer> cartItems = new LinkedHashMap<>();
    
    // ...
}

LinkedHashMap

• LinkedHashMap은 HashMap과 유사하지만, 연결 리스트를 사용하여 삽입 순서 또는 최근 접근 순서에 따라 요소를 유지한다.
• 입력 순서에 따라 순회가 가능하다.
• HashMap과 같지만 입력 순서를 링크로 유지해야 하므로 조금 더 무겁다.
• 입력 순서를 보장한다.

▶︎ 수정코드

주문 시 장바구니에 담긴 항목을 출력하는 printCart()에는 장바구니에 담은 순서대로 출력이 더 적합하여 2번으로 수정

배운 점

컬렉션 프레임워크 구현체들을 정렬할 때 어떤 기준으로 정렬하는 지에 따라 여러 가지 방법으로 정렬을 적용할 수 있다.