Spring JdbcTemplate方法詳解

時間 2019-11-08

標籤 spring jdbctemplate 方法詳解欄目 Spring 简体版

原文原文鏈接

JdbcTemplate主要提供如下五類方法：java

execute方法：能夠用於執行任何SQL語句，通常用於執行DDL語句；mysql
update方法及batchUpdate方法：update方法用於執行新增、修改、刪除等語句；batchUpdate方法用於執行批處理相關語句；sql
query方法及queryForXXX方法：用於執行查詢相關語句；數據庫
call方法：用於執行存儲過程、函數相關語句。app

JdbcTemplate類支持的回調類：ide

預編譯語句及存儲過程建立回調：用於根據JdbcTemplate提供的鏈接建立相應的語句；函數

PreparedStatementCreator：經過回調獲取JdbcTemplate提供的Connection，由用戶使用該Conncetion建立相關的PreparedStatement；測試

CallableStatementCreator：經過回調獲取JdbcTemplate提供的Connection，由用戶使用該Conncetion建立相關的CallableStatement；atom

預編譯語句設值回調：用於給預編譯語句相應參數設值；url

PreparedStatementSetter：經過回調獲取JdbcTemplate提供的PreparedStatement，由用戶來對相應的預編譯語句相應參數設值；

BatchPreparedStatementSetter：；相似於PreparedStatementSetter，但用於批處理，須要指定批處理大小；

自定義功能回調：提供給用戶一個擴展點，用戶能夠在指定類型的擴展點執行任何數量須要的操做；

ConnectionCallback：經過回調獲取JdbcTemplate提供的Connection，用戶可在該Connection執行任何數量的操做；

StatementCallback：經過回調獲取JdbcTemplate提供的Statement，用戶能夠在該Statement執行任何數量的操做；

PreparedStatementCallback：經過回調獲取JdbcTemplate提供的PreparedStatement，用戶能夠在該PreparedStatement執行任何數量的操做；

CallableStatementCallback：經過回調獲取JdbcTemplate提供的CallableStatement，用戶能夠在該CallableStatement執行任何數量的操做；

結果集處理回調：經過回調處理ResultSet或將ResultSet轉換爲須要的形式；

RowMapper：用於將結果集每行數據轉換爲須要的類型，用戶需實現方法mapRow(ResultSet rs, int rowNum)來完成將每行數據轉換爲相應的類型。

RowCallbackHandler：用於處理ResultSet的每一行結果，用戶需實現方法processRow(ResultSet rs)來完成處理，在該回調方法中無需執行rs.next()，該操做由JdbcTemplate來執行，用戶只需按行獲取數據而後處理便可。

ResultSetExtractor：用於結果集數據提取，用戶需實現方法extractData(ResultSet rs)來處理結果集，用戶必須處理整個結果集；

接下來讓咱們看下具體示例吧，在示例中不可能介紹到JdbcTemplate所有方法及回調類的使用方法，咱們只介紹表明性的，其他的使用都是相似的；

1）預編譯語句及存儲過程建立回調、自定義功能回調使用：

java代碼：

Java代碼

public void testPpreparedStatement1() {
int count = jdbcTemplate.execute(new PreparedStatementCreator() {
@Override
public PreparedStatement createPreparedStatement(Connection conn)
throws SQLException {
return conn.prepareStatement("select count(*) from test");
}}, new PreparedStatementCallback<Integer>() {
@Override
public Integer doInPreparedStatement(PreparedStatement pstmt)
throws SQLException, DataAccessException {
pstmt.execute();
ResultSet rs = pstmt.getResultSet();
rs.next();
return rs.getInt(1);
}});
Assert.assertEquals(0, count);
}

首先使用PreparedStatementCreator建立一個預編譯語句，其次由JdbcTemplate經過PreparedStatementCallback回調傳回，由用戶決定如何執行該PreparedStatement。此處咱們使用的是execute方法。

