Spring JdbcTemplate方法详解

 转载：

https://blog.csdn.net/dyllove98/article/details/7772463
https://www.e-learn.cn/content/qita/833737

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

• execute方法：可以用于执行任何SQL语句，一般用于执行DDL语句；
• update方法及batchUpdate方法：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)来处理结果集，用户必须处理整个结果集；

 

PreparedStatement和CallableStatement区别 :

Statement接口提供了执行语句和获取结果的基本方法， PreparedStatement继承自Statement, 而CallableStatement继承自PreparedStatement

PreparedStatement 　　接口添加了处理 IN 参数的方法
CallableStatement　　接口添加了处理 OUT 参数的方法

PreparedStatement:
　　 可变参数的SQL,编译一次,执行多次,效率高;
　　 安全性好，有效防止Sql注入等问题;
　　 支持批量更新,批量删除;
CallableStatement:
　　继承自PreparedStatement,支持带参数的SQL操作;
　　支持调用存储过程,提供了对输出和输入/输出参数(INOUT)的支持;

Statement每次执行sql语句，数据库都要执行sql语句的编译 ，最好用于仅执行一次查询并返回结果的情形时，效率高于PreparedStatement。

PreparedStatement是预编译的，使用PreparedStatement有几个好处
1. 在执行可变参数的一条SQL时，PreparedStatement比Statement的效率高，因为DBMS预编译一条SQL当然会比多次编译一条SQL的效率要高。
2. 安全性好，有效防止Sql注入等问题。
3. 对于多次重复执行的语句，使用PreparedStament效率会更高一点，并且在这种情况下也比较适合使用batch；
4. 代码的可读性和可维护性。

注：
executeQuery：返回结果集(ResultSet)。
executeUpdate: 执行给定SQL语句,该语句可能为 INSERT、UPDATE 或 DELETE 语句， 或者不返回任何内容的SQL语句（如 SQL DDL 语句）。
execute: 可用于执行任何SQL语句，返回一个boolean值，
表明执行该SQL语句是否返回了ResultSet。如果执行后第一个结果是ResultSet，则返回true，否则返回false。

 

接下来让我们看下具体示例吧，在示例中不可能介绍到JdbcTemplate全部方法及回调类的使用方法，我们只介绍代表性的，其余的使用都是类似的；  

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

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）预编译语句设值回调使用：  

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）结果集处理回调： 

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，当然可以转换为其他类，如表的对象画形式。 

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)，能将结果集的行转换为需要的形式。 

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方法，来简化开发： 

1）查询一行数据并将该行数据转换为Map返回
jdbcTemplate.queryForMap("select * from test where name='name5'");
2）查询一行任何类型的数据，最后一个参数指定返回结果类型
jdbcTemplate.queryForObject("select count(*) from test", Integer.class);
3）查询一批数据，默认将每行数据转换为Map
jdbcTemplate.queryForList("select * from test");
4）只查询一列数据列表，列类型是String类型，列名字是name
jdbcTemplate.queryForList("select name from test where name=?", new Object[]{"name5"}, String.class);
5）查询一批数据，返回为SqlRowSet，类似于ResultSet，但不再绑定到连接上
SqlRowSet rs = jdbcTemplate.queryForRowSet("select * from test");

 

 存储过程及函数回调

 创建一个表，插入一条数据

创建三个存储过程

CREATE DEFINER=`root`@`127.0.0.1` PROCEDURE `t_customer_insert`(IN `cust_name` varchar(16),IN `phone` varchar(16),IN `gender` tinyint,IN `create_time` bigint)
BEGIN
    INSERT INTO t_customer(cname,phone,gender,create_time) VALUES(cust_name,phone,gender,create_time);
END

CREATE DEFINER=`root`@`127.0.0.1` PROCEDURE `t_customer_select`(IN cust_id BIGINT, OUT cust_name varchar(16), OUT out_phone varchar(16))
BEGIN
    SELECT cname,phone INTO cust_name, out_phone FROM t_customer WHERE id = cust_id;
END

CREATE DEFINER=`root`@`127.0.0.1` PROCEDURE `t_customer_querylist`(IN cust_id BIGINT)
BEGIN
    SELECT * FROM t_customer WHERE id = cust_id;
