如何获取PL/SQL详细错误信息？API调用存储过程报错优化

当前代码仅返回SQLException.getMessage()，这只能拿到表层的通用错误描述，没法获取PL/SQL存储过程内部抛出的具体异常细节（比如ORA错误码、自定义异常信息）。要返回详细错误，需要遍历SQL异常链，收集所有层级的错误信息，同时提取错误码、SQL状态等关键字段。

修改后的代码如下：

@PostMapping("/procedures/{procedureName}")
public ResponseEntity<String> executeProcedure(@PathVariable String procedureName) {
    String sql = "{CALL " + procedureName + "}"; 
    try (Connection conn = jdbcTemplate.getDataSource().getConnection();
         CallableStatement stmt = conn.prepareCall(sql)) {
        stmt.execute();
        return ResponseEntity.ok("Procedure executed successfully");
    } catch (SQLException e) {
        StringBuilder errorDetails = new StringBuilder();
        Throwable currentEx = e;
        // 遍历所有链式异常，收集完整错误栈
        int index = 1;
        while (currentEx != null) {
            if (currentEx instanceof SQLException sqlEx) {
                errorDetails.append(String.format("错误[%d]: %n", index))
                            .append("错误码: ").append(sqlEx.getErrorCode()).append("%n")
                            .append("SQL状态: ").append(sqlEx.getSQLState()).append("%n")
                            .append("错误信息: ").append(sqlEx.getMessage()).append("%n%n");
            } else {
                errorDetails.append(String.format("非SQL错误[%d]: %s%n%n", index, currentEx.getMessage()));
            }
            currentEx = currentEx.getCause();
            index++;
        }
        return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(errorDetails.toString());
    }
}

关键修改说明： #

• 遍历异常链：PL/SQL的内部异常会被封装在SQLException的cause中，通过循环遍历getCause()可以拿到最底层的具体错误
• 提取关键字段：getErrorCode()能拿到Oracle的ORA错误码（比如ORA-01403表示无数据），getSQLState()返回SQL标准状态码，这些都是定位问题的关键
• 拼接详细信息：把每一层错误的码、状态、描述都整理成可读格式，方便调试和定位问题

如果需要更结构化的返回（比如JSON格式），可以定义一个错误信息类，将这些字段封装后返回，示例如下：

// 定义错误信息类
class ProcedureErrorResponse {
    private int errorCode;
    private String sqlState;
    private String message;
    private List<ProcedureErrorResponse> nestedErrors;

    // 构造器、getter、setter省略
}

// 修改API返回类型
@PostMapping("/procedures/{procedureName}")
public ResponseEntity<Object> executeProcedure(@PathVariable String procedureName) {
    String sql = "{CALL " + procedureName + "}"; 
    try (Connection conn = jdbcTemplate.getDataSource().getConnection();
         CallableStatement stmt = conn.prepareCall(sql)) {
        stmt.execute();
        return ResponseEntity.ok("Procedure executed successfully");
    } catch (SQLException e) {
        List<ProcedureErrorResponse> errorList = new ArrayList<>();
        Throwable currentEx = e;
        while (currentEx != null) {
            if (currentEx instanceof SQLException sqlEx) {
                ProcedureErrorResponse error = new ProcedureErrorResponse();
                error.setErrorCode(sqlEx.getErrorCode());
                error.setSqlState(sqlEx.getSQLState());
                error.setMessage(sqlEx.getMessage());
                errorList.add(error);
            }
            currentEx = currentEx.getCause();
        }
        return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(errorList);
    }
}

这样返回的JSON格式错误信息更便于前端或调用方解析处理。

内容的提问来源于stack exchange，提问作者GreatGig