SpringBoot配置项的使用总结！非常全面

青旅半醒 2023-07-03 06:27 23阅读 0赞

[![云擎][format_png]][format_png 1] [云擎][format_png 1]2019年06月24日 00:00:00阅读 92标签： [SpringBoot][]

在业务开发中，配置配置项是基本能力。本篇总结下SpringBoot中常用的配置项使用方法。

# 1，最基础的直接使用 #

![易学SpringBoot\]配置项的使用总结-图片-1][SpringBoot_-_-1]

在配置文件application.yml中写好配置。

在代码中直接使用

1.  @RestController
2.  public class HelloController \{
3.  @Value("$\{spring101.name\}")
4.  private String name;
5.  @Value("$\{spring101.age\}")
6.  private int age;
7.  @RequestMapping(value = "/hello", method = RequestMethod.GET)
8.  public String sayHello()\{
9.  String result = "my name is " + name + "and age is" + age;
10. return result;
11. \}
12. \}

测试：

![易学SpringBoot\]配置项的使用总结-图片-2][SpringBoot_-_-2]

很简单，能多说一句就是，在配置时是弱类型的，我们并没有定义string还是int。但是在代码里使用的时候，如果是int类型，spring是能够完成自动转换的。

# 2，在配置文件中使用配置项 #

我不想在代码里对多个配置项进行组装，可以在配置文件中对配置项进行操作，组合成一个新的配置项，供代码使用。

配置文件改成这样：

1.  spring101:
2.  name: uncley
3.  age: 20
4.  content: "content name is $\{spring101.name\} and age is $\{spring101.age\}"

代码：

1.  @RestController
2.  public class HelloController \{
3.  @Value("$\{spring101.name\}")
4.  private String name;
5.  @Value("$\{spring101.age\}")
6.  private int age;
7.  @Value("$\{spring101.content\}")
8.  private String content;
9.  @RequestMapping(value = "/hello", method = RequestMethod.GET)
10. public String sayHello()\{
11. // String result = "my name is " + name + ", and age is" + age;
12. return content;
13. \}
14. \}

测试：

![易学SpringBoot\]配置项的使用总结-图片-3][SpringBoot_-_-3]

总结：在配置文件中可以通过$\{\}直接使用配置文件中定义好的配置项。

# 3，配置项转换为bean #

如果配置项很多，每次使用时，需要一次次的写@Value也是有点麻烦。这时可以将配置项转换成一个bean，以后通过这个bean直接get就方便多了。

首先定义一个bean

1.  @Component
2.  @ConfigurationProperties(prefix = "spring101")
3.  @Data
4.  public class Uncle \{
5.  private String name;
6.  private int age;
7.  private String content;
8.  \}

@Component方便后面自动注入使用。

@ConfigurationProperties是关键，prefix指定配置项的前缀

@Data是lombok的注解，我前面的文章有过介绍，用来简化代码而已，非必须。

然后改下controller使用，增加如下代码

1.  @Autowired
2.  private Uncle uncle;
3.  @RequestMapping(value = "/helloUncle", method = RequestMethod.GET)
4.  public String sayHelloUncle()\{
5.  return uncle.toString();
6.  \}

测试：

![易学SpringBoot\]配置项的使用总结-图片-4][SpringBoot_-_-4]

ok，配置项全都通过bean拿到了。

# 4，多环境切换 #

再有一个，配置项使用经常遇到的场景是测试环境和生产环境需要切换参数。

这个可以通过配置profile搞定。

application.yml配置文件做如下修改：

1.  spring:
2.  profiles:
3.  active: prod
4.  spring101:
5.  name: uncley
6.  content: "content name is $\{spring101.name\} and age is $\{spring101.age\}"
7.  \---
8.  spring:
9.  profiles: test
10. spring101:
11. age: 20
12. \---
13. spring:
14. profiles: prod
15. spring101:
16. age: 40

spring.profiles.active执行那个环境生效。

\---用来区隔环境

spring.profiles用来表示当前环境名

我现在是把name和content方外外面，作为公共部分使用。

在生产和测试环境中配置了不同的age

通过修改spring.profiles.active的值达到区分环境的目的。

测试一下

![易学SpringBoot\]配置项的使用总结-图片-5][SpringBoot_-_-5]

多说一句，如果已经打好了包，在不同环境部署时，并不需要改下配置文件重新打包。

因为我们使用java -jar xxx.jar --spring.profiles.active=prod

后面加--spring.profiles.active就可以在启动jar包时指定要使用的环境了。

[format_png]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9hdmF0YXIuaXR5dWFuLmNvbS9CQy9ERS95dW5xaW5nXzEuanBn?x-oss-process=image/format,png
[format_png 1]: https://www.ityuan.com/u/1
[SpringBoot]: https://post.ityuan.com/?tag=SpringBoot
[SpringBoot_-_-1]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9pbWcuaXR5dWFuLmNvbS9jbG91ZHN0YXRpY3MvaW1hZ2UvMjAxOTA2MjMvMTU2MTMwNTU5OTg0MzA2Mjk3Mi5qcGc?x-oss-process=image/format,png
[SpringBoot_-_-2]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9pbWcuaXR5dWFuLmNvbS9jbG91ZHN0YXRpY3MvaW1hZ2UvMjAxOTA2MjMvMTU2MTMwNTU5OTg2MjAyNTg3Ny5qcGc?x-oss-process=image/format,png
[SpringBoot_-_-3]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9pbWcuaXR5dWFuLmNvbS9jbG91ZHN0YXRpY3MvaW1hZ2UvMjAxOTA2MjMvMTU2MTMwNTU5OTg4MDAyMjQ4NS5qcGc?x-oss-process=image/format,png
[SpringBoot_-_-4]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9pbWcuaXR5dWFuLmNvbS9jbG91ZHN0YXRpY3MvaW1hZ2UvMjAxOTA2MjMvMTU2MTMwNTU5OTkxODA1MjUwNy5qcGc?x-oss-process=image/format,png
[SpringBoot_-_-5]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9pbWcuaXR5dWFuLmNvbS9jbG91ZHN0YXRpY3MvaW1hZ2UvMjAxOTA2MjMvMTU2MTMwNTU5OTk4MzA2NzMyOC5qcGc?x-oss-process=image/format,png