编辑“︁Java CallableStatement”︁

{{DISPLAYTITLE:Java CallableStatement}}

'''Java CallableStatement''' 是 Java JDBC API 中的一个关键接口，用于执行数据库中的存储过程。它是 {{code|PreparedStatement}} 的子接口，专门设计用于调用数据库存储过程，并支持输入参数、输出参数以及输入输出参数的绑定。本文将详细介绍其工作原理、使用方法及实际应用场景。

== 介绍 ==
CallableStatement 允许 Java 程序通过 JDBC 调用数据库中的存储过程（Stored Procedures）。存储过程是预编译的 SQL 语句集合，存储在数据库中，可以通过名称调用。CallableStatement 提供了高效的方式来执行这些过程，并处理输入、输出参数。

=== 主要特点 ===
* 支持存储过程的调用。
* 允许绑定输入（IN）、输出（OUT）和输入输出（INOUT）参数。
* 提供类型安全的方式设置和获取参数值。
* 比普通 Statement 更高效，因为存储过程在数据库端已预编译。

== 基本语法 ==
CallableStatement 的 SQL 语句使用 `{call procedure_name(?, ?, ...)}` 或 `{? = call procedure_name(?, ?, ...)}` 格式，其中 `?` 是参数占位符。

=== 创建 CallableStatement ===
{{syntaxhighlight|lang=java|lines=true|code=
Connection conn = DriverManager.getConnection("jdbc:mysql://localhost:3306/mydb", "user", "password");
CallableStatement stmt = conn.prepareCall("{call get_employee_details(?, ?)}");
}}

== 参数绑定 ==
CallableStatement 支持三种参数类型：
1. **IN 参数**：传递给存储过程的输入值。
2. **OUT 参数**：存储过程返回的输出值。
3. **INOUT 参数**：既是输入又是输出的参数。

=== 设置 IN 参数 ===
{{syntaxhighlight|lang=java|lines=true|code=
stmt.setInt(1, 101); // 设置第一个参数为整数 101
stmt.setString(2, "John"); // 设置第二个参数为字符串 "John"
}}

=== 注册 OUT 参数 ===
{{syntaxhighlight|lang=java|lines=true|code=
stmt.registerOutParameter(1, Types.INTEGER); // 注册第一个参数为输出参数，类型为整数
stmt.registerOutParameter(2, Types.VARCHAR); // 注册第二个参数为输出参数，类型为字符串
}}

=== 执行并获取 OUT 参数 ===
{{syntaxhighlight|lang=java|lines=true|code=
stmt.execute();
int id = stmt.getInt(1); // 获取第一个输出参数
String name = stmt.getString(2); // 获取第二个输出参数
}}

== 实际案例 ==
假设有一个存储过程 `calculate_bonus`，它接受员工 ID（IN 参数）并返回奖金金额（OUT 参数）。

=== 数据库存储过程 ===
{{syntaxhighlight|lang=sql|lines=true|code=
CREATE PROCEDURE calculate_bonus(IN emp_id INT, OUT bonus DECIMAL(10,2))
BEGIN
    SELECT salary * 0.1 INTO bonus FROM employees WHERE id = emp_id;
END
}}

=== Java 调用代码 ===
{{syntaxhighlight|lang=java|lines=true|code=
try (Connection conn = DriverManager.getConnection("jdbc:mysql://localhost:3306/mydb", "user", "password");
     CallableStatement stmt = conn.prepareCall("{call calculate_bonus(?, ?)}")) {

    stmt.setInt(1, 101); // 设置员工 ID
    stmt.registerOutParameter(2, Types.DECIMAL); // 注册奖金为输出参数

    stmt.execute();
    double bonus = stmt.getDouble(2); // 获取奖金

    System.out.println("Bonus: " + bonus);
} catch (SQLException e) {
    e.printStackTrace();
}
}}

=== 输出示例 ===
如果员工 ID 101 的工资为 50000，则输出：
{{syntaxhighlight|lang=text|code=
Bonus: 5000.0
}}

== 高级用法 ==
=== 处理 INOUT 参数 ===
INOUT 参数既是输入也是输出。例如，存储过程 `increment_counter` 接受一个计数器并递增它：
{{syntaxhighlight|lang=sql|lines=true|code=
CREATE PROCEDURE increment_counter(INOUT counter INT)
BEGIN
    SET counter = counter + 1;
END
}}

Java 调用：
{{syntaxhighlight|lang=java|lines=true|code=
CallableStatement stmt = conn.prepareCall("{call increment_counter(?)}");
stmt.setInt(1, 5); // 设置初始值
stmt.registerOutParameter(1, Types.INTEGER); // 注册为 INOUT 参数

stmt.execute();
int newValue = stmt.getInt(1); // 获取新值
System.out.println("New value: " + newValue); // 输出 6
}}

=== 使用 ResultSet ===
如果存储过程返回结果集，可以通过 `getResultSet()` 获取：
{{syntaxhighlight|lang=java|lines=true|code=
CallableStatement stmt = conn.prepareCall("{call get_employees()}");
boolean hasResults = stmt.execute();

if (hasResults) {
    ResultSet rs = stmt.getResultSet();
    while (rs.next()) {
        System.out.println(rs.getString("name"));
    }
}
}}

== 错误处理 ==
始终检查 SQL 异常：
{{syntaxhighlight|lang=java|lines=true|code=
try {
    stmt.execute();
} catch (SQLException e) {
    System.err.println("SQL Error: " + e.getMessage());
}
}}

== 性能优化 ==
* 重用 CallableStatement 对象以减少解析开销。
* 使用批处理（`addBatch()`）执行多个存储过程调用。

== 总结 ==
CallableStatement 是 JDBC 中调用存储过程的核心工具，支持灵活的输入输出参数处理。通过预编译和参数化查询，它提供了高效、安全的数据库操作方式。掌握其用法可以显著提升数据库交互的效率和可维护性。

== 参见 ==
* [[Java PreparedStatement]]
* [[Java JDBC 基础]]
* [[数据库存储过程]]

[[Category:编程语言]]
[[Category:Java]]
[[Category:Java JDBC]]