END

  执行第一个存储过程

public void insertCustomer() {
    String sql = "call t_customer_insert('eerr1','13265326536',0,1557308503005)";
    jdbcTemplate.execute(sql);
}

 

 执行第二个存储过程 

    public void customerSelect() {

        Map<String, String> resultMap = getJdbcTemplate().execute(new CallableStatementCreator() {

            @Override
            public CallableStatement createCallableStatement(Connection con) throws SQLException {
                String storedProc = "{call t_customer_select (?,?,?)}";
                CallableStatement cs = con.prepareCall(storedProc);
                cs.setInt(1, 1); // 设置输入参数的值
                cs.registerOutParameter(2, Types.VARCHAR); // 注册输出参数的类型
                cs.registerOutParameter(3, Types.VARCHAR);
                return cs;
            }
        }, new CallableStatementCallback<Map<String, String>>() {

            @Override
            public Map<String, String> doInCallableStatement(CallableStatement cs)
                    throws SQLException, DataAccessException {
                cs.execute();
                Map<String, String> retMap = new HashMap<>();
                retMap.put("cname", cs.getString(2));
                retMap.put("phone", cs.getString(3));
                return retMap;
            }
        });
    }

 

执行第三个存储过程

    public <T> List<T> queryCustomer(long custid, Class<T> clazz) {
        return getJdbcTemplate().execute(new CallableStatementCreator() {

            @Override
            public CallableStatement createCallableStatement(Connection con) throws SQLException {
                String storedProc = "{call proc_cust_querylist(?)}";
                CallableStatement cs = con.prepareCall(storedProc);
                cs.setLong(1, custid);
                return cs;
            }
        }, new CallableStatementCallback<List<T>>() {

            @Override
            public List<T> doInCallableStatement(CallableStatement cs) throws SQLException, DataAccessException {
                cs.execute();
                ResultSet rs = cs.getResultSet();
                ResultSet result = cs.getResultSet();
                List<T> list = new ArrayList<T>();
                if (result != null) {
                    RowMapper<T> rowMapper = new BeanPropertyRowMapper<T>(clazz);
                    int rowNum = 1;
                    while (result.next()) {
                        list.add(rowMapper.mapRow(result, rowNum++));
                    }
                }
                return list;
            }
        });
    }

也可以用call方法来调用

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

outValues：通过SqlInOutParameter及SqlOutParameter参数定义的name来获取存储过程结果。

 

调用自定义函数  

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如何调用自定义函数： 

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;”）
• {?= call FUNCTION_TEST(?)}：可以使用{?= call …}形式调用自定义函数；
• params：无需使用SqlReturnResultSet提取结果集数据，而是使用SqlOutParameter来描述自定义函数返回值；
• CallableStatementCreator：同上个例子含义一样；
• cstmt.registerOutParameter(1, Types.INTEGER)：将OUT类型参数注册为JDBC类型Types.INTEGER，此处即返回值类型为Types.INTEGER。
• outValues.get("result")：获取结果，直接返回Integer类型，比hsqldb简单多了吧。 

 

 JdbcTemplate类还提供了很多便利方法，在此就不一一介绍了，但这些方法是由规律可循的，第一种就是提供回调接口让用户决定做什么，第二种可以认为是便利方法（如queryForXXX），用于那些比较简单的操作 

tatement的Batch使用:  
Statement stmt  = conn.createStatement();  
String sql = null;  
for(int i =0;i<20;i++){  
    sql = "insert into test(id,name)values("+i+","+i+"_name)";  
    stmt.addBatch(sql);  
}  
stmt.executeBatch();  
   
PreparedStatement的Batch使用:  
PreparedStatement pstmt  = con.prepareStatement("UPDATE EMPLOYEES  SET SALARY = ? WHERE ID =?");  
for(int i =0;i<length;i++){  
    pstmt.setBigDecimal(1, param1[i]);  
    pstmt.setInt(2, param2[i]);  
    pstmt.addBatch();  
}  
pstmt.executeBatch();  

 

 

【ReplicationDriver支持读写分离】
http://www.cnblogs.com/flywang/p/7777792.html
https://blog.csdn.net/zhu_tianwei/article/details/53454259