【News】ListとMapを組み合わせる:複数データを構造的に管理する方法

こんにちは、バナナドリームです。

前回は、Mapの中身を一括で処理するentrySet()・keySet()・values()の使い分けについて解説しました。

今回は、ListとMapを組み合わせて複数のデータを管理する方法がテーマです。

実務では、「1つのキーに対して複数の値を持たせたい」という場面がよくあります。そのようなときに役立つのが、Mapの値としてListを持たせる方法です。

Map<String, List>のような入れ子構造の作り方と、データの追加・取得・ループ処理を順に見ていきましょう。

なぜListとMapを組み合わせるのか

Mapは、キーと値をペアで管理するデータ構造です。

これまでの例では、1人の名前に対して1つの点数を持たせるなど、1つのキーに1つの値を対応させてきました。

Map<String, Integer> scores = new HashMap<>();

scores.put("Taro", 85);

scores.put("Hanako", 92);

scores.put("Jiro", 78);

しかし、実務では1つのキーに対して複数の値を管理したい場合があります。

例えば、次のようなケースです。

・1人のユーザーが複数の商品を購入している
・1つの部署に複数の社員が所属している
・1つのカテゴリに複数の商品が登録されている
・1人の生徒が複数の科目を受講している

このようなデータを管理するときは、Mapの値を単独のStringやIntegerではなく、Listにします。

Map<String, List<String>> map = new HashMap<>();

この構造では、MapのキーがString、値がListです。

例えば、部署名をキー、所属する社員名の一覧を値として管理できます。

Mapの値としてListを登録する基本

まずは、部署ごとに社員名を管理する例を見てみましょう。

Map<String, List<String>> departmentMembers = new HashMap<>();

List<String> salesMembers = new ArrayList<>();

salesMembers.add("Taro");

salesMembers.add("Hanako");

List<String> developmentMembers = new ArrayList<>();

developmentMembers.add("Jiro");

developmentMembers.add("Yuki");

departmentMembers.put("営業部", salesMembers);

departmentMembers.put("開発部", developmentMembers);

この例では、「営業部」というキーにTaroとHanakoが入ったListを登録しています。

同じように、「開発部」というキーにはJiroとYukiが入ったListを登録しています。

データのイメージは次のようになります。

営業部 → [Taro, Hanako]

開発部 → [Jiro, Yuki]

Mapの値としてListを持たせることで、1つの部署に複数の社員を関連付けられます。

キーを指定してListを取り出す

登録したListは、通常のMapと同じようにget()で取り出せます。

List<String> salesMembers = departmentMembers.get("営業部");

System.out.println(salesMembers);

// → [Taro, Hanako]

get("営業部")の戻り値はStringではなく、Listです。

そのため、取り出したListに対してget()やsize()など、Listのメソッドを使用できます。

List<String> salesMembers = departmentMembers.get("営業部");

System.out.println(salesMembers.get(0));

// → Taro

System.out.println(salesMembers.size());

// → 2

ただし、存在しないキーを指定するとnullが返ります。

List<String> members = departmentMembers.get("総務部");

System.out.println(members);

// → null

そのままListのメソッドを呼び出すと、NullPointerExceptionが発生する可能性があります。

List<String> members = departmentMembers.get("総務部");

System.out.println(members.size());

// → NullPointerException!

前回までに解説したcontainsKey()やgetOrDefault()を使い、安全に値を取り出すことが大切です。

if (departmentMembers.containsKey("総務部")) {

System.out.println(departmentMembers.get("総務部"));

} else {

System.out.println("該当する部署がありません");

}

既存のListに新しい値を追加する

すでにMapに登録されているListへ値を追加したい場合は、get()でListを取り出してからadd()を使います。

List<String> salesMembers = departmentMembers.get("営業部");

salesMembers.add("Sakura");

System.out.println(departmentMembers.get("営業部"));

// → [Taro, Hanako, Sakura]

get()で取り出したListは、Mapに登録されているListと同じものを参照しています。

そのため、取り出したListへadd()すると、Mapの中にあるListにも新しい値が追加されます。

次のように1行で書くこともできます。

departmentMembers.get("営業部").add("Sakura");

ただし、キーが存在しない場合はget()の結果がnullになるため、add()を呼び出すとNullPointerExceptionが発生します。

departmentMembers.get("総務部").add("Kenta");

// → NullPointerException!

値を追加する前に、キーが存在するかを確認しましょう。

新しいキーとListを追加する

まだMapに登録されていない部署へ社員を追加するときは、最初に新しいListを作成します。

if (!departmentMembers.containsKey("総務部")) {

departmentMembers.put("総務部", new ArrayList<>());

}

departmentMembers.get("総務部").add("Kenta");

System.out.println(departmentMembers.get("総務部"));

// → [Kenta]

containsKey()を使って「総務部」が登録されているか確認し、存在しない場合は空のArrayListを登録しています。

その後、get()でListを取り出して社員名を追加します。

この書き方であれば、新しいキーを追加する場合でもNullPointerExceptionを防げます。

computeIfAbsent()を使って簡潔に追加する

Java 8以降では、computeIfAbsent()を使うと、キーの存在確認とListの作成をまとめて書けます。

departmentMembers

.computeIfAbsent("総務部", key -> new ArrayList<>())

.add("Kenta");

System.out.println(departmentMembers.get("総務部"));

// → [Kenta]

computeIfAbsent()は、指定したキーがMapに存在しない場合だけ、新しい値を作成して登録します。

すでにキーが存在している場合は、登録済みのListをそのまま返します。

