JDBC的存储过程

以下内容引用自http://wiki.jikexueyuan.com/project/jdbc/stored-procedure.html：

正如一个Connection对象创建了Statement和PreparedStatement对象，它也创造了在数据库中被执行调用的CallableStatement对象。

一、创建CallableStatement对象

假设，需要执行下面的Oracle存储过程：

CREATE OR REPLACE PROCEDURE getEmpName
   (EMP_ID IN NUMBER, EMP_FIRST OUT VARCHAR) AS
BEGIN
   SELECT first INTO EMP_FIRST
   FROM Employees
   WHERE ID = EMP_ID;
END;

注意：上面的存储过程是在Oracle使用的，但使用的是MySQL数据库，所以在MySQL的环境下需要重新写出相同功能的代码，下面的代码是在EMP数据库中创建相同功能的代码：

DELIMITER $$

DROP PROCEDURE IF EXISTS `EMP`.`getEmpName` $$
CREATE PROCEDURE `EMP`.`getEmpName`
   (IN EMP_ID INT, OUT EMP_FIRST VARCHAR(255))
BEGIN
   SELECT first INTO EMP_FIRST
   FROM Employees
   WHERE ID = EMP_ID;
END $$

DELIMITER ;

当前有三种类型的参数：IN，OUT和INOUT。PreparedStatement对象只能使用IN参数。CallableStatement对象可以使用所有的三种类型。

下面是三种类型参数的定义：

参数	描述
IN	当SQL语句创建的时候，该参数的值是未知的。可以用setXXX()方法将值绑定到IN参数里。
OUT	该参数的值是由SQL语句的返回值。可以用getXXX()方法从OUT参数中检索值。
INOUT	该参数同时提供输入和输出值。可以用setXXX()方法将值绑定到IN参数里，并且也可以用getXXX()方法从OUT参数中检索值。

下面的代码片段展示了如何使用Connection.prepareCall()方法实现一个基于上述存储过程的CallableStatement对象：

CallableStatement cstmt = null;
try {
   String SQL = "{call getEmpName (?, ?)}";
   cstmt = conn.prepareCall(SQL);
   . . .
}
catch (SQLException e) {
   . . .
}
finally {
   . . .
}

字符串变量SQL使用参数占位符来表示存储过程。

使用CallableStatement对象就像使用PreparedStatement对象。在执行该语句前，必须将值绑定到所有的参数，否则将收到一个SQL异常。

如果有IN参数，只要按照适用于PreparedStatement对象相同的规则和技巧；用setXXX()方法来绑定对应的Java数据类型。

当使用OUT和INOUT参数就必须采用额外的CallableStatement方法：registerOutParameter()。registerOutParameter()方法将JDBC数据类型绑定到存储过程返回的数据类型。

一旦调用了存储过程，可以用适当的getXXX()方法从OUT参数参数中检索数值。这种方法将检索出来的SQL类型的值映射到Java数据类型。

二、关闭CallableStatement对象

正如关闭其它的Statement对象，出于同样的原因，也应该关闭CallableStatement对象。

close()方法简单的调用就可以完成这项工作。如果先关闭了Connection对象，那么它也会关闭CallableStatement对象。然而，应该始终明确关闭CallableStatement对象，以确保该对象被彻底关闭。

CallableStatement cstmt = null;
try {
   String SQL = "{call getEmpName (?, ?)}";
   cstmt = conn.prepareCall(SQL);
   . . .
}
catch (SQLException e) {
   . . .
}
finally {
   cstmt.close();
}

示例：

创建存储过程：

DELIMITER $$

DROP PROCEDURE IF EXISTS `EMP`.`getEmpName` $$
CREATE PROCEDURE `EMP`.`getEmpName`
   (IN EMP_ID INT, OUT EMP_FIRST VARCHAR(255))
BEGIN
   SELECT first INTO EMP_FIRST
   FROM Employees
   WHERE ID = EMP_ID;
END $$

DELIMITER ;

JDBCExample：

//STEP 1. Import required packages
import java.sql.*;

public class JDBCExample {
    // JDBC driver name and database URL
    static final String JDBC_DRIVER = "com.mysql.jdbc.Driver";
    static final String DB_URL = "jdbc:mysql://localhost/Test?serverTimezone=UTC";

    // Database credentials
    static final String USER = "root";
    static final String PASS = "root";

