如何在Spring Boot应用程序中记录活动配置?

时间:2014-06-27 09:53:22

标签: spring yaml spring-boot

我真的很想将YAML配置用于Spring Boot,因为我发现单个文件显示我的不同配置文件中有哪些属性是活​​动的,这是非常可读和有用的。不幸的是,我发现在application.yml中设置属性可能相当脆弱。

使用制表符而不是空格会导致属性不存在(据我所见,没有警告),而且我经常发现我的活动配置文件没有设置,因为我的一些未知问题YAML。

所以我想知道是否有任何钩子可以让我掌握当前活动的配置文件和属性,以便我可以记录它们。

同样,如果application.yml包含错误,是否有办法导致启动失败?要么我自己验证YAML,要么我可以杀死启动过程。

5 个答案:

答案 0 :(得分:8)

我遇到了同样的问题,并希望有一个调试标志可以告诉配置文件处理系统吐出一些有用的日志记录。一种可行的方法是为应用程序上下文注册事件侦听器,并从环境中打印出配置文件。我自己没有尝试这样做,所以你的里程可能会有所不同。我想也许就像这里概述的那样:

How to add a hook to the application context initialization event?

然后你在听众中做了类似的事情:

System.out.println("Active profiles: " + Arrays.toString(ctxt.getEnvironment().getActiveProfiles()));

可能值得一试。你可能做的另一种方法是声明要在你需要打印配置文件的代码中注入环境。即:

@Component
public class SomeClass {
  @Autowired
  private Environment env;
  ...
  private void dumpProfiles() {
    // Print whatever needed from env here
  }
}

答案 1 :(得分:7)

Actuator / env服务显示属性,但不显示哪个属性值实际处于活动状态。通常,您可能希望使用

覆盖应用程序属性
  • 特定于配置文件的应用程序属性
  • 命令行参数
  • 操作系统环境变量

因此,您将在多个来源中拥有相同的属性和不同的值。

Snippet bellow在启动时打印活动的应用程序属性值:

@Configuration
public class PropertiesLogger {
    private static final Logger log = LoggerFactory.getLogger(PropertiesLogger.class);

    @Autowired
    private AbstractEnvironment environment;

    @PostConstruct
    public void printProperties() {

        log.info("**** APPLICATION PROPERTIES SOURCES ****");

        Set<String> properties = new TreeSet<>();
        for (PropertiesPropertySource p : findPropertiesPropertySources()) {
            log.info(p.toString());
            properties.addAll(Arrays.asList(p.getPropertyNames()));
        }

        log.info("**** APPLICATION PROPERTIES VALUES ****");
        print(properties);

    }

    private List<PropertiesPropertySource> findPropertiesPropertySources() {
        List<PropertiesPropertySource> propertiesPropertySources = new LinkedList<>();
        for (PropertySource<?> propertySource : environment.getPropertySources()) {
            if (propertySource instanceof PropertiesPropertySource) {
                propertiesPropertySources.add((PropertiesPropertySource) propertySource);
            }
        }
        return propertiesPropertySources;
    }

    private void print(Set<String> properties) {
        for (String propertyName : properties) {
            log.info("{}={}", propertyName, environment.getProperty(propertyName));
        }
    }

}

答案 2 :(得分:7)

除了其他答案:在上下文刷新事件中记录活动属性。

Java 8

package mypackage;

import lombok.extern.slf4j.Slf4j;
import org.springframework.context.event.ContextRefreshedEvent;
import org.springframework.context.event.EventListener;
import org.springframework.core.env.ConfigurableEnvironment;
import org.springframework.core.env.MapPropertySource;
import org.springframework.stereotype.Component;

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;

@Slf4j
@Component
public class AppContextEventListener {

    @EventListener
    public void handleContextRefreshed(ContextRefreshedEvent event) {
        printActiveProperties((ConfigurableEnvironment) event.getApplicationContext().getEnvironment());
    }