departmentMembers

.computeIfAbsent("営業部", key -> new ArrayList<>())

.add("Sakura");

「営業部」がすでに存在していれば、既存のListにSakuraが追加されます。

「総務部」のようにキーが存在しなければ、新しいArrayListを作成してからKentaを追加します。

キーの存在確認とListの初期化を何度も書かずに済むため、実務でもよく使われる方法です。

ただし、初心者のうちはcontainsKey()とput()を使った基本的な流れを理解してから使うと、computeIfAbsent()が何をしているのか把握しやすくなります。

Mapの中にあるすべてのListをループする

部署名と所属する社員名をすべて表示したい場合は、entrySet()を使います。

for (Map.Entry<String, List<String>> entry

: departmentMembers.entrySet()) {

String department = entry.getKey();

List<String> members = entry.getValue();

System.out.println("部署:" + department);

for (String member : members) {

System.out.println("・" + member);

}

}

出力例は次のとおりです。

部署:営業部

・Taro

・Hanako

部署:開発部

・Jiro

・Yuki

外側のループではMapの各エントリを処理し、内側のループではListの各要素を処理しています。

このようにループの中に別のループがある構造を「二重ループ」と呼びます。

Mapから部署名と社員Listを取り出し、そのListをさらにループすることで、入れ子になったデータをすべて処理できます。

なお、HashMapではキーの表示順は保証されません。登録した順番で処理したい場合は、LinkedHashMapの使用を検討しましょう。

Listから特定の値を削除する

Mapの中にあるListから特定の値を削除したい場合は、Listのremove()を使います。

List<String> salesMembers = departmentMembers.get("営業部");

salesMembers.remove("Taro");

System.out.println(departmentMembers.get("営業部"));

// → [Hanako]

キーが存在するかを確認してから削除すると安全です。

if (departmentMembers.containsKey("営業部")) {

departmentMembers.get("営業部").remove("Taro");

}

Listからすべての要素が削除されても、Mapのキーは残ります。

departmentMembers.put("企画部", new ArrayList<>());

System.out.println(departmentMembers.containsKey("企画部"));

// → true

System.out.println(departmentMembers.get("企画部"));

// → []

空になったListと一緒にキーも削除したい場合は、Listが空かどうかをisEmpty()で確認してからMapのremove()を使います。

List<String> members = departmentMembers.get("企画部");

if (members != null && members.isEmpty()) {

departmentMembers.remove("企画部");

}

Listの要素を削除するremove()と、Mapのキーと値のペアを削除するremove()では、対象が異なる点に注意しましょう。

Stream APIを使ってListの中身を絞り込む

MapとListを組み合わせたデータでも、Stream APIを使って条件に合う要素を取り出せます。

例えば、営業部に所属する社員のうち、名前が「S」で始まる人だけを取り出す場合は次のように書けます。

List<String> salesMembers =

departmentMembers.getOrDefault("営業部", new ArrayList<>());

List<String> result = salesMembers.stream()

.filter(member -> member.startsWith("S"))

.collect(Collectors.toList());

System.out.println(result);

// → [Sakura]

getOrDefault()を使っているため、「営業部」というキーが存在しない場合でも空のListが返ります。

空のListに対してstream()を実行してもエラーにはならず、結果として空のListが作成されます。

Mapに登録されているすべてのListを1つのStreamとして扱いたい場合は、flatMap()を使う方法もあります。

List<String> allMembers = departmentMembers.values().stream()

.flatMap(List::stream)

.collect(Collectors.toList());

System.out.println(allMembers);

values()でMapに登録されているすべてのListを取り出し、flatMap()で1つの流れにまとめています。

ただし、flatMap()は少し発展的な書き方です。まずはentrySet()と二重ループを使った処理を理解してから取り入れても問題ありません。

まとめ

・1つのキーに複数の値を持たせたい場合は、Mapの値としてListを使用する
・Map<String, List>のように、型の中へ別の型を入れた構造を作れる
・既存のListへ値を追加するときは、get()で取り出してからadd()を使う
・存在しないキーへ追加する場合は、containsKey()で確認して空のListを登録する
・computeIfAbsent()を使うと、キーの確認とListの作成を簡潔に書ける
・すべての要素を処理するときは、entrySet()とListの二重ループを使う
・Listが空になってもMapのキーは残るため、必要に応じてMapからも削除する
・慣れてきたらStream APIやflatMap()を使った処理も選択肢に

次回:「Mapの中にオブジェクトを格納する:複数項目をまとめて管理する方法」

実務では、名前だけでなく、ID・年齢・所属部署など複数の項目をまとめて管理したい場面があります。
次回は独自クラスを作成し、Map<String, User>のようにオブジェクトを値として格納する方法と、そのデータを追加・取得・更新する基本を解説します。

有限会社バナナドリーム

千葉県浦安市を拠点に、Javaを中心としたシステム開発からITコンサルタント、Webサイト制作まで幅広く手がけるシステム開発会社です。
開発・実装からアフターフォローまで一貫して対応し、お客様の課題に寄り添ったきめ細やかなサービスを提供しています。

「やさしさがつなぐ、人と未来と技術。」を掲げ、技術力だけでなく人と人とのつながりを大切にした経営を実践。
社員一人ひとりの個性を尊重し、30名規模を上限とした少数精鋭体制のもと、社員・顧客・地域社会のすべてと良好な関係を築くことを理念としています。

「Realize Dream ~夢は実現する為にある~」という言葉のもと、関わるすべての人の夢の実現をサポートし続けます。

お問い合わせはこちら