SpringBoot读取配置文件的六种方式

最新推荐文章于 2024-05-18 16:40:18 发布
最新推荐文章于 2024-05-18 16:40:18 发布
阅读量9.3k 收藏 21
点赞数 4
文章标签： spring boot java 后端
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_50117748/article/details/132372336
版权

获取Spring默认的全局配置文件

方式一：

使用@Value注解实现

application.yml配置文件

server:
  port: 8081

person:
  name: "李四"
  age: 18
  message: 666

实体类

@Data
public class UserInfo {

    private String name;

    private Integer age;

    private String message;

}

测试：

@RestController
@Slf4j
public class TestController {
    @Value("${person.name")
    private String name;

    @Value("${person.age}")
    private Integer age;

    @Value("${person.message}")
    private String message;

    @GetMapping("/test")
    public UserInfo getUser(){
        UserInfo user = new UserInfo();
        user.setName(name);
        user.setAge(age);
        user.setMessage(message);
        log.info("name= {}",name);
        log.info("age= {} ",age);
        log.info("message= {}",message);
        return user;
    }

}

效果：

在这里插入图片描述

注意：

  • 此方式有不足之处就是@Value(“${person.name”)中的person.name在配置文件application.yml中必须存在，若不存在则回报如下的错误：

    -在这里插入图片描述

    • 解决此项错误：在配置文件添加对应的属性或在@Value注解中使用默认值，@Value注解使用默认值方式如下

      • @Value(“${person.name:”)：表示配置文件没有name属性时，name的默认值为空

      在这里插入图片描述

      • @Value(“${person.name:张三”)：表示配置文件没有name属性时，name的默认值为张三

        在这里插入图片描述

      • @Value中使用默认值的前提时配置文件没有对应的属性，否则默认值会被配置文件的覆盖

      在这里插入图片描述

此方只适合读取配置文件属性较少时使用

方式二：

使用@ConfigurationProperties注解

application.yml配置文件

server:
  port: 8082

person:
  name: "李四"
  age: 19
  message: 777

用户实体类

@Data
public class UserInfo {

    private String name;

    private Integer age;

    private String message;

}

获取配置文件信息配置类

@Data
@Configuration
@ConfigurationProperties(prefix = "person")  //perfix绑定配置文件的前缀
public class AppConfig {

    private String name;
    private Integer age;
    private String message;

}

测试：

@RestController
public class TestController {

    @Resource
    private AppConfig appConfig;

    @GetMapping("/test")
    public UserInfo getUserInfo(){
        UserInfo userInfo = new UserInfo();


        userInfo.setName(appConfig.getName());
        userInfo.setAge(appConfig.getAge());
        userInfo.setMessage(appConfig.getMessage());
        return userInfo;
    }

}

效果：

在这里插入图片描述

此方法适用于获取配置文件属性较多的情况下使用，具体看个人喜好

方式三：

使用Environment来获取，Environment是有Spring底层提供的Api，也是一个bean

application.yml配置文件

server:
  port: 8083

person:
  name: "王五"
  age: 20
  message: 888

用户实体类：

@Data
public class UserInfo {

    private String name;

    private Integer age;

    private String message;

}

测试：

@RestController
public class TestController{

    @Resource
    private Environment environment;

    @GetMapping("/test")
    public UserInfo getUserInfo(){
        UserInfo userInfo = new UserInfo();
        String name = environment.getProperty("person.name");

        Integer age = Integer.valueOf(environment.getProperty("person.age"));
        String message = environment.getProperty("person.message");
        userInfo.setName(name);
        userInfo.setAge(age);
        userInfo.setMessage(message);
        return userInfo;
    }
}

或：

@RestController
public class TestController implements EnvironmentAware {

    private Environment environment;

    @GetMapping("/test")
    public UserInfo getUserInfo(){
        UserInfo userInfo = new UserInfo();
        String name = environment.getProperty("person.name");

        Integer age = Integer.valueOf(environment.getProperty("person.age"));
        String message = environment.getProperty("person.message");
        userInfo.setName(name);
        userInfo.setAge(age);
        userInfo.setMessage(message);
        return userInfo;
    }

    @Override
    public void setEnvironment(Environment environment) {
        this.environment = environment;
    }
}

效果：

在这里插入图片描述

此方法适用于动态获取配置文件信息的情况下使用

以上三种方式是获取Spring默认的全局配置文件

获取外部配置文件

方式一：获取自定义的properties文件

结合@PropertySources、@PropertySource和@Value三个注解实现

自定义的properties文件：custom.properties

person.name = "赵六"
person.age = 21
person.message = "888"

配置读取自定义配置文件的类：

@Data
@Component
@PropertySources({@PropertySource(value = "classpath:custom.properties",encoding = "UTF-8")})
public class AppConfig {
    @Value("${person.name:李四}")
    private String name;

    @Value("${person.age}")
    private Integer age;

    @Value("${person.message}")
    private String message;
}

用户实体类：

@Data
public class UserInfo {

    private String name;

    private Integer age;

    private String message;

}

测试：

@RestController
public class TestController {

   @Resource
    private AppConfig appConfig;

   @GetMapping("/test")
    public UserInfo getUserInfo(){
       UserInfo userInfo = new UserInfo();

       userInfo.setName(appConfig.getName());
       userInfo.setAge(appConfig.getAge());
       userInfo.setMessage(appConfig.getMessage());

       return userInfo;
   }

}

效果：

在这里插入图片描述

方式二：获取自定义的yml文件

自定义yaml文件：custom.yml

person:
  name: "小六子"
  age: 22
  message: 555

yml配置文件

server:
  port: 8085

注意：在Spring默认的全局配置文件中，不能含有自定义文件中存在的K-V键值对，否则当结合@Value注解取值是优先取Spring默认全局配置文件中的值（即自定义配置文件不生效）

若yml配置文件如下，则优先显示Spring默认全局配置文件的内容

server:
  port: 8085
person:
  name: "zhaoliu"
  age: 22
  message: 666

在这里插入图片描述

配置读取自定义yml文件的配置类

@Configuration
public class CustomYamlConfig {

    @Bean
    public static PropertySourcesPlaceholderConfigurer yamlConfigure(){
        PropertySourcesPlaceholderConfigurer configurer = new PropertySourcesPlaceholderConfigurer();
        YamlPropertiesFactoryBean yamlPropertiesFactoryBean = new YamlPropertiesFactoryBean();
        yamlPropertiesFactoryBean.setResources(new ClassPathResource("custom.yml"));
        configurer.setProperties(Objects.requireNonNull(yamlPropertiesFactoryBean.getObject()));
        return configurer;
    }

}

结合@Value注解实现

测试：

@RestController
public class TestController {

    @Value("${person.name:李四}")
    private String name;

    @Value("${person.age}")
    private Integer age;

    @Value("${person.message}")
    private String message;

    @GetMapping("/test")
    public UserInfo getUserInfo(){
        UserInfo userInfo = new UserInfo();
        userInfo.setName(name);
        userInfo.setAge(age);
        userInfo.setMessage(message);
        return userInfo;
    }

}

效果：

在这里插入图片描述

方式三：Java原生态获取properties配置文件

自定义的properties文件：custom.properties

person.name = "六六六"
person.age = 22
person.message = "999"

yaml

server:
  port: 8086

@RestController
@Slf4j
public class TestController {

    @GetMapping("/test")
    public Map<String,Object> get() {
        Properties properties = new Properties();

        try{
            InputStreamReader inputStreamReader = new InputStreamReader(
                    this.getClass().getClassLoader().getResourceAsStream("custom.properties"), UTF_8);

                    properties.load(inputStreamReader);

        }catch (IOException e){
            log.info("e={}",e);
        }

        log.info("Properties Name:{}",properties.getProperty("person.name"));
        log.info("Properties Age:{}",properties.getProperty("person.age"));
        log.info("Properties Message:{}",properties.getProperty("person.message"));

        HashMap<String, Object> map = new HashMap<>();
        map.put("name",properties.getProperty("person.name"));
        map.put("age",properties.getProperty("person.age"));
        map.put("message",properties.getProperty("person.message"));

        return map;
    }
}

效果：

在这里插入图片描述

weixin_50117748
关注
  • 4
    点赞
  • 踩
  • 21
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
SpringBoot读取配置文件的四种方式
JunsIr的技术栈
11-10 1591
SpringBoot读取配置文件的四种方式 本文以读取druid数据库连接池为例，展示四种SpringBoot读取配置文件的实例。 首先你得有一个springboot项目，如果没有，请按下方式创建一个。 InteliJ-Idea_快速创建SpringBoot项目 我这边以web方式进行演示，不必跟我一样也行。 druid依赖 <dependency> <groupId>com.alibaba</groupId>
SpringBoot读取配置文件的几种方式
m0_58479800的博客
06-18 387
日积月累，水滴石穿 ???? 前言 在 SpringBoot 中呢，我们经常要读取配置文件的值，那读取配置文件的值有哪几种方式呢？跟着笔者一起来看看吧！ 一、使用@Value注解 先准备一下两个配置文件，名称为：application.properties和application.yml properties userproperties.name=gongj===properties userproperties.age=11===properties userproperties.sex=12==
SpringBoot如何读取配置文件参数并全局使用
08-25
主要介绍了SpringBoot如何读取配置文件参数并全局使用,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
SpringBoot读取配置的方式
IT小辉同学
07-15 1242
六月你好！夏安！
Java||Springboot读取本地目录的文件和文件结构，读取服务器文档目录数据供前端渲染的API实现
最新发布
RenGJ010617的博客
05-18 1658
将服务器的工作目录渲染到前端页面上是经常遇到需要实现的需求，其中通过后端API读取本地目录，获取文件信息和文件系统层级数据是篇博客将要谈到的主要内容。
SpringBoot 读取配置文件的 5 种方法！
磊哥聊Java
08-19 8749
作者 | 磊哥来源 | Java面试真题解析（ID：aimianshi666）转载请联系授权（微信ID：GG_Stone）Spring Boot 中读取配置文件有以下 5 种方法：使用 @Value 读取配置文件。使用 @ConfigurationProperties 读取配置文件。使用 Environment 读取配置文件。使用 @PropertySource 读取配置文件。使用原生方式读取配置...
SpringBoot读取配置的6种方式
热门推荐
白豆五的博客
07-16 1万+
通过了解springboot加载配置，可以更方便地封装自定义Starter。使用@Value注解：读取springboot全局配置文件单个配置。使用Environment接口：通过Environment接口动态获取配置。（将yml全部数据封装到Environment对象）使用@ConfigurationProperties注解：在配置类上使用@ConfigurationProperties注解并指定加载配置项的前缀，就可以批量读取配置注入自定义类的成员变量中。（自定义类需要提供setter方法）
SpringBoot 常用读取配置文件的 3 种方法！
weixin_43924444的博客
02-03 5787
它可以扫描特定包下所有的被**@ConfigurationProperties**标记的配置类，并将它们进行IoC注入。注解可以将指定的配置读取类的对象加载到Spring容器，也就是说，在其他配置类上使用一个@EnableConfigurationProperties注解，来将配置文件的参数和RabbitmqProperties类的属性绑定。如果仅仅只是使用了@ConfigurationProperties注解是没有效果的,它并不会将这个配置注入容器中，它还需要和注入容器的注解一起使用。
总结SpringBoot常用读取配置文件的3种方法
m0_51963973的博客
05-25 6383
添加@Data注解是为了方便测试有没有读取到。
SpringBoot读取配置文件常用方法解析
08-18
SpringBoot读取配置文件常用方法解析 SpringBoot 读取配置文件是指在 SpringBoot 项目中读取外部配置文件的方法，用于获取配置信息。下面将介绍 SpringBoot 读取配置文件的常用方法。 传统项目读取配置方式 在没有...
如何解决springboot读取配置文件的中文乱码问题
08-27
本篇文章主要介绍了如何解决springboot读取配置文件的中文乱码问题，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看
springboot读取配置文件.rar
03-19
综上所述，Spring Boot提供了灵活且强大的方式来管理和读取配置文件。无论是简单的`application.properties`还是结构化的`application.yml`，都能满足开发者的需求。通过`@ConfigurationProperties`、`@Value`和`...
SPRINGBOOT读取PROPERTIES配置文件数据过程详解
08-25
最后，运行测试类时，SPRINGBOOT 框架将自动读取配置文件中的数据，并将其映射到 `Coffer` 对象中。输出结果如下所示： ``` Coffer{ brand='Camel', length=100.0, width=80.0, height=60.0, contains=...
Spring Boot读取配置文件
hitpter的专栏
10-11 821
配置文件是用于存储应用程序的配置信息的文件。它可以包含各种配置项，如数据库连接信息、端口号、日志级别等。通过使用配置文件，我们可以将这些配置信息与应用程序的代码分离，使得应用程序更加灵活和可配置。和.yml。是一种基于键值对的格式，适合简单的配置信息。.yml是一种基于层次结构的格式，适合复杂的配置信息。在配置文件中，可以定义需要读取的配置项。myapp:port: 8080myapp.host和myapp.port。然后，在配置文件中，我们可以定义需要读取的配置项。
springboot中获取配置文件中属性值的几种方式
baomingshu的博客
01-30 2512
Configurationproperties(prefix=”xxx”)prefix的作用是区分同名配置,如果不指定，那么会去配置文件中寻找与该类的属性名一致的配置文件。在核心配置文件applicatin.properties中激活生产环境，这里的product对应文件名application-produc的横杠后面的produc。当指定prefix之后，就不需要再在属性上面搭配@value注解使用，因为当指定前缀school之后，属性就会自动注入。prefix怎么使用呢？
SpringBoot 读取配置文件
一个95后开发者，热爱编程，喜欢玩游戏. 希望可以结识更多的小伙伴...
06-30 257
Spring Boot读取Yml配置文件的3种方法
zlfjavahome的专栏
01-09 1万+
Spring Boot读取Yml配置文件
springboot读取配置文件方式
03-29
Spring Boot 提供了多种读取配置文件的方式，以下是其中几种常用的方式： 1. application.properties/application.yml：在 src/main/resources 目录下创建 application.properties 或 application.yml 文件，可以在其中设置应用程序的配置信息，例如： ``` server.port=8080 spring.datasource.url=jdbc:mysql://localhost:3306/mydatabase spring.datasource.username=root spring.datasource.password=123456 ``` 2. @Value 注解：在代码中使用 @Value 注解读取配置信息，例如： ``` @Value("${server.port}") private int serverPort; @Value("${spring.datasource.url}") private String dataSourceUrl; @Value("${spring.datasource.username}") private String dataSourceUsername; @Value("${spring.datasource.password}") private String dataSourcePassword; ``` 3. @ConfigurationProperties 注解：通过 @ConfigurationProperties 注解将配置文件中的属性值注入到 Bean 中，例如： ``` @ConfigurationProperties(prefix = "spring.datasource") public class DataSourceProperties { private String url; private String username; private String password; // getter/setter } ``` 4. Environment 接口：通过 Environment 接口读取配置信息，例如： ``` @Autowired private Environment env; int serverPort = env.getProperty("server.port", Integer.class); String dataSourceUrl = env.getProperty("spring.datasource.url"); String dataSourceUsername = env.getProperty("spring.datasource.username"); String dataSourcePassword = env.getProperty("spring.datasource.password"); ```

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值