《spring实战》学习笔记第5章使用配置属性

最新推荐文章于 2023-03-11 20:28:09 发布

晦暗天明

最新推荐文章于 2023-03-11 20:28:09 发布

阅读量141

点赞数

分类专栏：《spring实战》学习笔记文章标签： java spring spring boot javaweb

本文链接：https://blog.csdn.net/qq_37960629/article/details/115222968

版权

《spring实战》学习笔记专栏收录该内容

6 篇文章 1 订阅

订阅专栏

5. 1 　细粒度的自动配置

Spring 中有两种不同（但相关）的配置。

bean 装配：声明在 Spring 应用上下文中创建哪些应用组件以及它们之间如何互相注入的配置。
属性注入：设置 Spring 应用上下文中 bean 的值的配置。

在 Spring 的 XML 方式和基于 Java 的配置中，这两种类型的配置通常会在同一个地方显式声明。（配置文件）

在基于 Java 的配置中，带有@ Bean 注解的方法一般会同时初始化 bean 并立即为它的属性设置值。（代码注解）

5. 1. 1 　理解 Spring 的环境抽象

Spring 环境会拉取多个属性源，包括：

JVM 系统属性；
操作系统环境变量；
命令行参数；
应用属性配置文件。

它会将这些属性聚合到一个源中，通过这个源可以注入到 Spring 的 bean 中。

Spring Boot 自动配置的 bean 都可以通过 Spring 环境提取的属性进行配置。举个简单的例子，假设我们希望应用底层的 Servlet 容器使用另外一个端口监听请求，而不再使用 8080。

我们可以在“ src/ main/ resources/ application. properties” 中将 server. port 设置成一个不同的端口，

server. port= 909

也可以在“ src/ main/ resources/ application. yml” 中设置 server. port 的值，

server: port:
9090

如果你喜欢在外部配置该属性，那么可以在使用命令行参数启动应用的时候指定端口：

$ java -jar tacocloud-0.0.5-SNAPSHOT.jar --server.port=9090

如果你希望应用始终在一个特定的端口启动，那么可以通过操作系统的环境变量进行一次性的设置：

$ export SERVER_ PORT= 9090

上面这些配置的效果都是一样的

5. 1. 2 　配置数据源

如果你想要开始使用 MySQL 数据库，

spring:
  datasource:
    url: jdbc:mysql://localhost/tacocloud
    username: tacouser
    password: tacopassword

如果在类路径中存在 Tomcat 的 JDBC 连接池， DataSource 将使用该连接池。否则， Spring Boot 将会在类路径下尝试查找并使用如下的连接池实现：

HikariCP
Commons DBCP 2

5. 1. 3 　配置嵌入式服务器

我们已经看到过如何使用 server. port 属性来配置 servlet 容器的端口。但是，我还没有展示将 server. port 设置为 0 将会出现什么状况：

server:

port: 0

尽管我们将 server. port 属性显式设置成了 0，但是服务器并不会真的在端口 0 上启动。相反，它会任选一个可用的端口。在我们运行自动化集成测试的时候，这会非常有用，因为这样能够保证并发运行的测试不会与硬编码的端口号冲突。

这里有一部分，关于java配置生成HTTPS证书部分的内容，我觉得挺有用的，但是我没试过，仅做记录：

我们对底层容器常见的一项设置就是让它处理 HTTPS 请求。为了实现这一点，我们首先要使用 JDK 的 keytool 命令行工具生成 keystore：

$ keytool -keystore mykeys. jks -genkey -alias tomcat -keyalg RSA

在这个过程中，会询问我们一些关于名称和组织机构相关的问题，大多数问题都无关紧要。但是，它提示输入密码的时候需要记住你所选择的密码。在本例中，我选择使用 letmein 作为密码。

接下来，我们需要设置一些属性，以便于在嵌入式服务器中启用 HTTPS。我们可以在命令行中进行配置，但是这种方式非常不方便，相反，你可能更愿意通过 application. properties 或 application. yml 文件来声明配置。在 application. yml 中，配置属性如下所示：

server:
    port:8443
    ssl:
        key-store:file:///path/to/mykeys.jks
        key-store-password:letmein
        key-password:letmein

在这里，我们将 server. port 设置为 8443，这是在开发阶段 HTTPS 服务器的常用选择。 server. ssl. key- store 属性应该设置为我们所创建的 keystore 文件的路径。在这里，它使用了 file:// URL，因此会在文件系统中加载，但是，如果你需要将它打包到一个应用 JAR 文件中，就需要使用“ classpath:” URL 来引用它。 server. ssl. key- store- password 和 server. ssl. key- password 属性都设置成了创建 keystore 时所设置的密码。

