JPAエラー「java.lang.StringをLjava.lang.Stringにキャストできません;」の修正

投稿日: 2019-10-19 2022-11-06
タグ: JPA, Persistence

1. 序章

もちろん、StringをJavaのString配列にキャストできるとは思いもしません。

java.lang.String cannot be cast to [Ljava.lang.String;

しかし、これは一般的なJPAエラーであることが判明しました。

このクイックチュートリアルでは、これがどのように発生し、どのように解決するかを示します。

2. JPAの一般的なエラーケース

JPAでは、ネイティブクエリを操作し、EntityManagerのcreateNativeQueryメソッドを使用するときにこのエラーが発生することは珍しくありません。

そのJavadocは、このメソッドがObject []のリストを返すか、クエリによって1つの列のみが返される場合はObjectのみを返すことを実際に警告します。

例を見てみましょう。まず、すべてのクエリを実行するために再利用するクエリエグゼキュータを作成しましょう。

public class QueryExecutor {
    public static List<String[]> executeNativeQueryNoCastCheck(String statement, EntityManager em) {
        Query query = em.createNativeQuery(statement);
        return query.getResultList();
    }
}

上記のように、 createNativeQuery（）メソッドを使用しており、String配列を含む結果セットを常に期待しています。

その後、例で使用する単純なエンティティを作成しましょう。

@Entity
public class Message {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    private String text;

    // getters and setters

}

最後に、テストを実行する前にMessageを挿入するテストクラスを作成しましょう。

public class SpringCastUnitTest {

    private static EntityManager em;
    private static EntityManagerFactory emFactory;

    @BeforeClass
    public static void setup() {
        emFactory = Persistence.createEntityManagerFactory("jpa-h2");
        em = emFactory.createEntityManager();

        // insert an object into the db
        Message message = new Message();
        message.setText("text");

        EntityTransaction tr = em.getTransaction();
        tr.begin();
        em.persist(message);
        tr.commit();
    }
}

これで、 QueryExecutor を使用して、エンティティのtextフィールドを取得するクエリを実行できます。

@Test(expected = ClassCastException.class)
public void givenExecutorNoCastCheck_whenQueryReturnsOneColumn_thenClassCastThrown() {
    List<String[]> results = QueryExecutor.executeNativeQueryNoCastCheck("select text from message", em);

    // fails
    for (String[] row : results) {
        // do nothing
    }
}

ご覧のとおり、クエリには列が1つしかないため、JPAは実際には文字列配列のリストではなく、文字列のリストを返します。私たちは ClassCastException クエリは単一の列を返し、配列を期待していたためです。

3. 手動キャスト修正

このエラーを修正する最も簡単な方法は、結果セットオブジェクトのタイプを確認することです。 を避けるために ClassCastException。そのためのメソッドを実装しましょう QueryExecutor ：

public static List<String[]> executeNativeQueryWithCastCheck(String statement, EntityManager em) {
    Query query = em.createNativeQuery(statement);
    List results = query.getResultList();

    if (results.isEmpty()) {
        return new ArrayList<>();
    }

    if (results.get(0) instanceof String) {
        return ((List<String>) results)
          .stream()
          .map(s -> new String[] { s })
          .collect(Collectors.toList());
    } else {
        return (List<String[]>) results;
    }
}

次に、このメソッドを使用して、例外を取得せずにクエリを実行できます。

@Test
public void givenExecutorWithCastCheck_whenQueryReturnsOneColumn_thenNoClassCastThrown() {
    List<String[]> results = QueryExecutor.executeNativeQueryWithCastCheck("select text from message", em);
    assertEquals("text", results.get(0)[0]);
}

クエリが1つの列のみを返す場合は、結果を配列に変換する必要があるため、これは理想的なソリューションではありません。

4. JPAエンティティマッピングの修正

このエラーを修正する別の方法は、結果セットをエンティティにマッピングすることです。このようにして、クエリの結果を事前にマッピングする方法を決定し、不要なキャストを回避できます。

カスタムエンティティマッピングの使用をサポートするために、エグゼキュータに別のメソッドを追加しましょう。

public static <T> List<T> executeNativeQueryGeneric(String statement, String mapping, EntityManager em) {
    Query query = em.createNativeQuery(statement, mapping);
    return query.getResultList();
}

その後、カスタム SqlResultSetMapping を作成して、前のクエリの結果セットをMessageエンティティにマップします。

@SqlResultSetMapping(
  name="textQueryMapping",
  classes={
    @ConstructorResult(
      targetClass=Message.class,
      columns={
        @ColumnResult(name="text")
      }
    )
  }
)
@Entity
public class Message {
    // ...
}

この場合、新しく作成したSqlResultSetMappingに一致するコンストラクターも追加する必要があります。

public class Message {

    // ... fields and default constructor

    public Message(String text) {
        this.text = text;
    }

    // ... getters and setters

}

最後に、新しいエグゼキュータメソッドを使用してテストクエリを実行し、メッセージのリストを取得できます。

@Test
public void givenExecutorGeneric_whenQueryReturnsOneColumn_thenNoClassCastThrown() {
    List<Message> results = QueryExecutor.executeNativeQueryGeneric(
      "select text from message", "textQueryMapping", em);
    assertEquals("text", results.get(0).getText());
}

結果セットのマッピングをJPAに委任するため、このソリューションははるかにクリーンです。

5. 結論

この記事では、ネイティブクエリがこのClassCastExceptionを取得するための一般的な場所であることを示しました。また、タイプチェックを自分で行うことと、クエリ結果をトランスポートオブジェクトにマッピングすることによってタイプチェックを解決することも検討しました。

いつものように、例の完全なソースコードは、GitHubでから入手できます。

getdocs

13036