首先,我们需要了解什么是YAML配置文件。YAML 是一种可读性高,用来表达数据序列化的格式。YAML 的定位是方便人类阅读的配置文件,对于机器来说,它也很容易解析。因此,SpringBoot 采用了 YAML 作为自己的配置文件格式。
下面是关于如何自定义 SpringBoot 的 YAML 配置文件及外部部署的完整攻略:
1. 在代码中加入自定义的 YAML 配置文件
-
在 Spring Boot 的工程下创建 \src\main\resources 目录,将需要的依赖加入进来。
-
创建一个自定义的 YAML 配置文件,命名为 application-custom.yml。这里的 custom 为我们自定义的文件名,可以根据实际情况来命名。
-
配置 application.properties 文件,指定使用我们新定义的配置文件:
spring.config.name=application-custom spring.config.location=classpath:/,file:./config/
对于上面这个属性配置,表示当配置文件名称为 application-custom.yml 时,Spring Boot 会自动加载该文件作为配置文件。
2. 编写代码
-
创建一个简单的Controller,提供一个API接口并使用我们自定义的配置:
```java
@RestController
@ConfigurationProperties(prefix = "custom")
public class MyController {private String name; public String getName() { return name; } public void setName(String name) { this.name = name; } @GetMapping("/hello") public String hello() { return "Hello " + name; }
}
```在这里,我们使用 @ConfigurationProperties 注解来绑定配置文件中的属性,prefix 指定前缀,这里的前缀为 custom,表示需要绑定的属性需要以 custom 开头。
-
在配置文件 application-custom.yml 中添加以下属性:
yaml
custom.name: world表示自定义属性 name 的值为 world,这里的 custom 就是在 @ConfigurationProperties(prefix = "custom") 中指定的前缀。
3. 运行代码并部署
-
Mavne 构建代码: mvn clean package。
-
运行 jar 包: java -jar target/myproject.jar。
-
部署 jar 包:将生成的 jar 包上传至服务器上并运行。
示例1:将 jar 包上传到服务器上之后,通过以下命令运行
bash
java -jar myproject.jar --spring.config.location=/usr/local/conf/表示指定配置文件在 /usr/local/conf/ 下。
示例2:将 jar 包上传到服务器上之后,在运行命令时指定配置文件路径:
bash
java -jar myproject.jar --custom.name=world表示直接在命令行中指定自定义属性。
至此,我们就完成了 Spring Boot 自定义 YAML 配置文件及其外部部署过程。
本站文章如无特殊说明,均为本站原创,如若转载,请注明出处:springboot自定义yml配置文件及其外部部署过程 - Python技术站