使用 Spring 和 JDBC 访问关系型数据

本指南将引导您完成使用 Spring 访问关系型数据的过程。

您将构建什么

您将构建一个应用程序,该应用程序使用 Spring 的 JdbcTemplate 访问存储在关系数据库中的数据。

您需要什么

如何完成本指南

与大多数 Spring 入门指南 一样,您可以从头开始并完成每个步骤,或者可以跳过您已经熟悉的基本设置步骤。无论哪种方式,您最终都会获得可工作的代码。

从头开始,请继续访问 使用 Spring Initializr 开始

跳过基础知识,请执行以下操作

完成后,您可以将您的结果与 gs-relational-data-access/complete 中的代码进行比较。

使用 Spring Initializr 开始

您可以使用此 预初始化项目 并点击“生成”以下载 ZIP 文件。此项目已配置为适合本教程中的示例。

要手动初始化项目

  1. 导航到 https://start.spring.io。此服务会引入应用程序所需的所有依赖项,并为您完成大部分设置工作。

  2. 选择 Gradle 或 Maven 以及您要使用的语言。本指南假设您选择了 Java。

  3. 点击依赖项并选择JDBC APIH2 数据库

  4. 点击生成

  5. 下载生成的 ZIP 文件,该文件是根据您的选择配置的 Web 应用程序的存档。

如果您的 IDE 集成了 Spring Initializr,则可以从您的 IDE 中完成此过程。
您也可以从 Github 分叉项目并在您的 IDE 或其他编辑器中打开它。

创建 Customer 对象

您将要使用的简单数据访问逻辑管理客户的姓氏和名字。为了在应用程序级别表示此数据,请创建一个 Customer 类,如下面的清单(来自 src/main/java/com/example/relationaldataaccess/Customer.java)所示

package com.example.relationaldataaccess;

public class Customer {
  private long id;
  private String firstName, lastName;

  public Customer(long id, String firstName, String lastName) {
    this.id = id;
    this.firstName = firstName;
    this.lastName = lastName;
  }

  @Override
  public String toString() {
    return String.format(
        "Customer[id=%d, firstName='%s', lastName='%s']",
        id, firstName, lastName);
  }

  // getters & setters omitted for brevity
}

存储和检索数据

Spring 提供了一个名为 JdbcTemplate 的模板类,它使使用 SQL 关系数据库和 JDBC 变得容易。大多数 JDBC 代码都陷入了资源获取、连接管理、异常处理和一般错误检查的泥潭,这些与代码的目的完全无关。JdbcTemplate 为您处理所有这些问题。您只需专注于手头的任务即可。下面的清单(来自 src/main/java/com/example/relationaldataaccess/RelationalDataAccessApplication.java)显示了一个可以通过 JDBC 存储和检索数据的类

package com.example.relationaldataaccess;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.jdbc.core.JdbcTemplate;

import java.util.Arrays;
import java.util.List;
import java.util.stream.Collectors;

@SpringBootApplication
public class RelationalDataAccessApplication implements CommandLineRunner {

  private static final Logger log = LoggerFactory.getLogger(RelationalDataAccessApplication.class);

  public static void main(String args[]) {
    SpringApplication.run(RelationalDataAccessApplication.class, args);
  }

  @Autowired
  JdbcTemplate jdbcTemplate;

  @Override
  public void run(String... strings) throws Exception {

    log.info("Creating tables");

    jdbcTemplate.execute("DROP TABLE customers IF EXISTS");
    jdbcTemplate.execute("CREATE TABLE customers(" +
        "id SERIAL, first_name VARCHAR(255), last_name VARCHAR(255))");

    // Split up the array of whole names into an array of first/last names
    List<Object[]> splitUpNames = Arrays.asList("John Woo", "Jeff Dean", "Josh Bloch", "Josh Long").stream()
        .map(name -> name.split(" "))
        .collect(Collectors.toList());

    // Use a Java 8 stream to print out each tuple of the list
    splitUpNames.forEach(name -> log.info(String.format("Inserting customer record for %s %s", name[0], name[1])));

    // Uses JdbcTemplate's batchUpdate operation to bulk load data
    jdbcTemplate.batchUpdate("INSERT INTO customers(first_name, last_name) VALUES (?,?)", splitUpNames);

    log.info("Querying for customer records where first_name = 'Josh':");
    jdbcTemplate.query(
        "SELECT id, first_name, last_name FROM customers WHERE first_name = ?",
        (rs, rowNum) -> new Customer(rs.getLong("id"), rs.getString("first_name"), rs.getString("last_name")), "Josh")
    .forEach(customer -> log.info(customer.toString()));
  }
}

@SpringBootApplication 是一个便利注解,它添加了以下所有内容

  • @Configuration:将类标记为应用程序上下文的 bean 定义的来源。

  • @EnableAutoConfiguration:告诉 Spring Boot 开始根据类路径设置、其他 bean 和各种属性设置添加 bean。

  • @ComponentScan:告诉 Spring 在 com.example.relationaldataaccess 包中查找其他组件、配置和服务。在本例中,没有任何。

