第5章使用配置属性

原 作者 张毅迅 | 发表于 | 分类于 2019级

Spring实战

第5章 使用配置属性

细粒度的自动配置

  • 在深入了解配置属性之前，我们需要知道，在Spring中有两种不同但相关的配置：
    • bean装配：声明在Spring应用上下文中创建哪些应用组件以及他们之间如何互相注入的配置。
    • 属性注入：设置Spring应用上下文中bean值的配置
  • 在Spring的XML方式和基于Java的配置中，这两种类型的配置通常会在同一个地方显式声明。在基于Java的配置中，带有@Bean注解的方法一般会同时初始化bean并立即为它的属性设置值。

理解 Spring 的环境抽象

  • Spring的环境抽象是各种配置属性的一站式服务。它抽取了原始的属性，这样需要这些属性的bean就可以从Spring本身中获取了。Spring环境会拉取多个属性源，包括：

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

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

  • 例如，假设希望应用底层的Servlet容器使用另外一个端口监听请求，而不再使用8080，可以有下面的几种方法：

    • 在application.properties中设置：server.port=9090

    • 使用YAML，在application.yml中设置：

    • server:
	port: 9090

    • 也可以在外部配置该属性，可以在使用命令行参数启动应用的时候指定端口：$ java -jar tacocloud-0.0.5-SNAPSHOT.jar --server.port=9090

    • 还可以修改操作系统的环境变量：$ export SERVER_PORT=9090

配置数据源

  • 我们当然可以显式地配置自己的DataSource，但通常没有必要。相反，通过配置属性设置数据库URL和凭证信息会更加简单。例如，如果想使员工MySQL数据库，那么可以把如下的配置属性添加到application.properties中：
mysql.driver=com.mysql.cj.jdbc.Driver
mysql.url=jdbc:mysql://localhost:3306/xxxx
mysql.username=xxxx
mysql.password=xxxx

配置日志

  • 默认情况下，Spring Boot通过Logback配置日志，日志会以INFO级别写入到控制台中。在运行应用或其他样例的时候，可能已经在应用日志中发现了大量的INFO级别的条目。
  • 为了完全控制日志的配置，我们可以在类路径的根目录下创建一个logback.xml文件，下面是在application.properties中进行的配置：
logging.level.root=WARN
logging.level.org.springframework.web=DEBUG
logging.level.org.springframework.hibernate=ERROR
logging.file.name=TacoCloud.log
logging.file.path=/var/log
  • 第一行表示，对root目录下以WARN级别生成日志。最后两行分别表示生成日志的名称以及路径。

创建自己的配置属性

  • 为了支持配置属性的注入，Spring Boot提供了@ConfigurationProperties注解。将它放到Spring bean上之后，就会为该bean中那些能够根据Spring环境注入值的属性赋值。
  • 为了阐述@ConfigurationProperties是如何运行的，假设我们为OrderController添加了如下方法，该方法会列出当前认证用户过去的订单：
@GetMapping
public String ordersForUser(@AuthenticationPrincipal User user, Model model)
{
   
    model.addAttribute("orders", orderRepo.findByUserOrderByPlacedAtDesc(user));
    return "orderList";
}
  • 除此之外，还需要为OrderRepository添加必要的fingByUser()方法：
List<Order> findByUserOrderByPlacedAtDesc(User user);
  • 但是可能有些情况，会显示非常大的订单列表。所以我们需要将订单数量限制为20个，但是20这个数应该是动态的，所以我们可以新创建一个类：
package tacos.web;

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

@Component
@ConfigurationProperties(prefix = "taco.orders")
@Data
public class OrderProps {
   
    private int pageSize = 20;
}

package tacos.web;

import org.springframework.data.domain.PageRequest;
import org.springframework.data.domain.Pageable;
import org.springframework.security.core.annotation.AuthenticationPrincipal;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.validation.Errors;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.bind.support.SessionStatus;
import tacos.Order;
import tacos.User;
import tacos.data.OrderRepository;
import tacos.data.UserRepository;

import javax.validation.Valid;
import java.security.Principal;


