springboot的controller中如何获取applicatim.yml的配置值

 更新时间:2025年12月03日 12:12:21   作者:悟能不能悟  
本文介绍了在SpringBoot的Controller中获取application.yml配置值的四种方式,并举例说明了每种方式的使用场景和优缺点,结合实例代码给大家介绍的非常详细,感兴趣的朋友跟随小编一起看看吧

在Spring Boot的Controller中获取application.yml配置值,主要有以下几种方式:

1. 使用@Value注解(最常用)

application.yml 配置

app:
  name: "我的应用"
  version: "1.0.0"
  max-users: 100
  enabled: true
  timeout: 30000

Controller 中使用

@RestController
@RequestMapping("/api")
public class ConfigController {
    @Value("${app.name}")
    private String appName;
    @Value("${app.version}")
    private String appVersion;
    @Value("${app.max-users}")
    private int maxUsers;
    @Value("${app.enabled}")
    private boolean enabled;
    @Value("${app.timeout}")
    private long timeout;
    @GetMapping("/config")
    public Map<String, Object> getConfig() {
        Map<String, Object> config = new HashMap<>();
        config.put("name", appName);
        config.put("version", appVersion);
        config.put("maxUsers", maxUsers);
        config.put("enabled", enabled);
        config.put("timeout", timeout);
        return config;
    }
}

2. 使用@ConfigurationProperties(推荐用于复杂配置)

创建配置类

@Configuration
@ConfigurationProperties(prefix = "app")
@Data
public class AppConfig {
    private String name;
    private String version;
    private int maxUsers;
    private boolean enabled;
    private long timeout;
    private List<String> whitelist;
    private Map<String, String> endpoints;
}

在Controller中注入使用

@RestController
@RequestMapping("/api")
public class ConfigController {
    @Autowired
    private AppConfig appConfig;
    @GetMapping("/config")
    public AppConfig getConfig() {
        return appConfig;
    }
    @GetMapping("/info")
    public String getAppInfo() {
        return appConfig.getName() + " v" + appConfig.getVersion();
    }
}

3. 使用Environment接口

@RestController
@RequestMapping("/api")
public class ConfigController {
    @Autowired
    private Environment environment;
    @GetMapping("/env-config")
    public Map<String, Object> getEnvConfig() {
        Map<String, Object> config = new HashMap<>();
        config.put("name", environment.getProperty("app.name"));
        config.put("version", environment.getProperty("app.version"));
        config.put("maxUsers", environment.getProperty("app.max-users", Integer.class));
        config.put("timeout", environment.getProperty("app.timeout", Long.class, 5000L));
        return config;
    }
}

4. 复杂配置示例

application.yml

app:
  name: "用户管理系统"
  version: "2.1.0"
  database:
    url: "jdbc:mysql://localhost:3306/mydb"
    username: "admin"
    pool-size: 20
  security:
    jwt-secret: "my-secret-key"
    token-expire: 3600
    cors-origins:
      - "http://localhost:3000"
      - "https://example.com"
  features:
    enable-cache: true
    enable-notification: false

对应的配置类

@Configuration
@ConfigurationProperties(prefix = "app")
@Data
public class AppConfig {
    private String name;
    private String version;
    private DatabaseConfig database;
    private SecurityConfig security;
    private FeaturesConfig features;
    @Data
    public static class DatabaseConfig {
        private String url;
        private String username;
        private int poolSize;
    }
    @Data
    public static class SecurityConfig {
        private String jwtSecret;
        private int tokenExpire;
        private List<String> corsOrigins;
    }
    @Data
    public static class FeaturesConfig {
        private boolean enableCache;
        private boolean enableNotification;
    }
}

Controller中使用

@RestController
@RequestMapping("/api")
public class SystemController {
    @Autowired
    private AppConfig appConfig;
    @GetMapping("/system-info")
    public Map<String, Object> getSystemInfo() {
        return Map.of(
            "appName", appConfig.getName(),
            "databaseUrl", appConfig.getDatabase().getUrl(),
            "corsOrigins", appConfig.getSecurity().getCorsOrigins(),
            "enableCache", appConfig.getFeatures().isEnableCache()
        );
    }
}

