使用 JDBC 和 Spring 访问关系数据

Posted 2022-09-07 Spring_Learnin

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

你将建造什么

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

你需要什么

• 约15分钟
• 最喜欢的文本编辑器或 IDE
• JDK 1.8或更高版本
• Gradle 4+或Maven 3.2+
• 您还可以将代码直接导入 IDE：

• 弹簧工具套件 (STS)
• IntelliJ IDEA

如何完成本指南

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

要从头开始，请继续从 Spring Initializr 开始。

要跳过基础知识，请执行以下操作：

• 下载并解压缩本指南的源存储库，或使用Git克隆它：git clone https://github.com/spring-guides/gs-relational-data-access.git
• 光盘进入gs-relational-data-access/initial
• 跳转到创建Customer对象。

完成后，您可以对照中的代码检查结果​​gs-relational-data-access/complete​​。

从 Spring Initializr 开始

您可以使用这个预先初始化的项目并单击 Generate 下载 ZIP 文件。此项目配置为适合本教程中的示例。

手动初始化项目：

1. 导航到https://start.spring.io。该服务提取应用程序所需的所有依赖项，并为您完成大部分设置。
2. 选择 Gradle 或 Maven 以及您要使用的语言。本指南假定您选择了 Java。
3. 单击Dependencies并选择JDBC API和H2 Database。
4. 单击生成。
5. 下载生成的 ZIP 文件，该文件是根据您的选择配置的 Web 应用程序的存档。

如果您的 IDE 具有 Spring Initializr 集成，您可以从您的 IDE 完成此过程。

你也可以从 Github 上 fork 项目并在你的 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 JdbcTemplates 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 = ?", new Object[]  "Josh" ,
        (rs, rowNum) -> new Customer(rs.getLong("id"), rs.getString("first_name"), rs.getString("last_name"))
    ).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()​​在应用程序上下文加载后执行该方法。

首先，​​execute​​使用​​JdbcTemplate​​.

其次，获取一个字符串列表，并通过使用 Java 8 流，将它们拆分为 Java 数组中的名字/姓氏对。

然后使用 的​​batchUpdate​​​方法在新创建的表中安装一些记录​​JdbcTemplate​​​。方法调用的第一个参数是查询字符串。最后一个参数（​​Object​​​实例数组）保存要替换到​​?​​字符所在查询中的变量。

对于单个插入语句，insert方法JdbcTemplate很好。但是，对于多个插入，最好使用batchUpdate.

用于参数，通过指示 JDBC 绑定变量?来避免SQL 注入。

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

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

构建一个可执行的 JAR

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

如果您使用 Gradle，则可以使用​​./gradlew bootRun​​. 或者，您可以使用构建 JAR 文件​​./gradlew build​​，然后运行 ​​JAR 文件，如下所示：

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

如果您使用 Maven，则可以使用​​./mvnw spring-boot:run​​. 或者，您可以使用构建 JAR 文件，​​./mvnw clean package​​然后运行该 JAR 文件，如下所示：

java -jar 目标/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 具有许多用于配置和自定义连接池的功能——例如，连接到外部数据库而不是内存数据库。