Spring JdbcTemplate详解

Posted 2020-10-31 xuwenjin

为了使 JDBC 更加易于使用,Spring 在 JDBCAPI 上定义了一个抽象层, 以此建立一个JDBC存取框架.

作为 SpringJDBC 框架的核心, JDBC 模板的设计目的是为不同类型的JDBC操作提供模板方法. 每个模板方法都能控制整个过程,并允许覆盖过程中的特定任务.通过这种

方式,可以在尽可能保留灵活性的情况下,将数据库存取的工作量降到最低.

 

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

• execute方法：可以用于执行任何SQL语句，一般用于执行DDL语句；

• update方法：update方法用于执行新增、修改、删除等语句；

• batchUpdate方法：batchUpdate方法用于执行批处理相关语句；

• query方法及queryForXXX方法：用于执行查询相关语句；

• call方法：用于执行存储过程、函数相关语句。

 

1、首先在数据库新建一张表

CREATE TABLE xwj_user (
   id VARCHAR(32) NOT NULL,
   last_name VARCHAR(32),
   age INT(2),
   email VARCHAR(32)
) ENGINE=INNODB DEFAULT CHARSET=utf8

 

2、在pom.xml文件中，增加依赖

<dependencies>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-jdbc</artifactId>
            <version>4.2.5.RELEASE</version>
            <scope>compile</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-tx</artifactId>
            <version>4.2.5.RELEASE</version>
            <scope>compile</scope>
        </dependency>
        <!-- 获取上下文 -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
            <version>4.2.5.RELEASE</version>
        </dependency>
        <dependency>
            <groupId>com.mchange</groupId>
            <artifactId>c3p0</artifactId>
            <version>0.9.5.2</version>
        </dependency>
        <!-- 连接到mysql -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.35</version>
        </dependency>
        <!-- 单元测试 -->
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.10</version>
            <scope>test</scope>
        </dependency>
    </dependencies>

 

3、在resource下面增加两个配置文件db.properties、applicationContext.xml

　　db.properties配置文件：

jdbc.user=root
jdbc.password=root
jdbc.driverClass=com.mysql.jdbc.Driver
jdbc.jdbcUrl=jdbc:mysql://dev.yonyouccs.com:3001/icop-construct-busisubpack

initPoolSize=5
maxPoolSize=10

　　在xml文件中，导入这个属性文件以及配置c3p0数据源：

    <!-- 读取配置文件 -->
    <context:property-placeholder location="classpath:db.properties" />
    
    <bean id="dataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource">
        <property name="user" value="${jdbc.user}"></property>
        <property name="password" value="${jdbc.password}"></property>
        <property name="driverClass" value="${jdbc.driverClass}"></property>
        <property name="jdbcUrl" value="${jdbc.jdbcUrl}"></property>

        <property name="initialPoolSize" value="${initPoolSize}"></property>
        <property name="maxPoolSize" value="${maxPoolSize}"></property>
    </bean>

    <bean id="jdbcTemplate" class="org.springframework.jdbc.core.JdbcTemplate">
        <property name="dataSource" ref="dataSource"></property>
    </bean>

 

4、创建一个实体类User

package com.xwj.bean;

public class User {

    private String id;
    private String lastName;
    private int age;
    private String email;

    public String getId() {
        return id;
    }

    public void setId(String id) {
        this.id = id;
    }

    public String getLastName() {
        return lastName;
    }

    public void setLastName(String lastName) {
        this.lastName = lastName;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    public String getEmail() {
        return email;
    }

    public void setEmail(String email) {
        this.email = email;
    }

    public String toString() {
        return "User [id=" + id + ", lastName=" + lastName + ", email=" + email + ", age=" + age +"] ";
    }

}

 

5、创建一个测试类对JdbcTemplate的方法进行测试：

　　

package com.xwj.util;

import java.util.ArrayList;
import java.util.List;

import org.junit.Test;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
import org.springframework.jdbc.core.BeanPropertyRowMapper;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.jdbc.core.RowMapper;
import org.springframework.util.CollectionUtils;

import com.xwj.bean.User;

public class TestJdbc {

    private ApplicationContext ctx = null;
    private JdbcTemplate jdbcTemplate = null;

