SpringBoot：使用JdbcTemplate

什么是JDBC模板(jdbcTemplate)

模板就是事先准备好的东西,你只需要去套用就可以,JDBCTemplate就是这样的模板,通过设置JDBCTemplate可以减少对数据库的繁琐操作,例如连接数据库,获得链接关闭,获得statement,resultset,preparedstatement这些等等。

传统的JDBC应用步骤:

1.指定数据库连接参数
2.打开数据库连接
3.声明SQL语句
4.预编译并执行SQL语句
5.遍历查询结果（如果需要的话）
6.处理每一次遍历操作
7.处理抛出的任何异常
8.处理事务
9.关闭数据库连接

JDBC的缺点就是太麻烦了,不易编码,容易出错,不利于开发者把精力投入到业务上去。简化JDBC就是新技术的目标。Spring对数据库的操作在jdbc上面做了深层次的封装，使用spring的注入功能，可以把DataSource注册到JdbcTemplate之中。

使用Spring的JdbcTemplate （不带 SpringBoot ），选择注册DataSourceInitializer Bean来初始化数据库

@Configuration
@ComponentScan
@EnableTransactionManagement
@PropertySource(value = { "classpath:application.properties" })
public class AppConfig 
{
    @Autowired
    private Environment env;
 
    @Value("${init-db:false}")
    private String initDatabase;
    
    @Bean
    public static PropertySourcesPlaceholderConfigurer placeHolderConfigurer()
    {
        return new PropertySourcesPlaceholderConfigurer();
    }    
 
    @Bean
    public JdbcTemplate jdbcTemplate(DataSource dataSource)
    {
        return new JdbcTemplate(dataSource);
    }
 
    @Bean
    public PlatformTransactionManager transactionManager(DataSource dataSource)
    {
        return new DataSourceTransactionManager(dataSource);
    }
 
    @Bean
    public DataSource dataSource()
    {
        BasicDataSource dataSource = new BasicDataSource();
        dataSource.setDriverClassName(env.getProperty("jdbc.driverClassName"));
        dataSource.setUrl(env.getProperty("jdbc.url"));
        dataSource.setUsername(env.getProperty("jdbc.username"));
        dataSource.setPassword(env.getProperty("jdbc.password"));
        return dataSource;
    }
 
    @Bean
    public DataSourceInitializer dataSourceInitializer(DataSource dataSource)
    {
        DataSourceInitializer dataSourceInitializer = new DataSourceInitializer();    
        dataSourceInitializer.setDataSource(dataSource);
        ResourceDatabasePopulator databasePopulator = new ResourceDatabasePopulator();
        databasePopulator.addScript(new ClassPathResource("data.sql"));
        dataSourceInitializer.setDatabasePopulator(databasePopulator);
        dataSourceInitializer.setEnabled(Boolean.parseBoolean(initDatabase));
        return dataSourceInitializer;
    }
}

使用此配置后，我们可以将JdbcTemplate注入到Data Access组件中以与数据库进行交互。

public class User
{
    private Integer id;
    private String name;
    private String email;
 
    // setters & getters
}

@Repository
public class UserRepository
{
    @Autowired
    private JdbcTemplate jdbcTemplate;
 
    @Transactional(readOnly=true)
    public List<User> findAll() {
        return jdbcTemplate.query("select * from users", new UserRowMapper());
    }
}

class UserRowMapper implements RowMapper<User>
{
    @Override
    public User mapRow(ResultSet rs, int rowNum) throws SQLException 
    {
        User user = new User();
        user.setId(rs.getInt("id"));
        user.setName(rs.getString("name"));
        user.setEmail(rs.getString("email"));
 
        return user;
    }
}

SpringBoot配置JdbcTemplate

使用SpringBoot，我们可以利用自动配置功能，而无需自己配置bean。

<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>

通过添加spring-boot-starter-jdbc模块，我们得到以下自动配置：

spring-boot-starter-jdbc模块可传递地拉出用于配置DataSource bean的tomcat-jdbc- {version} .jar。
如果您没有明确定义任何DataSource bean，并且在类路径中有任何嵌入式数据库驱动程序（例如H2，HSQL或Derby），那么SpringBoot将使用内存中的数据库设置自动注册DataSource bean。
如果您还没有注册任何以下类型的bean，那么SpringBoot将自动注册它们。
- PlatformTransactionManager（DataSourceTransactionManager）
我们可以有schema.sql文件和根类路径data.sql文件，这SpringBoot会自动使用初始化database.In除了schema.sql文件和data.sql，春天开机就会加载的架构- ${}平台的.sql和数据$ {platform} .sql文件（如果在根类路径中可用）。这里的平台值是属性spring.datasource.platform的值，可以是hsqldb，h2，oracle，mysql，postgresql等。您可以使用以下属性来自定义脚本的默认名称：
spring.datasource.schema =创建db.sql

