使用SQL数据库

在Spring框架提供了广泛的支持使用使用SQL数据库，直接JDBC访问JdbcTemplate来完成“对象关系映射”技术，比如Hibernate。Spring Data提供了更多级别的功能：Repository直接从接口创建实现，并使用约定从方法名称生成查询。

1.1 配置数据源

Java的javax.sql.DataSource接口提供了一种使用数据库连接的标准方法。传统上，’DataSource'使用URL一些凭证来建立数据库连接

1.1.1 嵌入式数据库支持

通过使用内存中的嵌入式数据库来开发应用程序通常很方便。显然，内存数据库不提供持久存储。您需要在应用程序启动时填充数据库，并准备在应用程序结束时丢弃数据。

Spring Boot可以自动配置嵌入式H2， HSQL和Derby数据库。您无需提供任何连接URL。您只需要包含要使用的嵌入式数据库的构建依赖项。

如果您在测试中使用此功能，您可能会注意到整个测试套件都会重复使用相同的数据库，而不管您使用的应用程序上下文的数量。如果要确保每个上下文都有一个单独的嵌入式数据库，则应设置spring.datasource.generate-unique-name为true。

例如，典型的POM依赖关系如下：

<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>
<dependency>
	<groupId>org.hsqldb</groupId>
	<artifactId>hsqldb</artifactId>
	<scope>runtime</scope>
</dependency>

我们需要依赖于spring-jdbc自动配置嵌入式数据库。在这个例子中，它被传递过来 spring-boot-starter-data-jpa。
如果由于某种原因，您确实为嵌入式数据库配置了连接URL，请注意确保禁用数据库的自动关闭。如果你使用H2，你应该DB_CLOSE_ON_EXIT=FALSE这样做。如果使用HSQLDB，则应确保shutdown=true未使用HSQLDB 禁用数据库的自动关闭可以在数据库关闭时进行Spring Boot控制，从而确保在不再需要访问数据库时发生。

1.1.2 连接到生产数据库

我们也可以使用数据库连接池来自动配置生产数据库连接 DataSource。

Spring Boot使用以下算法来选择特定的实现：

我们更喜欢HikariCP的性能和并发性。如果HikariCP可用，我们总是选择它。
否则，如果Tomcat池DataSource可用，我们将使用它。
如果HikariCP和Tomcat池化数据源都不可用，并且 Commons DBCP2可用，我们就会使用它。

如果我们使用的是spring-boot-starter-jdbc或spring-boot-starter-data-jpa “starters”，我们将自动获得HikariCP依赖。

我们也可以通过设置spring.datasource.type属性来指定要使用的连接池。如果我们在Tomcat容器中运行应用程序 tomcat-jdbc（默认情况下提供），这一点尤为重要。

我们始终可以选择手动配置其他连接池。一旦我们定义了自己的DataSourcebean，则Spring Boot 将不会进行自动配置

DataSource配置由外部配置属性控制 spring.datasource.*。例如，您可以在以下部分声明以下部分 application.properties：

spring.datasource.url=jdbc:mysql://localhost/test
spring.datasource.username=dbuser
spring.datasource.password=dbpass
spring.datasource.driver-class-name=com.mysql.jdbc.Driver

我们至少应该通过设置spring.datasource.url 属性来指定URL 。否则，Spring Boot会尝试自动配置嵌入式数据库。

我们通常不需要指定driver-class-name，因为Spring Boot可以从大多数数据库推断它url

对于DataSource要创建的池，我们需要能够验证有效的Driver类是否可用，因此我们在执行任何操作之前检查它。换句话说，如果你设置spring.datasource.driver-class-name=com.mysql.jdbc.Driver，那么该类必须是可加载的。

如果使用 Tomcat连接池，则可以自定义许多其他设置，如以下示例所示：

# Number of ms to wait before throwing an exception if no connection is available.
spring.datasource.tomcat.max-wait=10000

# Maximum number of active connections that can be allocated from this pool at the same time.
spring.datasource.tomcat.max-active=50

# Validate the connection before borrowing it from the pool.
spring.datasource.tomcat.test-on-borrow=true

1.1.3 连接到JNDI数据源

如果将Spring Boot应用程序部署到Application Server，则可能需要使用Application Server的内置功能配置和管理DataSource，并使用JNDI访问它。

该spring.datasource.jndi-name属性可以被用作一个替代 spring.datasource.url，spring.datasource.username和spring.datasource.password 属性来访问DataSource从一个特定的JNDI位置。例如，以下部分application.properties显示了如何访问定义的JBoss AS DataSource：

spring.datasource.jndi-name=java:jboss/datasources/customers

1.2 使用JdbcTemplate

Spring JdbcTemplate和NamedParameterJdbcTemplate类是自动配置的，您可以@Autowire直接将它们放入自己的bean中，如以下示例所示：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.stereotype.Component;

@Component
public class MyBean {

	private final JdbcTemplate jdbcTemplate;

	@Autowired
	public MyBean(JdbcTemplate jdbcTemplate) {
		this.jdbcTemplate = jdbcTemplate;
	}

