大多数应用程序在某个时候都需要处理输入和输出问题。Spring Boot提供了一系列工具和与各种技术的集成,以帮助您在需要IO功能时。本节涵盖标准IO功能,如缓存和验证,以及更高级的主题,如调度和分布式事务。我们还将涵盖调用远程REST或SOAP服务以及发送电子邮件。
1. 缓存
Spring框架提供了对应用程序透明添加缓存的支持。在其核心,该抽象将缓存应用于方法,从而根据缓存中可用的信息减少执行次数。缓存逻辑是透明应用的,不会对调用者造成任何干扰。只要使用@EnableCaching
注解启用了缓存支持,Spring Boot就会自动配置缓存基础设施。
查看Spring Framework参考文档中的相关章节以获取更多详细信息。 |
简而言之,要为服务的操作添加缓存,请将相关注解添加到其方法中,如下例所示:
@Component
public class MyMathService {
@Cacheable("piDecimals")
public int computePiDecimal(int precision) {
...
}
}
@Component
class MyMathService {
@Cacheable("piDecimals")
fun computePiDecimal(precision: Int): Int {
...
}
}
此示例演示了在可能耗时的操作上使用缓存。在调用computePiDecimal
之前,抽象会查找与i
参数匹配的piDecimals
缓存条目。如果找到条目,则立即将缓存中的内容返回给调用者,并且不会调用该方法。否则,将调用该方法,并在返回值之前更新缓存。
您还可以透明地使用标准的JSR-107(JCache)注解(如@CacheResult )。但是,我们强烈建议不要混合使用Spring Cache和JCache注解。 |
如果没有添加任何特定的缓存库,Spring Boot会自动配置一个简单提供者,该提供者在内存中使用并发映射。当需要缓存(例如前面示例中的piDecimals
)时,此提供者会为您创建缓存。简单提供者并不真正推荐用于生产环境,但非常适合入门,确保您了解这些功能。当您确定要使用的缓存提供程序时,请务必阅读其文档,以了解如何配置应用程序使用的缓存。几乎所有提供程序都要求您显式配置应用程序中使用的每个缓存。有些提供了一种自定义默认缓存的方式,这些默认缓存由spring.cache.cache-names
属性定义。
1.1. 支持的缓存提供程序
缓存抽象并不提供实际存储,而是依赖于由org.springframework.cache.Cache
和org.springframework.cache.CacheManager
接口实现的抽象。
如果您没有定义类型为CacheManager
或名为cacheResolver
的CacheResolver
的bean(参见CachingConfigurer
),Spring Boot会尝试检测以下提供程序(按照指定的顺序):
-
JCache(JSR-107)(EhCache 3、Hazelcast、Infinispan等)
如果Spring Boot自动配置了CacheManager ,可以通过设置spring.cache.type 属性来强制使用特定的缓存提供程序。如果需要在某些环境(如测试)中使用无操作缓存,可以使用此属性。 |
使用spring-boot-starter-cache “Starter”可以快速添加基本的缓存依赖项。该Starter引入了spring-context-support 。如果手动添加依赖项,则必须包含spring-context-support 以便使用JCache或Caffeine支持。 |
如果Spring Boot自动配置了CacheManager
,您可以在完全初始化之前通过公开实现CacheManagerCustomizer
接口的bean来进一步调整其配置。以下示例设置一个标志,表示不应将null
值传递给底层映射:
@Configuration(proxyBeanMethods = false)
public class MyCacheManagerConfiguration {
@Bean
public CacheManagerCustomizer<ConcurrentMapCacheManager> cacheManagerCustomizer() {
return (cacheManager) -> cacheManager.setAllowNullValues(false);
}
}
@Configuration(proxyBeanMethods = false)
class MyCacheManagerConfiguration {
@Bean
fun cacheManagerCustomizer(): CacheManagerCustomizer<ConcurrentMapCacheManager> {
return CacheManagerCustomizer { cacheManager ->
cacheManager.isAllowNullValues = false
}
}
}
在上述示例中,预期存在自动配置的ConcurrentMapCacheManager 。如果不是这种情况(您提供了自己的配置或自动配置了不同的缓存提供程序),则根本不会调用自定义程序。您可以拥有任意数量的自定义程序,并且还可以使用@Order 或Ordered 对它们进行排序。 |
1.1.2. JCache(JSR-107)
JCache通过类路径上存在javax.cache.spi.CachingProvider
(即类路径上存在符合JSR-107的缓存库)来引导启动,并且JCacheCacheManager
由spring-boot-starter-cache
“Starter”提供。有多个符合标准的库可用,Spring Boot为Ehcache 3、Hazelcast和Infinispan提供了依赖管理。还可以添加任何其他符合标准的库。
可能会出现多个提供程序的情况,此时必须明确指定提供程序。即使JSR-107标准没有强制规定定义配置文件位置的标准化方式,Spring Boot也会尽力适应设置具有实现细节的缓存,如下例所示:
# 仅在存在多个提供程序时才需要
spring.cache.jcache.provider=com.example.MyCachingProvider
spring.cache.jcache.config=classpath:example.xml
# 仅在存在多个提供程序时才需要
spring:
cache:
jcache:
provider: "com.example.MyCachingProvider"
config: "classpath:example.xml"
当缓存库同时提供本地实现和JSR-107支持时,Spring Boot会优先选择JSR-107支持,以便在切换到不同的JSR-107实现时可用相同的功能。 |
Spring Boot对Hazelcast有通用支持。如果有单个HazelcastInstance 可用,则会自动重用该实例作为CacheManager ,除非指定了spring.cache.jcache.config 属性。 |
有两种方式可以自定义底层的javax.cache.cacheManager
:
-
通过设置
spring.cache.cache-names
属性,在启动时创建缓存。如果定义了自定义的javax.cache.configuration.Configuration
bean,则用于自定义它们。 -
调用
org.springframework.boot.autoconfigure.cache.JCacheManagerCustomizer
bean,使用CacheManager
的引用进行完全自定义。
如果定义了标准的javax.cache.CacheManager bean,则会自动将其包装在抽象期望的org.springframework.cache.CacheManager 实现中。不会对其进行进一步自定义。 |
1.1.3. Hazelcast
Spring Boot对Hazelcast有通用支持。如果已自动配置了HazelcastInstance
并且类路径上存在com.hazelcast:hazelcast-spring
,它会自动包装为CacheManager
。
Hazelcast可以作为符合JCache的缓存或符合Spring CacheManager 的缓存使用。将spring.cache.type 设置为hazelcast 时,Spring Boot将使用基于CacheManager 的实现。如果要将Hazelcast用作符合JCache的缓存,请将spring.cache.type 设置为jcache 。如果有多个符合JCache的缓存提供程序并希望强制使用Hazelcast,则必须显式设置JCache提供程序。 |
1.1.4. Infinispan
Infinispan没有默认的配置文件位置,因此必须明确指定。否则,将使用默认的引导。
spring.cache.infinispan.config=infinispan.xml
spring:
cache:
infinispan:
config: "infinispan.xml"
可以通过设置spring.cache.cache-names
属性在启动时创建缓存。如果定义了自定义的ConfigurationBuilder
bean,则用于自定义缓存。
为了与Spring Boot的Jakarta EE 9基线兼容,必须使用Infinispan的-jakarta
模块。对于每个带有-jakarta
变体的模块,必须使用该变体代替标准模块。例如,infinispan-core-jakarta
和infinispan-commons-jakarta
必须分别用于替代infinispan-core
和infinispan-commons
。
1.1.5. Couchbase
如果Spring Data Couchbase可用并且Couchbase已配置,将自动配置CouchbaseCacheManager
。可以通过设置spring.cache.cache-names
属性在启动时创建额外的缓存,并且可以使用spring.cache.couchbase.*
属性来配置缓存默认值。例如,以下配置创建具有10分钟过期时间的cache1
和cache2
缓存:
spring.cache.cache-names=cache1,cache2
spring.cache.couchbase.expiration=10m
spring:
cache:
cache-names: "cache1,cache2"
couchbase:
expiration: "10m"
如果需要更多对配置的控制,请考虑注册一个CouchbaseCacheManagerBuilderCustomizer
bean。以下示例显示了一个自定义器,为cache1
和cache2
配置了特定的条目过期时间:
@Configuration(proxyBeanMethods = false)
public class MyCouchbaseCacheManagerConfiguration {
@Bean
public CouchbaseCacheManagerBuilderCustomizer myCouchbaseCacheManagerBuilderCustomizer() {
return (builder) -> builder
.withCacheConfiguration("cache1", CouchbaseCacheConfiguration
.defaultCacheConfig().entryExpiry(Duration.ofSeconds(10)))
.withCacheConfiguration("cache2", CouchbaseCacheConfiguration
.defaultCacheConfig().entryExpiry(Duration.ofMinutes(1)));
}
}
@Configuration(proxyBeanMethods = false)
class MyCouchbaseCacheManagerConfiguration {
@Bean
fun myCouchbaseCacheManagerBuilderCustomizer(): CouchbaseCacheManagerBuilderCustomizer {
return CouchbaseCacheManagerBuilderCustomizer { builder ->
builder
.withCacheConfiguration(
"cache1", CouchbaseCacheConfiguration
.defaultCacheConfig().entryExpiry(Duration.ofSeconds(10))
)
.withCacheConfiguration(
"cache2", CouchbaseCacheConfiguration
.defaultCacheConfig().entryExpiry(Duration.ofMinutes(1))
)
}
}
}
1.1.6. Redis
如果Redis可用并已配置,将自动配置RedisCacheManager
。可以通过设置spring.cache.cache-names
属性在启动时创建额外的缓存,并且可以使用spring.cache.redis.*
属性来配置缓存默认值。例如,以下配置创建具有10分钟存活时间的cache1
和cache2
缓存:
spring.cache.cache-names=cache1,cache2
spring.cache.redis.time-to-live=10m
spring:
cache:
cache-names: "cache1,cache2"
redis:
time-to-live: "10m"
默认情况下,会添加键前缀,以便如果两个单独的缓存使用相同的键,则Redis不会有重叠的键,并且不会返回无效值。如果创建自己的RedisCacheManager ,强烈建议保持此设置启用。 |
您可以通过添加自己的RedisCacheConfiguration @Bean 来完全控制默认配置。如果需要自定义默认序列化策略,这可能很有用。 |
如果需要更多对配置的控制,请考虑注册一个RedisCacheManagerBuilderCustomizer
bean。以下示例显示了一个自定义器,为cache1
和cache2
配置了特定的存活时间:
@Configuration(proxyBeanMethods = false)
public class MyRedisCacheManagerConfiguration {
@Bean
public RedisCacheManagerBuilderCustomizer myRedisCacheManagerBuilderCustomizer() {
return (builder) -> builder
.withCacheConfiguration("cache1", RedisCacheConfiguration
.defaultCacheConfig().entryTtl(Duration.ofSeconds(10)))
.withCacheConfiguration("cache2", RedisCacheConfiguration
.defaultCacheConfig().entryTtl(Duration.ofMinutes(1)));
}
}
@Configuration(proxyBeanMethods = false)
class MyRedisCacheManagerConfiguration {
@Bean
fun myRedisCacheManagerBuilderCustomizer(): RedisCacheManagerBuilderCustomizer {
return RedisCacheManagerBuilderCustomizer { builder ->
builder
.withCacheConfiguration(
"cache1", RedisCacheConfiguration
.defaultCacheConfig().entryTtl(Duration.ofSeconds(10))
)
.withCacheConfiguration(
"cache2", RedisCacheConfiguration
.defaultCacheConfig().entryTtl(Duration.ofMinutes(1))
)
}
}
}
1.1.7. Caffeine
Caffeine是Guava缓存的Java 8重写版本,取代了对Guava的支持。如果存在Caffeine,则会自动配置一个CaffeineCacheManager
(由spring-boot-starter-cache
“Starter”提供)。可以通过设置spring.cache.cache-names
属性在启动时创建缓存,并可以通过以下任一方式进行自定义(按照指定的顺序):
-
由
spring.cache.caffeine.spec
定义的缓存规范 -
定义了一个
com.github.benmanes.caffeine.cache.CaffeineSpec
bean -
定义了一个
com.github.benmanes.caffeine.cache.Caffeine
bean
例如,以下配置将创建cache1
和cache2
缓存,最大大小为500,存活时间为10分钟
spring.cache.cache-names=cache1,cache2
spring.cache.caffeine.spec=maximumSize=500,expireAfterAccess=600s
spring:
cache:
cache-names: "cache1,cache2"
caffeine:
spec: "maximumSize=500,expireAfterAccess=600s"
如果定义了一个com.github.benmanes.caffeine.cache.CacheLoader
bean,则会自动关联到CaffeineCacheManager
。由于CacheLoader
将与缓存管理器管理的所有缓存相关联,因此必须将其定义为CacheLoader<Object, Object>
。自动配置会忽略任何其他泛型类型。
1.1.8. Cache2k
Cache2k是一个内存缓存。如果存在Cache2k spring集成,则会自动配置一个SpringCache2kCacheManager
。
可以通过设置spring.cache.cache-names
属性在启动时创建缓存。可以使用Cache2kBuilderCustomizer
bean自定义缓存默认值。以下示例显示了一个配置器,将缓存容量配置为200条记录,过期时间为5分钟:
@Configuration(proxyBeanMethods = false)
public class MyCache2kDefaultsConfiguration {
@Bean
public Cache2kBuilderCustomizer myCache2kDefaultsCustomizer() {
return (builder) -> builder.entryCapacity(200)
.expireAfterWrite(5, TimeUnit.MINUTES);
}
}
@Configuration(proxyBeanMethods = false)
class MyCache2kDefaultsConfiguration {
@Bean
fun myCache2kDefaultsCustomizer(): Cache2kBuilderCustomizer {
return Cache2kBuilderCustomizer { builder ->
builder.entryCapacity(200)
.expireAfterWrite(5, TimeUnit.MINUTES)
}
}
}
1.1.9. Simple
如果找不到其他提供程序,则会配置一个简单的实现,使用ConcurrentHashMap
作为缓存存储。如果应用程序中没有缓存库,则这是默认设置。默认情况下,会根据需要创建缓存,但可以通过设置cache-names
属性来限制可用缓存列表。例如,如果只想要cache1
和cache2
缓存,则将cache-names
属性设置如下:
spring.cache.cache-names=cache1,cache2
spring:
cache:
cache-names: "cache1,cache2"
如果这样做,且应用程序使用未列出的缓存,则在需要缓存但启动时未找到缓存时会在运行时失败。这类似于如果使用未声明的缓存,则“真实”缓存提供程序的行为方式。
2. Hazelcast
如果在类路径中找到Hazelcast并且存在合适的配置,Spring Boot会自动配置一个HazelcastInstance
,您可以在应用程序中注入它。
Spring Boot首先尝试通过检查以下配置选项来创建一个客户端:
-
存在
com.hazelcast.client.config.ClientConfig
bean。 -
由
spring.hazelcast.config
属性定义的配置文件。 -
存在
hazelcast.client.config
系统属性。 -
在工作目录或类路径根目录中存在
hazelcast-client.xml
。 -
在工作目录或类路径根目录中存在
hazelcast-client.yaml
(或hazelcast-client.yml
)。
如果无法创建客户端,Spring Boot会尝试配置一个嵌入式服务器。如果您定义了一个com.hazelcast.config.Config
bean,Spring Boot会使用它。如果您的配置定义了实例名称,Spring Boot会尝试定位现有实例而不是创建新实例。
您还可以通过配置指定要使用的Hazelcast配置文件,如以下示例所示:
spring.hazelcast.config=classpath:config/my-hazelcast.xml
spring:
hazelcast:
config: "classpath:config/my-hazelcast.xml"
否则,Spring Boot会尝试从默认位置查找Hazelcast配置:hazelcast.xml
在工作目录或类路径根目录中,或者在相同位置的YAML对应文件。我们还会检查hazelcast.config
系统属性是否已设置。有关更多详细信息,请参阅Hazelcast文档。
默认情况下,Hazelcast组件上的@SpringAware 受支持。可以通过声明一个HazelcastConfigCustomizer bean,并将其@Order 设置为大于零来覆盖ManagementContext 。 |
Spring Boot还为Hazelcast提供了显式缓存支持。如果启用了缓存,则HazelcastInstance 会自动包装在CacheManager 实现中。 |
3. Quartz Scheduler
Spring Boot为使用Quartz调度程序提供了几项便利功能,包括spring-boot-starter-quartz
“Starter”。如果Quartz可用,则会自动配置Scheduler
(通过SchedulerFactoryBean
抽象)。
以下类型的bean会自动被选中并与Scheduler
关联:
-
JobDetail
:定义特定的作业。可以使用JobBuilder
API构建JobDetail
实例。 -
Calendar
。 -
Trigger
:定义何时触发特定作业。
默认情况下,会使用内存中的JobStore
。但是,如果应用程序中有一个DataSource
bean可用,并且spring.quartz.job-store-type
属性已相应配置,则可以配置基于JDBC的存储,如以下示例所示:
spring.quartz.job-store-type=jdbc
spring:
quartz:
job-store-type: "jdbc"
当使用JDBC存储时,可以在启动时初始化模式,如以下示例所示:
spring.quartz.jdbc.initialize-schema=always
spring:
quartz:
jdbc:
initialize-schema: "always"
默认情况下,通过使用Quartz库提供的标准脚本来检测和初始化数据库。这些脚本会删除现有表,导致每次重新启动时删除所有触发器。还可以通过设置spring.quartz.jdbc.schema 属性来提供自定义脚本。 |
要使Quartz使用除应用程序主要DataSource
之外的DataSource
,请声明一个DataSource
bean,并将其@Bean
方法注释为@QuartzDataSource
。这样可以确保SchedulerFactoryBean
和模式初始化都使用Quartz特定的DataSource
。类似地,要使Quartz使用除应用程序主要TransactionManager
之外的TransactionManager
,请声明一个TransactionManager
bean,并将其@Bean
方法注释为@QuartzTransactionManager
。
默认情况下,通过配置创建的作业不会覆盖已从持久作业存储中读取的已注册作业。要启用覆盖现有作业定义,请设置spring.quartz.overwrite-existing-jobs
属性。
可以使用spring.quartz
属性和SchedulerFactoryBeanCustomizer
bean自定义Quartz调度程序配置,这允许对SchedulerFactoryBean
进行编程定制。还可以使用spring.quartz.properties.*
自定义高级Quartz配置属性。
特别是,Executor bean不会与调度程序关联,因为Quartz提供了一种通过spring.quartz.properties 配置调度程序的方法。如果需要自定义任务执行程序,请考虑实现SchedulerFactoryBeanCustomizer 。 |
作业可以定义setter方法来注入数据映射属性。常规bean也可以以类似的方式注入,如以下示例所示:
public class MySampleJob extends QuartzJobBean {
// Inject "MyService" bean
public void setMyService(MyService myService) {
this.myService = myService;
}
// Inject the "name" job data property
public void setName(String name) {
this.name = name;
}
@Override
protected void executeInternal(JobExecutionContext context) throws JobExecutionException {
this.myService.someMethod(context.getFireTime(), this.name);
}
}
class MySampleJob : QuartzJobBean() {
// Inject "MyService" bean
fun setMyService(myService: MyService?) {
this.myService = myService
}
// Inject the "name" job data property
fun setName(name: String?) {
this.name = name
}
override fun executeInternal(context: JobExecutionContext) {
myService!!.someMethod(context.fireTime, name)
}
}
4. 发送邮件
Spring框架通过JavaMailSender
接口提供了发送电子邮件的抽象,Spring Boot为其提供了自动配置以及一个启动器模块。
查看参考文档,详细解释如何使用JavaMailSender 。 |
如果spring.mail.host
和相关库(由spring-boot-starter-mail
定义)可用,则会创建默认的JavaMailSender
(如果不存在)。可以通过spring.mail
命名空间的配置项进一步自定义发件人。查看MailProperties
获取更多详细信息。
特别是,某些默认超时值是无限的,您可能希望更改以避免线程被无响应的邮件服务器阻塞,如下例所示:
spring.mail.properties[mail.smtp.connectiontimeout]=5000
spring.mail.properties[mail.smtp.timeout]=3000
spring.mail.properties[mail.smtp.writetimeout]=5000
spring:
mail:
properties:
"[mail.smtp.connectiontimeout]": 5000
"[mail.smtp.timeout]": 3000
"[mail.smtp.writetimeout]": 5000
还可以使用现有的JNDI中的Session
配置JavaMailSender
:
spring.mail.jndi-name=mail/Session
spring:
mail:
jndi-name: "mail/Session"
当设置了jndi-name
时,它将优先于所有其他与Session相关的设置。
5. 验证
只要JSR-303实现(如Hibernate验证器)在类路径上,Bean Validation 1.1支持的方法验证功能将自动启用。这使得可以在参数和/或返回值上使用jakarta.validation
约束来注释bean方法。具有此类注释方法的目标类需要在类型级别使用@Validated
注释,以便搜索内联约束注释。
例如,以下服务触发对第一个参数的验证,确保其大小在8到10之间:
@Service
@Validated
public class MyBean {
public Archive findByCodeAndAuthor(@Size(min = 8, max = 10) String code, Author author) {
return ...
}
}
@Service
@Validated
class MyBean {
fun findByCodeAndAuthor(code: @Size(min = 8, max = 10) String?, author: Author?): Archive? {
return null
}
}
应用程序的MessageSource
用于解析约束消息中的{parameters}
。这允许您使用应用程序的messages.properties
文件来进行Bean验证消息。一旦参数已解析,消息插值将使用Bean Validation的默认插值器完成。
要自定义用于构建ValidatorFactory
的Configuration
,请定义一个ValidationConfigurationCustomizer
bean。当定义了多个自定义器bean时,根据它们的@Order
注释或Ordered
实现的顺序调用它们。
6. 调用REST服务
Spring Boot提供了各种方便的方式来调用远程REST服务。如果您正在开发非阻塞的响应式应用,并且正在使用Spring WebFlux,那么您可以使用WebClient
。如果您更喜欢使用阻塞API,则可以使用RestClient
或RestTemplate
。
6.1. WebClient
如果您的类路径上有Spring WebFlux,我们建议您使用WebClient
来调用远程REST服务。WebClient
接口提供了一种函数式风格的API,并且完全是响应式的。您可以在专门的Spring Framework文档中的部分了解更多关于WebClient
的信息。
如果您不是在编写响应式的Spring WebFlux应用程序,可以使用RestClient 代替WebClient 。这提供了类似的函数式API,但是是阻塞的,而不是响应式的。 |
Spring Boot会为您创建并预配置一个原型WebClient.Builder
bean。强烈建议将其注入到您的组件中,并使用它来创建WebClient
实例。Spring Boot正在配置该构建器以共享HTTP资源,并以与服务器相同的方式反映编解码器设置(请参阅WebFlux HTTP编解码器自动配置),等等。
以下代码展示了一个典型的示例:
@Service
public class MyService {
private final WebClient webClient;
public MyService(WebClient.Builder webClientBuilder) {
this.webClient = webClientBuilder.baseUrl("https://example.org").build();
}
public Mono<Details> someRestCall(String name) {
return this.webClient.get().uri("/{name}/details", name).retrieve().bodyToMono(Details.class);
}
}
@Service
class MyService(webClientBuilder: WebClient.Builder) {
private val webClient: WebClient
init {
webClient = webClientBuilder.baseUrl("https://example.org").build()
}
fun someRestCall(name: String?): Mono<Details> {
return webClient.get().uri("/{name}/details", name)
.retrieve().bodyToMono(Details::class.java)
}
}
6.1.1. WebClient 运行时
Spring Boot会自动检测应用程序类路径上可用的库,以确定驱动WebClient
所使用的ClientHttpConnector
。按照优先顺序,支持以下客户端:
-
Reactor Netty
-
Jetty RS客户端
-
Apache HttpClient
-
JDK HttpClient
如果类路径上有多个客户端可用,则将使用最优先的客户端。
spring-boot-starter-webflux
启动器默认依赖于io.projectreactor.netty:reactor-netty
,它同时提供了服务器和客户端实现。如果您选择使用Jetty作为响应式服务器,您应该添加Jetty Reactive HTTP客户端库org.eclipse.jetty:jetty-reactive-httpclient
的依赖。在服务器和客户端之间使用相同的技术具有其优势,因为它将自动在客户端和服务器之间共享HTTP资源。
开发人员可以通过提供自定义的ReactorResourceFactory
或JettyResourceFactory
bean来覆盖Jetty和Reactor Netty的资源配置 - 这将应用于客户端和服务器。
如果您希望为客户端覆盖该选择,可以定义自己的ClientHttpConnector
bean,并完全控制客户端配置。
您可以在Spring Framework参考文档中了解更多关于WebClient
配置选项的信息。
6.1.2. WebClient 自定义
有三种主要方法可以对WebClient
进行自定义,取决于您希望自定义应用的范围有多广。
为了尽可能地缩小任何自定义的范围,可以注入自动配置的WebClient.Builder
,然后根据需要调用其方法。WebClient.Builder
实例是有状态的:构建器上的任何更改都会反映在随后使用它创建的所有客户端中。如果您希望使用相同的构建器创建多个客户端,还可以考虑使用WebClient.Builder other = builder.clone();
克隆构建器。
要对所有WebClient.Builder
实例进行应用范围广泛的附加自定义,可以声明WebClientCustomizer
bean,并在注入点本地更改WebClient.Builder
。
最后,您可以回退到原始API并使用WebClient.create()
。在这种情况下,不会应用任何自动配置或WebClientCustomizer
。
6.1.3. WebClient SSL支持
如果您需要在WebClient
使用的ClientHttpConnector
上进行自定义SSL配置,可以注入一个WebClientSsl
实例,该实例可以与构建器的apply
方法一起使用。
WebClientSsl
接口提供了访问您在application.properties
或application.yaml
文件中定义的任何SSL bundles的权限。
以下代码展示了一个典型的示例:
@Service
public class MyService {
private final WebClient webClient;
public MyService(WebClient.Builder webClientBuilder, WebClientSsl ssl) {
this.webClient = webClientBuilder.baseUrl("https://example.org").apply(ssl.fromBundle("mybundle")).build();
}
public Mono<Details> someRestCall(String name) {
return this.webClient.get().uri("/{name}/details", name).retrieve().bodyToMono(Details.class);
}
}
@Service
class MyService(webClientBuilder: WebClient.Builder, ssl: WebClientSsl) {
private val webClient: WebClient
init {
webClient = webClientBuilder.baseUrl("https://example.org")
.apply(ssl.fromBundle("mybundle")).build()
}
fun someRestCall(name: String?): Mono<Details> {
return webClient.get().uri("/{name}/details", name)
.retrieve().bodyToMono(Details::class.java)
}
}
6.2. RestClient
如果您的应用程序中没有使用Spring WebFlux或Project Reactor,我们建议您使用RestClient
来调用远程REST服务。
RestClient
接口提供了一种函数式风格的阻塞API。
Spring Boot会为您创建并预配置一个原型RestClient.Builder
bean。强烈建议在您的组件中注入它,并使用它来创建RestClient
实例。Spring Boot会使用HttpMessageConverters
和适当的ClientHttpRequestFactory
来配置该构建器。
以下代码展示了一个典型的示例:
@Service
public class MyService {
private final RestClient restClient;
public MyService(RestClient.Builder restClientBuilder) {
this.restClient = restClientBuilder.baseUrl("https://example.org").build();
}
public Details someRestCall(String name) {
return this.restClient.get().uri("/{name}/details", name).retrieve().body(Details.class);
}
}
@Service
class MyService(restClientBuilder: RestClient.Builder) {
private val restClient: RestClient
init {
restClient = restClientBuilder.baseUrl("https://example.org").build()
}
fun someRestCall(name: String?): Details {
return restClient.get().uri("/{name}/details", name)
.retrieve().body(Details::class.java)!!
}
}
6.2.1. RestClient定制
有三种主要方法可以对RestClient
进行定制,取决于您希望定制的范围有多广。
为了尽可能缩小任何定制的范围,可以注入自动配置的RestClient.Builder
,然后根据需要调用其方法。RestClient.Builder
实例是有状态的:对构建器的任何更改都会反映在随后使用它创建的所有客户端中。如果要使用相同的构建器创建多个客户端,还可以考虑使用RestClient.Builder other = builder.clone();
克隆构建器。
要对所有RestClient.Builder
实例进行应用范围广泛的附加定制,可以声明RestClientCustomizer
bean,并在注入点本地更改RestClient.Builder
。
最后,您可以退回到原始API并使用RestClient.create()
。在这种情况下,不会应用任何自动配置或RestClientCustomizer
。
6.2.2. RestClient SSL支持
如果您需要在RestClient
使用的ClientHttpRequestFactory
上进行自定义SSL配置,可以注入一个RestClientSsl
实例,该实例可与构建器的apply
方法一起使用。
RestClientSsl
接口提供了访问您在application.properties
或application.yaml
文件中定义的任何SSL bundles的方式。
以下代码展示了一个典型的示例:
@Service
public class MyService {
private final RestClient restClient;
public MyService(RestClient.Builder restClientBuilder, RestClientSsl ssl) {
this.restClient = restClientBuilder.baseUrl("https://example.org").apply(ssl.fromBundle("mybundle")).build();
}
public Details someRestCall(String name) {
return this.restClient.get().uri("/{name}/details", name).retrieve().body(Details.class);
}
}
@Service
class MyService(restClientBuilder: RestClient.Builder, ssl: RestClientSsl) {
private val restClient: RestClient
init {
restClient = restClientBuilder.baseUrl("https://example.org")
.apply(ssl.fromBundle("mybundle")).build()
}
fun someRestCall(name: String?): Details {
return restClient.get().uri("/{name}/details", name)
.retrieve().body(Details::class.java)!!
}
}
如果您需要在SSL bundle之外应用其他定制,可以使用ClientHttpRequestFactorySettings
类与ClientHttpRequestFactories
:
@Service
public class MyService {
private final RestClient restClient;
public MyService(RestClient.Builder restClientBuilder, SslBundles sslBundles) {
ClientHttpRequestFactorySettings settings = ClientHttpRequestFactorySettings.DEFAULTS
.withReadTimeout(Duration.ofMinutes(2))
.withSslBundle(sslBundles.getBundle("mybundle"));
ClientHttpRequestFactory requestFactory = ClientHttpRequestFactories.get(settings);
this.restClient = restClientBuilder.baseUrl("https://example.org").requestFactory(requestFactory).build();
}
public Details someRestCall(String name) {
return this.restClient.get().uri("/{name}/details", name).retrieve().body(Details.class);
}
}
@Service
class MyService(restClientBuilder: RestClient.Builder, sslBundles: SslBundles) {
private val restClient: RestClient
init {
val settings = ClientHttpRequestFactorySettings.DEFAULTS
.withReadTimeout(Duration.ofMinutes(2))
.withSslBundle(sslBundles.getBundle("mybundle"))
val requestFactory = ClientHttpRequestFactories.get(settings)
restClient = restClientBuilder
.baseUrl("https://example.org")
.requestFactory(requestFactory).build()
}
fun someRestCall(name: String?): Details {
return restClient.get().uri("/{name}/details", name).retrieve().body(Details::class.java)!!
}
}
6.3. RestTemplate
Spring Framework的RestTemplate
类早于RestClient
,是许多应用程序调用远程REST服务的经典方式。当您有现有代码不想迁移到RestClient
,或者因为您已经熟悉RestTemplate
API时,您可能会选择使用RestTemplate
。
由于RestTemplate
实例经常需要在使用之前进行自定义,Spring Boot不提供任何单个自动配置的RestTemplate
bean。但是,它会自动配置一个RestTemplateBuilder
,可以在需要时用于创建RestTemplate
实例。自动配置的RestTemplateBuilder
确保为RestTemplate
实例应用了明智的HttpMessageConverters
和适当的ClientHttpRequestFactory
。
以下代码展示了一个典型的示例:
@Service
public class MyService {
private final RestTemplate restTemplate;
public MyService(RestTemplateBuilder restTemplateBuilder) {
this.restTemplate = restTemplateBuilder.build();
}
public Details someRestCall(String name) {
return this.restTemplate.getForObject("/{name}/details", Details.class, name);
}
}
@Service
class MyService(restTemplateBuilder: RestTemplateBuilder) {
private val restTemplate: RestTemplate
init {
restTemplate = restTemplateBuilder.build()
}
fun someRestCall(name: String): Details {
return restTemplate.getForObject("/{name}/details", Details::class.java, name)!!
}
}
RestTemplateBuilder
包含许多有用的方法,可用于快速配置RestTemplate
。例如,要添加BASIC身份验证支持,您可以使用builder.basicAuthentication("user", "password").build()
。
6.3.1. RestTemplate自定义
有三种主要方法可以自定义RestTemplate
,取决于您希望自定义应用的广泛程度。
为了尽可能缩小任何自定义的范围,可以注入自动配置的RestTemplateBuilder
,然后根据需要调用其方法。每次方法调用都会返回一个新的RestTemplateBuilder
实例,因此自定义仅影响此构建器的使用。
要进行应用程序范围的附加自定义,请使用RestTemplateCustomizer
bean。所有这些bean都会自动注册到自动配置的RestTemplateBuilder
中,并应用于使用它构建的任何模板。
以下示例展示了一个自定义器,配置了除192.168.0.5
之外的所有主机使用代理:
public class MyRestTemplateCustomizer implements RestTemplateCustomizer {
@Override
public void customize(RestTemplate restTemplate) {
HttpRoutePlanner routePlanner = new CustomRoutePlanner(new HttpHost("proxy.example.com"));
HttpClient httpClient = HttpClientBuilder.create().setRoutePlanner(routePlanner).build();
restTemplate.setRequestFactory(new HttpComponentsClientHttpRequestFactory(httpClient));
}
static class CustomRoutePlanner extends DefaultProxyRoutePlanner {
CustomRoutePlanner(HttpHost proxy) {
super(proxy);
}
@Override
protected HttpHost determineProxy(HttpHost target, HttpContext context) throws HttpException {
if (target.getHostName().equals("192.168.0.5")) {
return null;
}
return super.determineProxy(target, context);
}
}
}
class MyRestTemplateCustomizer : RestTemplateCustomizer {
override fun customize(restTemplate: RestTemplate) {
val routePlanner: HttpRoutePlanner = CustomRoutePlanner(HttpHost("proxy.example.com"))
val httpClient: HttpClient = HttpClientBuilder.create().setRoutePlanner(routePlanner).build()
restTemplate.requestFactory = HttpComponentsClientHttpRequestFactory(httpClient)
}
internal class CustomRoutePlanner(proxy: HttpHost?) : DefaultProxyRoutePlanner(proxy) {
@Throws(HttpException::class)
public override fun determineProxy(target: HttpHost, context: HttpContext): HttpHost? {
if (target.hostName == "192.168.0.5") {
return null
}
return super.determineProxy(target, context)
}
}
}
最后,您可以定义自己的RestTemplateBuilder
bean。这样将替换自动配置的构建器。如果您希望任何RestTemplateCustomizer
bean被应用于您的自定义构建器,就像自动配置所做的那样,可以使用RestTemplateBuilderConfigurer
进行配置。以下示例公开了一个RestTemplateBuilder
,与Spring Boot的自动配置所做的匹配,只是还指定了自定义的连接和读取超时时间:
@Configuration(proxyBeanMethods = false)
public class MyRestTemplateBuilderConfiguration {
@Bean
public RestTemplateBuilder restTemplateBuilder(RestTemplateBuilderConfigurer configurer) {
return configurer.configure(new RestTemplateBuilder())
.setConnectTimeout(Duration.ofSeconds(5))
.setReadTimeout(Duration.ofSeconds(2));
}
}
@Configuration(proxyBeanMethods = false)
class MyRestTemplateBuilderConfiguration {
@Bean
fun restTemplateBuilder(configurer: RestTemplateBuilderConfigurer): RestTemplateBuilder {
return configurer.configure(RestTemplateBuilder()).setConnectTimeout(Duration.ofSeconds(5))
.setReadTimeout(Duration.ofSeconds(2))
}
}
最极端(并且很少使用)的选项是创建自己的RestTemplateBuilder
bean,而不使用配置器。除了替换自动配置的构建器外,这还会阻止使用任何RestTemplateCustomizer
bean。
6.3.2. RestTemplate SSL支持
如果您需要在RestTemplate
上进行自定义SSL配置,可以像本示例中所示将一个SSL包应用到RestTemplateBuilder
中:
@Service
public class MyService {
private final RestTemplate restTemplate;
public MyService(RestTemplateBuilder restTemplateBuilder, SslBundles sslBundles) {
this.restTemplate = restTemplateBuilder.setSslBundle(sslBundles.getBundle("mybundle")).build();
}
public Details someRestCall(String name) {
return this.restTemplate.getForObject("/{name}/details", Details.class, name);
}
}
@Service
class MyService(restTemplateBuilder: RestTemplateBuilder, sslBundles: SslBundles) {
private val restTemplate: RestTemplate
init {
restTemplate = restTemplateBuilder.setSslBundle(sslBundles.getBundle("mybundle")).build()
}
fun someRestCall(name: String): Details {
return restTemplate.getForObject("/{name}/details", Details::class.java, name)!!
}
}
7. Web 服务
Spring Boot提供了Web服务自动配置,所以您只需定义您的端点
即可。
可以通过spring-boot-starter-webservices
模块轻松访问Spring Web 服务功能。
SimpleWsdl11Definition
和SimpleXsdSchema
bean可以自动为您的WSDL和XSD分别创建。为此,请配置它们的位置,如下例所示:
spring.webservices.wsdl-locations=classpath:/wsdl
spring:
webservices:
wsdl-locations: "classpath:/wsdl"
7.1. 使用 WebServiceTemplate 调用 Web 服务
如果您需要从应用程序调用远程 Web 服务,可以使用WebServiceTemplate
类。由于WebServiceTemplate
实例通常需要在使用之前进行自定义,Spring Boot不提供任何单个自动配置的WebServiceTemplate
bean。但是,它会自动配置一个WebServiceTemplateBuilder
,可在需要时用于创建WebServiceTemplate
实例。
以下代码显示了一个典型的示例:
@Service
public class MyService {
private final WebServiceTemplate webServiceTemplate;
public MyService(WebServiceTemplateBuilder webServiceTemplateBuilder) {
this.webServiceTemplate = webServiceTemplateBuilder.build();
}
public SomeResponse someWsCall(SomeRequest detailsReq) {
return (SomeResponse) this.webServiceTemplate.marshalSendAndReceive(detailsReq,
new SoapActionCallback("https://ws.example.com/action"));
}
}
@Service
class MyService(webServiceTemplateBuilder: WebServiceTemplateBuilder) {
private val webServiceTemplate: WebServiceTemplate
init {
webServiceTemplate = webServiceTemplateBuilder.build()
}
fun someWsCall(detailsReq: SomeRequest?): SomeResponse {
return webServiceTemplate.marshalSendAndReceive(
detailsReq,
SoapActionCallback("https://ws.example.com/action")
) as SomeResponse
}
}
默认情况下,WebServiceTemplateBuilder
会使用类路径上可用的HTTP客户端库检测合适的基于HTTP的WebServiceMessageSender
。您还可以按照以下方式自定义读取和连接超时时间:
@Configuration(proxyBeanMethods = false)
public class MyWebServiceTemplateConfiguration {
@Bean
public WebServiceTemplate webServiceTemplate(WebServiceTemplateBuilder builder) {
WebServiceMessageSender sender = new HttpWebServiceMessageSenderBuilder()
.setConnectTimeout(Duration.ofSeconds(5))
.setReadTimeout(Duration.ofSeconds(2))
.build();
return builder.messageSenders(sender).build();
}
}
@Configuration(proxyBeanMethods = false)
class MyWebServiceTemplateConfiguration {
@Bean
fun webServiceTemplate(builder: WebServiceTemplateBuilder): WebServiceTemplate {
val sender = HttpWebServiceMessageSenderBuilder()
.setConnectTimeout(Duration.ofSeconds(5))
.setReadTimeout(Duration.ofSeconds(2))
.build()
return builder.messageSenders(sender).build()
}
}
8. 使用JTA进行分布式事务
Spring Boot通过从JNDI中检索的事务管理器支持跨多个XA资源的分布式JTA事务。
当检测到JTA环境时,Spring的JtaTransactionManager
用于管理事务。自动配置的JMS、DataSource和JPA bean已升级以支持XA事务。您可以使用标准的Spring习语,如@Transactional
,来参与分布式事务。如果您在JTA环境中,但仍希望使用本地事务,可以将spring.jta.enabled
属性设置为false
以禁用JTA自动配置。
8.1. 使用Jakarta EE托管的事务管理器
如果将Spring Boot应用程序打包为war
或ear
文件并部署到Jakarta EE应用服务器,则可以使用应用服务器内置的事务管理器。Spring Boot尝试通过查看常见的JNDI位置(java:comp/UserTransaction
、java:comp/TransactionManager
等)自动配置事务管理器。当使用应用服务器提供的事务服务时,通常还希望确保所有资源由服务器管理并通过JNDI公开。Spring Boot尝试通过查找JNDI路径(java:/JmsXA
或java:/XAConnectionFactory
)自动配置JMS,并且您可以使用spring.datasource.jndi-name
属性来配置您的DataSource
。
8.2. 混合使用XA和非XA JMS连接
在使用JTA时,主要的JMS ConnectionFactory
bean具有XA意识并参与分布式事务。您可以将其注入到您的bean中,而无需使用任何@Qualifier
:
public MyBean(ConnectionFactory connectionFactory) {
// ...
}
在某些情况下,您可能希望通过使用非XA ConnectionFactory
来处理某些JMS消息。例如,您的JMS处理逻辑可能比XA超时时间长。
如果要使用非XA ConnectionFactory
,可以使用nonXaJmsConnectionFactory
bean:
public MyBean(@Qualifier("nonXaJmsConnectionFactory") ConnectionFactory connectionFactory) {
// ...
}
jmsConnectionFactory
bean也通过bean别名
xaJmsConnectionFactory
提供:
public MyBean(@Qualifier("xaJmsConnectionFactory") ConnectionFactory connectionFactory) {
// ...
}
8.3. 支持嵌入式事务管理器
XAConnectionFactoryWrapper
和XADataSourceWrapper
接口可用于支持嵌入式事务管理器。这些接口负责包装XAConnectionFactory
和XADataSource
bean,并将它们公开为常规的ConnectionFactory
和DataSource
bean,这些bean会透明地加入分布式事务。DataSource和JMS自动配置使用JTA变体,前提是您在ApplicationContext
中注册了JtaTransactionManager
bean和适当的XA包装器bean。