    public static void main(String[] args) {
        Connection conn = null;
        CallableStatement stmt = null;
        try {
            // STEP 2: Register JDBC driver
            Class.forName("com.mysql.jdbc.Driver");

            // STEP 3: Open a connection
            System.out.println("Connecting to database...");
            conn = DriverManager.getConnection(DB_URL, USER, PASS);

            // STEP 4: Execute a query
            System.out.println("Creating statement...");
            String sql = "{call getEmpName (?, ?)}";
            stmt = conn.prepareCall(sql);

            // Bind IN parameter first, then bind OUT parameter
            int empID = 102;
            stmt.setInt(1, empID); // This would set ID as 102
            // Because second parameter is OUT so register it
            stmt.registerOutParameter(2, java.sql.Types.VARCHAR);

            // Use execute method to run stored procedure.
            System.out.println("Executing stored procedure...");
            stmt.execute();

            // Retrieve employee name with getXXX method
            String empName = stmt.getString(2);
            System.out.println("Emp Name with ID:" + empID + " is " + empName);
            stmt.close();
            conn.close();
        } catch (SQLException se) {
            // Handle errors for JDBC
            se.printStackTrace();
        } catch (Exception e) {
            // Handle errors for Class.forName
            e.printStackTrace();
        } finally {
            // finally block used to close resources
            try {
                if (stmt != null)
                    stmt.close();
            } catch (SQLException se2) {
            } // nothing we can do
            try {
                if (conn != null)
                    conn.close();
            } catch (SQLException se) {
                se.printStackTrace();
            } // end finally try
        } // end try
        System.out.println("Goodbye!");
    }// end main
}// end JDBCExample

这将产生如下所示结果：

三、JDBC的SQL转义语法

转义语法使能够通过使用标准的JDBC方法和属性，来灵活的使用数据库的某些特定功能，而该特定功能来说本来是不可用的。

常用的SQL转义语法格式如下所示：

{keyword 'parameters'}

当在编程的时候，会发现以下的这些转义序列会非常有用的：

1、d，t，ts关键字

它们能帮助确定日期，时间和时间戳的文字。众所周知，没有两个数据库管理系统的时间和日期的表现方式是相同的。该转义语法告诉驱动程序以目标数据库的格式来呈现日期或时间。例如：

{d 'yyyy-mm-dd'}

其中yyyy=年，mm=月，DD=日。使用这种语法{d '2009-09-03'}即是2009年3月9日。

下面是一个说明如何在表中插入日期的简单例子：

//Create a Statement object
stmt = conn.createStatement();
//Insert data ==> ID, First Name, Last Name, DOB
String sql="INSERT INTO STUDENTS VALUES" + "(100,'Zara','Ali', {d '2001-12-16'})";

stmt.executeUpdate(sql);

同样的，可以使用以下两种语法之一，无论是t或ts：

{t 'hh:mm:ss'}

其中hh=小时，mm=分，ss=秒。使用这种语法{t '13:30:29'}即是下午1点30分29秒。

{ts 'yyyy-mm-dd hh:mm:ss'}

这是用上述两种语法'd'和't'表示时间戳的组合语法。

2、escape关键字

该关键字在LIKE子句中使用，来定义转义字符。当使用SQL通配符％，来匹配零个或多个字符时，该关键字就非常有用。例如：

String sql = "SELECT symbol FROM MathSymbols WHERE symbol LIKE '\%' {escape '\'}";
stmt.execute(sql);

如果使用反斜杠字符（\）作为转义字符，必须在Java字符串里使用两个反斜杠字符，因为反斜杠也是一个Java转义字符。

3、fn关键字

该关键字代表在数据库管理系统中使用标量函数。例如，可以使用SQL的length函数来计算字符串的长度：

{fn length('Hello World')}

这将返回11，也就是字符串'Hello World'的长度。

4、call关键字

该关键字是用来调用存储过程的。例如，对于一个需要一个IN参数的存储过程，使用以下语法：

{call my_procedure(?)};

对于需要一个IN参数并返回一个OUT参数的存储过程，使用下面的语法：

{? = call my_procedure(?)};

5、oj关键字

该关键字用来表示外部连接，其语法如下所示：

{oj outer-join}

其中outer-join=表{LEFT|RIGHT|FULL}OUTER JOIN{表|outer-join}的搜索条件。例如：

String sql = "SELECT Employees  FROM {oj ThisTable RIGHT OUTER JOIN ThatTable on id = '100'}";
stmt.execute(sql);

 

测试工程：https://github.com/easonjim/5_java_example/tree/master/jdbcbasics/test8