	// ...

}

我们可以使用spring.jdbc.template.* 属性自定义模板的某些属性，如以下示例所示：

spring.jdbc.template.max-rows=500

在底层实现中NamedParameterJdbcTemplate会重复使用相同的JdbcTemplate。如果JdbcTemplate定义了多个且没有主要候选项， NamedParameterJdbcTemplate则不会自动配置。

1.3 JPA和Spring Data JPA

Java Persistence API是一种标准技术，可让您将对象“映射”到关系数据库。 spring-boot-starter-data-jpa POM提供了一种快速入门方式。它提供以下关键依赖项：

Hibernate：最受欢迎的JPA实现之一。
Spring Data JPA：使实现基于JPA的存储库变得容易。
Spring ORMs：Spring Framework的核心ORM支持。

我们不会在这里详细介绍JPA或Spring Data。您可以按照spring.io中的“使用JPA访问数据”指南阅读Spring Data JPA和Hibernate参考文档。

1.3.1 Entity Classes

传统上，JPA“Entity”类在persistence.xml文件中指定。使用Spring Boot，此文件不是必需的，而是使用“Entity Scanning”。默认情况下，将搜索主配置类（使用@EnableAutoConfiguration或@SpringBootApplication注解的那个）下的所有包。

任何使用@Entity，@Embeddable或@MappedSuperclass注解的类都被考虑在内。典型的实体类类似于以下示例：

package com.example.myapp.domain;

import java.io.Serializable;
import javax.persistence.*;

@Entity
public class City implements Serializable {

	@Id
	@GeneratedValue
	private Long id;

	@Column(nullable = false)
	private String name;

	@Column(nullable = false)
	private String state;

	// ... additional members, often include @OneToMany mappings

	protected City() {
		// no-args constructor required by JPA spec
		// this one is protected since it shouldn't be used directly
	}

	public City(String name, String state) {
		this.name = name;
		this.state = state;
	}

	public String getName() {
		return this.name;
	}

	public String getState() {
		return this.state;
	}

	// ... etc

}

我们也可以使用@EntityScan注解自定义实体扫描位置。
请参阅“第83.4节”，“从Spring配置中分离@Entity定义”“操作方法”。

1.3.2 Spring Data JPA Repositories

Spring Data JPA repositories 是我们可以定义访问数据的接口。 JPA查询是从您的方法名称自动创建的。例如，CityRepository接口可能会声明findAllByState(String state)方法以查找给定状态中的所有城市。

对于更复杂的查询，我们可以在我们的方法上使用Spring Data的@Query注解。

Spring Data repositories通常从Repository或CrudRepository接口扩展。如果使用自动配置，则会从包含主配置类（使用@EnableAutoConfiguration或@SpringBootApplication注解的那个）的包中搜索repositories 。

以下示例显示了典型的Spring Data repositories 接口定义：

package com.example.myapp.domain;

import org.springframework.data.domain.*;
import org.springframework.data.repository.*;

public interface CityRepository extends Repository<City, Long> {

	Page<City> findAll(Pageable pageable);

	City findByNameAndStateAllIgnoringCase(String name, String state);

}

Spring Data JPA存储库支持三种不同的引导模式：default，deferred和lazy。要启用延迟或延迟引导，需要applicaiton.properties 配置如下：

spring.data.jpa.repositories.bootstrap-mode=deferred

或者

spring.data.jpa.repositories.bootstrap-mode=lazy

使用延迟或延迟引导时，自动配置的EntityManagerFactoryBuilder将使用上下文的AsyncTaskExecutor（如果有）作为引导程序执行程序。如果存在多个，则将使用名为applicationTaskExecutor的那个。

更多详细参考文档：Spring Data JPA reference documentation.

1.3.3 创建和删除 JPA Databases

默认情况下，仅当您使用嵌入式数据库（H2，HSQL或Derby）时，才会自动创建JPA数据库。您可以使用spring.jpa.*属性显式配置JPA设置。例如，要创建和删除表，可以将以下行添加到application.properties：

spring.jpa.hibernate.ddl-auto=create-drop

Hibernate自己的内部属性名称（如果你碰巧记得更好）是hibernate.hbm2ddl.auto。您可以使用spring.jpa.properties.*（在将它们添加到实体管理器之前剥离前缀）来设置它以及其他Hibernate本机属性。
以下行显示了为Hibernate设置JPA属性的示例：

spring.jpa.properties.hibernate.globally_quoted_identifiers=true

前面示例中的行将hibernate.globally_quoted_identifiers属性的值传递给Hibernate实体管理器。

默认情况下，DDL执行（或验证）将延迟到ApplicationContext启动。还有一个spring.jpa.generate-ddl标志，但如果Hibernate自动配置处于活动状态，则不会使用它，因为ddl-auto设置更精细。

1.3.4 在视图中打开EntityManager

如果您正在运行Web应用程序，Spring Boot默认会注住OpenEntityManagerInViewInterceptor以应用“在视图中打开EntityManager”模式，以允许在Web视图中进行延迟加载。
如果您不想要此行为，则应在application.properties中将spring.jpa.open-in-view设置为false