main() 方法使用 Spring Boot 的 SpringApplication.run() 方法启动应用程序。

Spring Boot 支持 H2(一个内存中的关系数据库引擎)并自动创建连接。因为我们使用了 spring-jdbc,所以 Spring Boot 会自动创建一个 JdbcTemplate@Autowired JdbcTemplate 字段会自动加载它并使其可用。

Application 类实现了 Spring Boot 的 CommandLineRunner,这意味着它将在加载应用程序上下文后执行 run() 方法。

首先,使用 JdbcTemplateexecute 方法安装一些 DDL。

其次,获取一个字符串列表,并使用 Java 8 流将其拆分为 Java 数组中的 firstname/lastname 对。

然后,使用 JdbcTemplatebatchUpdate 方法在您新创建的表中安装一些记录。方法调用的第一个参数是查询字符串。最后一个参数(Object 实例数组)保存要替换到查询中 ? 字符位置的变量。

对于单个插入语句,JdbcTemplateinsert 方法很好用。但是,对于多个插入,最好使用 batchUpdate
使用 ? 作为参数以避免 SQL 注入攻击,方法是指示 JDBC 绑定变量。

最后,使用 query 方法搜索表中与条件匹配的记录。您再次使用 ? 参数为查询创建参数,并在调用时传入实际值。最后一个参数是一个 Java 8 lambda,用于将每个结果行转换为新的 Customer 对象。

Java 8 lambda 可以很好地映射到单方法接口,例如 Spring 的 RowMapper。如果您使用的是 Java 7 或更早版本,则可以插入一个匿名接口实现,并将方法体设置为与 lambda 表达式的体相同。

构建可执行 JAR

您可以使用 Gradle 或 Maven 从命令行运行应用程序。您还可以构建一个包含所有必要依赖项、类和资源的单个可执行 JAR 文件,然后运行该文件。构建可执行 jar 使得在整个开发生命周期中、跨不同环境等轻松地交付、版本化和部署服务作为应用程序。

如果您使用 Gradle,则可以使用 ./gradlew bootRun 运行应用程序。或者,您可以使用 ./gradlew build 构建 JAR 文件,然后运行 JAR 文件,如下所示

java -jar build/libs/gs-relational-data-access-0.1.0.jar

如果您使用 Maven,则可以使用 ./mvnw spring-boot:run 运行应用程序。或者,您可以使用 ./mvnw clean package 构建 JAR 文件,然后运行 JAR 文件,如下所示

java -jar target/gs-relational-data-access-0.1.0.jar
此处描述的步骤创建了一个可运行的 JAR。您还可以 构建一个经典的 WAR 文件

您应该看到以下输出

2019-09-26 13:46:58.561  INFO 47569 --- [           main] c.e.r.RelationalDataAccessApplication    : Creating tables
2019-09-26 13:46:58.564  INFO 47569 --- [           main] com.zaxxer.hikari.HikariDataSource       : HikariPool-1 - Starting...
2019-09-26 13:46:58.708  INFO 47569 --- [           main] com.zaxxer.hikari.HikariDataSource       : HikariPool-1 - Start completed.
2019-09-26 13:46:58.809  INFO 47569 --- [           main] c.e.r.RelationalDataAccessApplication    : Inserting customer record for John Woo
2019-09-26 13:46:58.810  INFO 47569 --- [           main] c.e.r.RelationalDataAccessApplication    : Inserting customer record for Jeff Dean
2019-09-26 13:46:58.810  INFO 47569 --- [           main] c.e.r.RelationalDataAccessApplication    : Inserting customer record for Josh Bloch
2019-09-26 13:46:58.810  INFO 47569 --- [           main] c.e.r.RelationalDataAccessApplication    : Inserting customer record for Josh Long
2019-09-26 13:46:58.825  INFO 47569 --- [           main] c.e.r.RelationalDataAccessApplication    : Querying for customer records where first_name = 'Josh':
2019-09-26 13:46:58.835  INFO 47569 --- [           main] c.e.r.RelationalDataAccessApplication    : Customer[id=3, firstName='Josh', lastName='Bloch']
2019-09-26 13:46:58.835  INFO 47569 --- [           main] c.e.r.RelationalDataAccessApplication    : Customer[id=4, firstName='Josh', lastName='Long']

总结

恭喜!您刚刚使用 Spring 开发了一个简单的 JDBC 客户端。

Spring Boot 具有许多用于配置和自定义连接池的功能,例如,连接到外部数据库而不是内存中的数据库。有关更多详细信息,请参阅 参考指南

另请参阅

以下指南可能也有帮助

想要编写新的指南或为现有指南做出贡献?请查看我们的 贡献指南

所有指南均以 ASLv2 许可证发布代码,并以 署名-非衍生作品创作共用许可证 发布文字。

获取代码