2）預編譯語句設值回調使用：

java代碼：

Java代碼

public void testPreparedStatement2() {
String insertSql = "insert into test(name) values (?)";
int count = jdbcTemplate.update(insertSql, new PreparedStatementSetter() {
@Override
public void setValues(PreparedStatement pstmt) throws SQLException {
pstmt.setObject(1, "name4");
}});
Assert.assertEquals(1, count);
String deleteSql = "delete from test where name=?";
count = jdbcTemplate.update(deleteSql, new Object[] {"name4"});
Assert.assertEquals(1, count);
}

經過JdbcTemplate的int update(String sql, PreparedStatementSetter pss)執行預編譯sql，其中sql參數爲「insert into test(name) values (?) 」，該sql有一個佔位符須要在執行前設值，PreparedStatementSetter實現就是爲了設值，使用setValues(PreparedStatement pstmt)回調方法設值相應的佔位符位置的值。JdbcTemplate也提供一種更簡單的方式「update(String sql, Object... args)」來實現設值，因此只要當使用該種方式不知足需求時才應使用PreparedStatementSetter。

3）結果集處理回調：

java代碼：

Java代碼

public void testResultSet1() {
jdbcTemplate.update("insert into test(name) values('name5')");
String listSql = "select * from test";
List result = jdbcTemplate.query(listSql, new RowMapper<Map>() {
@Override
public Map mapRow(ResultSet rs, int rowNum) throws SQLException {
Map row = new HashMap();
row.put(rs.getInt("id"), rs.getString("name"));
return row;
}});
Assert.assertEquals(1, result.size());
jdbcTemplate.update("delete from test where name='name5'");
}

RowMapper接口提供mapRow(ResultSet rs, int rowNum)方法將結果集的每一行轉換爲一個Map，固然能夠轉換爲其餘類，如表的對象畫形式。

java代碼：

Java代碼

public void testResultSet2() {
jdbcTemplate.update("insert into test(name) values('name5')");
String listSql = "select * from test";
final List result = new ArrayList();
jdbcTemplate.query(listSql, new RowCallbackHandler() {
@Override
public void processRow(ResultSet rs) throws SQLException {
Map row = new HashMap();
row.put(rs.getInt("id"), rs.getString("name"));
result.add(row);
}});
Assert.assertEquals(1, result.size());
jdbcTemplate.update("delete from test where name='name5'");
}

RowCallbackHandler接口也提供方法processRow(ResultSet rs)，能將結果集的行轉換爲須要的形式。

java代碼：

Java代碼

public void testResultSet3() {
jdbcTemplate.update("insert into test(name) values('name5')");
String listSql = "select * from test";
List result = jdbcTemplate.query(listSql, new ResultSetExtractor<List>() {
@Override
public List extractData(ResultSet rs)
throws SQLException, DataAccessException {
List result = new ArrayList();
while(rs.next()) {
Map row = new HashMap();
row.put(rs.getInt("id"), rs.getString("name"));
result.add(row);
}
return result;
}});
Assert.assertEquals(0, result.size());
jdbcTemplate.update("delete from test where name='name5'");
}

ResultSetExtractor使用回調方法extractData(ResultSet rs)提供給用戶整個結果集，讓用戶決定如何處理該結果集。

固然JdbcTemplate提供更簡單的queryForXXX方法，來簡化開發：

java代碼：

Java代碼