spring.jpa.open-in-view=false

1.4 Spring Data JDBC

Spring Data包含对JDBC的存储库支持，并将自动为CrudRepository上的方法生成SQL。对于更高级的查询，提供了@Query注解。

当必要的依赖项在类路径上时，Spring Boot将自动配置Spring Data的JDBC存储库。它们可以通过spring-boot-starter-data-jdbc的单一依赖项添加到项目中。如有必要，可以通过将@EnableJdbcRepositories注解或JdbcConfiguration子类添加到应用程序来控制Spring Data JDBC的配置。

更多关于JDBC 参考：https://spring.io/projects/spring-data-jdbc

1.5 使用 H2’s Web Console

H2数据库提供了一个基于浏览器的控制台，Spring Boot可以为您自动配置。满足以下条件时，将自动配置控制台：

您正在开发基于servlet的Web应用程序。
com.h2database：h2在类路径上。
您正在使用Spring Boot的开发人员工具

如果您没有使用Spring Boot的开发人员工具但仍想使用H2的控制台，则可以使用值true配置spring.h2.console.enabled属性。
spring.h2.console.enabled=true 
H2控制台仅用于开发期间，因此您应该注意确保spring.h2.console.enabled在生产中未设置为true。

1.5.1 修改H2 Console’s 上下文

默认情况下，控制台位于/h2-console。您可以使用spring.h2.console.path属性自定义控制台的路径

spring.h2.console.path=/h2-console

1.6 使用 jOOQ Java面向对象查询

Java Object Oriented Querying （jOOQ）是Data Geekery的一个流行产品，它从您的数据库生成Java代码，并允许您通过其流畅的API构建类型安全的SQL查询。商业版和开源版都可以与Spring Boot一起使用。

1.6.1 代码生成

了使用JOOQ类型安全查询，您需要从数据库模式生成Java类。您可以按照jOOQ用户手册中的说明进行操作。如果您使用jooq-codegen-maven插件并且还使用spring-boot-starter-parent“parent POM”，则可以安全地省略插件的标记。您还可以使用Spring Boot定义的版本变量（例如h2.version）来声明插件的数据库依赖性。以下清单显示了一个示例：

<plugin>
	<groupId>org.jooq</groupId>
	<artifactId>jooq-codegen-maven</artifactId>
	<executions>
		...
	</executions>
	<dependencies>
		<dependency>
			<groupId>com.h2database</groupId>
			<artifactId>h2</artifactId>
			<version>${h2.version}</version>
		</dependency>
	</dependencies>
	<configuration>
		<jdbc>
			<driver>org.h2.Driver</driver>
			<url>jdbc:h2:~/yourdatabase</url>
		</jdbc>
		<generator>
			...
		</generator>
	</configuration>
</plugin>

1.6.2 使用DSLContext

jOOQ提供的流畅API通过org.jooq.DSLContext接口启动。 Spring Boot将DSLContext自动配置为Spring Bean并将其连接到您的应用程序DataSource。要使用DSLContext，您可以@Autowire它，如以下示例所示：

@Component
public class JooqExample implements CommandLineRunner {

	private final DSLContext create;

	@Autowired
	public JooqExample(DSLContext dslContext) {
		this.create = dslContext;
	}

jOOQ手册倾向于使用名为create的变量来保存DSLContext。

然后，您可以使用DSLContext构建查询，如以下示例所示：

public List<GregorianCalendar> authorsBornAfter1980() {
	return this.create.selectFrom(AUTHOR)
		.where(AUTHOR.DATE_OF_BIRTH.greaterThan(new GregorianCalendar(1980, 0, 1)))
		.fetch(AUTHOR.DATE_OF_BIRTH);
}

1.6.3 jOOQ SQL Dialect

除非已配置spring.jooq.sql-dialect属性，否则Spring Boot会确定要用于数据源的SQL方言。如果Spring Boot无法检测到方言，则使用DEFAULT。

Spring Boot只能自动配置开源版本的jOOQ支持的方言。

1.6.4 自定义jOOQ

通过定义自己的@Bean定义可以实现更高级的自定义，这些定义在创建jOOQ配置时使用。您可以为以下jOOQ类型定义bean：

ConnectionProvider
ExecutorProvider
TransactionProvider
RecordMapperProvider
RecordUnmapperProvider
RecordListenerProvider
ExecuteListenerProvider
VisitListenerProvider
TransactionListenerProvider

如果要完全控制jOOQ配置，还可以创建自己的org.jooq.Configuration @Bean。

本文标题：0x09 Spring Boot 2.x 之使用SQL数据库

本文链接：https://blog.quwenai.cn/post/2995.html

作者授权：除特别说明外，本文由 toobug 原创编译并授权 TOOBUG信息安全网刊载发布。

本文链接：https://blog.quwenai.cn/post/2995.html

分享到：

正文

0x09 Spring Boot 2.x 之使用SQL数据库