SqlResultSetMappingのガイド

投稿日: 2019-10-18 2022-11-10
タグ: JPA, Persistence, sql

1. 序章

このガイドでは、Java Persistence API（JPA）の外にあるSqlResultSetMappingを見ていきます。

ここでのコア機能には、データベースSQLステートメントからの結果セットのJavaオブジェクトへのマッピングが含まれます。

2. 設定

その使用法を見る前に、いくつかのセットアップを行いましょう。

2.1. Mavenの依存関係

必要なMavenの依存関係は、HibernateとH2データベースです。 Hibernate は、JPA仕様の実装を提供します。インメモリデータベースにはH2データベースを使用します。

2.2. データベース

次に、次のように2つのテーブルを作成します。

CREATE TABLE EMPLOYEE
(id BIGINT,
 name VARCHAR(10));

EMPLOYEE テーブルには、1つの結果Entityオブジェクトが格納されます。 SCHEDULE_DAYS には、列 employeeId：によってEMPLOYEEテーブルにリンクされたレコードが含まれています

CREATE TABLE SCHEDULE_DAYS
(id IDENTITY,
 employeeId BIGINT,
 dayOfWeek  VARCHAR(10));

データ作成のスクリプトは、このガイドのコードにあります。

2.3. エンティティオブジェクト

エンティティオブジェクトは次のようになります。

@Entity
public class Employee {
    @Id
    private Long id;
    private String name;
}

エンティティオブジェクトは、データベーステーブルとは異なる名前が付けられている可能性があります。クラスに@Table のアノテーションを付けて、明示的にマップすることができます。

@Entity
@Table(name = "SCHEDULE_DAYS")
public class ScheduledDay {

    @Id
    @GeneratedValue
    private Long id;
    private Long employeeId;
    private String dayOfWeek;
}

3. スカラーマッピング

データができたので、クエリ結果のマッピングを開始できます。

3.1. ColumnResult

SqlResultSetMappingおよびQueryアノテーションはリポジトリクラスでも機能しますが、この例ではエンティティクラスでアノテーションを使用します。

毎日 SqlResultSetMapping アノテーションに必要なプロパティは1つだけです。名前。ただし、メンバータイプのいずれかがないと、何もマップされません。メンバータイプは、 ColumnResult 、 ConstructorResult 、およびEntityResultです。

この場合、 ColumnResult は、任意の列をスカラー結果タイプにマップします。

@SqlResultSetMapping(
  name="FridayEmployeeResult",
  columns={@ColumnResult(name="employeeId")})

ColumnResult property name は、クエリ内の列を識別します。

@NamedNativeQuery(
  name = "FridayEmployees",
  query = "SELECT employeeId FROM schedule_days WHERE dayOfWeek = 'FRIDAY'",
  resultSetMapping = "FridayEmployeeResult")

NamedNativeQuery アノテーションのresultSetMappingの値は、ResultSetMapping宣言のnameプロパティと一致するため、重要であることに注意してください。

その結果、NamedNativeQuery結果セットは期待どおりにマップされます。同様に、 StoredProcedureAPIにはこの関連付けが必要です。

3.2. ColumnResultテスト

コードを実行するには、Hibernate固有のオブジェクトが必要です。

@BeforeAll
public static void setup() {
    emFactory = Persistence.createEntityManagerFactory("java-jpa-scheduled-day");
    em = emFactory.createEntityManager();
}

最後に、名前付きクエリを呼び出してテストを実行します。

@Test
public void whenNamedQuery_thenColumnResult() {
    List<Long> employeeIds = em.createNamedQuery("FridayEmployees").getResultList();
    assertEquals(2, employeeIds.size());
}

4. コンストラクターマッピング

結果セットをオブジェクト全体にマップする必要がある場合を見てみましょう。

4.1. ConstructorResult

ColumnResult の例と同様に、SqlResultMappingアノテーションをEntityクラスScheduledDayに追加します。ただし、コンストラクターを使用してマップするには、コンストラクターを作成する必要があります。

public ScheduledDay (
  Long id, Long employeeId, 
  Integer hourIn, Integer hourOut, 
  String dayofWeek) {
    this.id = id;
    this.employeeId = employeeId;
    this.dayOfWeek = dayofWeek;
}

また、マッピングはターゲットクラスと列（両方が必要）を指定します。

