Spring中支持JDBC的JdbcTemplate模板类的使用

概述

       Spring JDBC抽象框架core包提供了JDBC模板类，其中JdbcTemplate是core包的核心类，所以其他模板类都是基于它封装完成的，JDBC模板类是第一种工作模式。

 

       JdbcTemplate类通过模板设计模式帮助我们消除了冗长的代码，只做需要做的事情（即可变部分），并且帮我们做哪些固定部分，如连接的创建及关闭。

 

       JdbcTemplate类对可变部分采用回调接口方式实现，如ConnectionCallback通过回调接口返回给用户一个连接，从而可以使用该连接做任何事情、StatementCallback通过回调接口返回给用户一个Statement，从而可以使用该Statement做任何事情等等，还有其他一些回调接口

Spring除了提供JdbcTemplate核心类，还提供了基于JdbcTemplate实现的NamedParameterJdbcTemplate类用于支持命名参数绑定、 SimpleJdbcTemplate类用于支持Java5+的可变参数及自动装箱拆箱等特性。

JdbcTemplate

首先让我们来看下如何使用JdbcTemplate来实现增删改查。

1、首先创建表结构：

[java] view plaincopyprint?

1. @RunWith(SpringJUnit4ClassRunner.class)  
2. @ContextConfiguration(locations = "classpath:spring-basic.xml")  
3. @ActiveProfiles("dev")  
4. public abstract class AbstractTestSupport {  
5.     protected transient Logger log = LoggerFactory.getLogger(this.getClass());  
6.   
7.     @Rule  
8.     public TestName name = new TestName();  
9.   
10.     @Before  
11.     public void setUp() {  
12.         String createTableSql = "create memory table test"   
13.                 + "(id int GENERATED BY DEFAULT AS IDENTITY PRIMARY KEY, "   
14.                 + "name varchar(100))";    
15.         jdbcTemplate.update(createTableSql);    
16.     }  
17.   
18.     @After  
19.     public void tearDown() {  
20.         String dropTableSql = "drop table test";    
21.         jdbcTemplate.execute(dropTableSql);   
22.     }  
23.       
24.     @Resource  
25.     private JdbcTemplate jdbcTemplate;  
26. }  

2、新增测试：

[java] view plaincopyprint?

1. @Test  
2. private void insert() {    
3.     jdbcTemplate.update("insert into test(name) values('name1')");    
4.     jdbcTemplate.update("insert into test(name) values('name2')");    
5.     Assert.assertEquals(2, jdbcTemplate.queryForInt("select count(*) from test"));    
6. }   

3、删除测试：

[java] view plaincopyprint?

1. @Test  
2. private void delete() {    
3.     jdbcTemplate.update("delete from test where name=?", new Object[]{"name2"});    
4.     Assert.assertEquals(1, jdbcTemplate.queryForInt("select count(*) from test"));    
5. }    

4、更新测试：

[java] view plaincopyprint?

1. @Test  
2. private void update() {    
3.     jdbcTemplate.update("update test set name='name3' where name=?", new Object[]{"name1"});    
4.     Assert.assertEquals(1, jdbcTemplate.queryForInt("select count(*) from test where name='name3'"));    
5. }   

5、查询测试：

[java] view plaincopyprint?

1. @Test  
2. private void select() {  
3.     jdbcTemplate.query("select * from test", new RowCallbackHandler() {  
4.         @Override  
5.         public void processRow(ResultSet rs) throws SQLException {  
6.             System.out.print("====id:" + rs.getInt("id"));  
7.             System.out.println(",name:" + rs.getString("name"));  
8.         }  
9.     });  
10. }  

 看完以上示例，大家是否觉得JdbcTemplate简化了我们很多劳动力呢？接下来让我们深入学习一下JdbcTemplate提供的方法。

       

JdbcTemplate主要提供以下五类方法：

• execute方法：可以用于执行任何SQL语句，一般用于执行DDL语句；
• update方法：update方法用于执行新增、修改、删除等语句；
• batchUpdate方法：用于执行批处理相关语句；
• query方法及queryForXXX方法：用于执行查询相关语句；
• call方法：用于执行存储过程、函数相关语句。

 

JdbcTemplate类支持的回调类：

• 预编译语句及存储过程创建回调：用于根据JdbcTemplate提供的连接创建相应的语句；

