《JDBC》第10节：JDBC之CallableStatement存储过程调用对象的常见方法及其使用

前一小节介绍了JDBC之DatabaseMetaData数据库元数据对象的常见方法及其使用，这里继续介绍JDBC中的CallableStatement对象，CallableStatement是对数据库存储过程的抽象，它继承自PreparedStatement预编译对象。所以CallableStatement对象拥有PreparedStatement对象的所有方法，并且自身还有一些扩展方法。

CallableStatement是一个位于java.sql包下的接口，提供了一些针对存储过程相关的操作方法，使用CallableStatement对象可以获取存储过程的一些信息，例如：存储过程的入参、出参、设置参数等。

下面就介绍一下JDBC之CallableStatement存储过程调用对象的常见方法及其使用。

1.1、创建存储过程

这里我们先在MySQL数据库中，创建一个存储过程，方便后面的案例演示。存储过程SQL语句如下：

drop PROCEDURE if EXISTS jdbc_test_proc;
delimiter $
CREATE PROCEDURE `jdbc_test_proc`( IN username varchar(50), IN pwd varchar(32), IN createTime datetime, IN insertNum int, OUT successNum int)
BEGIN
    -- 定义变量
    DECLARE id INT DEFAULT 1;

    -- 循环新增
    WHILE id <= insertNum DO
        INSERT INTO t_user ( username, PASSWORD, create_time )
        VALUES ( username, pwd, createTime );
        SET id = id + 1;
    END WHILE;

    -- 设置返回值
    SET successNum = id;

END$;

1.2、prepareCall()方法

prepareCall()方法的作用：调用存储过程，并且返回一个CallableStatement对象。

1.3、设置入参setXxx()方法

存储过程可以有入参、出参两种类型的参数，CallableStatement对象中提供了许多setXxx()方法，这些方法的作用就是给指定位置的参数，设置对应的参数值。

案例代码如下所示：

// 编写SQL语句，注意：这里的存储过程需要使用{}花括号，然后使用call调用存储过程
String sql = "{call jdbc_test_proc(?,?,?,?,?)}";
// 获取CallableStatement对象
CallableStatement callableStatement = connection.prepareCall(sql);
// 设置参数（存储过程的入参）
callableStatement.setString(1, "name001");
callableStatement.setString(2, "pwd123");
callableStatement.setDate(3, new java.sql.Date(System.currentTimeMillis()));
callableStatement.setInt(4, 3);

1.4、注册存储过程出参

存储过程可以有返回值，返回值一般在创建存储过程使用出参定义。在JDBC里面，需要调用registerOutParameter()方法进行出参的注册，这个方法的作用就是告诉JDBC，当前我这个存储过程的返回值是在哪个位置上，并且对应的数据类型是什么。

案例代码如下所示：

// 编写SQL语句，注意：这里的存储过程需要使用{}花括号，然后使用call调用存储过程
String sql = "{call jdbc_test_proc(?,?,?,?,?)}";
// 获取CallableStatement对象
CallableStatement callableStatement = connection.prepareCall(sql);
// 设置参数（存储过程的入参）
callableStatement.setString(1, "name001");
callableStatement.setString(2, "pwd123");
callableStatement.setDate(3, new java.sql.Date(System.currentTimeMillis()));
callableStatement.setInt(4, 3);
// 注册返回值参数(存储过程的出参)
callableStatement.registerOutParameter(5, java.sql.Types.INTEGER);

1.5、获取出参getXxx()方法

存储过程的出参定义好了之后，可以调用execute()方法执行存储过程，执行结束就可以获取到存储过程的返回值，要获取返回值可以调用getXxx()方法，这里的getXxx()方法根据存储过程的返回值数据类型来选择，例如：返回值是int类型，那么就调用getInteger()方法，依此类推。

案例代码，如下所示：

// 编写SQL语句，注意：这里的存储过程需要使用{}花括号，然后使用call调用存储过程
String sql = "{call jdbc_test_proc(?,?,?,?,?)}";
// 获取CallableStatement对象
CallableStatement callableStatement = connection.prepareCall(sql);
// 设置参数（存储过程的入参）
callableStatement.setString(1, "name001");
callableStatement.setString(2, "pwd123");
callableStatement.setDate(3, new java.sql.Date(System.currentTimeMillis()));
callableStatement.setInt(4, 3);
// 注册返回值参数(存储过程的出参)
callableStatement.registerOutParameter(5, java.sql.Types.INTEGER);
// 执行存储过程
callableStatement.execute();
// 获取执行结果的返回参数
int successNum = callableStatement.getInt(5);
System.out.println("执行结果:" + successNum);

1.6、完整案例代码

package com.gitcode.jdbc.chapter10;

import java.sql.CallableStatement;
import java.sql.Connection;
import java.sql.DriverManager;
import java.sql.SQLException;

/**
 * @author ZhuYouBin
 * @version 1.0.0
 * @date 2024/6/18 13:29
 * @description CallableStatement 对象
 */
public class CallableStatementDemo {
    public static void main(String[] args) throws ClassNotFoundException, SQLException {
        // 1、加载类对象，并且注册Driver驱动对象
        Class.forName("com.mysql.cj.jdbc.Driver");
        // 2、获取数据库连接
        String url = "jdbc:mysql://127.0.0.1:3306/jdbc-study";
        String username = "root";
        String password = "root";
        Connection connection = DriverManager.getConnection(url, username, password);
        // 编写SQL语句，注意：这里的存储过程需要使用{}花括号，然后使用call调用存储过程
        String sql = "{call jdbc_test_proc(?,?,?,?,?)}";
        // 获取CallableStatement对象
        CallableStatement callableStatement = connection.prepareCall(sql);
        // 设置参数（存储过程的入参）
        callableStatement.setString(1, "name--xx01");
        callableStatement.setString(2, "pwd123");
        callableStatement.setDate(3, new java.sql.Date(System.currentTimeMillis()));
        callableStatement.setInt(4, 3);
        // 注册返回值参数(存储过程的出参)
        callableStatement.registerOutParameter(5, java.sql.Types.INTEGER);
        // 执行存储过程
        callableStatement.execute();
        // 获取执行结果的返回参数
        int successNum = callableStatement.getInt(5);
        System.out.println("执行结果:" + successNum);
        // 5、关闭连接
        connection.close();
    }
}

1.7、源代码获取

源代码地址：

https://gitcode.com/qq_39826207/jdbc-study/tree/chapter-jdbc-10

今天就到这里，未完待续~~