    private void printActiveProperties(ConfigurableEnvironment env) {

        System.out.println("************************* ACTIVE APP PROPERTIES ******************************");

        List<MapPropertySource> propertySources = new ArrayList<>();

        env.getPropertySources().forEach(it -> {
            if (it instanceof MapPropertySource && it.getName().contains("applicationConfig")) {
                propertySources.add((MapPropertySource) it);
            }
        });

        propertySources.stream()
                .map(propertySource -> propertySource.getSource().keySet())
                .flatMap(Collection::stream)
                .distinct()
                .sorted()
                .forEach(key -> {
                    try {
                        System.out.println(key + "=" + env.getProperty(key));
                    } catch (Exception e) {
                        log.warn("{} -> {}", key, e.getMessage());
                    }
                });
        System.out.println("******************************************************************************");
    }
}

科特林

package mypackage

import mu.KLogging
import org.springframework.context.event.ContextRefreshedEvent
import org.springframework.context.event.EventListener
import org.springframework.core.env.ConfigurableEnvironment
import org.springframework.core.env.MapPropertySource
import org.springframework.stereotype.Component

@Component
class AppContextEventListener {

    companion object : KLogging()

    @EventListener
    fun handleContextRefreshed(event: ContextRefreshedEvent) {
        printActiveProperties(event.applicationContext.environment as ConfigurableEnvironment)
    }

    fun printActiveProperties(env: ConfigurableEnvironment) {
        println("************************* ACTIVE APP PROPERTIES ******************************")
        env.propertySources
                .filter { it.name.contains("applicationConfig") }
                .map { it as EnumerablePropertySource<*> }
                .map { it -> it.propertyNames.toList() }
                .flatMap { it }
                .distinctBy { it }
                .sortedBy { it }
                .forEach { it ->
                    try {
                        println("$it=${env.getProperty(it)}")
                    } catch (e: Exception) {
                        logger.warn("$it -> ${e.message}")
                    }
                }
        println("******************************************************************************")
    }
}

输出如:

************************* ACTIVE APP PROPERTIES ******************************
server.port=3000
spring.application.name=my-app
...
2017-12-29 13:13:32.843  WARN 36252 --- [           main] m.AppContextEventListener        : spring.boot.admin.client.service-url -> Could not resolve placeholder 'management.address' in value "http://${management.address}:${server.port}"
...
spring.datasource.password=
spring.datasource.url=jdbc:postgresql://localhost/my_db?currentSchema=public
spring.datasource.username=db_user
...
******************************************************************************

答案 3 :(得分:2)

如果application.yml包含错误,则会导致启动失败。我想这取决于你的意思&#34;错误&#34;虽然。如果YAML没有很好地形成,它肯定会失败。此外,如果您要设置@ConfigurationProperties,例如标记为ignoreInvalidFields=true,或者设置了无法转换的值。这是一个非常广泛的错误。

Environment实施可能会在启动时记录活动配置文件(但无论如何,您可以轻松获取并将其记录在启动器代码中 - toString() teh Environment将列出我认为的活动配置文件。如果添加执行器,还可以在/ env端点中使用活动配置文件(以及更多)。

答案 4 :(得分:1)

如果您想在初始化bean /应用程序之前获取活动配置文件,我找到的唯一方法是在SpringBootServletInitializer / SpringApplication中注册自定义Banner(即JHipster应用程序中的ApplicationWebXml)。

e.g。

@Override
protected SpringApplicationBuilder configure(SpringApplicationBuilder builder)
{
    // set a default to use when no profile is configured.
    DefaultProfileUtil.addDefaultProfile(builder.application());
    return builder.sources(MyApp.class).banner(this::printBanner);
}

/** Custom 'banner' to obtain early access to the Spring configuration to validate and debug it. */
private void printBanner(Environment env, Class<?> sourceClass, PrintStream out)
{
    if (env.getProperty("spring.datasource.url") == null)
    {
        throw new RuntimeException(
            "'spring.datasource.url' is not configured! Check your configuration files and the value of 'spring.profiles.active' in your launcher.");
    }
    ...
}