6、SpringBoot中常用获取配置文件中参数的方法

一、通过@Value注解来获取

• 新建Controller类，定义一个变量，然后在变量上添加@Value("${file.fileName}")注解，在application配置文件中添加配置：file.fileName=test，如下：

@RestController
@RequestMapping("/admin")
public class RegistController {
    private static final Logger log = LoggerFactory.getLogger(RegistController.class);

    @Value("${file.fileName}")
    private String fileName;

    @RequestMapping("getConfig")
    public String getConfig(){
       log.info("获取到配置文件中的参数-通过@Value方式：{}",fileName);
        return fileName;
    }
}

• 在application.properties配置中添加如下配置：

 

• 启动springboot工程,浏览器输入：http://localhost:8080/admin/getConfig,界面上就回展示获取到的配置信息，同时控制台打印获取到的配置信息。

 

 

二、通过ConfigurationProperties注解来定义一个配置对象，然后通过配置对象的属性获取配置信息

• 新建一个CustomerConfig对象，并添加注解@Component和@ConfigurationProperties，如下：

@Component
@ConfigurationProperties(prefix = "file")
public class CustomerConfig {
    private String fileName;

    private String filePath;

    private String fileSize;

    public String getFileName() {
        return fileName;
    }

    public void setFileName(String fileName) {
        this.fileName = fileName;
    }

    public String getFilePath() {
        return filePath;
    }

    public void setFilePath(String filePath) {
        this.filePath = filePath;
    }

    public String getFileSize() {
        return fileSize;
    }

    public void setFileSize(String fileSize) {
        this.fileSize = fileSize;
    }
}

注解说明:

@Component：表示将这个类交给spring容器管理

@ConfigurationProperties(prefix="file"):使用 prefix 来指定一个前缀，然后该类中的属性名就是配置中去掉前缀后的名字，一一对应即可。即：前缀名 + 属性名就是配置文件中定义的 key。

• 在需要使用到配置的类中，通过@Autowired将配置类注入进来，然后使用配置类的属性获取相应的配置信息。application中的配置信息见上。

@RestController
@RequestMapping("/admin")
public class RegistController {
    private static final Logger log = LoggerFactory.getLogger(RegistController.class);


    @Autowired
    private CustomerConfig customerConfig;


    @RequestMapping("getConfig")
    public String getConfig(){
        log.info("获取到配置文件中的参数-通过ConfigurationProperties方式：{}",customerConfig.getFileName());
        log.info("获取到配置文件中的参数-通过ConfigurationProperties方式：{}",customerConfig.getFilePath());
        log.info("获取到配置文件中的参数-通过ConfigurationProperties方式：{}",customerConfig.getFileSize());
        return fileName;
    }
}

 

• 启动springboot工程，浏览器输入：http://localhost:8080/admin/getConfig，控制台打印信息如下：

 

三、通过获取一个Map对象的方式动态获取配置信息

• 首先application.properties中的配置如下：

file.files.1=11111
file.files.2=22222
file.files.3=33333
file.files.[3/1/1]=44444

注：如果有特殊符号则用"[]"包起来即可，如上中的“[3/1/1]”配置

• 对应类中的变量定义为一个map，并且命名要和配置中的一致

private Map<String,String> files = new HashMap<>();

public Map<String, String> getFiles() {
    return files;
}

public void setFiles(Map<String, String> files) {
    this.files = files;
}

• 编写对应的controller类进行测试

@RequestMapping(value = "/testConfig",method = RequestMethod.POST)
public String testConfig(){
    Map<String,String> mapfile = customerConfig.getFiles();
    log.info("获取到配置1：{}",mapfile.get("1"));
    log.info("获取到配置2：{}",mapfile.get("2"));
    log.info("获取到配置3：{}",mapfile.get("3"));
    log.info("获取到配置3：{}",mapfile.get("3/1/1"));
    return "success";
}

按照上面的方式就可以获取到对应的配置参数

• 启动工程在浏览器中输入：http://localhost:8080/admin/testConfig，控制台打印信息如下：