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 通过 JDBC 访问关系型数据
本指南将引导您了解如何使用 Spring 访问关系型数据。
您将构建什么
您将构建一个应用程序,该应用程序使用 Spring 的 JdbcTemplate
来访问存储在关系型数据库中的数据。
您需要准备什么
-
约 15 分钟
-
您喜欢的文本编辑器或 IDE
-
Java 17 或更高版本
-
您也可以直接将代码导入到 IDE 中
如何完成本指南
与大多数 Spring 入门指南一样,您可以从头开始并完成每个步骤,或者跳过您已经熟悉的基本设置步骤。无论哪种方式,您最终都会获得可运行的代码。
要从头开始,请转到从 Spring Initializr 开始。
要跳过基础部分,请执行以下操作
-
下载并解压本指南的源代码仓库,或使用 Git 克隆:
git clone https://github.com/spring-guides/gs-relational-data-access.git
-
cd 到
gs-relational-data-access/initial
目录 -
跳转到创建
Customer
对象。
完成后,您可以将您的结果与 gs-relational-data-access/complete
中的代码进行对照检查。
从 Spring Initializr 开始
您可以使用这个预初始化项目,然后点击 Generate 下载 ZIP 文件。此项目已配置好以适用于本教程中的示例。
手动初始化项目
-
导航到 https://start.spring.io。该服务会引入应用程序所需的所有依赖,并为您完成大部分设置工作。
-
选择 Gradle 或 Maven 以及您想使用的语言。本指南假设您选择了 Java。
-
点击 Dependencies 并选择 JDBC API 和 H2 Database。
-
点击 Generate。
-
下载生成的 ZIP 文件,这是一个根据您的选择配置好的 Web 应用程序归档。
如果您的 IDE 集成了 Spring Initializr,您可以直接在 IDE 中完成此过程。 |
您也可以从 Github Fork 项目,并在您的 IDE 或其他编辑器中打开它。 |
创建一个 Customer
对象
您将使用的简单数据访问逻辑管理客户的名字和姓氏。为了在应用程序级别表示这些数据,请创建一个 Customer
类,如下面的列表(来自 src/main/java/com/example/relationaldataaccess/Customer.java
)所示
存储和检索数据
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()
方法。
首先,使用 JdbcTemplate
的 execute
方法安装一些 DDL。
其次,获取一个字符串列表,然后使用 Java 8 Stream 将它们分割成一个 Java 数组中的名字/姓氏对。
然后使用 JdbcTemplate
的 batchUpdate
方法在您新创建的表中插入一些记录。方法调用的第一个参数是查询字符串。最后一个参数(Object
实例数组)保存了将替换查询中 ?
字符的变量。
对于单个插入语句,JdbcTemplate 的 insert 方法很好用。然而,对于多个插入操作,最好使用 batchUpdate 。 |
使用 ? 作为参数,通过指示 JDBC 绑定变量来避免 SQL 注入攻击。 |
最后,使用 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 文件
如果您使用 Maven,可以使用 ./mvnw spring-boot:run
运行应用程序。或者,您可以使用 ./mvnw clean package
构建 JAR 文件,然后按如下方式运行 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 有许多用于配置和自定义连接池的功能——例如,连接到外部数据库而不是内存数据库。有关更多详细信息,请参阅参考指南。 |