Spring JdbcTemplate方法詳解

時間  2019-11-12
標籤 spring jdbctemplate 方法 詳解 欄目 Spring 简体版
原文   原文鏈接

Spring JdbcTemplate方法詳解

標籤： springhsqldbjava存儲數據庫相關sqljavascript

2012-07-22 14:42 72836人閱讀 評論(3) 舉報html

 分類：java

java教程（70） mysql

版權聲明：本文爲博主原創文章，未經博主容許不得轉載。spring

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

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

 

JdbcTemplate類支持的回調類：數據庫

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

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

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

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

         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代碼 

 收藏代碼

  1. @Test  
  2. public void testPpreparedStatement1() {  
  3.   int count = jdbcTemplate.execute(new PreparedStatementCreator() {  
  4.      @Override  
  5.      public PreparedStatement createPreparedStatement(Connection conn)  
  6.          throws SQLException {  
  7.          return conn.prepareStatement("select count(*) from test");  
  8.      }}, new PreparedStatementCallback<Integer>() {  
  9.      @Override  
  10.      public Integer doInPreparedStatement(PreparedStatement pstmt)  
  11.          throws SQLException, DataAccessException {  
  12.          pstmt.execute();  
  13.          ResultSet rs = pstmt.getResultSet();  
  14.          rs.next();  
  15.          return rs.getInt(1);  
  16.       }});      
  17.    Assert.assertEquals(0, count);  
  18. }  
  19.    

 

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

 

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

 

java代碼：Java代碼 

 收藏代碼

  1.       
  2. @Test  
  3. public void testPreparedStatement2() {  
  4.   String insertSql = "insert into test(name) values (?)";  
  5.   int count = jdbcTemplate.update(insertSql, new PreparedStatementSetter() {  
  6.       @Override  
  7.       public void setValues(PreparedStatement pstmt) throws SQLException {  
  8.           pstmt.setObject(1, "name4");  
  9.   }});  
  10.   Assert.assertEquals(1, count);      
  11.   String deleteSql = "delete from test where name=?";  
  12.   count = jdbcTemplate.update(deleteSql, new Object[] {"name4"});  
  13.   Assert.assertEquals(1, count);  
  14. }  

 

      經過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代碼 

 收藏代碼

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

 

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

 

java代碼：Java代碼 

 收藏代碼

  1. @Test  
  2. public void testResultSet2() {  
  3.   jdbcTemplate.update("insert into test(name) values('name5')");  
  4.   String listSql = "select * from test";  
  5.   final List result = new ArrayList();  
  6.   jdbcTemplate.query(listSql, new RowCallbackHandler() {  
  7.       @Override  
  8.       public void processRow(ResultSet rs) throws SQLException {  
  9.           Map row = new HashMap();  
  10.           row.put(rs.getInt("id"), rs.getString("name"));  
  11.           result.add(row);  
  12.   }});  
  13.   Assert.assertEquals(1, result.size());  
  14.   jdbcTemplate.update("delete from test where name='name5'");  
  15. }  

 

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

 

java代碼：Java代碼 

 收藏代碼

  1. @Test  
  2. public void testResultSet3() {  
  3.   jdbcTemplate.update("insert into test(name) values('name5')");  
  4.   String listSql = "select * from test";  
  5.   List result = jdbcTemplate.query(listSql, new ResultSetExtractor<List>() {  
  6.       @Override  
  7.       public List extractData(ResultSet rs)  
  8.      throws SQLException, DataAccessException {  
  9.           List result = new ArrayList();  
  10.           while(rs.next()) {  
  11.               Map row = new HashMap();  
  12.               row.put(rs.getInt("id"), rs.getString("name"));  
  13.               result.add(row);  
  14.            }  
  15.            return result;  
  16.   }});  
  17.   Assert.assertEquals(0, result.size());  
  18.   jdbcTemplate.update("delete from test where name='name5'");  
  19. }  

 

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

 

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

 

java代碼：Java代碼 

 收藏代碼

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

 

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

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

 

 

java代碼：Java代碼 

 收藏代碼

  1.       
  2. @Before  
  3. public void setUp() {  
  4.     String createTableSql = "create memory table test" +  
  5.     "(id int GENERATED BY DEFAULT AS IDENTITY PRIMARY KEY, " +  
  6.     "name varchar(100))";  
  7.     jdbcTemplate.update(createTableSql);  
  8.          
  9.     String createHsqldbFunctionSql =  
  10.       "CREATE FUNCTION FUNCTION_TEST(str CHAR(100)) " +  
  11.       "returns INT begin atomic return length(str);end";  
  12.     jdbcTemplate.update(createHsqldbFunctionSql);  
  13.     String createHsqldbProcedureSql =  
  14.       "CREATE PROCEDURE PROCEDURE_TEST" +  
  15.       "(INOUT inOutName VARCHAR(100), OUT outId INT) " +  
  16.       "MODIFIES SQL DATA " +  
  17.       "BEGIN ATOMIC " +  
  18.       "  insert into test(name) values (inOutName); " +  
  19.       "  SET outId = IDENTITY(); " +  
  20.       "  SET inOutName = 'Hello,' + inOutName; " +  
  21.     "END";  
  22.     jdbcTemplate.execute(createHsqldbProcedureSql);  
  23. }  

 

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

 

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

 

java代碼：Java代碼 

 收藏代碼

  1. @After  
  2. public void tearDown() {  
  3.     jdbcTemplate.execute("DROP FUNCTION FUNCTION_TEST");  
  4.     jdbcTemplate.execute("DROP PROCEDURE PROCEDURE_TEST");  
  5.     String dropTableSql = "drop table test";  
  6.     jdbcTemplate.execute(dropTableSql);  
  7. }  

 

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

 

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

 