@SqlResultSetMapping(
    name="ScheduleResult",
    classes={
      @ConstructorResult(
        targetClass=com.baeldung.sqlresultsetmapping.ScheduledDay.class,
        columns={
          @ColumnResult(name="id", type=Long.class),
          @ColumnResult(name="employeeId", type=Long.class),
          @ColumnResult(name="dayOfWeek")})})

ColumnResultsの順序は非常に重要です。列の順序が正しくない場合、コンストラクターは識別されません。この例では、順序はテーブルの列と一致しているため、実際には必要ありません。

@NamedNativeQuery(name = "Schedules",
  query = "SELECT * FROM schedule_days WHERE employeeId = 8",
  resultSetMapping = "ScheduleResult")

ConstructorResult のもう1つの独自の違いは、結果のオブジェクトが「新規」または「分離」としてインスタンス化されることです。一致する主キーがEntityManagerに存在する場合、マップされた Entity は切り離された状態になります。それ以外の場合は、新しいものになります。

SQLデータ型とJavaデータ型が一致しないために、ランタイムエラーが発生する場合があります。したがって、type。で明示的に宣言できます。

4.2. ConstructorResultテスト

単体テストでConstructorResultをテストしてみましょう。

@Test
public void whenNamedQuery_thenConstructorResult() {
  List<ScheduledDay> scheduleDays
    = Collections.checkedList(
      em.createNamedQuery("Schedules", ScheduledDay.class).getResultList(), ScheduledDay.class);
    assertEquals(3, scheduleDays.size());
    assertTrue(scheduleDays.stream().allMatch(c -> c.getEmployeeId().longValue() == 3));
}

5. エンティティマッピング

最後に、コードが少ない単純なエンティティマッピングについては、EntityResultを見てみましょう。

5.1. 単一のエンティティ

EntityResult では、エンティティクラスEmployeeを指定する必要があります。より詳細に制御するために、オプションのフィールドプロパティを使用します。 FieldResultと組み合わせると、一致しないエイリアスとフィールドをマップできます。

@SqlResultSetMapping(
  name="EmployeeResult",
  entities={
    @EntityResult(
      entityClass = com.baeldung.sqlresultsetmapping.Employee.class,
        fields={
          @FieldResult(name="id",column="employeeNumber"),
          @FieldResult(name="name", column="name")})})

これで、クエリにエイリアス列が含まれるはずです。

@NamedNativeQuery(
  name="Employees",
  query="SELECT id as employeeNumber, name FROM EMPLOYEE",
  resultSetMapping = "EmployeeResult")

ConstructorResult と同様に、EntityResultにはコンストラクターが必要です。ただし、ここではデフォルトのものが機能します。

5.2. 複数のエンティティ

単一のエンティティをマッピングすると、複数のエンティティのマッピングは非常に簡単になります。

@SqlResultSetMapping(
  name = "EmployeeScheduleResults",
  entities = {
    @EntityResult(entityClass = com.baeldung.sqlresultsetmapping.Employee.class),
    @EntityResult(entityClass = com.baeldung.sqlresultsetmapping.ScheduledDay.class)

5.3. EntityResultテスト

EntityResultの動作を見てみましょう。

@Test
public void whenNamedQuery_thenSingleEntityResult() {
    List<Employee> employees = Collections.checkedList(
      em.createNamedQuery("Employees").getResultList(), Employee.class);
    assertEquals(3, employees.size());
    assertTrue(employees.stream().allMatch(c -> c.getClass() == Employee.class));
}

複数のエンティティの結果は2つのエンティティを結合するため、一方のクラスのみのクエリアノテーションは混乱を招きます。

そのため、テストでクエリを定義します。

@Test
public void whenNamedQuery_thenMultipleEntityResult() {
    Query query = em.createNativeQuery(
      "SELECT e.id, e.name, d.id, d.employeeId, d.dayOfWeek "
        + " FROM employee e, schedule_days d "
        + " WHERE e.id = d.employeeId", "EmployeeScheduleResults");
    
    List<Object[]> results = query.getResultList();
    assertEquals(4, results.size());
    assertTrue(results.get(0).length == 2);

    Employee emp = (Employee) results.get(1)[0];
    ScheduledDay day = (ScheduledDay) results.get(1)[1];

    assertTrue(day.getEmployeeId() == emp.getId());
}

6. 結論

このガイドでは、を使用するためのさまざまなオプションについて説明しました。 SqlResultSetMapping 注釈。 SqlResultSetMapping JavaPersistenceAPIの重要な部分です。

コードスニペットは、GitHubのにあります。

getdocs

13036