1. 序章

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

2. プロジェクトの設定

2.1. Mavenのセットアップ

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

  • javax.javaee-api –JPAAPIが含まれているため
  • JPA APIの実装–この例では、 Hibernate を使用しますが、EclipseLinkもOKの代替手段です。
  • a MySQLデータベース
<properties>
    <jee.version>7.0</jee.version>
    <mysql.version>11.2.0.4</mysql.version>
    <hibernate.version>5.1.38</hibernate.version>
</properties>
<dependencies>
    <dependency>
        <groupId>javax</groupId>
        <artifactId>javaee-api</artifactId>
        <version>${jee.version}</version>
        <scope>provided</scope>
    </dependency>
    <dependency>
        <groupId>org.hibernate</groupId>
        <artifactId>hibernate-core</artifactId>
        <version>${hibernate.version}</version>
    </dependency>
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <version>${mysql.version}</version>
    </dependency>
</dependencies>

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

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

<?xml version="1.0" encoding="UTF-8"?>
<persistence xmlns="http://java.sun.com/xml/ns/persistence"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://java.sun.com/xml/ns/persistence
    http://java.sun.com/xml/ns/persistence/persistence_2_1.xsd"
    version="2.1">

    <persistence-unit name="jpa-db">
        <provider>org.hibernate.jpa.HibernatePersistenceProvider</provider>
        <class>com.baeldung.jpa.model.Car</class>
        <properties>
            <property name="javax.persistence.jdbc.driver" 
              value="com.mysql.jdbc.Driver" />
            <property name="javax.persistence.jdbc.url" 
              value="jdbc:mysql://127.0.0.1:3306/baeldung" />
            <property name="javax.persistence.jdbc.user" 
              value="baeldung" />
            <property name="javax.persistence.jdbc.password" 
              value="YourPassword" />
            <property name="hibernate.dialect" 
              value="org.hibernate.dialect.MySQLDialect" />
            <property name="hibernate.show_sql" value="true" />
        </properties>
    </persistence-unit>

</persistence>

JNDIデータソース(JEE環境)を参照する場合、定義されているすべてのHibernateプロパティは必要ありません。

<jta-data-source>java:jboss/datasources/JpaStoredProcedure</jta-data-source>

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

次に、テーブル(CAR)を作成しましょう– ID、MODEL YEARの3つの属性があります。

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を使用してデータベースと通信し、定義したストアドプロシージャを実行する準備が整いました。

これを行うと、車のリストとして結果を反復処理することもできます。

3.1. エンティティ

エンティティマネージャによって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を使用してプロシージャを実行するいくつかのテストを作成しましょう。

特定ののすべてのを取得します

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番目のテストでは、エンティティで定義したストアドプロシージャを使用しなくなったことに注意してください。 代わりに、手順を最初から定義しています。

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

4. 結論

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

この記事で使用されている例は、GitHubサンプルプロジェクトとして利用できます。