Spring Boot 应用程序属性
应用程序属性支持我们在不同的环境中工作。 在本章中,我们将学习如何配置和指定 Spring Boot 应用程序的属性。
Command Line 属性
Spring Boot 应用程序将命令行属性转换为 Spring Boot 环境属性。 命令行属性优先于其他属性源。 默认情况下,Spring Boot 使用 8080 端口号来启动 Tomcat。 让我们学习如何使用命令行属性更改端口号。
步骤 1 - 创建可执行 JAR 文件后,使用命令 java –jar <JARFILE>
运行它。
步骤 2 - 使用下面给屏幕截图中给出的命令,通过命令行属性更改 Spring Boot 应用程序的端口号。
注意
: 我们可以使用分隔符-
提供多个应用程序属性。
属性文件
属性文件用于将“N”个属性保存在单个文件中,以在不同的环境中运行应用程序。 在 Spring Boot 中,属性保存在 classpath
下的 application.properties
文件中。
application.properties
文件位于 src/main/resources
目录中。 示例 application.properties 文件的代码如下
server.port = 9090
spring.application.name = demoservice
请注意,在上面显示的代码中,Spring Boot 应用程序演示服务在端口 9090 上启动。
YAML 文件
Spring Boot 支持基于 YAML 的属性配置来运行应用程序。 我们可以使用 application.yml 文件来代替 application.properties。 这个 YAML 文件也应该保存在 classpath 中。 示例 application.yml 文件如下
spring:
application:
name: demoservice
server:
port: 9090
外部的属性
我们可以将属性保存在不同的位置或路径中,而不是将属性文件保存在类路径(classpath)下。 在运行 JAR 文件时,我们可以指定属性文件路径。 可以在运行 JAR 时使用以下命令指定属性文件的位置
-Dspring.config.location = /workspace/java/config/application.properties
**
使用 @Value 注解
@Value 注解用于读取 Java 代码中的环境或应用程序属性值。 读取属性值的语法如下所示
@Value("${property_key_name}")
请看以下示例,该示例显示了使用 @Value
注释读取 Java 变量中 spring.application.name
属性值的语法。
@Value("${spring.application.name}")
观察下面给出的代码来获得更好的理解
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@SpringBootApplication
@RestController
public class MyApplication {
@Value("${spring.application.name}")
private String name;
public static void main(String[] args) {
SpringApplication.run(DemoApplication.class, args);
}
@RequestMapping(value = "/")
public String name() {
return name;
}
}
注意
- 如果在运行应用程序时未找到该属性,Spring Boot 将抛出非法参数异常,因为无法解析值“${spring.application.name}”中的占位符“spring.application.name”。
为了解决占位符问题,我们可以使用下面给出的语法设置属性的默认值
@Value("${property_key_name:default_value}")
@Value("${spring.application.name:demoservice}")
Spring Boot 活动配置文件
Spring Boot 支持基于 Spring 活动配置文件的不同属性。 例如,我们可以为开发和生产保留两个单独的文件来运行 Spring Boot 应用程序。
application.properties 中的 Spring 活动配置文件
让我们了解如何在 application.properties 中拥有 Spring 活动配置文件。 默认情况下,应用程序。 属性将用于运行 Spring Boot 应用程序。 如果我们想使用基于配置文件的属性,我们可以为每个配置文件保留单独的属性文件,如下所示
application.properties
server.port = 8080
spring.application.name = demoservice
application-dev.properties
server.port = 9090
spring.application.name = demoservice
application-prod.properties
server.port = 4431
spring.application.name = demoservice
在运行 JAR 文件时,我们需要根据每个属性文件指定 spring 活动配置文件。 默认情况下,Spring Boot 应用程序使用 application.properties 文件。 设置活动配置文件的命令如下所示
$ java -jar springapp-0.0.1-SNAPSHOT.jar --spring.profiles.active=dev
我们可以在控制台日志上看到活动配置文件名称,如下所示
2022-04-23 20:13:16.322 INFO 14028 --- [
main] com.study.MyApplication :
The following profiles are active: dev
现在,Tomcat 已在端口 9090 (http) 上启动,如下所示
2022-04-23 20:13:17.185 INFO 14028 --- [
main] s.b.c.e.t.TomcatEmbeddedServletContainer :
Tomcat started on port(s): 9090 (http)
我们可以设置生产活动配置文件,如下所示
$ java -jar springapp-0.0.1-SNAPSHOT.jar --spring.profiles.active=prod
我们可以在控制台日志上看到活动配置文件名称,如下所示
2022-04-23 20:13:20.322 INFO 14028 --- [
main] com.study.MyApplication :
The following profiles are active: prod
现在,Tomcat 在端口 4431 (http) 上启动,如下所示
2022-04-23 20:13:21.185 INFO 14028 --- [
main] s.b.c.e.t.TomcatEmbeddedServletContainer :
Tomcat started on port(s): 4431 (http)
application.yml 的 Spring 活动配置文件
让我们了解如何为 application.yml 保持 Spring 活动配置文件。 我们可以将 Spring 活动配置文件属性保留在单个 application.yml 文件中。 无需使用单独的文件,如 application.properties。
以下是在 application.yml 文件中保留 Spring 活动配置文件的示例代码。 请注意,分隔符 (---)
用于分隔 application.yml 文件中的每个配置文件。
spring:
application:
name: demoservice
server:
port: 8080
---
spring:
profiles: dev
application:
name: demoservice
server:
port: 9090
---
spring:
profiles: prod
application:
name: demoservice
server:
port: 4431
下面给出了设置开发活动配置文件的命令
$ java -jar springapp-0.0.1-SNAPSHOT.jar --spring.profiles.active=dev
我们可以在控制台日志上看到活动配置文件名称,如下所示
2022 -04-23 20:41:37.202 INFO 14104 --- [
main] com.study.MyApplication :
The following profiles are active: dev
现在,Tomcat 在端口 9090 (http) 上启动,如下所示
2022 -04-23 20:41:38.650 INFO 14104 --- [
main] s.b.c.e.t.TomcatEmbeddedServletContainer :
Tomcat started on port(s): 9090 (http)
下面给出了设置生产活动配置文件的命令
$ java -jar springapp-0.0.1-SNAPSHOT.jar --spring.profiles.active=prod
我们可以在控制台日志上看到活动配置文件名称,如下所示
2022 -04-23 20:45:37.202 INFO 13400 --- [
main] com.study.MyApplication :
The following profiles are active: dev
这将在端口 4431 (http) 上启动 Tomcat,如下所示:
2022 -04-23 20:45:38.473 INFO 13400 --- [
main] s.b.c.e.t.TomcatEmbeddedServletContainer :
Tomcat started on port(s): 4431 (http)