[Java]SpringBoot配置参数

Posted 2023-04-05 你好，摸了么

偶尔忘记怎么获取配置的参数，备忘一下。

• Spring Boot会自动识别正确的配置文件（.properties或.yml）并加载其中的属性。
  例如：application.properties与application.yml
• 读取机制为 Environment ，它将配置抽象为Properties和Profiles，并提供了一个接口来访问配置。SpringBoot中，Environment默认使用的Environment实现类是StandardServletEnvironment

1、参数注入

1.1、@PropertySource配置文件引入+@Configuration注入

使用下列注解引入配置文件

注解	用途
@PropertySource(“classpath:/datasource.properties”)	在任意被注入的类、方法使用。提供了一种方便的声明性机制，用于将 PropertySource 添加到 Spring 的环境中。与@Configuration类结合使用。一般用于引入不会被默认加载的自定义配置文件

例如下面的代码，加载了resources下自定义的baidu-secret.properties文件，在其他类使用的时候，注入BaiduProperties 即可获取baidu-secret.properties配置文件中的参数。

@PropertySource只是将自定义的配置文件引入，具体值还需要适用 @Value注解配置

import lombok.Data;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;

@Data
@Configuration
@PropertySource("classpath:baidu-secret.properties")
public class BaiduProperties 

    @Value("baidu.ocr.client_id")
    private String clientId;

    @Value("$baidu.ocr.client_secret")
    private String clientSecret;


    @Value("$baidu.trans.appid")
    private String appId;

    @Value("$baidu.trans.key")
    private String key;

    @Value("$baidu.trans.url")
    private String url;

另外还有一个注解，可以指定参数前缀。不用也可以，没什么必要，感觉通常情况参数在一处写完整比较易读

注解	用途
@ConfigurationProperties	可以指定前缀外部化配置的注释。如果要绑定和验证某些外部属性（例如，从 .properties 文件），请将其添加到类定义或 @Configuration 类中的 @Bean 方法中。

1.2、@ImportResource

使用下列注解兼容Spring配置文件，使用位置为启动类(一般情况)

注解	用途
@ImportResource(“classpath:/applicationContext.xml”)	在启动类使用，引入Spring配置文件

2、使用Environment

除了使用@Value注解，还可以使用SpringBoot的 Environment来动态的获取程序加载的参数。
demo如下，可以获取参数 hello.world：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.core.env.Environment;
import org.springframework.stereotype.Component;

@Component
public class DemoEnvironment implements CommandLineRunner 

    @Autowired
    private Environment environment;

    @Override
    public void run(String... args) throws Exception 
        String property = environment.getProperty("hello.world");
        System.out.println("Hello world: " + property);
    

springboot通过java代码获取配置参数

一 问题描述

在springboot中，没有任何的 xml ，那么我们如果要配置一个 Bean该怎么办，

比如我们要配置一个数据库连接池，以前会这么配置：

 现在使用java的配置

@Configuration ：声明一个类作为配置类，代替 xml 文件

@Bean ：声明在方法上，将方法的返回值加入 Bean 容器，代替 <bean> 标签

@Value ：属性注入

@PropertySource

我们接下来用 java 配置来尝试实现连接池配置：：指定外部属性文件

1.1 使用java配置获取参数

1.pom文件

 2.application配置文件

 3.java配置获取参数

package com.ljf.spring.boot.demo.config;

import com.alibaba.druid.pool.DruidDataSource;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;

import javax.sql.DataSource;

@Configuration
@PropertySource("classpath:application.properties")
public class ParamConfig 
    @Value("$jdbc.url")
    String url;
    @Value("$jdbc.driverClassName")
    String driverClassName;
    @Value("$jdbc.username")
    String username;
    @Value("$jdbc.password")
    String password;
    //第一种方式
  
    @Bean
    public DataSource dataSource()
        DruidDataSource dataSource = new DruidDataSource();
        dataSource.setDriverClassName(driverClassName);
        System.out.println("driverClassName:"+driverClassName);
        dataSource.setUrl(url); dataSource.setUsername(username);
        dataSource.setPassword(password);
        return dataSource;
    
 

@Configuration ：声明我们 JdbcConfig 是一个配置类

@PropertySource ：指定属性文件的路径是 : classpath:jdbc.properties

通过 @Value 为属性注入值

通过 @Bean 将 dataSource() 方 法声明为一个注册Bean的方法，Spring会自动调用该方法，将方法的返回值 加入Spring容器中。

4. 我们就可以在任意位置通过 @Autowired 注入 DataSource 了！

5.结果

 1.2 使用java配置获取参数

 在Spring Boot中，提供了一种新的属性注入方式，支持各种java基本数据类型及复杂类型的注入。

1.基本类：

package com.ljf.spring.boot.demo.config;

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

@ConfigurationProperties(prefix = "jdbc")
public class JdbcProperties 
    private String url;
    private String driverClassName;
    private String username;
    private String password;

    public String getUrl() 
        return url;
    

    public void setUrl(String url) 
        this.url = url;
    

    public String getDriverClassName() 
        return driverClassName;
    

    public void setDriverClassName(String driverClassName) 
        this.driverClassName = driverClassName;
    

    public String getUsername() 
        return username;
    

    public void setUsername(String username) 
        this.username = username;
    

    public String getPassword() 
        return password;
    

    public void setPassword(String password) 
        this.password = password;
    

 2.配置获取类

package com.ljf.spring.boot.demo.config;

import com.alibaba.druid.pool.DruidDataSource;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import javax.sql.DataSource;

@Configuration
@EnableConfigurationProperties(JdbcProperties.class)
public class JdbcConfig 
    @Autowired
    private JdbcProperties prop;

    public JdbcConfig(JdbcProperties prop) 
        System.out.println("第2种autorwire:"+prop.getDriverClassName());
        this.prop = prop;
    

    public  String  getInfo()
        System.out.println("第1种autorwire:"+prop.getDriverClassName());
        return "第1种autorwire:"+prop.getDriverClassName();
    
    @Bean
    public DataSource dataSource(JdbcProperties prop)
        DruidDataSource dataSource = new DruidDataSource();
        dataSource.setDriverClassName(prop.getDriverClassName());
        System.out.println("第3种 初始bean: driverClassName:"+prop.getDriverClassName());
        dataSource.setUrl(prop.getUrl()); dataSource.setUsername(prop.getUsername());
        dataSource.setPassword(prop.getPassword());
        return dataSource;
    

4.优化controller类

package com.ljf.spring.boot.demo.controller;

import com.ljf.spring.boot.demo.config.JdbcConfig;
import com.ljf.spring.boot.demo.config.ParamConfig;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import com.ljf.spring.boot.demo.hello.world.config.*;
import org.springframework.web.bind.annotation.ResponseBody;

@Controller
public class UserController 
    @Autowired
    private ProdcuctConfig pv ;
    @Autowired
    private ParamConfig paramConfig;
    @Autowired
    private JdbcConfig jdbcConfig;
    @RequestMapping("/testpv")
    @ResponseBody
    public String test()
        System.out.println("contorller:获取到bean:"+pv.getDeviceRunStateVo());
        return "ok";
    
    @RequestMapping("/testp")
    @ResponseBody
    public String testp()
     //   System.out.println("contorller:获取到参数:"+paramConfig.dataSource());
        System.out.println("contorller:获取到参数:"+jdbcConfig.getInfo());
        return "ok";
    

5.启动:

 6.访问

打印日志：