web-dev-qa-db-ja.com

変更不可能なマップは（本当に）いつ必要ですか？

次のような定数のマップがあります。

_private static Map<String, Character> _typesMap =
        new HashMap<String, Character>() {
        {
            put ("string", 'S');
            put ("normalizedString", 'N');
            put ("token", 'T');
            // (...)
        }
_

このマップを作成するには、本当にCollections.unmodifiableMap()を使用する必要がありますか？それを使用する利点は何ですか？それらが実際に一定にならないという明らかな事実以外に、それを使用しないことの不利な点はありますか？

javacollectionsunmodifiable
37
Paulo Guedes

Collections.unmodifiableMapは、マップが変更されないことを保証します。メソッド呼び出しから内部マップの読み取り専用ビューを返したい場合、これは主に便利です。例：

class A {
    private Map importantData;

    public Map getImportantData() {
        return Collections.unmodifiableMap(importantData);
    }
}

これにより、クライアントがデータを変更する危険を冒さない高速な方法が得られます。これは、マップのコピーを返すよりもはるかに高速でメモリ効率が高くなります。クライアントが戻り値を本当に変更したい場合は、自分でコピーできますが、コピーへの変更はAのデータに反映されません。

マップ参照を他の誰かに返さない場合は、不変にすることについて偏執的でない限り、わざわざ変更できないようにしてください。あなたはおそらくそれを変更しないように自分を信頼することができます。

70
Cameron Skinner

「Collections.unmodifiableMapはマップが変更されないことを保証する」という上記のCameron Skinnerの声明は実際には一般的にのみpartly trueですが、問題の特定の例についてはたまたま正確です（ Characterオブジェクトは不変です）。例を挙げて説明します。

Collections.unmodifiableMapは実際には、マップに保持されているオブジェクトへのreferencesを変更できないという保護のみを提供します。それはそれが返すマップへの「プット」を制限することによってそれを行います。ただし、Collections.unmodifiableMapはマップのコンテンツのコピーを作成しないため、元のカプセル化されたマップはクラスの外部から変更できます。

Pauloが投稿した質問では、マップに保持されているCharacterオブジェクトは変更できません。ただし、一般にこれは真実ではない可能性があり、Collections.unmodifiableMapによって通知される変更不可性が唯一の保護手段であってはなりません。たとえば、以下の例を参照してください。

import Java.awt.Point;
import Java.util.Collections;
import Java.util.HashMap;
import Java.util.Map;

public class SeeminglyUnmodifiable {
   private Map<String, Point> startingLocations = new HashMap<>(3);

   public SeeminglyUnmodifiable(){
      startingLocations.put("LeftRook", new Point(1, 1));
      startingLocations.put("LeftKnight", new Point(1, 2));
      startingLocations.put("LeftCamel", new Point(1, 3));
      //..more locations..
   }

   public Map<String, Point> getStartingLocations(){
      return Collections.unmodifiableMap(startingLocations);
   }

   public static void main(String [] args){
     SeeminglyUnmodifiable  pieceLocations = new SeeminglyUnmodifiable();
     Map<String, Point> locations = pieceLocations.getStartingLocations();

     Point camelLoc = locations.get("LeftCamel");
     System.out.println("The LeftCamel's start is at [ " + camelLoc.getX() +  ", " + camelLoc.getY() + " ]");

     //Try 1. update elicits Exception
     try{
        locations.put("LeftCamel", new Point(0,0));  
     } catch (Java.lang.UnsupportedOperationException e){
        System.out.println("Try 1 - Could not update the map!");
     }

     //Try 2. Now let's try changing the contents of the object from the unmodifiable map!
     camelLoc.setLocation(0,0);

     //Now see whether we were able to update the actual map
     Point newCamelLoc = pieceLocations.getStartingLocations().get("LeftCamel");
     System.out.println("Try 2 - Map updated! The LeftCamel's start is now at [ " + newCamelLoc.getX() +  ", " + newCamelLoc.getY() + " ]");       }
}

この例を実行すると、次のことがわかります。

The LeftCamel's start is at [ 1.0, 3.0 ]
Try 1 - Could not update the map!
Try 2 - Map updated! The LeftCamel's start is now at [ 0.0, 0.0 ]

StartingLocationsマップはカプセル化され、getStartingLocationsメソッドでCollections.unmodifiableMapを利用することによってのみ返されます。ただし、上記のコードの「試してみる2」に見られるように、スキームは、任意のオブジェクトへのアクセスを取得してから変更することによって破壊されます。マップに保持されているオブジェクト自体が不変である場合は、Collections.unmodifiableMapにのみ依存して、真に変更不可能なマップを提供できると言うだけで十分です。そうでない場合は、マップ内のオブジェクトをコピーするか、可能であればオブジェクトのモディファイアメソッドへのアクセスを制限します。

30
Don