JavaにおけるIdentity Mapパターン:効率的なオブジェクトID管理
Identity Mapデザインパターンの意図
JavaにおけるIdentity Mapデザインパターンは、ロードされたすべてのオブジェクトをマップに保持することで、各オブジェクトが一度だけロードされるようにし、データベースのパフォーマンスとメモリ管理を向上させることを目的としています。
実世界の例を用いたIdentity Mapパターンの詳細な説明
実世界の例
会議を企画していて、すべての参加者がチェックインする必要がある受付がある場面を想像してください。このシナリオは、重複オブジェクトを防ぐJavaのIdentity Mapパターンを示しています。不要な遅延や混乱を避けるために、各参加者の詳細は最初にチェックインしたときにコンピューターシステムに入力されます。同じ参加者が再度受付に来た場合、システムは同じ情報を再提出させることなく、迅速に詳細を取得します。これにより、各参加者の情報が効率的かつ一貫して処理されることが保証されます。これは、Identity Mapパターンがオブジェクトが一度だけロードされ、アプリケーション全体で再利用されることを保証する方法に似ています。
平易な言葉で
Identity Mapデザインパターンは、各固有のオブジェクトが一度だけロードされ、中央のレジストリから再利用されるようにすることで、アプリケーションのメモリ内の重複オブジェクトを防ぎます。
Wikipediaによると
DBMSの設計において、Identity Mapパターンは、同じオブジェクトデータをデータベースから重複して取得することを防ぐために、コンテキスト固有のインメモリキャッシュを提供することにより、パフォーマンスを向上させるために使用されるデータベースアクセスデザインパターンです。
JavaにおけるIdentity Mapパターンのプログラム例
Javaプログラミングでのこのデモンストレーションの目的のために、メモリ内の重複オブジェクトを回避するIdentity Mapパターンを示す、データベースインスタンスが既に作成されていると仮定します。
まず、Person
エンティティとそのフィールドの実装を見てみましょう。
@EqualsAndHashCode(onlyExplicitlyIncluded = true)
@Getter
@Setter
@AllArgsConstructor
public final class Person implements Serializable {
private static final long serialVersionUID = 1L;
@EqualsAndHashCode.Include
private int personNationalId;
private String name;
private long phoneNum;
@Override
public String toString() {
return "Person ID is : " + personNationalId + " ; Person Name is : " + name + " ; Phone Number is :" + phoneNum;
}
}
以下は、ユーザーがデータベース内のレコードを検索するために利用するエンティティであるPersonFinder
の実装です。これには、関連するDBがアタッチされています。また、最近読み取られたレコードを保存するためのIdentityMap
も保持しています。
@Slf4j
@Getter
@Setter
public class PersonFinder {
private static final long serialVersionUID = 1L;
// Access to the Identity Map
private IdentityMap identityMap = new IdentityMap();
private PersonDbSimulatorImplementation db = new PersonDbSimulatorImplementation();
public Person getPerson(int key) {
// Try to find person in the identity map
Person person = this.identityMap.getPerson(key);
if (person != null) {
LOGGER.info("Person found in the Map");
return person;
} else {
// Try to find person in the database
person = this.db.find(key);
if (person != null) {
this.identityMap.addPerson(person);
LOGGER.info("Person found in DB.");
return person;
}
LOGGER.info("Person with this ID does not exist.");
return null;
}
}
}
上記のクラスのIdentity Mapフィールドは、単にpersonNationalIdをキーとし、対応するPersonオブジェクトを値とするHashMapの抽象化です。以下にその実装を示します。
@Slf4j
@Getter
public class IdentityMap {
private Map<Integer, Person> personMap = new HashMap<>();
public void addPerson(Person person) {
if (!personMap.containsKey(person.getPersonNationalId())) {
personMap.put(person.getPersonNationalId(), person);
} else { // Ensure that addPerson does not update a record. This situation will never arise in our implementation. Added only for testing purposes.
LOGGER.info("Key already in Map");
}
}
public Person getPerson(int id) {
Person person = personMap.get(id);
if (person == null) {
LOGGER.info("ID not in Map.");
}
return person;
}
public int size() {
if (personMap == null) {
return 0;
}
return personMap.size();
}
}
次に、Identity MapがApp
のmain
関数でどのように機能するかを見てみましょう。
public static void main(String[] args) {
// Dummy Persons
Person person1 = new Person(1, "John", 27304159);
Person person2 = new Person(2, "Thomas", 42273631);
Person person3 = new Person(3, "Arthur", 27489171);
Person person4 = new Person(4, "Finn", 20499078);
Person person5 = new Person(5, "Michael", 40599078);
// Init database
PersonDbSimulatorImplementation db = new PersonDbSimulatorImplementation();
db.insert(person1);
db.insert(person2);
db.insert(person3);
db.insert(person4);
db.insert(person5);
// Init a personFinder
PersonFinder finder = new PersonFinder();
finder.setDb(db);
// Find persons in DataBase not the map.
LOGGER.info(finder.getPerson(2).toString());
LOGGER.info(finder.getPerson(4).toString());
LOGGER.info(finder.getPerson(5).toString());
// Find the person in the map.
LOGGER.info(finder.getPerson(2).toString());
}
この例を実行すると、次のコンソール出力が生成されます。
11:19:43.775 [main] INFO com.iluwatar.identitymap.IdentityMap -- ID not in Map.
11:19:43.780 [main] INFO com.iluwatar.identitymap.PersonDbSimulatorImplementation -- Person ID is : 2 ; Person Name is : Thomas ; Phone Number is :42273631
11:19:43.780 [main] INFO com.iluwatar.identitymap.PersonFinder -- Person found in DB.
11:19:43.780 [main] INFO com.iluwatar.identitymap.App -- Person ID is : 2 ; Person Name is : Thomas ; Phone Number is :42273631
11:19:43.780 [main] INFO com.iluwatar.identitymap.IdentityMap -- ID not in Map.
11:19:43.780 [main] INFO com.iluwatar.identitymap.PersonDbSimulatorImplementation -- Person ID is : 4 ; Person Name is : Finn ; Phone Number is :20499078
11:19:43.780 [main] INFO com.iluwatar.identitymap.PersonFinder -- Person found in DB.
11:19:43.780 [main] INFO com.iluwatar.identitymap.App -- Person ID is : 4 ; Person Name is : Finn ; Phone Number is :20499078
11:19:43.780 [main] INFO com.iluwatar.identitymap.IdentityMap -- ID not in Map.
11:19:43.780 [main] INFO com.iluwatar.identitymap.PersonDbSimulatorImplementation -- Person ID is : 5 ; Person Name is : Michael ; Phone Number is :40599078
11:19:43.780 [main] INFO com.iluwatar.identitymap.PersonFinder -- Person found in DB.
11:19:43.780 [main] INFO com.iluwatar.identitymap.App -- Person ID is : 5 ; Person Name is : Michael ; Phone Number is :40599078
11:19:43.780 [main] INFO com.iluwatar.identitymap.IdentityMap -- Person ID is : 2 ; Person Name is : Thomas ; Phone Number is :42273631
11:19:43.780 [main] INFO com.iluwatar.identitymap.PersonFinder -- Person found in the Map
11:19:43.780 [main] INFO com.iluwatar.identitymap.App -- Person ID is : 2 ; Person Name is : Thomas ; Phone Number is :42273631
JavaでIdentity Mapパターンを使用するタイミング
Identity Mapデザインパターンは、単一のセッションまたはトランザクション内で同じデータへの複数アクセスが発生するJavaアプリケーションで使用され、効率的なオブジェクトマッピングと一貫性を保証します。
Identity MapパターンJavaチュートリアル
JavaにおけるIdentity Mapパターンの実世界の応用例
- JavaのORM(オブジェクト関係マッピング)フレームワークは、データベースとのやり取りをより効率的に処理するためにIdentity Mapを実装することが多く、Javaデザインパターンにおけるこのパターンの重要性を示しています。
- さまざまなビジネスプロセス間で一貫したデータ状態を維持するためのエンタープライズアプリケーション。
Identity Mapパターンの利点とトレードオフ
利点
- 各オブジェクトのコピーが1つだけメモリに存在するようにすることで、メモリ使用量を削減します。
- アプリケーションのすべての部分が同じインスタンスを参照するため、更新中の一貫性のない状態を防ぎます。
- 同じデータに対して繰り返しデータベースを読み込むことを避けることで、パフォーマンスを向上させます。
トレードオフ
- オブジェクト管理と永続化ロジックの複雑さを増します。
- 特に同時実行環境では、適切に管理しないと古いデータにつながる可能性があります。
関連するJavaデザインパターン
- データマッパー: 永続化ロジックをドメインロジックから分離します。Identity Mapは、各オブジェクトが一度だけロードされるようにするためにデータマッパーによって使用され、パフォーマンスとデータの一貫性を向上させます。
- Unit of Work: 変更を追跡し、トランザクションの一貫性を処理することにより、複数のオブジェクトのアクションを調整します。Identity Mapは、トランザクションの影響を受けるオブジェクトを追跡するためにUnit of Work内で使用されます。