微服务 从0开始 Spring Cloud 配置文件

Posted 2022-05-18 桃花键神

🔎这里是【秒懂·云原生】，关注我学习云原生不迷路
👍如果对你有帮助，给博主一个免费的点赞以示鼓励
欢迎各位🔎点赞👍评论收藏⭐️

👀专栏介绍

【秒懂·云原生】 目前主要更新微服务，一起学习一起进步。

👀本期介绍

主要介绍Spring Cloud 配置文件

文章目录

• 👀专栏介绍
• 👀本期介绍
• • 默认配置文件
  • 外部化配置
  • YAML
  • 自动载入外部属性到Bean
  • 多Profile
  • Starter

默认配置文件

在创建Spring Boot项目时，会默认在resource文件夹下创建
application.propertities的属性文件。在上面的例子中，我们在application.propertities中加上了服务启动端口的配置，代码如下所示:

属性文件是最常见的管理配置属性的方式。Spring Boot提供的SpringApplication类会搜索并加载application.properties文件来获取配置属性值。SpringApplication类会在下面位置搜索该文件:
·当前目录的"/config”子目录
·当前目录
.classpath中的"/config"包
.classpath

上面的顺序也表示了该位置上包含的属性文件的优先级。优先级按照从高到低的顺序排列。可以通过spring.config.name配置属性来指定不同的属性文件名称。还可以通过spring.config.location来添加额外的属性文件的搜索路径。如果Spring Boot在优先级更高的位置找到了配置，那么它就会忽略低优先级的配置。

外部化配置

Spring Boot所提供的配置优先级顺序比较复杂。按照优先级从高到低的顺序，具体的列表如下所示:

• 1）命令行参数。SpringApplication类默认会把命令行参数转化成应用中可以使用的配置参数。
• 2)通过system#getProperties方法获取的Java系统参数。
• 3）操作系统环境变量。使用Docker启动时，经常会设置系统变量。 4)从java: complenv得到的JNDI属性。
• 5)通过RandomValuePropertySource生成的random.*属性。
• 6）应用jar文件之外的属性文件，如通过spring.config.location参数指定的属性文件。
• 7)应用jar文件内部的属性文件，这是常用的方式。
• 8）在应用配置Java类（包含@Configuration注解的Java类)中通过@PropertySource注解声明的属性文件。
• 9）通过SpringApplication#setDefaultProperties方法声明的默认属性。

有些系统会涉及一些数据库或其他第三方账户等信息，出于安全考虑，这些信息并不会提前配置在项目中。对于这种情况，可以在运行程序的时候通过参数指定一个外部配置文件的方式来解决。
以demo.jar为例，方法如下:

这里指定的外部文件名无固定要求，如果需要通过bash脚本来加载不同环境的外部配置文件，文件的命名可以参考application-env.properties。

YAML

YAML是JSON的超集，是一种非常方便的格式，它一般用于指定分层配置数据。SpringApplication类能够自动支持YAML，将其作为Properties属性文件的替代者。SpringFramework提供了两个可用于加载YAML文档的类:
YamlPropertiesFactoryBean将YAML加载为Properties; YamlMapFactoryBean将YAML加载为Map。如下面的属性配置:

相应的YAML的配置如下:

从上面的对比可以看出YAML利于开发者阅读，更易于实施和使用。

自动载入外部属性到Bean

当@EnableConfigurationProperties注解应用到@Configuration修饰的配置类时，任何被@ConfigurationProperties注解的Bean将自动由Environment配置。这种风格的配置特别适合与SpringApplication的外部YAML配置配合使用。

Spring Boot使用相对宽松的规则来将环境属性绑定到使用

@ConfigurationProperties注解的Bean中，所以不需要环境属性名称和Bean属性名称完全匹配。Java中的属性变量命名使用驼峰法，例如当属性名定义为maxLength时，在配置文件中max-length和MAXLENGTH都将会被映射到maxLength属性。我们看几个实例应用。
属性实体类代码如下:

在@ConfigurationProperties中指明prefix，定义实体的映射规则，可以简化配置。这种配置方式支持复杂的属性类型，如数组、Map和子对象等。

多Profile

spring Boot使用Profile为不同环境提供不同配置，可以和全局Profile配合使用。
Spring通过配置spring.profiles.active指定激活某个具体的Profile。除了使用spring.profiles.active激活一个或者多个Profile之外，还可以用spring.profiles.include来叠加Profile。如下所示:

spring. profiles.include: prod,dev

一个多Profile的application.yml配置如下所示:

spring:
  profiles:
    active: dev
#开发环境配置
spring:
  profiles: dev
server:
  port: 8080
#测试环境配置
spring:
  profiles: test
server:
  port: 8081
--
#生产环境配置
spring:
  profiles: prod
server:
  port: 8082
 

上述application.yml文件分为四部分，使用一组(—)来作为分隔符。第一部分，通用配置部分，表示三个环境都通用的属性，默认激活了dev的Profile;后面三部分分别表示不同的环境，指定了不同的端口(port) 。

Spring Boot应用通常会被打包成jar包部署到服务器中。在启动jar应用时，可以加上参数–spring.profiles.active=test指定应用加载哪个环境的配置。在IDEA中也可以直接指定应用启动时激活哪个Profile。

Starter

Spring Boot项目的快速发展与流行，很大程度依赖于Starter的出现。Starter方便了Spring各项依赖的集成，通过Starter，可以在Spring Boot中获取到所需相关技术的一站式支持（依赖、相关的自动配置文件和相关的Bean)，而无需通过实例代码和复制粘贴来获取依赖。例如当需要Spring中的Web支持时，可以通过引入spring-boot-starter-web这个Starter依赖，它将自动为项目配置一个内嵌的Tomcat以及开启SpringWebMvc的功能，下面是一些常用的Starter:

• spring-boot-starter:核心Starter，包含自动配置的支持、日志以及YAML解析等。
• spring-boot-starter-aop:提供Spring AOP和AspectJ的面向切面的编程支持。
• spring-boot-starter-data-jpa:提供Spring Data JPA支持（由Hibernate提供底层支持）。
• spring-boot-starter-data-mongodb:提供Spring Data MongoDB和MongoDB支持。
• spring-boot-starter-jdbc:提供JDBC支持（由Tomcat JDBC连接池提供支持）。
• spring-boot-starter-jersey:提供使用JAX-RS和Jersey构建RESTful风格的Web应用的支持。
• spring-boot-starter-web:提供使用Spring MVC构建Web(包含RESTful)应用的支持，使用Tomcat作为默认嵌入式容器。
• spring-boot-starter-webflux:提供使用Spring Framework的Reactive
  Web构建WebFlux应用的支持。
• spring-boot-starter-actuator: Spring
• Boot的Actuator支持，其提供了生产就绪功能，帮助开发者监控和管理应用。

更多的Starter可以通过官方文档查阅。Starter大大简化了开发者对Spring相关依赖的配置，让他们能够将更多的精力放置在业务开发上，提高生产效率。