CallableStatementで関数を呼び出す方法をJDBCのサンプルコードでわかりやすく解説

ストアドプロシージャと同様に、データベース内に関数（ファンクション）を作成して保存することもできます。この記事では、MySQLでの関数の作成方法と、JDBCのCallableStatementを使ってその関数を呼び出す手順を、具体的なサンプルコードとともに詳しく解説します。

MySQLで関数を作成する構文

MySQLデータベースに関数を作成する場合の基本構文は以下の通りです。

CREATE FUNCTION 関数名(入力引数) RETURNS 戻り値の型
BEGIN
    変数の宣言;
    処理文 . . . . . . . . . .
    return 戻り値;
END

サンプルテーブルの準備

ここでは、データベースに以下のような内容を持つ Emp テーブルが存在するものとして説明を進めます。

+--------+------------+----------------+
| Name   | DOB        | Location       |
+--------+------------+----------------+
| Amit   | 1970-01-08 | Hyderabad      |
| Sumith | 1970-01-08 | Vishakhapatnam |
| Sudha  | 1970-01-05 | Vijayawada     |
+--------+------------+----------------+

関数の作成例：getDob()

以下は関数作成の具体例です。ここでは getDob() という名前の関数を作成しています。この関数は従業員の名前を受け取り、該当するレコードのDOB（生年月日）カラムの値を取得して返します。

CREATE FUNCTION getDob(emp_name VARCHAR(50)) RETURNS DATE
BEGIN
declare dateOfBirth DATE;
select DOB into dateOfBirth from EMP where Name = emp_name;
return dateOfBirth;
END

JDBCでCallableStatementを使って関数を呼び出す手順

ストアドプロシージャと同じように、CallableStatementオブジェクトを使用すれば関数も呼び出せます。JDBCプログラムから関数を呼び出すには、以下の手順が必要です。

• データベースに接続する。

• CallableStatementオブジェクトを作成し、コンストラクタに関数呼び出しを文字列形式で渡す。

• プレースホルダー（?）に値を設定する。

• Callableステートメントを実行する。

関数呼び出しのクエリ構文

JDBCから関数を呼び出す際のクエリは次のように記述します。

{? = call getDob(?)}

ご覧の通り、このクエリにはPreparedStatementやCallableStatementと同様にプレースホルダー（?）が含まれています。

上記のクエリでは、最初のプレースホルダーが関数の戻り値を表し、2番目のプレースホルダーが入力パラメータを表します。

戻り値用プレースホルダーの登録

戻り値を表すプレースホルダーは、CallableStatementインターフェースのregisterOutParameter()メソッドを使って、出力パラメータとして登録する必要があります。このメソッドには、プレースホルダーの位置を表す整数値と、パラメータのSQL型を表す整数値を渡します。

cstmt.registerOutParameter(1, Types.DATE);

また、getDob()関数がVARCHAR型の値を受け取るため、setString()メソッドを使って入力パラメータに値を設定します。

完全なJDBCプログラム例

以下のJDBCプログラムは、関数getDobを実行し、結果を取得する完全なコード例です。

import java.sql.CallableStatement;
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.SQLException;
import java.sql.Types;
public class CallingFunctionsUsingCallable2 {
    public static void main(String args[]) throws SQLException {
       // ドライバの登録
       DriverManager.registerDriver(new com.mysql.jdbc.Driver());

       // 接続の取得
       String mysqlUrl = "jdbc:mysql://localhost/sampleDB";
       Connection con = DriverManager.getConnection(mysqlUrl, "root", "password");
       System.out.println("Connection established......");

       // CallableStatementの準備
       CallableStatement cstmt = con.prepareCall("{? = call getDob(?)}");

       cstmt.registerOutParameter(1, Types.DATE);
       cstmt.setString(2, "Amit");
       cstmt.execute();

       System.out.print("Date of birth: "+cstmt.getDate(1));
    }
}

実行結果

上記プログラムを実行すると、以下のような出力が得られます。

Connection established......
Date of birth: 1970-01-08

このように、CallableStatementを活用することで、データベースに保存された関数をJavaアプリケーションから簡単に呼び出し、戻り値を取得することができます。ストアドプロシージャとの主な違いは、関数が必ず戻り値を返す点であり、そのため最初のプレースホルダーを出力パラメータとして登録する必要がある点に注意してください。