结束HTTPS部分

5. 1. 4 　配置日志

默认情况下， Spring Boot 通过 Logback 配置日志，日志会以 INFO 级别写入到控制台中。

为了完全控制日志的配置，我们可以在类路径的根目录下（在 src/ main/ resources 中）创建一个 logback. xml 文件。

如下是一个简单 logback. xml 文件的样例：

<configuration>   
  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">    
    <encoder>   
      <pattern>   
        %d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n  
      </pattern>   
    </encoder>   
  </appender>   
  <logger name="root" level="INFO"/>
  <root level="INFO">   
    <appender-ref ref="STDOUT" />   
  </root>   
</configuration>

在日志配置方面，你可能遇到的常见变更就是修改日志级别和指定日志写入到哪个文件中。借助 Spring Boot 的配置属性功能，我们不用创建 logback. xml 文件就能完成这些变更。

要设置日志级别，我们可以创建以 logging. level 作为前缀的属性，随后紧跟着的是我们想要设置日志级别的 logger。

logging:
    level:
        root: WARN
        org.springframework.security: DEBUG

现在，假设我们想要将日志条目写入到“/ var/ logs/” 中的 TacoCloud. log 文件中。 logging. path 和 logging. file 文件可以按照如下形式进行设置：

logging:
path: /var/logs/
file: TacoCloud.log
    level:
        root: WARN
        org.springframework.security: DEBUG

5. 1. 5 　使用特定的属性值

在设置属性的时候，我们并非必须要将它们的值设置为硬编码的 String 或数值。其实，我们还可以从其他的配置属性派生值。

例如，假设（不管基于什么原因）我们想要设置一个名为 greeting. welcome 的属性，它的值来源于名为 spring. application. name 的另一个属性。为了实现该功能，在设置 greeting. welcome 的时候，我们可以使用${} 占位符标记：

greeting:
welcome: ${spring.application.name}

我们甚至可以将占位符嵌入到其他文本中：

greeting:
welcome: You are using ${spring.application.name}.

总之配置属性并不专属于 Spring 创建的 bean。

5. 2 　创建自己的配置属性

为了支持配置属性的注入， Spring Boot 提供了@ ConfigurationProperties 注解。将它放到 Spring bean 上之后，它就会为该 bean 中那些能够根据 Spring 环境注入值的属性赋值。

例如，我们可以在 application. yml 中按照如下的方式设置该属性：

taco:
orders:
pageSize: 10

使用方法：


@Controller
@RequestMapping("/orders")
@SessionAttributes("order")
public class OrderController {
    private int pageSize = 20;

  public void setPageSize(int pageSize) {
    this.pageSize = pageSize; 
  }
}

代码的 pageSize 值默认为 20，但是通过设置 taco. orders. pageSize 属性，我们可以很容易地将其修改为任意的值。并且不用重启项目。

5. 2. 1 　定义配置属性的持有者

这里并没有说@ ConfigurationProperties 只能用到控制器或特定类型的 bean 中。

@ ConfigurationProperties 实际上通常会放到一种特定类型的 bean 中，这种 bean 的目的就是持有配置数据。这样的话，特定的配置细节就能从控制器和其他应用程序类中抽离出来，多个 bean 也能更容易地共享一些通用的配置。

配置属性持有者并没有什么特别之处。它们只是专门存放 Spring 环境注入到其属性中的 bean。

5. 2. 2 　声明配置属性元数据

元数据：IDE中在配置文件中，鼠标悬停后可以得知相关信息

我觉得没什么用就不记笔记了。

5. 3 　使用 profile 进行配置

当应用部署到不同的运行时环境中的时候，有些配置细节通常会有些差别。配置不同环境之间有差异的属性时，

有种办法就是使用环境变量，通过这种方式来指定配置属性，而不是在 application. properties 和 application. yml 中进行定义。

尽管这种方式可以运行，但是如果配置属性比较多，那么将它们声明为环境变量会非常麻烦。

相对于这种方式，更推荐采用 Spring profile。 profile 是一种条件化的配置，在运行时，根据哪些 profile 处于激活状态，可以使用或忽略不同的 bean、配置类和配置属性。

5. 3. 1 　定义特定 profile 的属性

定义特定 profile 相关的属性的一种方式就是创建另外一个 YAML 或属性文件，其中只包含用于生产环境的属性。文件的名称要遵守如下的约定： application-{ profile 名}. yml 或 application-{ profile 名}. properties。然后，我们就可以在这里声明适用于该 profile 的配置属性了。

