TOC

JPAによるストアドプロシージャの手引き

JPAを使用したスト​​アドプロシージャのガイド

1. 前書き

このクイックチュートリアルでは、Java Persistence API（JPA）内でのストアドプロシージャの使用について説明します。

2. プロジェクトのセットアップ

2.1. Mavenセットアップ

まず、pom.xml:で次の依存関係を定義する必要があります

  • javax.javaee-api – JPAAPIが含まれているため

  • JPA APIの実装–この例では、Hibernateを使用しますが、EclipseLinkもOKの代替手段です。

  • MySQLデータベース 


    7.0
    11.2.0.4
    5.1.38


    
        javax
        javaee-api
        ${jee.version}
        provided
    
    
        org.hibernate
        hibernate-entitymanager
        ${hibernate.version}
    
    
        mysql
        mysql-connector-java
        ${mysql.version}

2.2. 永続性ユニットの定義

2番目のステップは、src/main/resources/META-INF/persistence.xmlファイルの作成です。これには永続性ユニットの定義が含まれています。 




    
        org.hibernate.jpa.HibernatePersistenceProvider
        com.example.jpa.model.Car

JNDI DataSource（JEE環境）を参照する場合、定義されたすべてのHibernateプロパティは必要ありません。 

java:jboss/datasources/JpaStoredProcedure

2.3. テーブル作成スクリプト

次に、ID, MODELとYEARの3つの属性を持つTable ( CAR )を作成しましょう。 

CREATE TABLE `car` (
  `ID` int(10) NOT NULL AUTO_INCREMENT,
  `MODEL` varchar(50) NOT NULL,
  `YEAR` int(4) NOT NULL,
  PRIMARY KEY (`ID`)
) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8;

もちろん、DBスキーマとアクセス許可が既に設定されていることを前提としていました。

2.4. DBでのストアドプロシージャの作成

Javaコードにジャンプする前の最後のステップは、MySQLデータベースでのストアドプロシージャの作成です。 

DELIMITER $$
CREATE DEFINER=`root`@`localhost` PROCEDURE `FIND_CAR_BY_YEAR`(in p_year int)
begin
SELECT ID, MODEL, YEAR
    FROM CAR
    WHERE YEAR = p_year;
end
$$
DELIMITER ;

3. JPAストアドプロシージャ

これで、JPAを使用してデータベースと通信し、定義したストアドプロシージャを実行する準備が整いました。

これを行うと、Car.のListとして結果を反復処理することもできます。

3.1. Carエンティティ

エンティティマネージャによってCARデータベーステーブルに適切にマップされているCarエンティティの下。

また、@NamedStoredProcedureQueriesアノテーションを使用して、エンティティで直接ストアドプロシージャを定義していることに注意してください。 

@Entity
@Table(name = "CAR")
@NamedStoredProcedureQueries({
  @NamedStoredProcedureQuery(
    name = "findByYearProcedure",
    procedureName = "FIND_CAR_BY_YEAR",
    resultClasses = { Car.class },
    parameters = {
        @StoredProcedureParameter(
          name = "p_year",
          type = Integer.class,
          mode = ParameterMode.IN) })
})
public class Car {

    private long id;
    private String model;
    private Integer year;

    public Car(String model, Integer year) {
        this.model = model;
        this.year = year;
    }

    public Car() {
    }

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    @Column(name = "ID", unique = true, nullable = false, scale = 0)
    public long getId() {
        return id;
    }

    @Column(name = "MODEL")
    public String getModel() {
        return model;
    }

    @Column(name = "YEAR")
    public Integer getYear() {
        return year;
    }

    // standard setter methods
}

3.2. データベースへのアクセス

これで、すべてが定義され、適切に配置されたので、実際にJPAを使用してプロシージャを実行するいくつかのテストを記述しましょう。

指定されたyear内のすべてのCarsを取得します：__ 

public class StoredProcedureTest {

    private static EntityManagerFactory factory = null;
    private static EntityManager entityManager = null;

    @BeforeClass
    public static void init() {
        factory = Persistence.createEntityManagerFactory("jpa-db");
        entityManager = factory.createEntityManager();
    }

    @Test
    public void findCarsByYearWithNamedStored() {
        StoredProcedureQuery findByYearProcedure =
          entityManager.createNamedStoredProcedureQuery("findByYearProcedure");

        StoredProcedureQuery storedProcedure =
          findByYearProcedure.setParameter("p_year", 2015);

        storedProcedure.getResultList()
          .forEach(c -> Assert.assertEquals(new Integer(2015), ((Car) c).getYear()));
    }

    @Test
    public void findCarsByYearNoNamedStored() {
        StoredProcedureQuery storedProcedure =
          entityManager
            .createStoredProcedureQuery("FIND_CAR_BY_YEAR",Car.class)
            .registerStoredProcedureParameter(1, Integer.class, ParameterMode.IN)
            .setParameter(1, 2015);

        storedProcedure.getResultList()
          .forEach(c -> Assert.assertEquals(new Integer(2015), ((Car) c).getYear()));
    }

}

2番目のテストでは、we’re no longer using the stored procedure we defined on the entityであることに注意してください。 代わりに、手順を最初から定義しています。

これは、ストアドプロシージャを使用する必要があるが、エンティティを変更して再コンパイルするオプションがない場合に非常に役立ちます。

4. 結論

このチュートリアルでは、ストアドプロシージャとJava Persistence APIの使用について説明しました。

この記事で使用されている例は、sample project in GitHubとして利用できます。

Related