PreparedStatementCreator：通过回调获取JdbcTemplate提供的Connection，由用户使用该Conncetion创建相关的PreparedStatement；

CallableStatementCreator：通过回调获取JdbcTemplate提供的Connection，由用户使用该Conncetion创建相关的CallableStatement；

• 预编译语句设值回调：用于给预编译语句相应参数设值；

         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全部方法及回调类的使用方法，我们只介绍代表性的，其余的使用都是类似的；

• 预编译语句及存储过程创建回调、自定义功能回调使用：

[java] view plaincopyprint?

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. }   

首先使用PreparedStatementCreator创建一个预编译语句，其次由JdbcTemplate通过PreparedStatementCallback回调传回，由用户决定如何执行该PreparedStatement。此处我们使用的是execute方法。

• 预编译语句设值回调使用：

[java] view plaincopyprint?

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

通过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。

• 结果集处理回调：

[java] view plaincopyprint?

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] view plaincopyprint?

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] view plaincopyprint?

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] view plaincopyprint?

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");   

 存储过程及函数回调：

MySQL

[java] view plaincopyprint?

1. @RunWith(SpringJUnit4ClassRunner.class)  
2. @ContextConfiguration(locations = "classpath:spring-basic.xml")  
3. @ActiveProfiles("dev")  
4. public abstract class AbstractTestSupport {  
5.     protected transient Logger log = LoggerFactory.getLogger(this.getClass());  
6.   
7.     @Rule  
8.     public TestName name = new TestName();  
9.   
10.     @Before  
11.     public void setUp() {  
12.         // 2.创建自定义函数  
13.         String createFunctionSql = "CREATE FUNCTION FUNCTION_TEST(str VARCHAR(100)) "  
14.                 + "returns INT return LENGTH(str)";  
15.         String dropFunctionSql = "DROP FUNCTION IF EXISTS FUNCTION_TEST";  
16.         jdbcTemplate.update(dropFunctionSql);  
17.         jdbcTemplate.update(createFunctionSql);  
18.         // 3.准备sql,mysql支持{?= call …}  
19.         final String callFunctionSql = "{?= call FUNCTION_TEST(?)}";  
20.         // 4.定义参数  
21.         List<SqlParameter> params = new ArrayList<SqlParameter>();  
22.         params.add(new SqlOutParameter("result", Types.INTEGER));  
23.         params.add(new SqlParameter("str", Types.VARCHAR));  
24.         Map<String, Object> outValues = jdbcTemplate.call(new CallableStatementCreator() {  
25.             @Override  
26.             public CallableStatement createCallableStatement(Connection conn) throws SQLException {  
27.                 CallableStatement cstmt = conn.prepareCall(callFunctionSql);  
28.                 cstmt.registerOutParameter(1, Types.INTEGER);  
29.                 cstmt.setString(2, "test");  
30.                 return cstmt;  
31.             }  
32.         }, params);  
33.         Assert.assertEquals(4, outValues.get("result"));  
34.     }  
35.   
36.     @After  
37.     public void tearDown() {  
38.     }  
39.   
40.     @Resource  
41.     private JdbcTemplate jdbcTemplate;  
42. }  

[java] view plaincopyprint?

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. }   

• {call PROCEDURE_TEST(?, ?)}：定义存储过程sql；
• params：定义存储过程参数；SqlInOutParameter描述INOUT类型参数、SqlOutParameter描述OUT类型参数；
• CallableStatementCreator：用于创建CallableStatement，并设值及注册OUT参数类型；
• outValues：通过SqlInOutParameter及SqlOutParameter参数定义的name来获取存储过程结果。

Oracel

[java] view plaincopyprint?

1. @Resource  
2. private CallableStatementCallback<Map<String, String>> tranchkCallableStatementCallback;  
3. @Resource  
4. private JdbcTemplate jdbcTemplate;  
5.   
6. @Test  
7. public void testCall(){  
8.     Map<String, String> map = new HashMap<String, String>();  
9.     map = jdbcTemplate.execute("{call SP_BMPS_CHKBANKFILE(" + 9999 + "," + 1 + ",?)}",  
10.             tranchkCallableStatementCallback);  
11.     String line = map.get("outLine");  
12.     System.out.println(line);  
13. }  

存储过程

[sql] view plaincopyprint?

