Sep11

SpringBoot配置属性参数中文说明文档

Author: leeon  Click: 1444   Comments: 0 Category: java  Tag: springboot
flyway.baseline-description
执行基线时标记已有Schema的描述。
flyway.baseline-on-migrate
在没有元数据表的情况下,针对非空Schema执行迁移时是否自动调用基线。(默认值:false。)
flyway.baseline-version
执行基线时用来标记已有Schema的版本。(默认值:1。)
flyway.check-location
检查迁移脚本所在的位置是否存在。(默认值:false。)
flyway.clean-on-validation-error
在验证错误时,是否自动执行清理。(默认值:false。)
flyway.enabled
开启Flyway。(默认值:true。)
flyway.encoding
设置SQL迁移文件的编码。(默认值:UTF-8。)
flyway.ignore-failed-future-migration
在读元数据表时,是否忽略失败的后续迁移。(默认值:false。)
flyway.init-sqls
获取连接后立即执行初始化的SQL语句。
flyway.locations
迁移脚本的位置。(默认值:db/migration。)
flyway.out-of-order
是否允许乱序(out of order)迁移。(默认值:false。)
flyway.password
待迁移数据库的登录密码。
flyway.placeholder-prefix
设置每个占位符的前缀。(默认值:${。)
flyway.placeholder-replacement
是否要替换占位符。(默认值:true。)
flyway.placeholder-suffix
设置占位符的后缀。(默认值:}。)
flyway.placeholders.[placeholder name]
设置占位符的值。
flyway.schemas
Flyway管理的Schema列表,区分大小写。默认连接对应的默认Schema。
flyway.sql-migration-prefix
SQL迁移的文件名前缀。(默认值:V。)
flyway.sql-migration-separator
SQL迁移的文件名分隔符。(默认值:__。)
flyway.sql-migration-suffix
SQL迁移的文件名后缀。(默认值:.sql。)
flyway.table
Flyway使用的Schema元数据表名称。(默认值:schema_version。)
flyway.target
Flyway要迁移到的目标版本号。(默认最新版本。)
flyway.url
待迁移的数据库的JDBC URL。如果没有设置,就使用配置的主数据源。
flyway.user
待迁移数据库的登录用户。
flyway.validate-on-migrate
在运行迁移时是否要自动验证。(默认值:true。)
liquibase.change-log
变更日志配置路径。(默认值:classpath:/db/changelog/db.changelog-master.yaml。)
liquibase.check-change-log-location
检查变更日志位置是否存在。(默认值:true。)
liquibase.contexts
要使用的运行时上下文列表,用逗号分隔。
liquibase.default-schema
默认的数据库Schema。
liquibase.drop-first
先删除数据库Schema。(默认值:false。)
liquibase.enabled
开启Liquibase支持。(默认值:true。)
liquibase.password
待迁移数据库的登录密码。
liquibase.url
待迁移数据库的JDBC URL。如果没有设置,就使用配置的主数据源。
liquibase.user
待迁移数据库的登录用户。
multipart.enabled
开启分段(multi-part)上传支持。(默认值:true。)
multipart.file-size-threshold
大于该阈值的文件会写到磁盘上。这里的值可以使用MB或KB后缀来表明是兆字节还是千
字节。(默认值:0。)
multipart.location
上传文件的中间存放位置。
multipart.max-file-size
最大文件大小。这里的值可以使用MB或KB后缀来表明是兆字节还是千字节。(默认值:1MB。)
multipart.max-request-size
最大请求大小。这里的值可以使用MB或KB后缀来表明是兆字节还是千字节。(默认值:10MB。)
security.basic.authorize-mode
要运用的安全授权模式。
security.basic.enabled
开启基本身份验证。(默认值:true。)
security.basic.path
要保护的路径,用逗号分隔。(默认值:[/**]。)
security.basic.realm
HTTP基本领域(realm)用户名。(默认值:Spring。)
security.enable-csrf
开启跨站请求伪造(cross-site request forgery)支持。(默认值:false。)
security.filter-order
安全过滤器链顺序。(默认值:0。)
security.headers.cache
开启缓存控制HTTP头。(默认值:false。)
security.headers.content-type
开启X-Content-Type-Options头。(默认值:false。)
security.headers.frame
开启X-Frame-Options头。(默认值:false。)
security.headers.hsts
HTTP Strict Transport Security(HSTS)模式(可设置为none、domain、all)。
security.headers.xss
开启跨站脚本(cross-site scripting)保护。(默认值:false。)
security.ignored
要从默认保护路径中排除掉的路径列表,用逗号分隔。
security.oauth2.client.access-token-uri
用于获取访问令牌的URI。
security.oauth2.client.access-token-validity-seconds
在令牌过期前多长时间验证一次。
security.oauth2.client.additional-information. [key]
设置额外的信息,令牌授予者会将其添加到令牌里。
security.oauth2.client.authentication-scheme
传送持有人令牌(bearer token)的方法,包括form、header、none、query,可选其一。(默认值:header。)
security.oauth2.client.authorities
要赋予经授权客户端的权限。
security.oauth2.client.authorized-grant-types
客户端可用的授予类型。
security.oauth2.client.auto-approve-scopes
客户端自动通过的范围。
security.oauth2.client.client-authentication-scheme
在客户端身份认证时用于传输身份认证信息的方法,包括form、header、none、query,可选其一。(默认值:header。)
security.oauth2.client.client-id
OAuth2客户端ID。
security.oauth2.client.client-secret
OAuth2客户端密钥。默认随机生成。
security.oauth2.client.grant-type
获得资源访问令牌的授予类型。
security.oauth2.client.id
应用程序的客户端ID。
security.oauth2.client.pre-established-redirect-uri
与服务器预先建立好的重定向URI。如果设置了该属性,用户授权请求中的重定向URI会被忽略,因为服务器不需要它。
security.oauth2.client.refresh-token-validity-seconds
刷新令牌在过期前的有效时间。
security.oauth2.client.registered-redirect-uri
客户端里注册的重定向URI,用逗号分隔。
security.oauth2.client.resource-ids
与客户端关联的资源ID,用逗号分隔。
security.oauth2.client.scope
客户端分配的域。
security.oauth2.client.token-name
令牌名称。
security.oauth2.client.use-current-uri
请求里的当前URI(如果设置了的话)是否优先于预建立的重定向URI。(默认值:true。)
security.oauth2.client.user-authorization-uri
用户要重定向以便授访问令牌的URI。
security.oauth2.resource.id
资源的标识符。
security.oauth2.resource.jwt.key-uri
JWT令牌的URI。如果没有配置key-value,使用的又是公钥,那么可以对这个属性进行设置。
security.oauth2.resource.jwt.key-value
JWT令牌的验证密钥,可以是对称密钥,也可以是PEM编码的RSA公钥。如果没有配置
这个属性,那么可以用key-uri代替。
security.oauth2.resource.prefer-token-info
使用令牌的信息,设置为false则使用用户信息。(默认值:true。)
security.oauth2.resource.service-id
服务ID。(默认值:resource。)
security.oauth2.resource.token-info-uri
令牌解码端点URI。
security.oauth2.resource.token-type
在使用userInfoUri时发送的令牌类型。
security.oauth2.resource.user-info-uri
用户端点的URI。
security.oauth2.sso.filter-order
在没有显式提供WebSecurityConfigurerAdapter时应用的过滤器顺序,在Web-SecurityConfigurerAdapter里也可以指定顺序。
security.oauth2.sso.login-path
登录页的路径——登录页是触发重定向到OAuth2授权服务器的页面。(默认值:/login。)
security.require-ssl
对所有请求开启安全通道。(默认值:false。)
security.sessions
创建会话使用的策略。(可选值包括:always、never、if_required、stateless。)
security.user.name
默认的用户名。(默认值:user。)
security.user.password
默认用户的密码。
security.user.role
赋予默认用户的角色。
server.address
服务器绑定的网络地址。
server.compression.enabled
是否要开启压缩。(默认值:false。)
server.compression.excluded-user-agents
用逗号分割的列表,标明哪些用户代理不该开启压缩。(可选值包括:text/html、
text/xml、text/plain、text/css)
server.compression.mime-types
要开启压缩的MIME类型列表,用逗号分割。
server.compression.min-response-size
要执行压缩的最小响应大小(单位为字节)。(默认值:2048。)
server.context-parameters.[param name]
设置一个Servlet上下文参数。
server.context-path
应用程序的上下文路径。
server.display-name
应用程序的显示名称。(默认值:application。)
server.jsp-servlet.class-name
针对JSP使用的Servlet类名。(默认值:org.apache.jasper.servlet.JspServlet。)
server.jsp-servlet.init-parameters.[param name]
设置JSP Servlet初始化参数。
server.jsp-servlet.registered
JSP Servlet是否要注册到内嵌的Servlet容器里。(默认值:true。)
server.port
服务器的HTTP端口。
server.servlet-path
主分发器Servlet的路径。(默认值:/。)
server.session.cookie.comment
会话Cookie的注释。
server.session.cookie.domain
会话Cookie的域。
server.session.cookie.http-only
会话Cookie的HttpOnly标记。
server.session.cookie.max-age
会话Cookie的最大保存时间,单位为秒。
server.session.cookie.name
会话Cookie名称。
server.session.cookie.path
会话Cookie的路径。
server.session.cookie.secure
会话Cookie的Secure标记。
server.session.persistent
是否在两次重启间持久化会话数据。(默认值:false。)
server.session.timeout
会话超时时间,单位为秒。
server.session.tracking-modes
会话跟踪模式(包括:cookie、url和ssl,可选其一或若干)。
server.ssl.ciphers
支持的SSL加密算法。
server.ssl.client-auth
客户端授权是主动想(want)还是被动需要(need)。要有一个TrustStore。
server.ssl.enabled
是否开启SSL。(默认值:true。)
server.ssl.key-alias
在KeyStore里标识密钥的别名。
server.ssl.key-password
在KeyStore里用于访问密钥的密码。
server.ssl.key-store
持有SSL证书的KeyStore的路径(通常指向一个.jks文件)。
server.ssl.key-store-password
访问KeyStore时使用的密钥。
server.ssl.key-store-provider
KeyStore的提供者。
server.ssl.key-store-type
KeyStore的类型。
server.ssl.protocol
要使用的SSL协议。(默认值:TLS。)
server.ssl.trust-store
持有SSL证书的TrustStore。
server.ssl.trust-store-password
用于访问TrustStore的密码。
server.ssl.trust-store-provider
TrustStore的提供者。
server.ssl.trust-store-type
TrustStore的类型。
server.tomcat.access-log-enabled
是否开启访问日志。(默认值:false。)
server.tomcat.access-log-pattern
访问日志的格式。(默认值:common。)
server.tomcat.accesslog.directory
创建日志文件的目录。可以相对于Tomcat基础目录,也可以是绝对路径。(默认值:logs。)
server.tomcat.accesslog.enabled
开启访问日志。(默认值:false。)
server.tomcat.accesslog.pattern
访问日志的格式。(默认值:common。)
server.tomcat.accesslog.prefix
日志文件名的前缀。(默认值:access_log。)
server.tomcat.accesslog.suffix
日志文件名的后缀。(默认值:.log。)
server.tomcat.background-processor-delay
两次调用backgroundProcess方法之间的延迟时间,单位为秒。(默认值:30。)
server.tomcat.basedir
Tomcat的基础目录。如果没有指定则使用一个临时目录。
server.tomcat.internal-proxies
匹配可信任代理服务器的正则表达式。默认值:“10\.\d{1,3}\.\d{1,3}\. \d{1,3}|192\.168\.\d{1,3}\.\d{1,3}| 169\.254\.\d{1,3}\.\d{1,3}| 127\.\d{1,3}\.\d{1,3}\.\d{1,3}|172\.1[6-9]{1}\.\d{1,3}\.\d{1,3}| 172\.2[0-9]{1}\.\d{1,3}\.\d{1,3}|172\.3[0-1]{1}\.\d{1,3}\.\d{1,3}”。
server.tomcat.max-http-header-size
HTTP消息头的最大字节数。(默认值:0。)
server.tomcat.max-threads
最大工作线程数。(默认值:0。)
server.tomcat.port-header
用来覆盖原始端口值的HTTP头的名字。
server.tomcat.protocol-header
持有流入协议的HTTP头,通常的名字是X-Forwarded-Proto。仅当设置了remoteIp-
Header的时候,它会被配置为RemoteIpValve。
server.tomcat.protocol-header-https-value
协议头的值,表明流入请求使用了SSL。(默认值:https。)
server.tomcat.remote-ip-header
表明从哪个HTTP头里可以提取到远端IP。仅当设置了remoteIpHeader的时候,它会被配置为RemoteIpValve。
server.tomcat.uri-encoding
用来解码URI的字符编码。
server.undertow.access-log-dir
Undertow的访问日志目录。(默认值:logs。)
server.undertow.access-log-enabled
是否开启访问日志。(默认值:false。)
server.undertow.access-log-pattern
访问日志的格式。(默认值:common。)
server.undertow.accesslog.dir
Undertow访问日志目录。
server.undertow.accesslog.enabled
开启访问日志。(默认值:false。)
server.undertow.accesslog.pattern
访问日志的格式。(默认值:common。)
server.undertow.buffer-size
每个缓冲的字节数。
server.undertow.buffers-per-region
每个区(region)的缓冲数。
server.undertow.direct-buffers
在Java堆外分配缓冲。
server.undertow.io-threads
要为工作线程创建的I/O线程数。
server.undertow.worker-threads
工作线程数。
spring.activemq.broker-url
ActiveMQ代理的URL。默认自动生成。
spring.activemq.in-memory
标明默认代理URL是否应该在内存里。如果指定了一个显式的代理则忽略该属性。(默认值:true。)
spring.activemq.password
代理的登录密码。
spring.activemq.pooled
标明是否要创建一个PooledConnectionFactory来代替普通的ConnectionFactory。(默认值:false。)
spring.activemq.user
代理的登录用户名。
spring.aop.auto
添加@EnableAspectJAutoProxy。(默认值:true。)
spring.aop.proxy-target-class
是否要创建基于子类(即Code Generation Library,CGLIB)的代理来代替基于Java接口的代理,前者为true,后者为false。(默认值:false。)
spring.application.admin.enabled
开启应用程序的管理功能。(默认值:false。)
spring.application.admin.jmx-name
应用程序管理MBean的JMX名称。(默认值:org.springframework.boot:type=
Admin,name=SpringApplication。)
spring.artemis.embedded.cluster-password
集群密码。默认在启动时随机生成。
spring.artemis.embedded.data-directory
Journal文件目录。如果关闭了持久化则不需要该属性。
spring.artemis.embedded.enabled
如果有Artemis服务器API则开启嵌入模式。(默认值:true。)
spring.artemis.embedded.persistent
开启持久化存储。(默认值:false。)
spring.artemis.embedded.queues
要在启动时创建的队列列表,用逗号分隔。(默认值:[]。)
spring.artemis.embedded.server-id
服务器ID。默认情况下,使用一个自动递增的计数器。(默认值:0。)
spring.artemis.embedded.topics
在启动时要创建的主题列表,用逗号分隔。(默认值:[]。)
spring.artemis.host
Artemis代理主机。(默认值:localhost。)
spring.artemis.mode
Artemis部署模式,默认自动检测。可以显式地设置为native或embedded。
spring.artemis.port
Artemis代理端口。(默认值:61616。)
spring.autoconfigure.exclude
要排除的自动配置类。
spring.batch.initializer.enabled
如果有必要的话,在启动时创建需要的批处理表。(默认值:true。)
spring.batch.job.enabled
在启动时执行上下文里的所有Spring Batch任务。(默认值:true。)
spring.batch.job.names
启动时要执行的任务名列表,用逗号分隔。默认在上下文里找到的所有任务都会执行。
spring.batch.schema
指向初始化数据库Schema 用的SQL 文件的路径。( 默认值: classpath:org/springframework/batch/core/[email protected]@[email protected]@.sql。)
spring.batch.table-prefix
所有批处理元数据表的表前缀。
spring.cache.cache-names
如果底层缓存管理器支持缓存名的话,可以在这里指定要创建的缓存名列表,用逗号分隔。通常这会禁用运行时创建其他额外缓存的能力。
spring.cache.ehcache.config
用来初始化EhCache的配置文件的位置。
spring.cache.guava.spec
用来创建缓存的Spec。要获得有关Spec格式的详细情况,可以查看CacheBuilderSpec。
spring.cache.hazelcast.config
用来初始化Hazelcast的配置文件的位置。
spring.cache.infinispan.config
用来初始化Infinispan的配置文件的位置。
spring.cache.jcache.config
用来初始化缓存管理器的配置文件的位置。配置文件依赖于底层的缓存实现。
spring.cache.jcache.provider
CachingProvider实现的全限定类名,用来获取JSR-107兼容的缓存管理器,仅在Classpath里有不只一个JSR-107实现时才需要这个属性。
spring.cache.type
缓存类型,默认根据环境自动检测。
spring.dao.exceptiontranslation.enabled
打开PersistenceExceptionTranslationPostProcessor。(默认值:true。)
spring.data.elasticsearch.cluster-name
Elasticsearch集群名。(默认值:elasticsearch)
spring.data.elasticsearch.cluster-nodes
集群节点地址列表,用逗号分隔。如果没有指定,就启动一个客户端节点。
spring.data.elasticsearch.properties
用来配置客户端的额外属性。
spring.data.elasticsearch.repositories.enabled
开启Elasticsearch仓库。(默认值:true。)
spring.data.jpa.repositories.enabled
开启JPA仓库。(默认值:true。)
spring.data.mongodb.authentication-database
身份认证数据库名。
spring.data.mongodb.database
数据库名。
spring.data.mongodb.field-naming-strategy
要使用的FieldNamingStrategy的全限定名。
spring.data.mongodb.grid-fs-database
GridFS数据库名称。
spring.data.mongodb.host
Mongo服务器主机地址。
spring.data.mongodb.password
Mongo服务器的登录密码。
spring.data.mongodb.port
Mongo服务器端口号。
spring.data.mongodb.repositories.enabled
开启Mongo仓库。(默认值:true。)
spring.data.mongodb.uri
Mongo数据库URI。设置了该属性后就主机和端口号会被忽略。(默认值:mongodb://localhost/test。)
spring.data.mongodb.username
Mongo服务器的登录用户名。
spring.data.rest.base-path
用于发布仓库资源的基本路径。
spring.data.rest.default-page-size
分页数据的默认页大小。(默认值:20。)
spring.data.rest.limit-param-name
用于标识一次返回多少记录的URL查询字符串参数名。(默认值:size。)
spring.data.rest.max-page-size
最大分页大小。(默认值:1000。)
spring.data.rest.page-param-name
URL查询字符串参数的名称,用来标识返回哪一页。(默认值:page。)
spring.data.rest.return-body-on-create
在创建实体后是否返回一个响应体。(默认值:false。)
spring.data.rest.return-body-on-update
在更新实体后是否返回一个响应体。(默认值:false。)
spring.data.rest.sort-param-name
URL查询字符串参数的名称,用来标识结果排序的方向。(默认值:sort。)
spring.data.solr.host
Solr的主机地址。如果设置了zk-host则忽略该属性。(默认值:http://127.0.0.1:8983/solr。)
spring.data.solr.repositories.enabled
开启Solr仓库。(默认值:true。)
spring.data.solr.zk-host
ZooKeeper主机地址,格式为“主机:端口”。
spring.datasource.abandon-when-percentage-full
一个百分比形式的阈值,超过该阈值则关闭并报告被弃用(超时)的连接。
spring.datasource.allow-pool-suspension
是否允许池暂停(pool suspension)。在开启池暂停后会有性能会受到一定影响,除非你真的需要这个功能(例如在冗余的系统下),否则不要开启它。该属性只在使用Hikari数据库连接池时有用。(默认值:false。)
spring.datasource.alternate-username-allowed
是否允许使用其他用户名。
spring.datasource.auto-commit
更新操作是否自动提交。
spring.datasource.catalog
默认的Catalog名称。
spring.datasource.commit-on-return
在连接归还时,连接池是否要提交挂起的事务。
spring.datasource.connection-init-sql
在所有新连接创建时都会执行的SQL语句,该语