Spring JdbcTemplate方法详解

1. qldbFunctionSql);  
2.     String createHsqldbProcedureSql =  
3.       "CREATE PROCEDURE PROCEDURE_TEST" +  
4.       "(INOUT inOutName VARCHAR(100), OUT outId INT) " +  
5.       "MODIFIES SQL DATA " +  
6.       "BEGIN ATOMIC " +  
7.       "  insert into test(name) values (inOutName); " +  
8.       "  SET outId = IDENTITY(); " +  
9.       "  SET inOutName = 'Hello,' + inOutName; " +  
10.     "END";  
11.     jdbcTemplate.execute(createHsqldbProcedureSql);  
12. }  

 

       其中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），用于那些比较简单的操作。