引數和資料值處理的常見問題
Spring Framework 的 JDBC 支援所提供的不同方法中存在引數和資料值處理的常見問題。本節介紹如何解決這些問題。
為引數提供 SQL 型別資訊
通常,Spring 根據傳入引數的型別確定引數的 SQL 型別。可以顯式提供用於設定引數值的 SQL 型別。有時為了正確設定 NULL 值,這是必要的。
您可以透過多種方式提供 SQL 型別資訊
-
JdbcTemplate的許多更新和查詢方法都帶有一個額外的int陣列形式的引數。此陣列用於透過使用java.sql.Types類中的常量值來指示相應引數的 SQL 型別。為每個引數提供一個條目。 -
您可以使用
SqlParameterValue類包裝需要此額外資訊的引數值。為此,為每個值建立一個新例項,並在建構函式中傳入 SQL 型別和引數值。您還可以為數值提供一個可選的比例引數。 -
對於使用命名引數的方法,您可以使用
SqlParameterSource類,BeanPropertySqlParameterSource或MapSqlParameterSource。它們都具有為任何命名引數值註冊 SQL 型別的方法。
處理 BLOB 和 CLOB 物件
您可以將影像、其他二進位制資料和大量文字儲存在資料庫中。這些大物件對於二進位制資料稱為 BLOB(Binary Large OBject),對於字元資料稱為 CLOB(Character Large OBject)。在 Spring 中,您可以直接使用 JdbcTemplate 處理這些大物件,也可以在使用 RDBMS Objects 和 SimpleJdbc 類提供的高階抽象時處理它們。所有這些方法都使用 LobHandler 介面的實現來實際管理 LOB(Large OBject)資料。LobHandler 透過 getLobCreator 方法提供對 LobCreator 類的訪問,該類用於建立要插入的新 LOB 物件。
LobCreator 和 LobHandler 為 LOB 輸入和輸出提供以下支援
-
BLOB
-
byte[]:getBlobAsBytes和setBlobAsBytes -
InputStream:getBlobAsBinaryStream和setBlobAsBinaryStream
-
-
CLOB
-
String:getClobAsString和setClobAsString -
InputStream:getClobAsAsciiStream和setClobAsAsciiStream -
Reader:getClobAsCharacterStream和setClobAsCharacterStream
-
下一個示例展示瞭如何建立和插入 BLOB。稍後我們將展示如何從資料庫中讀回它。
此示例使用 JdbcTemplate 和 AbstractLobCreatingPreparedStatementCallback 的實現。它實現了一個名為 setValues 的方法。此方法提供了一個 LobCreator,我們使用它來設定 SQL 插入語句中 LOB 列的值。
在此示例中,我們假設有一個變數 lobHandler,它已經設定為 DefaultLobHandler 的例項。您通常透過依賴注入來設定此值。
以下示例展示瞭如何建立和插入 BLOB
-
Java
-
Kotlin
final File blobIn = new File("spring2004.jpg");
final InputStream blobIs = new FileInputStream(blobIn);
final File clobIn = new File("large.txt");
final InputStream clobIs = new FileInputStream(clobIn);
final InputStreamReader clobReader = new InputStreamReader(clobIs);
jdbcTemplate.execute(
"INSERT INTO lob_table (id, a_clob, a_blob) VALUES (?, ?, ?)",
new AbstractLobCreatingPreparedStatementCallback(lobHandler) { (1)
protected void setValues(PreparedStatement ps, LobCreator lobCreator) throws SQLException {
ps.setLong(1, 1L);
lobCreator.setClobAsCharacterStream(ps, 2, clobReader, (int)clobIn.length()); (2)
lobCreator.setBlobAsBinaryStream(ps, 3, blobIs, (int)blobIn.length()); (3)
}
}
);
blobIs.close();
clobReader.close();
| 1 | 傳入 lobHandler(在此示例中是一個普通的 DefaultLobHandler)。 |
| 2 | 使用 setClobAsCharacterStream 方法傳入 CLOB 的內容。 |
| 3 | 使用 setBlobAsBinaryStream 方法傳入 BLOB 的內容。 |
val blobIn = File("spring2004.jpg")
val blobIs = FileInputStream(blobIn)
val clobIn = File("large.txt")
val clobIs = FileInputStream(clobIn)
val clobReader = InputStreamReader(clobIs)
jdbcTemplate.execute(
"INSERT INTO lob_table (id, a_clob, a_blob) VALUES (?, ?, ?)",
object: AbstractLobCreatingPreparedStatementCallback(lobHandler) { (1)
override fun setValues(ps: PreparedStatement, lobCreator: LobCreator) {
ps.setLong(1, 1L)
lobCreator.setClobAsCharacterStream(ps, 2, clobReader, clobIn.length().toInt()) (2)
lobCreator.setBlobAsBinaryStream(ps, 3, blobIs, blobIn.length().toInt()) (3)
}
}
)
blobIs.close()
clobReader.close()
| 1 | 傳入 lobHandler(在此示例中是一個普通的 DefaultLobHandler)。 |
| 2 | 使用 setClobAsCharacterStream 方法傳入 CLOB 的內容。 |
| 3 | 使用 setBlobAsBinaryStream 方法傳入 BLOB 的內容。 |
|
如果您在 請參閱您使用的 JDBC 驅動程式的文件,以驗證它是否支援在不提供內容長度的情況下流式傳輸 LOB。 |
現在是時候從資料庫中讀取 LOB 資料了。同樣,您使用帶有相同例項變數 lobHandler 和 DefaultLobHandler 引用的 JdbcTemplate。以下示例展示瞭如何執行此操作
-
Java
-
Kotlin
List<Map<String, Object>> l = jdbcTemplate.query("select id, a_clob, a_blob from lob_table",
new RowMapper<Map<String, Object>>() {
public Map<String, Object> mapRow(ResultSet rs, int i) throws SQLException {
Map<String, Object> results = new HashMap<String, Object>();
String clobText = lobHandler.getClobAsString(rs, "a_clob"); (1)
results.put("CLOB", clobText);
byte[] blobBytes = lobHandler.getBlobAsBytes(rs, "a_blob"); (2)
results.put("BLOB", blobBytes);
return results;
}
});
| 1 | 使用 getClobAsString 方法檢索 CLOB 的內容。 |
| 2 | 使用 getBlobAsBytes 方法檢索 BLOB 的內容。 |
val l = jdbcTemplate.query("select id, a_clob, a_blob from lob_table") { rs, _ ->
val clobText = lobHandler.getClobAsString(rs, "a_clob") (1)
val blobBytes = lobHandler.getBlobAsBytes(rs, "a_blob") (2)
mapOf("CLOB" to clobText, "BLOB" to blobBytes)
}
| 1 | 使用 getClobAsString 方法檢索 CLOB 的內容。 |
| 2 | 使用 getBlobAsBytes 方法檢索 BLOB 的內容。 |
為 IN 子句傳入值列表
SQL 標準允許根據包含可變值列表的表示式選擇行。一個典型的例子是 select * from T_ACTOR where id in (1, 2, 3)。JDBC 標準不直接支援預處理語句的此可變列表。您不能宣告可變數量的佔位符。您需要準備具有所需數量佔位符的多個變體,或者在知道需要多少佔位符後動態生成 SQL 字串。NamedParameterJdbcTemplate 中提供的命名引數支援採用後一種方法。您可以將值作為簡單的 java.util.List(或任何 Iterable)傳入。此列表用於將所需的佔位符插入到實際的 SQL 語句中,並在語句執行期間傳入值。
傳入許多值時請小心。JDBC 標準不保證您可以為 IN 表示式列表使用超過 100 個值。各種資料庫都超過此數字,但它們通常對允許的值數量有硬性限制。例如,Oracle 的限制是 1000。 |
除了值列表中的原始值之外,您還可以建立物件陣列的 java.util.List。此列表可以支援為 in 子句定義多個表示式,例如 select * from T_ACTOR where (id, last_name) in ((1, 'Johnson'), (2, 'Harrop'))。當然,這要求您的資料庫支援此語法。
處理儲存過程呼叫的複雜型別
當您呼叫儲存過程時,有時可以使用資料庫特有的複雜型別。為了適應這些型別,Spring 提供了一個 SqlReturnType,用於在從儲存過程呼叫返回時處理它們,以及一個 SqlTypeValue,用於在它們作為引數傳遞給儲存過程時處理它們。
SqlReturnType 介面有一個必須實現的單個方法(名為 getTypeValue)。此介面用作 SqlOutParameter 宣告的一部分。以下示例顯示了返回使用者宣告型別 ITEM_TYPE 的 java.sql.Struct 物件的值
-
Java
-
Kotlin
import java.sql.CallableStatement;
import java.sql.Struct;
import java.sql.Types;
import javax.sql.DataSource;
import org.springframework.jdbc.core.SqlOutParameter;
import org.springframework.jdbc.object.StoredProcedure;
public class TestItemStoredProcedure extends StoredProcedure {
public TestItemStoredProcedure(DataSource dataSource) {
super(dataSource, "get_item");
declareParameter(new SqlOutParameter("item", Types.STRUCT, "ITEM_TYPE",
(CallableStatement cs, int colIndx, int sqlType, String typeName) -> {
Struct struct = (Struct) cs.getObject(colIndx);
Object[] attr = struct.getAttributes();
TestItem item = new TestItem();
item.setId(((Number) attr[0]).longValue());
item.setDescription((String) attr[1]);
item.setExpirationDate((java.util.Date) attr[2]);
return item;
}));
// ...
}
}
import org.springframework.jdbc.core.SqlOutParameter
import org.springframework.jdbc.`object`.StoredProcedure
import java.sql.CallableStatement
import java.sql.Struct
import java.sql.Types
import java.util.Date
import javax.sql.DataSource
class TestItemStoredProcedure(dataSource: DataSource) : StoredProcedure(dataSource, "get_item") {
init {
declareParameter(SqlOutParameter("item",Types.STRUCT,"ITEM_TYPE") {
cs: CallableStatement, colIndx: Int, _: Int, _: String? ->
val struct = cs.getObject(colIndx) as Struct
val attr = struct.attributes
TestItem(
(attr[0] as Number).toLong(),
attr[1] as String,
attr[2] as Date
)
})
// ...
}
}
您可以使用 SqlTypeValue 將 Java 物件(例如 TestItem)的值傳遞給儲存過程。SqlTypeValue 介面有一個必須實現的單個方法(名為 createTypeValue)。傳入活動連線,您可以使用它來建立特定於資料庫的物件,例如 java.sql.Struct 例項或 java.sql.Array 例項。以下示例建立了一個 java.sql.Struct 例項
-
Java
-
Kotlin
TestItem testItem = new TestItem(123L, "A test item",
new SimpleDateFormat("yyyy-M-d").parse("2010-12-31"));
SqlTypeValue value = new AbstractSqlTypeValue() {
protected Object createTypeValue(Connection connection, int sqlType, String typeName) throws SQLException {
Object[] item = new Object[] { testItem.getId(), testItem.getDescription(),
new java.sql.Date(testItem.getExpirationDate().getTime()) };
return connection.createStruct(typeName, item);
}
};
val testItem = TestItem(123L, "A test item",
SimpleDateFormat("yyyy-M-d").parse("2010-12-31"))
val value = object : AbstractSqlTypeValue() {
override fun createTypeValue(connection: Connection, sqlType: Int, typeName: String?): Any {
val item = arrayOf<Any>(testItem.id, testItem.description,
Date(testItem.expirationDate.time))
return connection.createStruct(typeName, item)
}
}
您現在可以將此 SqlTypeValue 新增到包含儲存過程 execute 呼叫的輸入引數的 Map 中。
SqlTypeValue 的另一個用途是向 Oracle 儲存過程傳入值陣列。Oracle 在 OracleConnection 上有一個 createOracleArray 方法,您可以透過解包它來訪問它。您可以使用 SqlTypeValue 建立一個數組並用 Java java.sql.Array 中的值填充它,如下例所示
-
Java
-
Kotlin
Long[] ids = new Long[] {1L, 2L};
SqlTypeValue value = new AbstractSqlTypeValue() {
protected Object createTypeValue(Connection conn, int sqlType, String typeName) throws SQLException {
return conn.unwrap(OracleConnection.class).createOracleArray(typeName, ids);
}
};
val ids = arrayOf(1L, 2L)
val value: SqlTypeValue = object : AbstractSqlTypeValue() {
override fun createTypeValue(conn: Connection, sqlType: Int, typeName: String?): Any {
return conn.unwrap(OracleConnection::class.java).createOracleArray(typeName, ids)
}
}