出于任何原因，如果您想自己控制和配置DataSource bean，则可以在Configuration类中配置DataSource bean。

@Configuration
public class DataSourceConfig {

    @Bean
    @Primary
    @ConfigurationProperties(prefix = "spring.datasource.center")
    DataSource dsCenter() {
        return DataSourceBuilder.create().build();
    }

    @Bean(name = "hisDatasource")
    @ConfigurationProperties(prefix = "spring.datasource.his")
    DataSource dsHis() {
        return DataSourceBuilder.create().build();
    }

}

application.property

spring.datasource.center.dirverClassName: com.mysql.jdbc.Driver
spring.datasource.center.jdbc-url:jdbc:mysql://gz-cdb-6oo2gh6t.sql.tencentcdb.com:62179/kfzx_hospital?tinyInt1isBit=false&useUnicode=true&useSSL=false&characterEncoding=UTF-8
spring.datasource.center.username:root
spring.datasource.center.password:!QAZ2wsx#EDC4rfv

spring.datasource.his.driver-class-name=oracle.jdbc.driver.OracleDriver
spring.datasource.his.jdbc-url=jdbc:oracle:thin:@10.0.0.6:1521/BSHIS
spring.datasource.his.username:zy_zj
spring.datasource.his.password:zy_zj

JdbcTemplate

queryForInt()/queryForLong()

使用queryForInt()主要是为了获取数据库中记录总数,获取指定条件的记录数等,不需要对应列名,只需要返回一个数据即可.queryForLong()是同理的.

queryForMap()

如果你想查询到结果并命名的话,你可以使用queryForMap(),查询到的值更改列名为别名,然后使用map.get("别名")来获取.

可能遇到的错：

image.png

queryForObject()

其实本质上queryForObject()和queryForInt()是一直的,只不过可以返回一个非int的值,比如你查询指定id的对象的某一个属性,可以使用Object进行接收,而不能使用int来接收.

String sql = "SELECT name FROM user WHERE id = ?";
return jdbcTemplate.queryForObject(sql,String.class,id);  
//需要注意的是：第一个参数：SQL语句，第二个参数：你查询的结果的返回值类型，第三个参数是：你传入的参数

queryForList()

在我们需要得到一个数据集合的时候,我们通常使用queryForList()进行。返回的结果是一个List<Map>结构的集合。其中一个Map代表了一行数据，使用列名作为key，使用值作为value。

并且queryForList()会默认自动封装。不需要手动进行数据封装。

queryForMap()

queryForMap（）是查询一条数据的时候使用的封装。将列名作为key，值作为value。封装成一个map返回结果。

需要特别注意的是：因为queryForMap（）是要求必须要有结果集的，如果查询出的结果是null，则会报错！如果不确定是否有结果集，请使用query（）进行查询，然后获取数据。

query()

query（）进行查询的时候，必须自行对结果集进行取出并封装。

优点是：数据更加灵活，如果你想在结果集中加上一个固定值作为标记，甚至自己自定义key的值，对value的值进行计算等等，都可以，非常灵活。

缺点是：你需要手动进行封装数据。
代码如下：

public Map queryById(Long id) {
        StringBuilder sql = new StringBuilder();
        sql.append("SELECT * FROM user where 1=1");
        List<Object> paramList = new ArrayList<>();
        if (!StringUtils.isEmpty(id)) {
            sql.append(" AND id = ? ");
            paramList.add(id);
        }
        List<Map<String, Object>> query = this.jdbcTemplate.query(sql.toString(),
                (rs, rowNum) -> {
                    Map<String, Object> dataMap = new HashMap<>();
                    dataMap.put("name", rs.getString("name"));
                    dataMap.put("age", rs.getInt("age") + 100); //对查询出来的结果进行计算，修改等等操作
                    dataMap.put("L3", 1);    //我添加了一个固定列到结果集中
                    return dataMap;
                }, paramList.toArray());
        HashMap<Object, Object> map = new HashMap<>();
        map.put("query",query);

        return map;
    }

@Entity
@Table(name = "user")
public class User {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    @Column(name = "id")
    private Long id;
    @Column(name = "name")
    private String name;
    @Column(name = "age")
    private int age;

    public Long getId() {
        return id;
    }

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

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

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

结果:
{"query":[{"L3":1,"name":"zhsadsdfsn","age":156}]}

SpringBoot：使用JdbcTemplate

什么是JDBC模板(jdbcTemplate)

传统的JDBC应用步骤:

使用Spring的JdbcTemplate （ 不带 SpringBoot ），选择注册DataSourceInitializer Bean来初始化数据库

SpringBoot配置JdbcTemplate

JdbcTemplate

queryForInt()/queryForLong()

queryForMap()

queryForObject()

queryForList()

queryForMap()

query()

推荐阅读更多精彩内容

使用Spring的JdbcTemplate （不带 SpringBoot ），选择注册DataSourceInitializer Bean来初始化数据库