例如，我们可以创建一个新的名为 application- prod. yml 的文件，其中包含如下属性：

spring:
   datasource:
       url: jdbc: mysql://localhost/tacocloud
       username: tacouser
       password: tacopassword
logging:
   level:
       tacos: WARN

定义特定 profile 相关的属性的另外一种方式仅适用于 YAML 配置。它会将特定 profile 的属性和非profile 的属性都放到 application. yml 中，它们之间使用 3 个中划线进行分割，并且使用 spring. profiles 属性来命名 profile。如果按照这种方式定义生产环境的属性，等价的 application. yml 如下所示：

taco:
orders:
pageSize: 10
---
spring:
   datasource:
       url: jdbc: mysql://localhost/tacocloud
       username: tacouser
       password: tacopassword
logging:
   level:
       tacos: WARN

我们可以看到， application. yml 文件通过一组中划线（---）分成了两部分。第二部分指定了 spring. profiles 值，

通过创建模式为 application-{ profile 名}. yml 或 application-{ profile 名}. properties 的 YAML 或属性文件，我们可以按需定义任意数量的 profile。

或者，我们也可以在 application. yml 中再输入 3 个中划线，结合 spring. profiles 属性来指定其他名称的 profile，然后添加该 profile 特定的相关属性。

5. 3. 2 　激活 profile

在 application. yml 中，就可以激活 profile

spring:
   profiles:
       active:
       - prod

但是，这可能是激活 profile 最糟糕的一种方式。这个 profile 会变成默认的 profile，我们体验不到使用 profile 将生产环境相关属性和开发环境相关的属性分开的任何好处。

因此，推荐使用环境变量来设置处于激活状态的 profile。

在生产环境中，我们可以这样设置

SPRING_ PROFILES_ ACTIVE：

% export SPRING_ PROFILES_ ACTIVE= prod

这样部署到该机器上的任何应用就都会激活 prod profile，对应的属性会比默认 profile 具备更高的优先级。

如果以可执行 JAR 文件的形式运行应用，那么我们还可以以命令行参数的形式设置激活的 profile：

% java -jar taco-cloud.jar --spring.profiles.active=prod

你可能已经注意到了， spring. profiles. active 属性名是复数形式的 profile。这意味着我们可以设置多个激活的 profile。如果使用环境变量，通常这可以通过逗号分隔的列表来实现：

% export SPRING_ PROFILES_ ACTIVE = prod, audit, ha

或者

spring:
   profiles:
       active:
       - prod
       - audit
       - ha

5. 3. 3 　使用 profile 条件化地创建 bean

假设我们希望某些 bean 仅在特定 profile 激活的情况下才需要创建。在这种情况下，@ Profile 注解可以将某些 bean 设置为仅适用于给定的 profile。

  @Bean
  @Profile("dev") 
  public CommandLineRunner dataLoader(IngredientRepository repo,
        UserRepository userRepo, PasswordEncoder encoder) {
           //……
}

如果是多个profile 环境下都要启动，则改成

@Profile({"dev","qa"})

如果除了 prod 激活时， CommandLineRunner bean 都需要创建，

@Profile("!prod")

我们还可以在带有@ Configuration 注解的类上使用@ Profile。

@Profile({"!prod"，"!qa"})
@Configuration
public class DevelopmentConfig {
    //……
}

在这里， CommandLineRunner bean（包括 DevelopmentConfig 中定义的其他 bean）只有在 prod 和 qa 均没有激活的情况下才会创建。

5. 4 　小结

Spring bean 可以添加@ ConfigurationProperties 注解，这样就能够从多个属性源中选取一个来注入它的值。
配置属性可以通过命令行参数、环境变量、 JVM 系统属性、属性文件或 YAML 文件等方式进行设置。
配置属性可以用来覆盖自动配置相关的设置，包括指定数据源 URL 和日志级别。
Spring profile 可以与属性源协同使用，从而能够基于激活的 profile 条件化地设置配置属性。

晦暗天明

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
《spring实战》学习笔记第5章使用配置属性

5. 1 　细粒度的自动配置Spring 中有两种不同（但相关）的配置。bean 装配：声明在 Spring 应用上下文中创建哪些应用组件以及它们之间如何互相注入的配置。属性注入：设置 Spring 应用上下文中 bean 的值的配置。在 Spring 的 XML 方式和基于 Java 的配置中，这两种类型的配置通常会在同一个地方显式声明。（配置文件）在基于 Java 的配置中， ..
复制链接

扫一扫