Spring Boot 2 使用自定義配置

在application.yml定義配置後，可以使用Environment來讀取配置，也可以使用@Value註解讓業務代碼去讀取配置。
如果屬性較多，可以定義屬性映射對象。

開發環境：IntelliJ IDEA 2019.2.2
Spring Boot版本：2.1.8

新建一個名稱為demo的Spring Boot項目。

一、使用@Value註解

1、application.yml配置為

jdbc:
  url: localhost:3306

2、添加一個類 ValueProp.cs

註解@Component把類ValueProp註冊到Spring容器中，@Value的值對應application.yml中的配置。

package com.example.demo;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Component
public class ValueProp {

    @Value("${jdbc.url}")
    private String jdbcUrl;

    public String getJdbcUrl() {
        return jdbcUrl;
    }
}

3、修改啟動類代碼 DemoApplication.cs

package com.example.demo;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@SpringBootApplication
@RestController
public class DemoApplication  {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }

    @Autowired
    private ValueProp valueProp;

    @RequestMapping("/")
    public String index(){
        return valueProp.getJdbcUrl();
    }
}

項目結構圖

訪問：http://localhost:8080/
頁面顯示：localhost:3306

二、定義屬性映射對象

如果上面例子application.yml裡面的jdbc下麵有多個屬性時，直接使用@Value會造成代碼冗餘。
可以新建一個屬性映射類來指定配置首碼jdbc。

1、application.yml配置為

備註：roles下麵是一個字元串集合，需要使用 - 格式。

jdbc:
  url: localhost:3306
  user: root
  password: 123456
  db:
    name: mysql
    version: 1.0
    roles:
      - manager
      - client

2、新建一個屬性映射類 JdbcProp.cs

使用註解@ConfigurationProperties聲明該類的配置首碼為“jdbc”。

package com.example.demo;

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

import java.util.List;

@ConfigurationProperties(prefix = "jdbc")
public class JdbcProp {
    private String url;
    private String user;
    private String password;
    private Database db;

    public String getUrl() {
        return url;
    }
    public void setUrl(String url) {
        this.url = url;
    }
    public String getUser() {
        return user;
    }
    public void setUser(String user) {
        this.user = user;
    }
    public String getPassword() {
        return password;
    }
    public void setPassword(String password) {
        this.password = password;
    }
    public Database getDb() {
        return db;
    }
    public void setDb(Database db) {
        this.db = db;
    }

    public static class Database{
        private String name;
        private String version;
        private List<String> roles;

        public String getName() {
            return name;
        }
        public void setName(String name) {
            this.name = name;
        }
        public String getVersion() {
            return version;
        }
        public void setVersion(String version) {
            this.version = version;
        }
        public List<String> getRoles() {
            return roles;
        }
        public void setRoles(List<String> roles) {
            this.roles = roles;
        }
    }
}

3、新建一個配置類 JdbcConfig.cs

目的是讓Spring容器知道有這麼一個自定義的屬性映射對象。

package com.example.demo;

import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Configuration;

@Configuration
@EnableConfigurationProperties(value = JdbcProp.class)
public class JdbcConfig {
}

4、修改啟動類代碼 DemoApplication.cs

package com.example.demo;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@SpringBootApplication
@RestController
public class DemoApplication  {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }

    @Autowired
    private JdbcProp jdbcProp;

    @RequestMapping(value = "/", produces = MediaType.APPLICATION_JSON_VALUE)
    public JdbcProp index(){
        return jdbcProp;
    }
}

項目結構圖

訪問：http://localhost:8080/

頁面顯示：

{"url":"localhost:3306","user":"root","password":"123456","db":{"name":"mysql","version":"1.0","roles":["manager","client"]}}