5. 带默认值的配置

@RestController
@RequestMapping("/api")
public class ConfigController {
    // 使用默认值
    @Value("${app.unknown-property:default-value}")
    private String unknownProperty;
    @Value("${app.retry-count:3}")
    private int retryCount;
    @GetMapping("/default-values")
    public Map<String, Object> getWithDefaults() {
        return Map.of(
            "unknownProperty", unknownProperty,
            "retryCount", retryCount
        );
    }
}

主要区别和选择建议

方式

适用场景

优点

缺点

@Value

简单的单个配置项

简单直接

配置分散,不易管理

@ConfigurationProperties

复杂的配置组

类型安全,集中管理

需要创建配置类

Environment

动态获取配置

灵活,可动态获取

类型转换需要手动处理

推荐使用 @ConfigurationProperties,特别是当配置项较多或有关联时,这样代码更清晰、易于维护。

到此这篇关于springboot的controller中如何获取applicatim.yml的配置值的文章就介绍到这了,更多相关springboot controller applicatim.yml配置值内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Spring Cloud Zipkin服务端追踪服务

    Spring Cloud Zipkin服务端追踪服务

    这篇文章主要介绍了Spring Cloud Zipkin服务端追踪服务,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-04-04
  • Redisson RedLock红锁加锁实现过程及原理

    Redisson RedLock红锁加锁实现过程及原理

    本文主要介绍了Redis中Redisson红锁(Redlock)使用原理,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2023-02-02
  • SpringBoot actuator 健康检查不通过的解决方案

    SpringBoot actuator 健康检查不通过的解决方案

    这篇文章主要介绍了SpringBoot actuator 健康检查不通过的解决方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-07-07
  • 解决SpringBoot中的Scheduled单线程执行问题

    解决SpringBoot中的Scheduled单线程执行问题

    在一次SpringBoot中使用Scheduled定时任务时,发现某一个任务出现执行占用大量资源,会导致其他任务也执行失败,这篇文章主要介绍了SpringBoot中的Scheduled单线程执行问题及解决方法,需要的朋友可以参考下
    2022-06-06
  • java中的反射及其优点说明

    java中的反射及其优点说明

    这篇文章主要介绍了java中的反射及其优点说明,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-05-05
  • idea中java及java web项目的常见问题及解决

    idea中java及java web项目的常见问题及解决

    在IDEA中处理乱码问题主要涉及四个方面:文件编码设置为UTF-8、编辑器默认编码调整、Tomcat运行配置编码设置以及解决cmd中的乱码,此外,详细介绍了在IDEA中创建Web项目的步骤,包括新建Java工程、添加Web框架支持、添加Tomcat依赖库
    2024-09-09
  • SpringBoot指标监控的实现

    SpringBoot指标监控的实现

    本文主要介绍了SpringBoot指标监控的实现,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-09-09
  • Java流程控制之循环结构while、do...while

    Java流程控制之循环结构while、do...while

    这篇文章主要介绍了Java流程控制之循环结构while及do...while,文章除了讲解循环结构while和do...while之外,还讲解了他们之间的区别,下面我们就一起进入文章讲解更多详细内容吧
    2021-12-12
  • java中的Io(input与output)操作总结(四)

    java中的Io(input与output)操作总结(四)

    前面已经把java io的主要操作讲完了,这一节我们来说说关于java io的其他内容:Serializable序列化/DataOutputStream和DataInputStream类/管道流等等,感兴趣的朋友可以了解下
    2013-01-01
  • 基于Java实现对文件进行MD5加密

    基于Java实现对文件进行MD5加密

    MD5(Message-Digest Algorithm 5)是一种广泛使用的哈希函数,可以生成一个128位(16字节)的哈希值,本文将介绍如何使用Java语言实现对文件的MD5加密,帮助开发者理解和应用这一技术
    2025-06-06

最新评论