1. CREATE OR REPLACE PROCEDURE "SP_BMPS_CHKBANKFILE" (iv_chlcode       IN VARCHAR2, --通道号  
2.                                                    iv_checktype     IN VARCHAR2, -- 0 信息流 1 资金流  
3.                                                    out_line OUT INT) IS  
4.   
5.   CURSOR lc_checkdate IS select * from tcor_chk_bankfile_tmp;  
6.   
7.   lr_bankfile tcor_chk_bankfile_tmp%ROWTYPE;  
8.   
9.   ln_bankfilecnt number;  
10.   
11.   ln_checkkeycnt number;  
12.   
13. BEGIN  
14.   
15.   dbms_output.put_line('IN PROCEDURE SP_BACS_POSCHECK: PROCEDURE START [存储过程处理开始！] ');  
16.   
17.   out_line :=0;  
18.     
19.   dbms_output.put_line(out_line);  
20.   
21.   OPEN lc_checkdate;  
22.   LOOP  
23.     FETCH lc_checkdate INTO lr_bankfile;  
24.       
25.     EXIT WHEN lc_checkdate%NOTFOUND;  
26.       
27.     select count(1) into ln_bankfilecnt  
28.       from tcor_chk_bankfile t  
29.      where t.check_key = lr_bankfile.check_key  
30.        and nvl(t.tran_amount, 0) = nvl(lr_bankfile.tran_amount, 0)  
31.        and t.do_date < = to_char(sysdate, 'yyyy-mm-dd')  
32.        and t.do_date > = to_char(sysdate - 10, 'yyyy-mm-dd')  
33.        and t.tran_tp = lr_bankfile.tran_tp  
34.        and t.check_type = lr_bankfile.check_type;  
35.   
36.          
37.     select count(*) into ln_checkkeycnt   
38.     from tcor_chk_bankfile a   
39.     where  a.check_key  = nvl(lr_bankfile.check_key, ' ')  
40.       and  a.check_type = lr_bankfile.check_type and a.tran_tp = lr_bankfile.tran_tp;  
41.         
42.          
43.     if ln_bankfilecnt = 0 then  
44.         --有更新  没有插入  
45.         if ln_checkkeycnt = 1 then  
46.             update TCOR_CHK_BANKFILE set TPL_NO = nvl(lr_bankfile.tpl_no, ''),  
47.                                          FILE_NAME = nvl(lr_bankfile.file_name, ''),  
48.                                          BANK_CODE=nvl(lr_bankfile.bank_code, ''),  
49.                                          SUPPLIER_BILL_NO =  nvl(lr_bankfile.supplier_bill_no, ''))  
50.             where CHECK_KEY = nvl(lr_bankfile.check_key, '') and CHECK_TYPE = nvl(lr_bankfile.check_type, '');  
51.                                          
52.            out_line := sql%rowcount;  
53.         --同时存在消费：消费撤销对应的两条记录的过滤掉不入库                               
54.         elsif  (ln_checkkeycnt < 1) then  
55.            insert into TCOR_CHK_BANKFILE  
56.             (CHK_NO,  
57.             TPL_NO,  
58.             FILE_NAME,  
59.             BANK_CODE,  
60.             SUPPLIER_BILL_NO)  
61.           values  
62.             (SEQ_BANKFILE.NEXTVAL,  
63.             lr_bankfile.tpl_no,  
64.             lr_bankfile.file_name,  
65.             lr_bankfile.bank_code,  
66.             lr_bankfile.supplier_bill_no);  
67.                
68.           out_line := out_line + sql%rowcount;  
69.            
70.          end if;  
71.       
72.     end if;  
73.     
74.   END LOOP;  
75.   
76.   delete from tcor_chk_bankfile_tmp; --结束后删除临时表  
77.   
78.   commit;  
79.   
80.   IF lc_checkdate%ISOPEN THEN  
81.     CLOSE lc_checkdate;  
82.   END IF;  
83.   dbms_output.put_line('IN PROCEDURE SP_BACS_POSCHECK: PROCEDURE END [存储过程处理结束！] ');  
84. EXCEPTION  
85.   WHEN OTHERS THEN  
86.     
87.     IF lc_checkdate%ISOPEN THEN  
88.       CLOSE lc_checkdate;  
89.     END IF;  
90.     
91.     ROLLBACK;  
92.     delete from tcor_chk_bankfile_tmp; --结束后删除临时表  
93.     out_line :=0;  
94.     commit;  
95. end SP_BMPS_CHKBANKFILE;