Spring-讀取配置

雄獅虎豹發表於2022-04-09
Spring

[toc]

Spring-讀取配置

概述

在Spring中，動態配置可以在配置中心或者profile檔案中放置，而讀取配置的方式有很多種，我常用的有以下兩種：

  • 通過@Value("${property-name}")註解的方式讀取配置，這種方式的好處是簡單直接，需要讀取哪個配置，直接在需要的類裡面新增一個成員變數加上這個註解就可以了，缺點就是對每個需要使用這個配置的類都要加一個成員變數。當然@Value註解還支援通過EL表示式進行一些稍微點的操作，功能還是比較強大的。
  • 通過@ConfigurationProperties註解使用配置類的方式讀取，這種方式將配置轉換成實體類，其它類要使用它，採用自動注入的方式直接使用即可。

通過@Value註解讀取配置

在配置檔案或配置中心的配置
user:
  name: k
讀取和適用配置
// 讀取配置
@Value("${user.name}")
private String userName;

public void func() {
    // 使用
    System.out.println(userName);
}

通過@ConfigurationProperties配置類讀取配置

在配置檔案或配置中心的配置
prop:
  user: "k"
  password: "***"
  owns:
    - name: "apple"
      size: 20
    - name: "orange"
      size: 10
配置類
import java.util.List;

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

import lombok.Data;

/**
 * 使用者配置類：從配置檔案中讀取配置方便使用
 */
@Data
@Component
@ConfigurationProperties(prefix = "prop")
public class SpringConfig {
    private String user;

    private String password;

    private List<Owns> owns;

    @Data
    private static class Owns {
        private String name;

        private Integer size;
    }
}
使用配置類：簡單的示例，獲取配置類的bean，然後讀取配置。也可以通過自動注入的方式讀取配置。
/**
     * 根據類名讀取配置
     * 例如："com.kaesar.getup.config.SpringConfig"
     * 
     * @param propertyClassName
     * @return
     * @throws ClassNotFoundException
     */
    @ApiOperation(value = "讀取配置", tags = {"根據配置名讀取配置"})
    @GetMapping("readProperties/{propertyClassName}")
    public String readProperties(@ApiParam(name = "propertyClassName", value = "配置key", required = true) @PathVariable String propertyClassName) throws ClassNotFoundException {
        Map<String, ?> propertyClass = applicationContext.getBeansOfType(Class.forName(propertyClassName));

        return propertyClass.toString();
    }

總結

當前，Spring還有一些別的方式讀取配置，比如讀取系統引數、通過配置檔案讀取等，具體使用哪種方式就看覺得哪個更方便了。

$1.01^{365} ≈ 37.7834343329$
$0.99^{365} ≈ 0.02551796445$
相信堅持的力量！

相關文章