    {
        ctx = new ClassPathXmlApplicationContext("ApplicationContext.xml");
        jdbcTemplate = (JdbcTemplate) ctx.getBean("jdbcTemplate");
    }

    /**
     * 执行 INSERT
     */
    @Test
    public void testInsert() {
        String sql = "INSERT INTO xwj_user(id, last_name, age) VALUES(?, ?, ?)";
        jdbcTemplate.update(sql, "1", "a-xwj", 0);
    }

    /**
     * 执行UPDATE
     */
    @Test
    public void testUpdate() {
        String sql = "UPDATE xwj_user SET last_name = ? WHERE id = ?";
        jdbcTemplate.update(sql, "b-xwj", 1);
    }

    /**
     * 执行 DELETE
     */
    @Test
    public void testDelete() {
        String sql = "DELETE from xwj_user WHERE id = ?";
        jdbcTemplate.update(sql, 1);
    }

    /**
     * 测试批量更新操作 最后一个参数是 Object[] 的 List 类型：因为修改一条记录需要一个 Object 数组，修改多条记录就需要一个
     * List 来存放多个数组。
     */
    @Test
    public void testBatchUpdate() {
        String sql = "INSERT INTO xwj_user(id, last_name, email) VALUES(?, ?, ?)";

        List<Object[]> batchArgs = new ArrayList<>();
        batchArgs.add(new Object[] { "2", "AA", "[email protected]" });
        batchArgs.add(new Object[] { "3", "BB", "[email protected]" });
        batchArgs.add(new Object[] { "4", "CC", "[email protected]" });
        batchArgs.add(new Object[] { "5", "DD", "[email protected]" });

        jdbcTemplate.batchUpdate(sql, batchArgs);
    }

    /**
     * 从数据库中获取一条记录，实际得到对应的一个对象 注意：不是调用 queryForObject(String sql,Class<Employee> requiredType, Object... args) 方法! 
     * 而需要调用queryForObject(String sql, RowMapper<Employee> rowMapper, Object... args)
     * 1、其中的 RowMapper 指定如何去映射结果集的行，常用的实现类为 BeanPropertyRowMapper 
     * 2、使用SQL中的列的别名完成列名和类的属性名的映射，例如 last_name lastName 
     * 3、不支持级联属性。 JdbcTemplate只能作为一个 JDBC 的小工具, 而不是 ORM 框架
     */
    @Test
    public void testQueryForObject() {
        String sql = "SELECT id, last_name lastName, email FROM xwj_user WHERE ID = ?";
        RowMapper<User> rowMapper = new BeanPropertyRowMapper<>(User.class);
        // 在将数据装入对象时需要调用set方法。
        User user = jdbcTemplate.queryForObject(sql, rowMapper, 2);
        System.out.println(user);
    }
    
    /** 
     * 一次查询多个对象 
     * 注意：调用的不是 queryForList 方法 
     */  
    @Test  
    public void testQueryForList() {  
        String sql = "SELECT id, name, email FROM xwj_user WHERE id > ?";  
        RowMapper<User> rowMapper = new BeanPropertyRowMapper<>(User.class);  
        List<User> userList = jdbcTemplate.query(sql, rowMapper, 1);  
        if (!CollectionUtils.isEmpty(userList)) {
            userList.forEach(user -> {
                System.out.println(user);
            });
        }
    }  
    
    /** 
     * 获取单个列的值或做统计查询 
     * 使用 queryForObject(String sql, Class<Long> requiredType)  
     */  
    @Test  
    public void testQueryForCount() {  
        String sql = "SELECT count(id) FROM xwj_user";  
        long count = jdbcTemplate.queryForObject(sql, Long.class);  
          
        System.out.println(count);  
    }     

}

 

总结：JdbcTemplate是Spring框架自带的对JDBC操作的封装，目的是提供统一的模板方法使对数据库的操作更加方便、友好，效率也不错。但是功能还是不够强大（比如不支持级联属性），在实际应用中还需要和hibernate、mybaties等框架混合使用。

 

　　本文源码地址：https://github.com/xuwenjin/xwj_repo/tree/master/springJdbc

　　相关资源地址：JdbcTemplate使用简介

　　　　　　　　   Spring的JDBCTemplate批量更新的性能问题