Springboot 使用SQL数据库
在Spring框架提供了广泛的支持使用使用SQL数据库,直接JDBC访问JdbcTemplate
来完成“对象关系映射”技术,比如Hibernate。Spring Data提供了更多级别的功能:Repository
直接从接口创建实现,并使用约定从方法名称生成查询。
摘译自 官方文档
配置数据源
Java的javax.sql.DataSource
接口提供了一种使用数据库连接的标准方法。传统上,'DataSource'使用URL
一些凭证来建立数据库连接。
有关更多高级示例,请参阅“操作方法”部分,通常是为了完全控制DataSource的配置。 |
嵌入式数据库支持
通过使用内存中嵌入式数据库来开发应用程序通常很方便。显然,内存数据库不提供持久存储。您需要在应用程序启动时填充数据库,并准备在应用程序结束时丢弃数据。
“操作方法”部分包含有关如何初始化数据库的部分。 |
Spring Boot可以自动配置嵌入式H2, HSQL和Derby数据库。您无需提供任何连接URL。您只需要包含要使用的嵌入式数据库的构建依赖项。
如果您在测试中使用此功能,您可能会注意到整个测试套件都会重复使用相同的数据库,无论您使用的应用程序上下文的数量如何。如果要确保每个上下文都有一个单独的嵌入式数据库,则应设置 |
例如,典型的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>
您需要依赖于 |
如果由于某种原因,您确实为嵌入式数据库配置了连接URL,请注意确保禁用数据库的自动关闭。如果你使用H2,你应该 |
连接到生产数据库
也可以使用池自动配置生产数据库连接 DataSource
。Spring Boot使用以下算法来选择特定的实现:
- 我们更喜欢HikariCP的性能和并发性。如果HikariCP可用,我们总是选择它。
- 否则,如果Tomcat池
DataSource
可用,我们将使用它。 - 如果HikariCP和Tomcat池化数据源都不可用,并且 Commons DBCP2可用,我们就会使用它。
如果您使用spring-boot-starter-jdbc
或spring-boot-starter-data-jpa
“启动器”,您将自动获得依赖HikariCP
。
您可以完全绕过该算法,并通过设置 |
始终可以手动配置其他连接池。如果您定义自己的 |
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
您至少应该通过设置 |
您通常不需要指定 |
对于 |
有关DataSourceProperties
更多支持的选项,请参阅 。无论实际实施如何,这些都是标准选项。也可以微调实现特定的设置,使用各自的前缀(spring.datasource.hikari.*
,spring.datasource.tomcat.*
,和spring.datasource.dbcp2.*
)。有关更多详细信息,请参阅您正在使用的连接池实现的文档。
例如,如果使用 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
连接到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
使用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
在 |
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。您可以按照“访问数据与JPA” 从指导spring.io并宣读了春天的数据JPA和 Hibernate的参考文档。 |
实体类
传统上,JPA“实体”类在persistence.xml
文件中指定。使用Spring Boot,此文件不是必需的,而是使用“实体扫描”。默认情况下,将搜索主配置类(注释为@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
}
您可以使用 |
Spring Data JPA存储库
Spring Data JPA存储库是您可以定义以访问数据的接口。JPA查询是从您的方法名称自动创建的。例如,CityRepository
接口可能会声明一个findAllByState(String state)
方法来查找给定状态中的所有城市。
对于更复杂的查询,您可以使用Spring Data的Query
注释来注释您的方法 。
Spring Data存储库通常从Repository
或 CrudRepository
接口扩展 。如果使用自动配置,则会从包含主配置类(带有@EnableAutoConfiguration
或标注的类)的软件包中搜索存储库@SpringBootApplication
。
以下示例显示了典型的Spring Data存储库接口定义:
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。要启用延迟或延迟引导,请分别设置 spring.data.jpa.repositories.bootstrap-mode
为deferred
或lazy
。使用延迟或延迟引导时,自动配置EntityManagerFactoryBuilder
将使用上下文的异步任务执行程序(如果有)作为引导程序执行程序。
我们几乎没有涉及Spring Data JPA的表面。有关完整的详细信息,请参阅Spring Data JPA参考文档。 |
创建和删除JPA数据库
默认情况下,仅当您使用嵌入式数据库(H2,HSQL或Derby)时,才会自动创建JPA数据库。您可以使用spring.jpa.*
属性显式配置JPA设置 。例如,要创建和删除表,您可以将以下行添加到application.properties
:
spring.jpa.hibernate.ddl-auto=create-drop
Hibernate自己的内部属性名称(如果你碰巧记得更好)是 |
spring.jpa.properties.hibernate.globally_quoted_identifiers=true
在前面的示例中的线穿过的一个值true
的 hibernate.globally_quoted_identifiers
属性设置为休眠实体管理器。
默认情况下,DDL执行(或验证)将延迟到ApplicationContext
启动。还有一个spring.jpa.generate-ddl
标志,但如果Hibernate自动配置处于活动状态,则不会使用该标志,因为ddl-auto
设置更精细。
在View中打开EntityManager
如果您正在运行Web应用程序,则默认情况下Spring Boot会注册 OpenEntityManagerInViewInterceptor
以应用“在视图中打开EntityManager”模式,以允许在Web视图中进行延迟加载。如果你不希望这种行为,你应该设置spring.jpa.open-in-view
到 false
你application.properties
。
Spring Data JDBC
Spring Data包含对JDBC的存储库支持,并将自动为方法生成SQL CrudRepository
。对于更高级的查询,@Query
提供了注释。
当必要的依赖项在类路径上时,Spring Boot将自动配置Spring Data的JDBC存储库。它们可以通过单一依赖项添加到项目中spring-boot-starter-data-jdbc
。如有必要,您可以通过向应用程序添加@EnableJdbcRepositories
注释或 JdbcConfiguration
子类来控制Spring Data JDBC的配置。
有关Spring Data JDBC的完整详细信息,请参阅 参考文档。 |
使用H2的Web控制台
该H2数据库提供了一个 基于浏览器的控制台是春天开机即可自动为您配置。满足以下条件时,将自动配置控制台:
- 您正在开发基于servlet的Web应用程序。
com.h2database:h2
在类路径上。- 您正在使用Spring Boot的开发人员工具。
如果您没有使用Spring Boot的开发人员工具但仍想使用H2的控制台,则可以 |
H2控制台仅用于开发期间,因此您应该注意确保 |
更改H2控制台的路径
默认情况下,控制台可用于/h2-console
。您可以使用该spring.h2.console.path
属性自定义控制台的路径。
使用jOOQ
Java面向对象查询(jOOQ)是Data Geekery的一个流行产品, 它从您的数据库生成Java代码,并允许您通过其流畅的API构建类型安全的SQL查询。商业版和开源版都可以与Spring Boot一起使用。
代码生成
要使用jOOQ类型安全查询,您需要从数据库模式生成Java类。您可以按照jOOQ用户手册中的说明进行 操作。如果您使用该 jooq-codegen-maven
插件并且还使用spring-boot-starter-parent
“父POM”,则可以安全地省略插件的<version>
标签。您还可以使用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>
使用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手册倾向于使用一个名为 |
然后,您可以使用它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);
}
jOOQ SQL方言
除非spring.jooq.sql-dialect
已配置该属性,否则Spring Boot会确定要用于数据源的SQL方言。如果Spring Boot无法检测到方言,它会使用DEFAULT
。
Spring Boot只能自动配置开源版本jOOQ支持的方言。 |
自定义jOOQ
通过定义自己的@Bean
定义可以实现更高级的自定义,这些定义在Configuration
创建jOOQ时使用。您可以为以下jOOQ类型定义bean:
ConnectionProvider
ExecutorProvider
TransactionProvider
RecordMapperProvider
RecordUnmapperProvider
RecordListenerProvider
ExecuteListenerProvider
VisitListenerProvider
TransactionListenerProvider
org.jooq.Configuration
@Bean
如果要完全控制jOOQ配置,也可以创建自己的。