9

Spring Boot 文档说我们可以在 application.properties 文件中设置属性。
但我找不到列出可以设置的可用属性的文档。
我在哪里可以找到这样的文件？

例如，我想为嵌入式 servlet 设置 documentRoot。
我发现 setDocumentRoot() 方法是在 AbstractEmbeddedServletContainerFactory.java 中实现的。
但是我不知道何时何地调用该方法，或者可以在application.properties中设置的属性名称。
我认为这应该很容易，因为 Spring Boot 的目的就是简化配置。

提前致谢。

更新：

正如 M. Deinum 建议的那样，我在 application.properties 中添加了“server.document-root: someDirectoryName”，但出现了以下错误。

Caused by: org.springframework.beans.NotWritablePropertyException: Invalid property 'document-root' of bean class [org.springframework.boot.context.embedded.properties.ServerProperties]: Bean property 'document-root' is not writable or has an invalid setter method. Does the parameter type of the setter match the return type of the getter?
    at org.springframework.beans.BeanWrapperImpl.setPropertyValue(BeanWrapperImpl.java:1057)
    at org.springframework.beans.BeanWrapperImpl.setPropertyValue(BeanWrapperImpl.java:915)
    at org.springframework.beans.AbstractPropertyAccessor.setPropertyValues(AbstractPropertyAccessor.java:82)
    at org.springframework.validation.DataBinder.applyPropertyValues(DataBinder.java:730)
    at org.springframework.validation.DataBinder.doBind(DataBinder.java:626)
    at org.springframework.boot.bind.RelaxedDataBinder.doBind(RelaxedDataBinder.java:78)
    at org.springframework.validation.DataBinder.bind(DataBinder.java:611)
    at org.springframework.boot.bind.PropertiesConfigurationFactory.doBindPropertiesToTarget(PropertiesConfigurationFactory.java:232)
    at org.springframework.boot.bind.PropertiesConfigurationFactory.bindPropertiesToTarget(PropertiesConfigurationFactory.java:204)
    at org.springframework.boot.context.properties.ConfigurationPropertiesBindingPostProcessor.postProcessAfterInitialization(ConfigurationPropertiesBindingPostProcessor.java:312)
    ... 31 more

我认为这是因为 org.springframework.boot.context.embedded.properties.ServerProperties 的实现方式。（见https://github.com/spring-projects/spring-boot/blob/97cb7f096798ecd016de71f892fa55585d45f5eb/spring-boot/src/main/java/org/springframework/boot/context/embedded/properties/ServerProperties.java）

它声明了'@ConfigurationProperties(name = "server", ignoreUnknownFields = false)'。因此，它管理以“服务器”开头的应用程序属性，并且不允许未知的属性名称。
而且它不支持 documentRoot getter/setter。

顺便说一句，ServerProperties 类由 org.springframework.boot.autoconfigure.web.ServerPropertiesAutoConfiguration 制作为 Bean（参见https://github.com/spring-projects/spring-boot/blob/97cb7f096798ecd016de71f892fa55585d45f5eb/spring-boot-autoconfigure/src /main/java/org/springframework/boot/autoconfigure/web/ServerPropertiesAutoConfiguration.java），以便它可以参与配置过程。

因此，我尝试自己实现类似 ServerProperties 的一个和类似 ServerPropertiesAutoConfiguration 的一个。
代码如下：

package com.sample.server;

import java.io.File;

import org.springframework.boot.context.embedded.ConfigurableEmbeddedServletContainerFactory;
import org.springframework.boot.context.embedded.EmbeddedServletContainerCustomizer;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class SampleConfiguration
{
    @Bean
    public SampleServerProperties sampleServerProperties()
    {
        return new SampleServerProperties();
    }

    @ConfigurationProperties(name = "sample.server")
    public static class SampleServerProperties
        implements EmbeddedServletContainerCustomizer 
    {
        private String documentRoot;
        public String getDocumentRoot()
        {
            return documentRoot;
        }
        public void setDocumentRoot(String documentRoot)
        {
            System.out.println("############## setDocumentRoot");
            this.documentRoot = documentRoot;
        }

        @Override
        public void customize(ConfigurableEmbeddedServletContainerFactory factory)
        {
            if (getDocumentRoot() != null)
            {
                factory.setDocumentRoot(new File(getDocumentRoot()));
            }
        }
    }
}

并将以下行添加到 application.properties。

sample.server.documentRoot: someDirectoryName

...它的工作原理！

“############## setDocumentRoot”打印到控制台，实际设置了文档根目录。

所以，我现在很高兴，但这是正确的做法吗？

4

3 回答 3

7

目前对原始问题的最正确答案是在单个位置没有（技术上也不可能）详尽的列表。我们可以并且将尽可能多地记录它（在时间允许的情况下——感激地接受贡献）。用户指南中有一个手动整理的属性列表，其中包含非详尽且可能不准确的列表。最终列表来自搜索源代码@ConfigurationProperties和@Value注释，以及偶尔使用RelaxedEnvironment(cf here )。howto 文档中也有一些一般性建议。

于 2013-11-19T15:42:35.520 回答
0

你的问题非常恰当。当我在寻找 ajp 配置 ( http://www.appsdev.is.ed.ac.uk/blog/?p=525 ) 时，我找到了一个更简单的替代解决方案：

在 application.properties 中设置：

tomcat.server.document-root=/your/document/root/

在您的应用程序类中：

1）使用@Value注解放置属性

@Value("${tomcat.server.document-root}")
String documentRoot;

2）并添加豆

@Bean
public EmbeddedServletContainerFactory servletContainer() {

    TomcatEmbeddedServletContainerFactory tomcat = new TomcatEmbeddedServletContainerFactory();

    if (StringUtils.isNotBlank(documentRoot)) {
        tomcat.setDocumentRoot(new File(documentRoot));
    }

    return tomcat;
}

你完成了！

于 2016-03-05T18:46:02.510 回答
0

在这里你可以找到spring bootapplication.properties可以使用的所有属性的列表

于 2017-11-07T11:07:18.063 回答