@Controller
@RequestMapping("/orders")
@SessionAttributes("order")
public class OrderController {
   
    private OrderRepository orderRepo;
    private OrderProps orderProps;

    public OrderController(OrderRepository orderRepo, OrderProps orderProps)
    {
   
        this.orderRepo = orderRepo;
        this.orderProps = orderProps;
    }


    @GetMapping("/current")
    public String orderForm(@AuthenticationPrincipal User user, @ModelAttribute Order order)
    {
   
        if(order.getDeliveryName() == null)
            order.setDeliveryName(user.getFullname());
        if(order.getDeliveryStreet() == null)
            order.setDeliveryStreet(user.getStreet());
        if(order.getDeliveryCity() == null)
            order.setDeliveryCity(user.getCity());
        if(order.getDeliveryState() == null)
            order.setDeliveryState(user.getState());
        if(order.getDeliveryZip() == null)
            order.setDeliveryZip(user.getZip());

        return "orderForm";
    }

    @GetMapping
    public String ordersForUser(@AuthenticationPrincipal User user, Model model)
    {
   
        Pageable pageable = PageRequest.of(0, orderProps.getPageSize());
        model.addAttribute("orders",
                orderRepo.findByUserOrderByPlacedAtDesc(user, pageable));
        return "orderList";
    }

    @PostMapping
    public String processOrder(@Valid Order order, Errors errors, SessionStatus sessionStatus, @AuthenticationPrincipal User user)
    {
   
        if(errors.hasErrors())
            return "orderForm";

        order.setUser(user);

        orderRepo.save(order);
        sessionStatus.setComplete();
        return "redirect:/";
    }
}
  • 下面是重新校验过的OrderProps：
package tacos.web;

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import org.springframework.validation.annotation.Validated;

import javax.validation.constraints.Max;
import javax.validation.constraints.Min;

@Component
@ConfigurationProperties(prefix = "taco.orders")
@Data
@Validated
public class OrderProps {
   
    @Min (value = 5, message = "must be between 5 and 25")
    @Max(value = 25, message = "must be between 5 and 25")
    private int pageSize = 20;
}

声明配置属性元数据

  • 为了创建自定义配置属性的元数据，需要在META-INF下创建一个名为additional-spring-configuration-metadata.json的文件。
  • 对于taco.orders.pageSize属性来说，我们可以通过如下的JSON为其添加元数据
{
   
  "properties": [
    {
   
      "name": "taco.orders.page-size",
      "type": "java.lang.String",
      "description": "Sets the maximum number of orders to display in a list."
    }
  ]
}

使用profile进行配置

  • 当应用部署到不同的运行时环境中的时候，有些配置细节通常会有差别。例如，数据库连接的细节在开发环境和质量保证环境中就可能不同。有一种办法是使用环境变量通过这种方式来指定配置属性，而不是在application.properties和application.yml中进行定义。
  • 例如，开发阶段可以依赖自动配置的嵌入式H2数据库。但是生产环境中，可以按照下面的方式将数据库配置属性设置为环境变量：
% export SPRING_DATASOURCE_URL=jdbc:mysql://localhost/tacocloud
% export SPRING_DATASOURCE_USERNAME=tacouser
% export SPRING_DATASOURCE_PASSWORD=tacopassword
  • 还可以使用Spring profile。profile是一种条件化的配置，运行时会根据哪些profile处于激活状态。可以使用或忽略不同的bean、配置类和配置属性。
  • 例如，对于调试级别的日志要求，只需要设置：
logging.level.tacos=DEBUG

定义特定profile的属性

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

激活profile

  • 在生产环境中，可以这样设置：
% export SPRING_PROFILES_ACTIVE=prod
  • 在JAR文件中，可以这样设置：
% java -jar taco-cloud.jar --spring.profiles.active=prod

使用profile条件化地创建bean

@Bean
@Profile("!prod")
public CommandLineRunner dataLoader(IngredientRepository repo, UserRepository userRepo, PasswordEncoder encoder)
{
   
    ...;
}
  • 这表示，只要prod profile不激活就要创建CommandLineRunner bean。