javascript
【译】Spring Boot Features
【更新中】本文大部分內(nèi)容翻譯自官方文檔https://docs.spring.io/spring-boot/docs/2.2.5.RELEASE/reference/html/spring-boot-features.html
文章目錄
- 1.Spring應(yīng)用程序
- 1.1 啟動(dòng)失敗
- 1.2 延遲初始化
- 1.3 自定義Banner
- 1.4 自定義SpringApplication
- 1.5 構(gòu)建流式API
- 1.6 Application事件和監(jiān)聽器
- 1.7 Web Environment
- 1.8 訪問(wèn)應(yīng)用程序參數(shù)
- 1.9 使用ApplicationRunner或CommandLineRunner
- 1.10 應(yīng)用程序退出
- 1.11 管理特性
- 2. 外部化配置
- 2.1 配置隨機(jī)值
- 2.2 訪問(wèn)命令行屬性
- 2.3 應(yīng)用程序?qū)傩晕募?/li>
- 2.4 Profile-specific屬性
- 2.5 占位符屬性
- 2.6 加密屬性
- 2.7 使用YAML代替Properties
- 2.7.1 加載YAML
- 2.7.2 將YAML作為Properties公開在Spring環(huán)境
- 2.7.3 Multi-profile YAML文檔
- 2.7.4 YAML的不足
- 2.8 類型安全的配置屬性
- 2.8.1 JavaBean屬性綁定
- 2.8.2 構(gòu)造方法綁定
- 2.8.3 開啟```@ConfigurationProperties```注解類型
- 2.8.4 使用```@ConfigurationProperties```注解類型
- 2.8.5 第三方配置
- 2.8.6 寬松的綁定
- 2.8.7 合并復(fù)雜類型
- 2.8.8 屬性轉(zhuǎn)換
- 轉(zhuǎn)換時(shí)間(Converting durations)
- 轉(zhuǎn)換數(shù)據(jù)大小(Converting Data Sizes)
- 2.8.9 @ConfigurationProperties校驗(yàn)
- 2.8.10 @ConfigurationProperties和@Value
- 3. 配置文件
- 3.1 添加活動(dòng)的配置文件
- 3.2 以編程方式設(shè)置配置文件
- 3.3 Profile-specific配置文件
1.Spring應(yīng)用程序
The SpringApplication類提供了一種方便的方法來(lái)引導(dǎo)從main()方法啟動(dòng)的Spring應(yīng)用程序。你可以委托給SpringApplication.run方法,如下所示:
public static void main(String[] args) {SpringApplication.run(Application20200106.class, args); }應(yīng)用程序啟動(dòng),你應(yīng)該看到類似以下輸出:
. ____ _ __ _ _/\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \ ( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \\\/ ___)| |_)| | | | | || (_| | ) ) ) )' |____| .__|_| |_|_| |_\__, | / / / /=========|_|==============|___/=/_/_/_/:: Spring Boot :: v2.2.2.RELEASE2019-04-31 13:09:54.117 INFO 56603 --- [ main] o.s.b.s.app.SampleApplication : Starting SampleApplication v0.1.0 on mycomputer with PID 56603 (/apps/myapp.jar started by pwebb) 2019-04-31 13:09:54.166 INFO 56603 --- [ main] ationConfigServletWebServerApplicationContext : Refreshing org.springframework.boot.web.servlet.context.AnnotationConfigServletWebServerApplicationContext@6e5a8246: startup date [Wed Jul 31 00:08:16 PDT 2013]; root of context hierarchy 2019-04-01 13:09:56.912 INFO 41370 --- [ main] .t.TomcatServletWebServerFactory : Server initialized with port: 8080 2019-04-01 13:09:57.501 INFO 41370 --- [ main] o.s.b.s.app.SampleApplication : Started SampleApplication in 2.992 seconds (JVM running for 3.658)默認(rèn)情況下,會(huì)顯示INFO日志消息,包括一些相關(guān)的啟動(dòng)細(xì)節(jié),比如啟動(dòng)應(yīng)用程序的用戶。
如果你需要除了INFO級(jí)別的日志信息,你可以設(shè)置日志級(jí)別。
應(yīng)用程序版本是從主程序類包中的實(shí)現(xiàn)版本確定的。
設(shè)置spring.main.log-startup-info為false可以關(guān)閉啟動(dòng)日志信息記錄。
這還將關(guān)閉應(yīng)用程序活動(dòng)配置文件的日志記錄。
要在啟動(dòng)期間添加額外的日志記錄,您可以在SpringApplication的子類中重寫logStartupInfo(boolean)。
1.1 啟動(dòng)失敗
如果您的應(yīng)用程序啟動(dòng)失敗,注冊(cè)的FailureAnalyzers將有機(jī)會(huì)提供專用的錯(cuò)誤消息和修復(fù)問(wèn)題的具體操作。
例如,如果您在端口8080上啟動(dòng)一個(gè)web應(yīng)用程序,并且該端口已經(jīng)在使用,您應(yīng)該看到類似于以下消息:
Spring Boot提供了很多FailureAnalyzers實(shí)現(xiàn),你也可以創(chuàng)建自定義的故障分析器
如果沒(méi)有故障分析器能處理異常,你也可以顯示完整的條件報(bào)告,以便更好地理解出錯(cuò)的原因。您需要為org.springframework.boot.autoconfigure.logging.ConditionEvaluationReportLoggingListener啟用debug屬性或啟用DEBUG日志記錄。
例如,如果您使用java -jar運(yùn)行您的應(yīng)用程序,您可以啟用debug屬性,如下所示:
java -jar myproject-0.0.1-SNAPSHOT.jar --debug1.2 延遲初始化
開啟延遲初始化可以減少應(yīng)用程序所需的世界,在web應(yīng)用程序中,啟用延遲初始化將導(dǎo)致在接收到HTTP請(qǐng)求之前許多與web相關(guān)的bean不會(huì)被初始化。
延遲初始化的缺點(diǎn)是較晚得發(fā)現(xiàn)應(yīng)用程序中的問(wèn)題。如果一個(gè)錯(cuò)誤配置的bean是延遲初始化的,在啟動(dòng)期間不會(huì)出現(xiàn)故障,故障會(huì)發(fā)生bean被初始化的時(shí)候。
還必須注意確保JVM有足夠的內(nèi)存來(lái)容納應(yīng)用程序的所有bean,而不僅僅是只容納那些在啟動(dòng)期間初始化的bean。
由于這些原因,延遲初始化默認(rèn)是禁用的,建議在開啟延遲初始化之前對(duì)JVM的堆大小進(jìn)行微調(diào)(fine-tuning)。
用編程方式開啟延遲初始化:
使用SpringApplicationBuilder的lazyInitialization方法:
使用SpringApplication的setLazyInitialization方法:
SpringApplication springApplication = new SpringApplication(Application20200106.class); springApplication.setLazyInitialization(true);配置文件開啟延遲從初始化:
使用spring.main.lazy-initialization屬性:
如果你希望一部分bean使用延遲初始化,一部分bean禁用延遲初始化,你可以使用@Lazy(false)注解。
- lazy = true,表示延遲,默認(rèn)為true
- lazy = false,表示不延遲
1.3 自定義Banner
在classpath中添加一個(gè)banner.txt文件或者設(shè)置spring.banner.location屬性來(lái)改變?cè)趩?dòng)期間打印的banner。
如果文件編碼不是UTF-8,需要設(shè)置spring.banner.charset。
除了文本文件,還可以在classpath中添加banner.gif,banner.jpg,banner.png圖片文件。或者設(shè)置spring.banner.image.location屬性。
圖片被轉(zhuǎn)換成ASCII碼打印在任何文本banner上方。
在banner.txt文件中,可以使用下列占位符:
表1 Banner變量
| ${application.version} | 應(yīng)用程序的版本號(hào),和MANIFEST.MF一樣的聲明。例如,Implementation-Version: 1.0打印成1.0。 |
| ${application.formatted-version} | 應(yīng)用程序的版本號(hào),和MANIFEST.MF一樣,按照格式顯示(用圓括號(hào)括起來(lái)并且加上前綴v)。如(v1.0)。 |
| ${spring-boot.version} | 你在使用的Spring Boot版本,如2.2.2.RELEASE。 |
| ${spring-boot.formatted-version} | 你在使用的Spring Boot版本,按照格式顯示(用圓括號(hào)括起來(lái)并且加上前綴v)。如v2.2.2.RELEASE。 |
| ${Ansi.NAME} (or ${AnsiColor.NAME}, ${AnsiBackground.NAME}, ${AnsiStyle.NAME}) | NAME是ANSI轉(zhuǎn)義碼的名稱,詳情參見AnsiPropertySource。 |
| ${application.title} | 應(yīng)用程序的Title,和MANIFEST.MF一樣。如Implementation-Title: MyApp打印成MyApp。 |
如果你想用編程的方式生成一個(gè)banner,可以使用SpringApplication.setBanner(…)。
實(shí)現(xiàn)org.springframework.boot.Banner接口并重寫printBanner()方法。
You can also use the spring.main.banner-mode property to determine if the banner has to be printed on System.out (console), sent to the configured logger (log), or not produced at all (off).
你也可以使用spring.main.banner-mode屬性控制banner是否在System.out(console)被打印,或者發(fā)送到已配置的日志程序,或者關(guān)閉。
打印banner的bean被注冊(cè)成一個(gè)單例bean,名字為:springBootBanner。
1.4 自定義SpringApplication
如果默認(rèn)的SpringApplication不是你的菜,你可以創(chuàng)建一個(gè)本地實(shí)例并對(duì)其設(shè)置。例如,關(guān)閉banner:
public static void main(String[] args) {SpringApplication springApplication = new SpringApplication(Application20200106.class);springApplication.setBannerMode(Banner.Mode.OFF);springApplication.run(args); }傳給SpringApplication的構(gòu)造方法參數(shù)是Spring beans的配置源。在大多數(shù)情況下,都是引用@Configuration類,但是也可以引用XML配置或引用被掃描的包。
引用XML配置:
ResourceLoader resourceLoader = new ClassPathXmlApplicationContext("config/spring/user/applicationContext-user.xml"); SpringApplication springApplication = new SpringApplication(resourceLoader,Application20200106.class);引用被掃描的包:
配置類UserConfiguration:
package cn.shrmus.springboot.demo20200106.configuration;import org.springframework.context.annotation.ComponentScan; import org.springframework.context.annotation.Configuration;@ComponentScan("cn.shrmus.springboot.demo20200106.user") @Configuration public class UserConfiguration { }啟動(dòng)類Application20200106:
@Import(value = cn.shrmus.springboot.demo20200106.configuration.UserConfiguration.class) @SpringBootApplication public class Application20200106{public static void main(String[] args) {ResourceLoader resourceLoader = new AnnotationConfigApplicationContext("cn.shrmus.springboot.demo20200106.user"); // ResourceLoader resourceLoader = new AnnotationConfigApplicationContext(cn.shrmus.springboot.demo20200106.configuration.UserConfiguration.class);SpringApplication springApplication = new SpringApplication(resourceLoader,Application20200106.class);ConfigurableApplicationContext configurableApplicationContext = springApplication.run(args);UserController userController = configurableApplicationContext.getBean(UserController.class);System.out.println(userController);SpringApplication.exit(configurableApplicationContext);}也可以使用application.properties文件配置SpringApplication,詳情參考外部化配置。
要查看SpringApplication的完整配置,參考SpringApplicationJavadoc。
1.5 構(gòu)建流式API
如果需要構(gòu)建一個(gè)ApplicationCOntext層次結(jié)構(gòu)(具有父/子關(guān)系的多個(gè)上下文),或者你更喜歡使用構(gòu)建“流式”API,你可以使用SpringApplicationBuilder。
The SpringApplicationBuilderlets you chain together multiple method calls and includes parentand childmethods that let you create a hierarchy, as shown in the following example:
使用SpringApplicationBuilder將包含parent和child方法等多個(gè)方法的調(diào)用都鏈在一起,以此創(chuàng)建一個(gè)層次結(jié)構(gòu),如下:
new SpringApplicationBuilder().sources(Parent.class).child(Application.class).bannerMode(Banner.Mode.OFF).run(args);創(chuàng)建ApplicationContext層次結(jié)構(gòu)會(huì)有一些限制,Web組件被包含在子上下文中,父上下文和子上下文都使用同一個(gè)Environment。閱讀SpringApplicationBuilderJavadoc查看詳情。
1.6 Application事件和監(jiān)聽器
除了常見的Spring框架事件(如ContextRefreshedEvent)外,SpringApplication還發(fā)送一些額外的應(yīng)用程序事件。
有些事件是在創(chuàng)建ApplicationContext之前觸發(fā)的,所以不能將監(jiān)聽器注冊(cè)成@Bean,你可以使用SpringApplication.addListeners(…)方法或SpringApplicationBuilder.listeners(…)方法注冊(cè)它們。
如果你希望監(jiān)聽器能自動(dòng)注冊(cè),不管應(yīng)用程序時(shí)如何創(chuàng)建的,你可以在META-INF/spring.factories文件中使用org.springframework.context.ApplicationListener添加監(jiān)聽器的引用。如下:
org.springframework.context.ApplicationListener=cn.shrmus.springboot.demo20200106.listener.MyListener在程序運(yùn)行時(shí),應(yīng)用程序事件按一下順序發(fā)送:
上面的列表只包含綁定到SpringApplication中的SpringApplicationEvent。除此之外,以下事件會(huì)在ApplicationPreparedEvnet之后和ApplicationStartedEvent之前發(fā)布:
A WebServerInitializedEventis sent after the WebServeris ready. ServletWebServerInitializedEventand ReactiveWebServerInitializedEventare the servlet and reactive variants respectively.
通常不需要使用應(yīng)用程序事件,但是知道它們的存在是很方便的。在內(nèi)部,Spring Boot使用事件處理各種任務(wù)。
Application events are sent by using Spring Framework’s event publishing mechanism. Part of this mechanism ensures that an event published to the listeners in a child context is also published to the listeners in any ancestor contexts. As a result of this, if your application uses a hierarchy of SpringApplicationinstances, a listener may receive multiple instances of the same type of application event.
應(yīng)用程序事件是使用Spring框架的事件發(fā)布機(jī)制發(fā)送的。此機(jī)制的一部分確保將事件發(fā)布到子上下文中的監(jiān)聽器,也能將事件發(fā)布到任何祖先上下文的監(jiān)聽器。因此,如果你的應(yīng)用程序使用了SpringApplication實(shí)例的層次結(jié)構(gòu),則監(jiān)聽器可能會(huì)接收同一類型應(yīng)用程序事件的多個(gè)實(shí)例。
To allow your listener to distinguish between an event for its context and an event for a descendant context, it should request that its application context is injected and then compare the injected context with the context of the event. The context can be injected by implementing ApplicationContextAwareor, if the listener is a bean, by using @Autowired.
允許監(jiān)聽器區(qū)分它的上下文事件和子上下文的事件,它應(yīng)該請(qǐng)求注入它的應(yīng)用程序上下文,然后將注入的上下文與事件的上下文比較。上下文可以通過(guò)ApplicationContextAware實(shí)現(xiàn)注入,或者,如果監(jiān)聽器是bean,可以通過(guò)@Autowired注入。
1.7 Web Environment
一個(gè)SpringApplication會(huì)替你創(chuàng)建正確類型的ApplicationContext。用于確定WebApplicationType的算法相當(dāng)簡(jiǎn)單:
- 如果存在Spring MVC,使用AnnotationConfigServletWebServerApplicationContext
- 如果不在存Spring MVC,但是存在Spring WebFlux,使用AnnotationConfigReactiveWebServerApplicationContext
- 否則,使用AnnotationConfigApplicationContext
這意味著如果你同一個(gè)應(yīng)用程序中使用Spring MVC和來(lái)自于Spring WebFlux的WebClinet,那么默認(rèn)情況下使用Spring MVC。
你也可以通過(guò)調(diào)用setWebApplicationType(WebApplicationType)來(lái)覆蓋它。
還可以通過(guò)調(diào)用setApplicationContextClass(…)完全控制ApplicationContext類型。
在Junit測(cè)試中使用ApplicationContext時(shí),通常需要調(diào)用setWebApplicationType(WebApplicationType.NONE)。
1.8 訪問(wèn)應(yīng)用程序參數(shù)
如果你需要訪問(wèn)傳遞給SpringApplication.run(…)的應(yīng)用程序參數(shù),則需要注入org.springframework.boot.ApplicationArguments。
The ApplicationArgumentsinterface provides access to both the raw String[]arguments as well as parsed optionand non-optionarguments.
接口ApplicationArguments提供對(duì)原始String[]參數(shù)和解析過(guò)的option和non-option參數(shù)的訪問(wèn)。如下:
import org.springframework.boot.*; import org.springframework.beans.factory.annotation.*; import org.springframework.stereotype.*;@Component public class MyBean {@Autowiredpublic MyBean(ApplicationArguments args) {boolean debug = args.containsOption("debug");List<String> files = args.getNonOptionArgs();// if run with "--debug logfile.txt" debug=true, files=["logfile.txt"]} }Spring Boot還可以向Spring Environment注冊(cè)一個(gè)CommandLinePropertySource。還可以使用@Value注解注入單個(gè)應(yīng)用程序參數(shù)。
1.9 使用ApplicationRunner或CommandLineRunner
如果你需要在SpringApplication啟動(dòng)后運(yùn)行一些特定的代碼,你可以實(shí)現(xiàn)ApplicationRunner或者CommandLineRunner接口。
這兩個(gè)接口以相同的方式工作,并提供一個(gè)單一的run方法,這個(gè)方法在SpringApplication.run(…)結(jié)束之前被調(diào)用。
接口CommandLineRunner以簡(jiǎn)單字符串?dāng)?shù)組的形式提供對(duì)應(yīng)用程序參數(shù)的訪問(wèn),而ApplicationRunner使用談?wù)撨^(guò)的ApplicationArguments。下面的例子展示帶run方法的CommandLineRunner:
import org.springframework.boot.*; import org.springframework.stereotype.*;@Component public class MyBean implements CommandLineRunner {public void run(String... args) {// Do something...} }如果定義了多個(gè)CommandLineRunner或ApplicationRunnerbean,必須按特定的順序調(diào)用它們。可以通過(guò)實(shí)現(xiàn)org.springframework.core.Ordered接口或org.springframework.core.annotation.Order注解控制調(diào)用順序。
1.10 應(yīng)用程序退出
每個(gè)SpringApplication向JVM注冊(cè)一個(gè)shotdown hook確保ApplicationContext在退出時(shí)能夠優(yōu)雅地關(guān)閉。所有標(biāo)準(zhǔn)的Spring生命周期回調(diào)(例如DisposableBean接口或@PreDestroy注解)都會(huì)被使用。
另外,如果希望SpringApplication.exit()被調(diào)用時(shí)返回特殊的退出碼,可以實(shí)現(xiàn)org.springframework.boot.ExitCodeGenerator接口。這個(gè)退出碼會(huì)被傳遞給System.exit()作為狀態(tài)碼返回。如下:
@SpringBootApplication public class ExitCodeApplication {@Beanpublic ExitCodeGenerator exitCodeGenerator() {return () -> 42;}public static void main(String[] args) {System.exit(SpringApplication.exit(SpringApplication.run(ExitCodeApplication.class, args)));} }此外,接口ExitCodeGenerator可以由異常實(shí)現(xiàn)。當(dāng)遇到這樣的異常,Spring Boot將返回退出碼,退出碼是實(shí)現(xiàn)這個(gè)接口時(shí)重寫getExitCode()方法提供的退出碼。
import org.springframework.boot.ExitCodeGenerator;public class CustomizingException extends Exception implements ExitCodeGenerator {@Overridepublic int getExitCode() {return 43;} }1.11 管理特性
通過(guò)指定spring.application.admin.enabled屬性來(lái)為應(yīng)用程序開啟管理相關(guān)的特性。這將在MBeanServer平臺(tái)上公開SpringApplicationAdminMXBean。你可以使用這個(gè)特性來(lái)管理你的Spring Boot遠(yuǎn)程應(yīng)用程序。這個(gè)特性對(duì)于任何服務(wù)包裝器實(shí)現(xiàn)都是有用的。
如果你想知道應(yīng)用程序在哪個(gè)HTTP端口上運(yùn)行,獲取local.server.port屬性的值。
2. 外部化配置
Spring Boot允許您將配置外部化,以便可以在不同的環(huán)境中使用相同的應(yīng)用程序代碼。你可以使用properties文件,YAML文件,環(huán)境變量和命令行參數(shù)外部化配置。屬性值可以通過(guò)使用@Value注解直接注入到bean中。通過(guò)Spring的Environment抽象訪問(wèn),或通過(guò)@ConfigurationProperties綁定到結(jié)構(gòu)化對(duì)象。
Spring Boot使用一種非常特殊的PropertySource順序,其設(shè)計(jì)目的是允許合理地覆蓋值。屬性按以下順序排序:
舉一個(gè)具體的例子,假設(shè)你開發(fā)的一個(gè)@Component類使用name屬性,如下:
import org.springframework.stereotype.*; import org.springframework.beans.factory.annotation.*;@Component public class MyBean {@Value("${name}")private String name;// ...}在你的應(yīng)用程序classpath(jar內(nèi))中的application.properties文件為name提供一個(gè)合理的默認(rèn)屬性值。在新environment中運(yùn)行時(shí),可以在jar之外提供一個(gè)application.properties文件覆蓋name。對(duì)于一次性測(cè)試,可以使用特定的命令行開關(guān)啟動(dòng)(java -jar app.jar --name="Spring")。
在帶有環(huán)境變量的命令行上提供SPRING_APPLICATION_JSON屬性,使用下面的UNIX shell:
$ SPRING_APPLICATION_JSON='{"acme":{"name":"test"}}' java -jar myapp.jar在前面的例子中,在Spring Environment以acme.name=test結(jié)束。你還可以在系統(tǒng)屬性中用spring.application.json提供JSON。如下:
$ java -Dspring.application.json='{"name":"test"}' -jar myapp.jar還可以使用命令行參數(shù)提供JSON,如下:
$ java -jar myapp.jar --spring.application.json='{"name":"test"}'還可以使用JNDI變量提供JSON,如下:
java:comp/env/spring.application.json2.1 配置隨機(jī)值
用于注入隨機(jī)值的RandomValuePropertySource是非常有用的(作為秘鑰或測(cè)試用例)。它可以生成integers,longs,uuids,strings。如下:
my.secret=${random.value} my.number=${random.int} my.bignumber=${random.long} my.uuid=${random.uuid} my.number.less.than.ten=${random.int(10)} my.number.in.range=${random.int[1024,65536]}語(yǔ)法:random.int*的語(yǔ)法是OPEN value (,max) CLOSE,其中OPEN,CLOSE是任意字符,value,max是整數(shù)。如果提供max,則value為最小值,max為最大值(不含)。
2.2 訪問(wèn)命令行屬性
默認(rèn)情況下,SpringApplication將任何命令行選項(xiàng)參數(shù)(參數(shù)以--開頭,如--server.port=9000)轉(zhuǎn)換為property,并將它們添加到Spring Environment中。
As mentioned previously, command line properties always take precedence over other property sources.
就如前面所說(shuō),命令行屬性始終優(yōu)先于其它屬性源。
如果不希望將命令行屬性添加到Environment中,可以使用SpringApplication.setAddCommandLineProperties(false)來(lái)禁用。
=myproject
通過(guò)spring.config.location指定文件位置:
$ java -jar myproject.jar --spring.config.location=classpath:/default.properties,classpath:/override.propertiesspring.config.name和spring.config.location很早就用于確定必須加載哪些文件。它們必須定義為環(huán)境屬性(通常是操作系統(tǒng)環(huán)境變量,系統(tǒng)屬性,命令行參數(shù))。
如果spring.config.location包含目錄(與文件相反),它們應(yīng)該以/結(jié)尾(在運(yùn)行時(shí),在加載前附加由spring.config.name生成的名稱,包含profile-specific文件名)。spring.config.location中指定的文件按原樣使用,不支持profile-specific變體,并被任何profile-specific屬性覆蓋。
配置位置以相反的順序搜索。默認(rèn)情況下,配置位置是classpath:/,classpath:/config/,file:./,file:./config/。搜索結(jié)果的順序如下:
當(dāng)使用spring.config.location自定義配置位置時(shí),它們替代默認(rèn)的位置。例如,如果spring.config.location的值被配置成classpath:/custom-config/,file:./custom-config/,搜索順序如下:
作為選擇,當(dāng)使用spring.config.additional-location自定義配置位置時(shí),它們被使用除默認(rèn)位置外。附加位置在默認(rèn)位置之前被搜索。例如,如果附加位置classpath:/custom-config/,file:./custom-config/被配置,搜索順序如下:
This search ordering lets you specify default values in one configuration file and then selectively override those values in another. You can provide default values for your application in application.properties(or whatever other basename you choose with spring.config.name) in one of the default locations. These default values can then be overridden at runtime with a different file located in one of the custom locations.
這種搜索順序允許您在一個(gè)配置文件中指定默認(rèn)值,然后有選擇地在另一個(gè)配置文件中覆蓋這些值。你可以在一個(gè)默認(rèn)位置的application.properties中為你的應(yīng)用程序提供默認(rèn)值(或你選擇的任何其他基本的spring.config.name)。在運(yùn)行時(shí)使用位于自定義位置中另一個(gè)文件覆蓋這些默認(rèn)值。
如果使用環(huán)境變量而不是系統(tǒng)屬性,大部分操作系統(tǒng)不允許點(diǎn)分隔(period-separated)的鍵名,但你可以使用下劃線(SPRING_CONFIG_NAME代替spring.config.name)。
如果應(yīng)用程序在容器中運(yùn)行,然后可以使用JNDI屬性(在java:comp/env中)或servlet上下文初始化參數(shù)來(lái)代替環(huán)境變量或系統(tǒng)屬性。
2.4 Profile-specific屬性
除application.properties文件之外,profile-specific屬性也能通過(guò)使用application-{profile}.properties命名約定被定義。Environment有一組默認(rèn)配置文件(默認(rèn)情況下,[default]),如果沒(méi)有設(shè)置活動(dòng)配置文件,就使用這些默認(rèn)配置文件。換句話說(shuō),如果沒(méi)有配置文件被明確激活,那么屬性從application-default.properties被加載。
Profile-specific屬性從與標(biāo)準(zhǔn)application.properties相同的位置加載,使用profile-specific文件總是覆蓋non-specific文件,不管profile-specific文件位于打包的jar的內(nèi)部或外部。
If several profiles are specified, a last-wins strategy applies. For example, profiles specified by the spring.profiles.activeproperty are added after those configured through the SpringApplicationAPI and therefore take precedence.
如果多個(gè)配置文件被指定,則應(yīng)用最后配置的策略。例如,spring.profiles.active屬性指定的配置文件添加在通過(guò)SpringApplicationAPI配置之后,因此優(yōu)先。
假設(shè)application.properties中有如下配置:
spring.profiles.active=pro,dev最終生效的是application-dev.properties文件。
如果你在spring.config.location指定了一些文件,profile-specific的變體不被考慮。如果你想使用profile-specific屬性,在spring.config.location中使用目錄。
2.5 占位符屬性
文件application.properties中的值在使用時(shí)通過(guò)現(xiàn)有的Environment過(guò)濾,所以你可以返回到以前定義的值(例如,系統(tǒng)屬性中定義的值)。
app.name=MyApp app.description=${app.name} is a Spring Boot application您還可以使用此技術(shù)創(chuàng)建現(xiàn)有Spring Boot屬性的“短”變體。點(diǎn)擊howto.html查看詳情。
2.6 加密屬性
Spring Boot不提供任何對(duì)屬性值加密的支持,然而,它提供了修改Spring Environment中包含的值所必須的hook點(diǎn)。EnvironmentPostProcessor接口允許你在應(yīng)用啟動(dòng)之前操作(manipulate)Environment。點(diǎn)擊howto.html查看詳情。
如果您正在尋找一種安全的方式來(lái)存儲(chǔ)憑證和密碼,Spring Cloud Vault項(xiàng)目提供了在HashiCorp Vault中存儲(chǔ)外部化配置的支持。
2.7 使用YAML代替Properties
YAML是JSON的超集,因此是指定分層配置數(shù)據(jù)的一種方便的格式。當(dāng)你的classpath中有SnakeYAML庫(kù)時(shí),SpringApplication類自動(dòng)支持YAML作為properties的另一種選擇。
SnakeYAML是由spring-boot-starter自動(dòng)提供的。
2.7.1 加載YAML
Spring框架提供了兩個(gè)方便的類用于加載YAML文檔。YamlPropertiesFactoryBean將YAML加載為Properties,YamlMapFactoryBean將YAML加載為Map。
例如:參考以下YAML文檔:
environments:dev:url: https://dev.example.comname: Developer Setupprod:url: https://another.example.comname: My Cool App將上述YAML文檔轉(zhuǎn)換為下列properties:
environments.dev.url=https://dev.example.com environments.dev.name=Developer Setup environments.prod.url=https://another.example.com environments.prod.name=My Cool AppYAML列表用[index]作為引用,代表屬性鍵。如下:
my:servers:- dev.example.com- another.example.com將上述YAML文檔轉(zhuǎn)換為下列properties:
my.servers[0]=dev.example.com my.servers[1]=another.example.com通過(guò)使用Spring Boot的Binder工具(@ConfigurationProperties就是這么做的)來(lái)綁定這樣的屬性。如果在目標(biāo)bean中有java.util.List(或者Set)類型的屬性,你需要提供setter或使用可變值初始化它。下面的例子綁定到上述屬性:
@ConfigurationProperties(prefix="my") public class Config {private List<String> servers = new ArrayList<String>();public List<String> getServers() {return this.servers;} }2.7.2 將YAML作為Properties公開在Spring環(huán)境
類YamlPropertySourceLoader可將YAML作為PropertySource公開在Spring環(huán)境中。這樣就可以使用帶有占位符語(yǔ)法的@Value注解來(lái)訪問(wèn)YAML屬性。
2.7.3 Multi-profile YAML文檔
通過(guò)使用spring.profiles鍵,你可以在一個(gè)文件中指定多個(gè)profile-specific YAML文檔,指定文檔何時(shí)應(yīng)用,如下:
server:address: 192.168.1.100 --- spring:profiles: development server:address: 127.0.0.1 --- spring:profiles: production & eu-central server:address: 192.168.1.120如果development配置文件是激活的,那么server.address的屬性值為127.0.0.1。
同理,如果production和eu-central配置文件是激活的,server.address的屬性值為192.168.1.120。
如果development,production和eu-central配置文件都沒(méi)有啟用,那么server.address的屬性值為192.168.1.100。
spring.profiles可以包含簡(jiǎn)單的配置文件名(如production)或配置文件表達(dá)式。配置文件表達(dá)式允許表達(dá)更復(fù)雜的配置文件邏輯,如production & (eu-central | eu-west)。查看參考指南了解更多詳情。
如果在應(yīng)用程序上下文啟動(dòng)時(shí)沒(méi)有顯式激活配置文件,則默認(rèn)配置文件將被激活。因此,在下列YAML中,我們?yōu)閟pring.security.user.password設(shè)置了一個(gè)僅在默認(rèn)配置文件中可用的值:
server:port: 8000 --- spring:profiles: defaultsecurity:user:password: weak然而,在下面的例子中,密碼總是被設(shè)置,因?yàn)樗鼪](méi)有附加到任何配置文件中,而且它必須在所有其他配置文件中被顯式重置:
server:port: 8000 spring:security:user:password: weakSpring profiles designated by using the spring.profileselement may optionally be negated by using the !character. If both negated and non-negated profiles are specified for a single document, at least one non-negated profile must match, and no negated profiles may match.
使用spring.profiles元素指定的Spring配置文件通過(guò)使用!字符選擇性地否定。如果為單個(gè)文檔指定了否定配置文件和非否定配置文件,至少有一個(gè)非否定的配置文件必須匹配,并且否定的配置文件不能匹配。
2.7.4 YAML的不足
YAML文件不能通過(guò)@PropertySource注解加載。因此,在需要以這種方式加載值的情況下,需要使用屬性文件。
在profile-specific YAML文件中使用multi YAML文檔語(yǔ)法可能導(dǎo)致意外發(fā)生。如下:
application-dev.yml
server:port: 8000 --- spring:profiles: "!test"security:user:password: "secret"如果使用參數(shù)--spring.profiles.active=dev運(yùn)行應(yīng)用程序,你可能希望security.user.password設(shè)置為secret,但是并不會(huì)。
嵌套的文檔將被過(guò)濾,因?yàn)橹魑募麨閍pplication-dev.yml。它已經(jīng)被認(rèn)為是profile-specific,嵌套文檔將被忽略。
建議不要將profile-specific YAML文件和多個(gè)YAML文檔混合使用。只使用其中一個(gè)。
2.8 類型安全的配置屬性
使用@Value("${property}")注解注入配置屬性有時(shí)會(huì)很麻煩(cumbersome),特別(especially)是在處理多個(gè)屬性或數(shù)據(jù)本質(zhì)上是分層的情況下。Spring Boot提供了另一種處理屬性的方法,允許強(qiáng)類型bean控制和驗(yàn)證應(yīng)用程序的配置。
請(qǐng)參見@Value和類型安全的配置屬性之間的區(qū)別。
2.8.1 JavaBean屬性綁定
可以綁定一個(gè)聲明標(biāo)準(zhǔn)JavaBean屬性的bean,如下面的例子所示:
package com.example;import java.net.InetAddress; import java.util.ArrayList; import java.util.Collections; import java.util.List;import org.springframework.boot.context.properties.ConfigurationProperties;@ConfigurationProperties("acme") public class AcmeProperties {private boolean enabled;private InetAddress remoteAddress;private final Security security = new Security();public boolean isEnabled() { ... }public void setEnabled(boolean enabled) { ... }public InetAddress getRemoteAddress() { ... }public void setRemoteAddress(InetAddress remoteAddress) { ... }public Security getSecurity() { ... }public static class Security {private String username;private String password;private List<String> roles = new ArrayList<>(Collections.singleton("USER"));public String getUsername() { ... }public void setUsername(String username) { ... }public String getPassword() { ... }public void setPassword(String password) { ... }public List<String> getRoles() { ... }public void setRoles(List<String> roles) { ... }} }上述POJO定義了下列屬性:
- acme.enabled,默認(rèn)值為false。
- acme.remote-address,可以強(qiáng)制使用來(lái)自String的類型。
- acme.security.username,嵌套的"security"對(duì)象,其名稱由屬性的名稱決定。特別是(In particular),返回類型沒(méi)有被使用,可能是SecurityProperties。
- acme.security.password。
- acme.security.roles,默認(rèn)是USER的String集合。
Spring Boot自動(dòng)配置大量使用@ConfigurationProperties來(lái)輕松配置自動(dòng)配置的bean。
類似于自動(dòng)配置類,在Spring Boot中可用的@ConfigurationProperties類僅供內(nèi)部使用。
The properties that map to the class, which are configured via properties files, YAML files, environment variables etc., are public API but the content of the class itself is not meant to be used directly.
映射到類的屬性(通過(guò)屬性文件、YAML文件、環(huán)境變量等配置)是公共API,但是類本身的內(nèi)容并不意味著可以直接(directly)使用。
這種安排依賴于(relies on)默認(rèn)的空構(gòu)造函數(shù),getter和setter通常是強(qiáng)制性的(mandatory),因?yàn)榻壎ㄊ峭ㄟ^(guò)標(biāo)準(zhǔn)的Java bean屬性描述符進(jìn)行的,就像在Spring MVC中一樣。在下列情況下可省略setter:
- 只要映射被初始化,就需要一個(gè)getter,但不一定是setter,因?yàn)榻壎ㄆ骺梢詫?duì)它們進(jìn)行修改。
- 可以通過(guò)索引(通常使用YAML)或使用單個(gè)逗號(hào)分隔(comma-separated)的值(屬性)訪問(wèn)集合和數(shù)組。在后一個(gè)情況下,setter是必需的。我們建議始終為此類型添加setter。如果你初始化一個(gè)集合,請(qǐng)確保它是可變的(not immutable)(如前面的實(shí)例所示)。
- 如果初始化了嵌套的POJO屬性(如前面示例中的Security字段),則不需要setter。如果你想用綁定器使用其默認(rèn)構(gòu)造方法動(dòng)態(tài)(on the fly)創(chuàng)建一個(gè)實(shí)例,則需要setter。
有些人使用Lombok自動(dòng)添加getter和setter。請(qǐng)確保Lombok不會(huì)為這樣的類型生成任何特定的(particular)構(gòu)造方法,因?yàn)槿萜鲿?huì)自動(dòng)使用它來(lái)實(shí)例化對(duì)象。
最后,只有標(biāo)準(zhǔn)Java Bean屬性被支持,不支持綁定靜態(tài)屬性。
2.8.2 構(gòu)造方法綁定
上一節(jié)的示例可以在不變的情況下(in an immutable fashion)重寫,如下所示:
package com.example;import java.net.InetAddress; import java.util.List;import org.springframework.boot.context.properties.ConfigurationProperties; import org.springframework.boot.context.properties.ConstructorBinding; import org.springframework.boot.context.properties.DefaultValue;@ConstructorBinding @ConfigurationProperties("acme") public class AcmeProperties {private final boolean enabled;private final InetAddress remoteAddress;private final Security security;public AcmeProperties(boolean enabled, InetAddress remoteAddress, Security security) {this.enabled = enabled;this.remoteAddress = remoteAddress;this.security = security;}public boolean isEnabled() { ... }public InetAddress getRemoteAddress() { ... }public Security getSecurity() { ... }public static class Security {private final String username;private final String password;private final List<String> roles;public Security(String username, String password,@DefaultValue("USER") List<String> roles) {this.username = username;this.password = password;this.roles = roles;}public String getUsername() { ... }public String getPassword() { ... }public List<String> getRoles() { ... }}}在這個(gè)設(shè)置中,@ConstructorBinding注解用于指示(indicate)應(yīng)該使用構(gòu)造函數(shù)綁定。
This means that the binder will expect to find a constructor with the parameters that you wish to have bound.
這意味著綁定器將期望找到帶參數(shù)的構(gòu)造方法,而這些參數(shù)是已綁定的。
具有@ConstructorBinding類的內(nèi)部類(如上面示例中的Security)也將通過(guò)其構(gòu)造函數(shù)綁定。
可以使用@DefaultValue指定默認(rèn)值,并用相同的轉(zhuǎn)換服務(wù)將String值強(qiáng)制(coerce)轉(zhuǎn)換為缺失屬性的目標(biāo)類型。
要使用構(gòu)造函數(shù)綁定,必須使用啟動(dòng)@EnableConfigurationProperties或配置屬性掃描。由常規(guī)Spring機(jī)制創(chuàng)建的bean(如@Componentbean,通過(guò)(via)@Bean方法創(chuàng)建的bean,或者通過(guò)@Import加載的bean)不能使用構(gòu)造函數(shù)綁定。
如果您的類有多個(gè)構(gòu)造方法,您還可以直接在需要綁定的構(gòu)造方法上使用@ConstructorBinding。
2.8.3 開啟@ConfigurationProperties注解類型
Spring Boot提供了綁定@ConfigurationProperties類型并將它們注冊(cè)為bean的基礎(chǔ)設(shè)施(infrastructure)。你可以逐個(gè)類地啟用配置屬性,或啟用與組件掃描工作方式類似的配置屬性掃描。
有時(shí)候,用@ConfigurationProperties注解的類不適合掃描,例如,如果您正在開發(fā)自己的自動(dòng)配置,或者希望有條件地啟用它們。在這些情況下,使用@EnableConfigurationProperties注解指定要處理的類型列表。這個(gè)注解可以用在任何@Configuration類上,如下:
@Configuration(proxyBeanMethods = false) @EnableConfigurationProperties(AcmeProperties.class) public class MyConfiguration { }要想使用配置屬性掃描,要將@ConfigurationPropertiesScan注解添加到你的應(yīng)用程序中。通常(typically),它被添加到使用@SpringBootApplication注解的主應(yīng)用程序類中,但@ConfigurationPropertiesScan注解也可以被添加到任何@Configuration類中。默認(rèn)情況下,將對(duì)聲明注解的類的包進(jìn)行掃描。如果你想掃描特定的包,你可以按下面的例子來(lái)做:
@SpringBootApplication @ConfigurationPropertiesScan({ "com.example.app", "org.acme.another" }) public class MyApplication { }當(dāng)@ConfigurationPropertiesbean使用配置屬性掃描或通過(guò)@EnableConfigurationProperties注冊(cè)時(shí),這個(gè)bean戶有一個(gè)按照慣例的(conventional)名稱:<prefix>-<fqn>,其中<prefix>是在@ConfigurationProperties注解中指定的環(huán)境鍵前綴,<fqn>是bean的全限定名(the fully qualified name of the bean)。如果注解不提供任何前綴,則只使用bean的全限定名。
上述2.8.2的例子中的bean名是acme-com.example..AcmeProperties。
建議@ConfigurationProperties只處理(deal with)環(huán)境,特別(in particular)是不從上下文注入其他bean。對(duì)于極端(corner)情況,可以使用setter注入或框架提供的任何*Aware接口(例如你要訪問(wèn)Environment可以使用EnvironmentAware)。如果你仍然要使用構(gòu)造方法注入其他bean,則必須使用@Component注解配置屬性bean,并使用JavaBean屬性綁定。
2.8.4 使用@ConfigurationProperties注解類型
這種配置方式在SpringApplication外部的YAML配置中特別好用,如下面的例子所示:
# application.ymlacme:remote-address: 192.168.1.1security:username: adminroles:- USER- ADMIN# additional configuration as required要使用@ConfigurationPropertiesbean,你可以與任何其他bean相同的方式注入它們,如下所示:
@Service public class MyService {private final AcmeProperties properties;@Autowiredpublic MyService(AcmeProperties properties) {this.properties = properties;}//...@PostConstructpublic void openConnection() {Server server = new Server(this.properties.getRemoteAddress());// ...}}Using @ConfigurationProperties also lets you generate metadata files that can be used by IDEs to offer auto-completion for your own keys.
使用@ConfigurationProperties還可以生成元數(shù)據(jù)文件,IDE可以使用這些元數(shù)據(jù)文件為你的鍵提供自動(dòng)完成功能。詳見appendix。
2.8.5 第三方配置
除了(as well as)使用@ConfigurationProperties注解類外,您還可以在公共@Bean方法上使用它。當(dāng)你想將屬性綁定到超出你控制范圍外的第三方組件時(shí),這樣做特別有用。
從Environment屬性配置bean,將@ConfigurationProperties添加到它的bean registration中,如下所示:
@ConfigurationProperties(prefix = "another") @Bean public AnotherComponent anotherComponent() {... }Any JavaBean property defined with the anotherprefix is mapped onto that AnotherComponentbean in manner similar to the preceding AcmePropertiesexample.
使用another前綴定義的任何JavaBean屬性都將以類似前面的(preceding)AcmeProperties示例的方式映射到AnotherComponentbean。
2.8.6 寬松的綁定
Spring Boot使用一些寬松的(relaxed)規(guī)則將Environment屬性綁定到@ConfigurationPropertiesbeans中,因此,Environment屬性名和bean屬性名不需要完全匹配(exact match)。有用的常見示例包括短橫線分隔的(dash-speparated)環(huán)境屬性(如context-path綁定到contextPath),以及大寫的(capitalized)環(huán)境屬性(如PORT綁定到port)。如下所示:
@ConfigurationProperties(prefix="acme.my-project.person") public class OwnerProperties {private String firstName;public String getFirstName() {return this.firstName;}public void setFirstName(String firstName) {this.firstName = firstName;}}使用上述代碼,可以使用以下屬性名:
表2 寬松的綁定
| acme.my-project.person.first-name | 短橫線分隔的(kebab case)命名方式,建議在.properties和.yml文件中使用。 |
| acme.myProject.person.firstName | 標(biāo)準(zhǔn)駝峰命名法(Standard camel case syntax)。 |
| acme.my_project.person.first_name | 下劃線命名法(Underscore notation),它是.properties和.yml文件中使用的另一種格式(alternative format)。 |
| ACME_MYPROJECT_PERSON_FIRSTNAME | 大寫命名法(upper case format),建議用于系統(tǒng)環(huán)境變量。 |
注解的prefix值必須是短橫線分隔的命名方式(小寫用-分隔,如acme.my-project..person)。
表3 每個(gè)屬性源的寬松的綁定規(guī)則
| Properties文件 | 駝峰命名法,短橫線分隔命名法,或下劃線命名法 | 使用[]的標(biāo)準(zhǔn)列表語(yǔ)法(syntax)或逗號(hào)分隔的值(comma-separated) |
| YAML文件 | 駝峰命名法,短橫線分隔命名法,或下劃線命名法 | 標(biāo)準(zhǔn)的YAML列表語(yǔ)法或逗號(hào)分隔的值 |
| 環(huán)境變量 | 用下劃線作為分隔符的大寫命名法。_不應(yīng)在屬性名中使用 | 被下劃線環(huán)繞(surrounded)的數(shù)值(numeric values)。例如MY_ACME_1_OTHER = my.acme[1].other |
| 系統(tǒng)變量 | 駝峰命名法,短橫線分隔命名法,或下劃線命名法 | 使用[]的標(biāo)準(zhǔn)列表語(yǔ)法(syntax)或逗號(hào)分隔的值(comma-separated) |
建議屬性存儲(chǔ)為小寫的短橫線分隔的命名方法,如my.property-name=acme。
綁定到Map屬性時(shí),如果key包含除了(other than)小寫字母,數(shù)字字符(alpha-numeric characters),或-之外的任何內(nèi)容,你需要使用括號(hào)符號(hào)(bracket notation),以便原來(lái)的(original)值被保存(is preserved)。如果key沒(méi)有被[]環(huán)繞(is not surrounded),任何不是字母數(shù)字或-的字符都被刪除。例如,以下屬性綁定到Map:
acme:map:"[/key1]": value1"[/key2]": value2/key3: value3上面的屬性將綁定到以/key1、/key2和key3作為map中的key的Map。
For YAML files, the brackets need to be surrounded by quotes for the keys to be parsed properly.
YAML文件,要正確解析鍵,方括號(hào)(brackets)需要用引號(hào)(quotes)包圍。
2.8.7 合并復(fù)雜類型
當(dāng)有多個(gè)列表配置在多個(gè)地方,通過(guò)覆蓋來(lái)替換整個(gè)列表。
例如,假設(shè)MyPojo對(duì)象的name和description屬性默認(rèn)為null。下面展示一個(gè)AcmeProperties類中包含MyPojo列表:
@ConfigurationProperties("acme") public class AcmeProperties {private final List<MyPojo> list = new ArrayList<>();public List<MyPojo> getList() {return this.list;} }使用下面的配置:
acme:list:name: my namedescription: my description --- spring:profiles: dev acme:list:name: my another name如果dev配置文件不是活動(dòng)的,AcmeProperties.list包含了一個(gè)MyPojo,如前面定義的那樣。如果dev配置文件被啟用,list仍然只包含一個(gè)元素(name值為my another name并且description值為null),該配置不會(huì)向list中添加第二個(gè)MyPojo實(shí)例,并且不會(huì)合并項(xiàng)(items)。
當(dāng)List被指定在多個(gè)配置文件中時(shí),具有最高優(yōu)先級(jí)的那個(gè)(并且只使用那個(gè))被使用。如下所示:
acme:list:name: my namedescription: my descriptionname: another namedescription: another description --- spring:profiles: dev acme:list:name: my another name在前面的例子中,如果dev配置文件是活動(dòng)的,AcmeProperties.list包含了一個(gè)MyPojo(name值為my another name并且description值為null)。對(duì)于YAML,可以使用逗號(hào)分隔的列表和YAML列表來(lái)完全覆蓋list的內(nèi)容。
對(duì)于Map屬性,你可以綁定來(lái)自多個(gè)源的屬性值。但是,對(duì)于多個(gè)源中的相同屬性,將使用具有最高優(yōu)先級(jí)的屬性。下面展示一個(gè)AcmeProperties類中包含Map<String, MyPojo>:
@ConfigurationProperties("acme") public class AcmeProperties {private final Map<String, MyPojo> map = new HashMap<>();public Map<String, MyPojo> getMap() {return this.map;} }使用下面的配置:
acme:map:key1:name: my name 1description: my description 1 --- spring:profiles: dev acme:map:key1:name: dev name 1key2:name: dev name 2description: dev description 2如果dev配置文件不是活動(dòng)的,AcmeProperties.map包含一個(gè)key1(name值為my name 1并且description值為my description 1)。如果dev文件被啟用,map包含兩個(gè)元素key1(name值為dev name 1并且description值為my description 1)和key2(name值為dev name 2并且description值為dev description 2)
前面的合并規(guī)則適用于來(lái)自所有屬性源的屬性,而不僅僅是YAML文件。
2.8.8 屬性轉(zhuǎn)換
Spring Boot綁定到@ConfigurationPropertiesbean時(shí),它嘗試將外部應(yīng)用程序?qū)傩詮?qiáng)制轉(zhuǎn)換為正確的類型。如果需要自定義類型轉(zhuǎn)換,你可以提供一個(gè)ConversionService類(使用命名為conversionService的類)或自定義屬性編輯器(通過(guò)CustomEditorConfigurer類)或自定義轉(zhuǎn)換器Converters(使用注釋為@ConfigurationPropertiesBinding的類)。
因?yàn)檫@個(gè)bean是在應(yīng)用程序生命周期的早期請(qǐng)求的,因此確保限制ConversionService使用的依賴項(xiàng)。通常,任何你需要的依賴項(xiàng)可能在創(chuàng)建時(shí)沒(méi)有完全初始化。你可能希望重命名自定義ConversionService,如果不需要配置keys則強(qiáng)制執(zhí)行,并且只依賴于使用@ConfigurationPropertiesBinding的自定義轉(zhuǎn)換器。
轉(zhuǎn)換時(shí)間(Converting durations)
Spring Boot提供專門的工具來(lái)表達(dá)時(shí)間。如果你公開一個(gè)java.time.Duration屬性,在應(yīng)用程序?qū)傩灾锌墒褂靡韵赂袷?#xff1a;
- 常規(guī)long表達(dá)(使用毫秒(milliseconds)作為默認(rèn)單元,除非已指定@DurationUnit)
- java.time.Duration使用的標(biāo)準(zhǔn)ISO-8601格式
- 一種更具可讀性的格式,值和單位是耦合(coupled)的(例如10s表示10秒)
如下所示:
@ConfigurationProperties("app.system") public class AppSystemProperties {@DurationUnit(ChronoUnit.SECONDS)private Duration sessionTimeout = Duration.ofSeconds(30);private Duration readTimeout = Duration.ofMillis(1000);public Duration getSessionTimeout() {return this.sessionTimeout;}public void setSessionTimeout(Duration sessionTimeout) {this.sessionTimeout = sessionTimeout;}public Duration getReadTimeout() {return this.readTimeout;}public void setReadTimeout(Duration readTimeout) {this.readTimeout = readTimeout;} }指定30秒后會(huì)話超時(shí),30,PT30S,30s都可以。讀取超時(shí)為500ms,可以用500,PT0.5S,500ms。
還可以使用任何支持的單位,如:
- ns表示納秒(nanosecond)
- us表示微秒(microsecond)
- ms表示毫秒(millisecond)
- s表示秒(second)
- m表示分(minute)
- h表示時(shí)(hour)
- d表示天(day)
默認(rèn)單位是毫秒,可以使用@DurationUnit覆蓋,如上面的例子所示。
如果你從以前的版本升級(jí)到使用Long來(lái)表示時(shí)間,如果切換到Duration的單位不是毫秒,請(qǐng)確保使用@DurationUnit定義這個(gè)單位。這樣做提供了一個(gè)透明的升級(jí)路徑,同時(shí)提供更豐富的格式。
轉(zhuǎn)換數(shù)據(jù)大小(Converting Data Sizes)
Spring框架有一個(gè)以字節(jié)表示大小的DataSize值類型。如果你公開一個(gè)DataSize屬性,在應(yīng)用程序?qū)傩灾锌墒褂靡韵赂袷?#xff1a;
- 常規(guī)long表達(dá)(使用字節(jié)作為默認(rèn)單元,除非已指定@DataSizeUnit)
- java.time.Duration使用的標(biāo)準(zhǔn)ISO-8601格式
- 一種更具可讀性的格式,值和單位是耦合(coupled)的(例如10MB表示10兆)
如下所示:
@ConfigurationProperties("app.io") public class AppIoProperties {@DataSizeUnit(DataUnit.MEGABYTES)private DataSize bufferSize = DataSize.ofMegabytes(2);private DataSize sizeThreshold = DataSize.ofBytes(512);public DataSize getBufferSize() {return this.bufferSize;}public void setBufferSize(DataSize bufferSize) {this.bufferSize = bufferSize;}public DataSize getSizeThreshold() {return this.sizeThreshold;}public void setSizeThreshold(DataSize sizeThreshold) {this.sizeThreshold = sizeThreshold;} }指定10兆字節(jié)的緩沖區(qū)大小,10,10MB都可以。256字節(jié)的大小閾值可以指定為256,256B。
還可以使用任何支持的單位,如:
- B表示字節(jié)(byte)
- KB表示千字節(jié)(kilobyte)
- MB表示兆字節(jié)(megabyte)
- GB表示千兆字節(jié),吉字節(jié)(gigabyte)
- TB表示兆兆字節(jié),太字節(jié)(terabyte)
默認(rèn)單位是字節(jié),可以使用@DataSizeUnit覆蓋,如上面的例子所示。
如果你從以前的版本升級(jí)到使用Long來(lái)表示字節(jié),如果切換到DataSize的單位不是字節(jié),請(qǐng)確保使用@DataSizeUnit定義這個(gè)單位。這樣做提供了一個(gè)透明的升級(jí)路徑,同時(shí)提供更豐富的格式。
2.8.9 @ConfigurationProperties校驗(yàn)
當(dāng)用Spring的@Validated注解類時(shí),Spring引導(dǎo)嘗試驗(yàn)證ConfigurationProperties類。你可以直接在配置類上使用JSR-303 javax.validation約束注解。要做到這一點(diǎn),請(qǐng)確保兼容的JSR-303實(shí)現(xiàn)在classpath上,然后向字段中添加約束注解,如下所示:
@ConfigurationProperties(prefix="acme") @Validated public class AcmeProperties {@NotNullprivate InetAddress remoteAddress;// ... getters and setters}你還可以通過(guò)使用注解@Bean來(lái)觸發(fā)驗(yàn)證,該方法使用@Validated創(chuàng)建配置屬性。
確保始終對(duì)嵌套(nested)屬性觸發(fā)驗(yàn)證,即使沒(méi)有找到屬性,也必須使用@Valid注解關(guān)聯(lián)的(associated)字段。下面的例子建立在前面的AcmeProperties例子上:
@ConfigurationProperties(prefix="acme") @Validated public class AcmeProperties {@NotNullprivate InetAddress remoteAddress;@Validprivate final Security security = new Security();// ... getters and setterspublic static class Security {@NotEmptypublic String username;// ... getters and setters} }你還可以通過(guò)創(chuàng)建一個(gè)名為configurationPropertiesValidator的bean definition來(lái)添加自定義Spring Validator。@Bean方法應(yīng)該聲明為靜態(tài)的。配置屬性驗(yàn)證器(validator)是在應(yīng)用程序生命周期的早期創(chuàng)建的,將@Bean方法聲明為靜態(tài)方法可以在創(chuàng)建bean的時(shí)候不用實(shí)例化(instantiate)@Configuration類。這樣做可以避免任何可能由早期實(shí)例化引起的問(wèn)題。
模塊spring-boot-actuator包含一個(gè)公開所有@ConfigurationPropertiesbean的終端。將web瀏覽器指向/actuator/configprops或使用等效的JMX終端。點(diǎn)擊生產(chǎn)預(yù)備特性查看詳情。
2.8.10 @ConfigurationProperties和@Value
注解@Value是核心容器的功能,它不提供與類型安全配置屬性相同的特性。下表總結(jié)了@ConfigurationProperties和@Value支持的特性:
| 寬松的綁定(Relaxed binding) | Yes | No |
| 元數(shù)據(jù)支持(Meta-data support) | Yes | No |
| SpEL表達(dá)式 | No | Yes |
如果你為自己的組件定義了一組(a set of)配置keys,建議將它們分組到帶有@ConfigurationProperties注解的POJO中。你還應(yīng)該注意(aware),由于@Value不支持寬松的綁定,因此如果你需要使用環(huán)境變量來(lái)提供值,那么它就不是一個(gè)好的選擇。
最后,雖然您可以在@Value中編寫SpEL表達(dá)式,但是這樣的表達(dá)式不會(huì)從應(yīng)用程序?qū)傩晕募刑幚怼?/p>
3. 配置文件
Spring配置文件提供了一種方法來(lái)隔離(segregate)應(yīng)用程序配置的各個(gè)部分,并使其僅在某些環(huán)境中可用。任何@Component、@Configuration或@ConfigurationProperties都可以標(biāo)記為@Profile來(lái)限制它的加載時(shí)間,如下所示:
@Configuration(proxyBeanMethods = false) @Profile("production") public class ProductionConfiguration {// ...}如果ConfigurationProperties類是通過(guò)EnableConfigurationProperties注冊(cè)的而不是通過(guò)自動(dòng)掃描注冊(cè)的,@Profile注解需要在具有@EnableConfigurationProperties注解的@Configuration類上指定。在掃描@ConfigurationProperties的情況下,可以在@ConfigurationProperties類本身上指定@Profile。
你可以使用spring.profiles.active``````Environment屬性指定哪些配置文件是活動(dòng)的。你可以使用前面描述的任何方式指定屬性。例如,你可以在application.properties中包含它,如下所示:
spring.profiles.active=dev,hsqldb你還可以在命令行使用參數(shù):--spring.profiles.active=dev,hsqldb
3.1 添加活動(dòng)的配置文件
屬性spring.profiles.active遵循與其他屬性相同的順序規(guī)則:優(yōu)先使用優(yōu)先級(jí)最高的PropertySource。這意味著你可以在application.properties中指定活動(dòng)配置文件,然后使用命令行開關(guān)替換它們。
有時(shí),將profil-specific文件的屬性添加到active profiles比替換更有用。spring.profiles.include屬性可用于無(wú)條件地添加active profiles。SpringApplication入口點(diǎn)還有一個(gè)用于設(shè)置其他配置文件的Java API(也就是說(shuō),在spring.profiles.active屬性激活的對(duì)象之上)。參見SpringApplication中的setAdditionalProfiles()方法。
例如,當(dāng)使用開關(guān)運(yùn)行具有以下屬性的應(yīng)用程序時(shí),--spring.profiles.active=prod,proddb和prodmq配置文件也被激活:
--- my.property: fromyamlfile --- spring.profiles: prod spring.profiles.include:- proddb- prodmq請(qǐng)記住,可以在YAML文檔中定義spring.profiles屬性,以確定配置中何時(shí)包含此特定文檔。有關(guān)詳細(xì)信息,請(qǐng)閱讀howto.html。
3.2 以編程方式設(shè)置配置文件
在應(yīng)用程序運(yùn)行之前,可以通過(guò)調(diào)用SpringApplication.setAdditionalProfiles(…)以編程方式設(shè)置active profiles。也可以通過(guò)使用Spring的ConfigurableEnvironment接口來(lái)激活配置文件。
3.3 Profile-specific配置文件
Profile-specific的兩個(gè)不同的設(shè)置,application.properties(或application.yml)和通過(guò)@ConfigurationProperties引用的文件都被視為文件并加載。有關(guān)詳細(xì)信息,請(qǐng)閱讀Profile-specific屬性。
總結(jié)
以上是生活随笔為你收集整理的【译】Spring Boot Features的全部?jī)?nèi)容,希望文章能夠幫你解決所遇到的問(wèn)題。
- 上一篇: jsp+ssm计算机毕业设计民宿客栈管理
- 下一篇: html文本框监听粘贴,JavaScri