java代碼：Java代碼 

 收藏代碼

  1. @Test  
  2. public void testCallableStatementCreator1() {  
  3.     final String callFunctionSql = "{call FUNCTION_TEST(?)}";  
  4.     List<SqlParameter> params = new ArrayList<SqlParameter>();  
  5.     params.add(new SqlParameter(Types.VARCHAR));  
  6.     params.add(new SqlReturnResultSet("result",  
  7.        new ResultSetExtractor<Integer>() {  
  8.            @Override  
  9.            public Integer extractData(ResultSet rs) throws SQLException,  
  10.                DataAccessException {  
  11.                while(rs.next()) {  
  12.                    return rs.getInt(1);  
  13.                }  
  14.               return 0;  
  15.        }));  
  16.     Map<String, Object> outValues = jdbcTemplate.call(  
  17.        new CallableStatementCreator() {  
  18.             @Override  
  19.             public CallableStatement createCallableStatement(Connection conn) throws SQLException {  
  20.               CallableStatement cstmt = conn.prepareCall(callFunctionSql);  
  21.               cstmt.setString(1, "test");  
  22.               return cstmt;  
  23.     }}, params);  
  24.     Assert.assertEquals(4, outValues.get("result"));  
  25. }  
  26.    

 

  • {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代碼 

 收藏代碼

  1. @Test  
  2. public void testCallableStatementCreator2() {  
  3.     JdbcTemplate mysqlJdbcTemplate = new JdbcTemplate(getMysqlDataSource);  
  4.     //2.建立自定義函數  
  5. String createFunctionSql =  
  6.     "CREATE FUNCTION FUNCTION_TEST(str VARCHAR(100)) " +  
  7.      "returns INT return LENGTH(str)";  
  8. String dropFunctionSql = "DROP FUNCTION IF EXISTS FUNCTION_TEST";  
  9. mysqlJdbcTemplate.update(dropFunctionSql);         
  10. mysqlJdbcTemplate.update(createFunctionSql);  
  11. //3.準備sql,mysql支持{?= call …}  
  12. final String callFunctionSql = "{?= call FUNCTION_TEST(?)}";  
  13. //4.定義參數  
  14. List<SqlParameter> params = new ArrayList<SqlParameter>();  
  15. params.add(new SqlOutParameter("result", Types.INTEGER));  
  16. params.add(new SqlParameter("str", Types.VARCHAR));  
  17. Map<String, Object> outValues = mysqlJdbcTemplate.call(  
  18. new CallableStatementCreator() {  
  19.     @Override  
  20.     public CallableStatement createCallableStatement(Connection conn) throws SQLException {  
  21.       CallableStatement cstmt = conn.prepareCall(callFunctionSql);  
  22.       cstmt.registerOutParameter(1, Types.INTEGER);  
  23.       cstmt.setString(2, "test");  
  24.         return cstmt;  
  25.     }}, params);  
  26.    Assert.assertEquals(4, outValues.get("result"));  
  27. }  
  28. public DataSource getMysqlDataSource() {  
  29.     String url = "jdbc:mysql://localhost:3306/test";  
  30.     DriverManagerDataSource dataSource =  
  31.         new DriverManagerDataSource(url, "root", "");     dataSource.setDriverClassName("com.mysql.jdbc.Driver");  
  32.     return dataSource;  
  33. }  
  34.    
  • 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代碼 

 收藏代碼

  1. @Test  
  2. public void testCallableStatementCreator3() {  
  3.     final String callProcedureSql = "{call PROCEDURE_TEST(?, ?)}";  
  4.     List<SqlParameter> params = new ArrayList<SqlParameter>();  
  5.     params.add(new SqlInOutParameter("inOutName", Types.VARCHAR));  
  6.     params.add(new SqlOutParameter("outId", Types.INTEGER));  
  7.     Map<String, Object> outValues = jdbcTemplate.call(  
  8.       new CallableStatementCreator() {  
  9.         @Override  
  10.         public CallableStatement createCallableStatement(Connection conn) throws SQLException {  
  11.           CallableStatement cstmt = conn.prepareCall(callProcedureSql);  
  12.           cstmt.registerOutParameter(1, Types.VARCHAR);  
  13.           cstmt.registerOutParameter(2, Types.INTEGER);  
  14.           cstmt.setString(1, "test");  
  15.           return cstmt;  
  16.     }}, params);  
  17.     Assert.assertEquals("Hello,test", outValues.get("inOutName"));  
  18.     Assert.assertEquals(0, outValues.get("outId"));  
  19. }  
  20.    
  • {call PROCEDURE_TEST(?, ?)}：定義存儲過程sql；
  • params：定義存儲過程參數；SqlInOutParameter描述INOUT類型參數、SqlOutParameter描述OUT類型參數；
  • CallableStatementCreator：用於建立CallableStatement，並設值及註冊OUT參數類型；
  • outValues：經過SqlInOutParameter及SqlOutParameter參數定義的name來獲取存儲過程結果。

 

       JdbcTemplate類還提供了不少便利方法，在此就不一一介紹了，但這些方法是由規律可循的，第一種就是提供回調接口讓用戶決定作什麼，第二種能夠認爲是便利方法（如queryForXXX），用於那些比較簡單的操做。

 

更多關係spring的信息

 Spring 論壇  http://www.itchm.com/forum-59-1.html

<script type="text/javascript"><!-- google_ad_client = "ca-pub-1944176156128447"; /* csdn 橫中 */ google_ad_slot = "7877933139"; google_ad_width = 468; google_ad_height = 60; //--></script><script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"></script>

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程