//1.查詢一行數據並返回int型結果
jdbcTemplate.queryForInt("select count(*) from test");
//2. 查詢一行數據並將該行數據轉換爲Map返回
jdbcTemplate.queryForMap("select * from test where name='name5'");
//3.查詢一行任何類型的數據，最後一個參數指定返回結果類型
jdbcTemplate.queryForObject("select count(*) from test", Integer.class);
//4.查詢一批數據，默認將每行數據轉換爲Map
jdbcTemplate.queryForList("select * from test");
//5.只查詢一列數據列表，列類型是String類型，列名字是name
jdbcTemplate.queryForList("
select name from test where name=?", new Object[]{"name5"}, String.class);
//6.查詢一批數據，返回爲SqlRowSet，相似於ResultSet，但再也不綁定到鏈接上
SqlRowSet rs = jdbcTemplate.queryForRowSet("select * from test");

3）存儲過程及函數回調：

首先修改JdbcTemplateTest的setUp方法，修改後以下所示：

java代碼：

Java代碼

@Before
public void setUp() {
String createTableSql = "create memory table test" +
"(id int GENERATED BY DEFAULT AS IDENTITY PRIMARY KEY, " +
"name varchar(100))";
jdbcTemplate.update(createTableSql);
String createHsqldbFunctionSql =
"CREATE FUNCTION FUNCTION_TEST(str CHAR(100)) " +
"returns INT begin atomic return length(str);end";
jdbcTemplate.update(createHsqldbFunctionSql);
String createHsqldbProcedureSql =
"CREATE PROCEDURE PROCEDURE_TEST" +
"(INOUT inOutName VARCHAR(100), OUT outId INT) " +
"MODIFIES SQL DATA " +
"BEGIN ATOMIC " +
" insert into test(name) values (inOutName); " +
" SET outId = IDENTITY(); " +
" SET inOutName = 'Hello,' + inOutName; " +
"END";
jdbcTemplate.execute(createHsqldbProcedureSql);
}

其中CREATE FUNCTION FUNCTION_TEST用於建立自定義函數，CREATE PROCEDURE PROCEDURE_TEST用於建立存儲過程，注意這些建立語句是數據庫相關的，本示例中的語句只適用於HSQLDB數據庫。

其次修改JdbcTemplateTest的tearDown方法，修改後以下所示：

java代碼：

Java代碼

public void tearDown() {
jdbcTemplate.execute("DROP FUNCTION FUNCTION_TEST");
jdbcTemplate.execute("DROP PROCEDURE PROCEDURE_TEST");
String dropTableSql = "drop table test";
jdbcTemplate.execute(dropTableSql);
}

其中drop語句用於刪除建立的存儲過程、自定義函數及數據庫表。

接下來看一下hsqldb如何調用自定義函數：

java代碼：

Java代碼

public void testCallableStatementCreator1() {
final String callFunctionSql = "{call FUNCTION_TEST(?)}";
List<SqlParameter> params = new ArrayList<SqlParameter>();
params.add(new SqlParameter(Types.VARCHAR));
params.add(new SqlReturnResultSet("result",
new ResultSetExtractor<Integer>() {
@Override
public Integer extractData(ResultSet rs) throws SQLException,
DataAccessException {
while(rs.next()) {
return rs.getInt(1);
}
return 0;
}));
Map<String, Object> outValues = jdbcTemplate.call(
new CallableStatementCreator() {
@Override
public CallableStatement createCallableStatement(Connection conn) throws SQLException {
CallableStatement cstmt = conn.prepareCall(callFunctionSql);
cstmt.setString(1, "test");
return cstmt;
}}, params);
Assert.assertEquals(4, outValues.get("result"));
}

{call FUNCTION_TEST(?)}：定義自定義函數的sql語句，注意hsqldb {?= call …}和{call …}含義是同樣的，而好比mysql中兩種含義是不同的；
params：用於描述自定義函數佔位符參數或命名參數類型；SqlParameter用於描述IN類型參數、SqlOutParameter用於描述OUT類型參數、SqlInOutParameter用於描述INOUT類型參數、SqlReturnResultSet用於描述調用存儲過程或自定義函數返回的ResultSet類型數據，其中SqlReturnResultSet須要提供結果集處理回調用於將結果集轉換爲相應的形式，hsqldb自定義函數返回值是ResultSet類型。
CallableStatementCreator：提供Connection對象用於建立CallableStatement對象
outValues：調用call方法將返回類型爲Map<String, Object>對象；
outValues.get("result")：獲取結果，即經過SqlReturnResultSet對象轉換過的數據；其中SqlOutParameter、SqlInOutParameter、SqlReturnResultSet指定的name用於從call執行後返回的Map中獲取相應的結果，即name是Map的鍵。

注：由於hsqldb {?= call …}和{call …}含義是同樣的，所以調用自定義函數將返回一個包含結果的ResultSet。

最後讓咱們示例下mysql如何調用自定義函數：

java代碼：

Java代碼

public void testCallableStatementCreator2() {
JdbcTemplate mysqlJdbcTemplate = new JdbcTemplate(getMysqlDataSource);
//2.建立自定義函數
String createFunctionSql =
"CREATE FUNCTION FUNCTION_TEST(str VARCHAR(100)) " +
"returns INT return LENGTH(str)";
String dropFunctionSql = "DROP FUNCTION IF EXISTS FUNCTION_TEST";
mysqlJdbcTemplate.update(dropFunctionSql);
mysqlJdbcTemplate.update(createFunctionSql);
//3.準備sql,mysql支持{?= call …}
final String callFunctionSql = "{?= call FUNCTION_TEST(?)}";
//4.定義參數
List<SqlParameter> params = new ArrayList<SqlParameter>();
params.add(new SqlOutParameter("result", Types.INTEGER));
params.add(new SqlParameter("str", Types.VARCHAR));
Map<String, Object> outValues = mysqlJdbcTemplate.call(
new CallableStatementCreator() {
@Override
public CallableStatement createCallableStatement(Connection conn) throws SQLException {
CallableStatement cstmt = conn.prepareCall(callFunctionSql);
cstmt.registerOutParameter(1, Types.INTEGER);
cstmt.setString(2, "test");
return cstmt;
}}, params);
Assert.assertEquals(4, outValues.get("result"));
}
public DataSource getMysqlDataSource() {
String url = "jdbc:mysql://localhost:3306/test";
DriverManagerDataSource dataSource =
new DriverManagerDataSource(url, "root", ""); dataSource.setDriverClassName("com.mysql.jdbc.Driver");
return dataSource;
}

getMysqlDataSource：首先啓動mysql（本書使用5.4.3版本），其次登陸mysql建立test數據庫（「create database test;」），在進行測試前，請先下載並添加mysql-connector-java-5.1.10.jar到classpath；
{?= call FUNCTION_TEST(?)}：可使用{?= call …}形式調用自定義函數；
params：無需使用SqlReturnResultSet提取結果集數據，而是使用SqlOutParameter來描述自定義函數返回值；
CallableStatementCreator：同上個例子含義同樣；
cstmt.registerOutParameter(1, Types.INTEGER)：將OUT類型參數註冊爲JDBC類型Types.INTEGER，此處即返回值類型爲Types.INTEGER。
outValues.get("result")：獲取結果，直接返回Integer類型，比hsqldb簡單多了吧。

最後看一下如何如何調用存儲過程：

java代碼：

Java代碼

public void testCallableStatementCreator3() {
final String callProcedureSql = "{call PROCEDURE_TEST(?, ?)}";
List<SqlParameter> params = new ArrayList<SqlParameter>();
params.add(new SqlInOutParameter("inOutName", Types.VARCHAR));
params.add(new SqlOutParameter("outId", Types.INTEGER));
Map<String, Object> outValues = jdbcTemplate.call(
new CallableStatementCreator() {
@Override
public CallableStatement createCallableStatement(Connection conn) throws SQLException {
CallableStatement cstmt = conn.prepareCall(callProcedureSql);
cstmt.registerOutParameter(1, Types.VARCHAR);
cstmt.registerOutParameter(2, Types.INTEGER);
cstmt.setString(1, "test");
return cstmt;
}}, params);
Assert.assertEquals("Hello,test", outValues.get("inOutName"));
Assert.assertEquals(0, outValues.get("outId"));
}