springboot属性配置和使用(转)

沧海一滴 沧海一滴     2022-07-31     206

关键词:

Spring Boot 属性配置和使用

Spring Boot 允许通过外部配置让你在不同的环境使用同一应用程序的代码,简单说就是可以通过配置文件来注入属性或者修改默认的配置。

Spring Boot 入门 请看:http://blog.csdn.net/isea533/article/details/50278205

Spring Boot 支持多种外部配置方式

这些方式优先级如下:

  1. 命令行参数
  2. 来自java:comp/env的JNDI属性
  3. Java系统属性(System.getProperties()
  4. 操作系统环境变量
  5. RandomValuePropertySource配置的random.*属性值
  6. jar包外部的application-{profile}.propertiesapplication.yml(带spring.profile)配置文件
  7. jar包内部的application-{profile}.propertiesapplication.yml(带spring.profile)配置文件
  8. jar包外部的application.propertiesapplication.yml(不带spring.profile)配置文件
  9. jar包内部的application.propertiesapplication.yml(不带spring.profile)配置文件
  10. @Configuration注解类上的@PropertySource
  11. 通过SpringApplication.setDefaultProperties指定的默认属性

命令行参数

通过java -jar app.jar --name="Spring" --server.port=9090方式来传递参数。

参数用--xxx=xxx的形式传递。

可以使用的参数可以是我们自己定义的,也可以是Spring Boot中默认的参数。

很多人可能会关心如web端口如何配置这样的问题,这些都是Spring Boot中提供的参数,部分可用参数如下:

# LOGGING
logging.path=/var/logs
logging.file=myapp.log
logging.config= # location of config file (default classpath:logback.xml for logback)
logging.level.*= # levels for loggers, e.g. "logging.level.org.springframework=DEBUG" (TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF)

# EMBEDDED SERVER CONFIGURATION (ServerProperties)
server.port=8080
server.address= # bind to a specific NIC
server.session-timeout= # session timeout in seconds
server.context-parameters.*= # Servlet context init parameters, e.g. server.context-parameters.a=alpha
server.context-path= # the context path, defaults to ‘/‘
server.servlet-path= # the servlet path, defaults to ‘/‘

更多常见的应用属性请浏览这里

注意:命令行参数在app.jar的后面!

可以通过SpringApplication.setAddCommandLineProperties(false)禁用命令行配置。

Java系统属性

注意Java系统属性位置java -Dname="isea533" -jar app.jar,可以配置的属性都是一样的,优先级不同。

例如java -Dname="isea533" -jar app.jar --name="Spring!"name值为Spring!

操作系统环境变量

配置过JAVA_HOME的应该都了解这一个。

这里需要注意的地方,有些OS可以不支持使用.这种名字,如server.port,这种情况可以使用SERVER_PORT来配置。

具体名字如何匹配,看本文后面。

RandomValuePropertySource

系统中用到随机数的地方,例如:

my.secret=${random.value}
my.number=${random.int}
my.bignumber=${random.long}
my.number.less.than.ten=${random.int(10)}
my.number.in.range=${random.int[1024,65536]}

random.int*支持value参数和,max参数,当提供max参数的时候,value就是最小值。

应用配置文件(.properties或.yml)

在配置文件中直接写:

name=Isea533
server.port=8080

.yml格式的配置文件如:

name: Isea533
server:
    port: 8080

当有前缀的情况下,使用.yml格式的配置文件更简单。关于.yml配置文件用法请看这里

注意:使用.yml时,属性名的值和冒号中间必须有空格,如name: Isea533正确,name:Isea533就是错的。

属性配置文件的位置

spring会从classpath下的/config目录或者classpath的根目录查找application.propertiesapplication.yml

/config优先于classpath根目录

@PropertySource

这个注解可以指定具体的属性配置文件,优先级比较低。

SpringApplication.setDefaultProperties

例如:

SpringApplication application = new SpringApplication(Application.class);
Map<String, Object> defaultMap = new HashMap<String, Object>();
defaultMap.put("name", "Isea-Blog");
//还可以是Properties对象
application.setDefaultProperties(defaultMap);
application.run(args);

应用(使用)属性

@Value(“${xxx}”)

这种方式是最简单的,通过@Value注解可以将属性值注入进来。

@ConfigurationProperties

Spring Boot 可以方便的将属性注入到一个配置对象中。例如:

my.name=Isea533
my.port=8080
my.servers[0]=dev.bar.com
my.servers[1]=foo.bar.com

对应对象:

@ConfigurationProperties(prefix="my")
public class Config {
    private String name;
    private Integer port;
    private List<String> servers = new ArrayList<String>();

    public String geName(){
        return this.name;
    }

    public Integer gePort(){
        return this.port;
    }
    public List<String> getServers() {
        return this.servers;
    }
}

Spring Boot 会自动将prefix="my"前缀为my的属性注入进来。

Spring Boot 会自动转换类型,当使用List的时候需要注意在配置中对List进行初始化!

Spring Boot 还支持嵌套属性注入,例如:

name=isea533
jdbc.username=root
jdbc.password=root
...

对应的配置类:

@ConfigurationProperties
public class Config {
    private String name;
    private Jdbc jdbc;
    class Jdbc {
        private String username;
        private String password;
        //getter...
    }

    public Integer gePort(){
        return this.port;
    }
    public Jdbc getJdbc() {
        return this.jdbc;
    }
}

jdbc开头的属性都会注入到Jdbc对象中。

在@Bean方法上使用@ConfigurationProperties

例如:

@ConfigurationProperties(prefix = "foo")
@Bean
public FooComponent fooComponent() {
    ...
}

Spring Boot 会将foo开头的属性按照名字匹配注入到FooComponent对象中。

属性占位符

例如:

app.name=MyApp
app.description=${app.name} is a Spring Boot application

可以在配置文件中引用前面配置过的属性(优先级前面配置过的这里都能用)。

通过如${app.name:默认名称}方法还可以设置默认值,当找不到引用的属性时,会使用默认的属性。

由于${}方式会被Maven处理。如果你pom继承的spring-boot-starter-parent,Spring Boot 已经将maven-resources-plugins默认的${}方式改为了@ @方式,例如@[email protected]

如果你是引入的Spring Boot,你可以修改使用其他的分隔符

通过属性占位符还能缩短命令参数

例如修改web默认端口需要使用--server.port=9090方式,如果在配置中写上:

server.port=${port:8080}

那么就可以使用更短的--port=9090,当不提供该参数的时候使用默认值8080

属性名匹配规则

例如有如下配置对象:

@Component
@ConfigurationProperties(prefix="person")
public class ConnectionSettings {

    private String firstName;

}

firstName可以使用的属性名如下:

  1. person.firstName,标准的驼峰式命名
  2. person.first-name,虚线(-)分割方式,推荐在.properties.yml配置文件中使用
  3. PERSON_FIRST_NAME,大写下划线形式,建议在系统环境变量中使用

属性验证

可以使用JSR-303注解进行验证,例如:

@Component
@ConfigurationProperties(prefix="connection")
public class ConnectionSettings {

    @NotNull
    private InetAddress remoteAddress;

    // ... getters and setters

}

最后

以上是Spring Boot 属性配置和使用的内容,有些不全面的地方或者读者有更多疑问,可以查看Spring Boot完整文档 或 Externalized Configuration

关于Spring Boot更多的内容可以继续关注本博客。

Spring Boot 系列

由于我博客Spring Boot 系列文章还不够多,所以暂时不打算创建专栏,如果再多几篇我就建专栏。

  1. Spring Boot 入门

  2. Spring Boot 属性配置和使用

  3. Spring Boot 集成MyBatis

  4. Spring Boot 静态资源处理

http://blog.csdn.net/isea533/article/details/50281151

 

springboot属性配置和使用

...就是可以通过配置文件来注入属性或者修改默认的配置。SpringBoot系列SpringBoot入门SpringBoot属性配置和使用SpringBoot集成MyBatisSpringBoot静态资源处理SpringBoot-配置排序依赖技巧SpringBoot-DevTools介绍SpringBoot支持 查看详情

springboot属性配置和使用

SpringBoot 属性配置和使用1、添加属性文件 application.properties (名字固定) 2、访问端口生效 3、更多配置参考 #===================================================================#COMMONSPRINGBOOTPROPERTIES 查看详情

springboot属性配置和使用(代码片段)

SpringBoot属性配置和使用SpringBoot是由Pivotal团队提供的全新框架,其设计目的是用来简化新Spring应用的初始搭建以及开发过程。该框架使用了特定的方式来进行配置,从而使开发人员不再需要定义样板化的配置。简单说就... 查看详情

springboot属性配置和使用(代码片段)

SpringBoot属性配置和使用SpringBoot是由Pivotal团队提供的全新框架,其设计目的是用来简化新Spring应用的初始搭建以及开发过程。该框架使用了特定的方式来进行配置,从而使开发人员不再需要定义样板化的配置。简单说就... 查看详情

springboot属性配置和使用

Springboot中yml配置文件的缩进是按前面字母的,不是以后面":"为参照物的注解是javaSE5中的重要的语言变化之一。它们可以提供用来完整地描述程序所需的信息,而这些信息是无法用java来表达的。因此注解可以用来生成描述文件,... 查看详情

使用springboot配置和注入数据源属性的方法和步骤

 /**   1、书写一个名为resources/application.properties的属性文件---->书写一个配置属性类,类名为:**/   文件:application.propertiesjdbc.driverClassName=com.mysql.jdbc.Driverjdbc.url=jdbc:mysq 查看详情

如何使用springboot和嵌入式tomcat配置此属性?

我是否在application.properties文件中配置了像connectionTimeout这样的属性,或者在其他地方配置它?我无法从谷歌那里得知这一点。Tomcatpropertieslist我发现这个Spring-Bootexample,但它不包含connectionTimeout属性,当我在我的application.properties... 查看详情

spring编程:springboot属性配置和属性优先级

SpringBoot允许我们外部化程序的配置,以便我们可以在不同的环境中使用相同的应用代码。我们可以使用properties、YAML、环境变量、命令行参数进行外部化配置。配置的属性值可以通过@Value注解直接注入到beans中,通过Sp... 查看详情

如何使用 SpringBoot2、JUnit5 和 Kotlin 将配置属性注入单元测试

】如何使用SpringBoot2、JUnit5和Kotlin将配置属性注入单元测试【英文标题】:HowcanIinjectconfigpropertiesintoaunittest,usingSpringBoot2,JUnit5,andKotlin【发布时间】:2018-12-2202:03:35【问题描述】:我的场景:我正在构建一个使用Kotlin和SpringBoot2.0.3... 查看详情

springboot配置分析(属性和结构化)

使用idea自带插件创建项目一直下一步到完成 application.propertieslocal.ip.addr=192.168.2.110redis.host=192.168.3.11redis.auth=redis-01redis.port=6380gerry.datasource.driverClassName=com.mysql.jdbc.Drivergerry.dataso 查看详情

springboot中yaml文件配置属性

参考技术A首先,在SpringBoot中,有两种配置文件的方式。一种是application.properties,另一种application.yaml(或者是application.yml)。yaml文件格式是SpringBoot支持的一种JSON超集文件格式,相对于传统的Properties配置文件,yaml文件以数据为核... 查看详情

springboot配置文件详解(告别xml)

参考技术A快速学会和掌握SpringBoot的核心配置文件的使用。SpringBoot提供了丰富的外部配置,常见的有:其中核心配置文件我们并不陌生,主要以Key-Value的形式进行配置,其中属性Key主要分为两种:在application.properties添加配置如... 查看详情

springboot配置文件注解

参考技术Aspringboot使用一个全局配置文件,配置文件的名字是固定的:application.properties或application.yml@ConfigurationProperties:将全局配置文件的属性值,映射到SpringBoot组件上@Value:从全局配置文件中读取属性,映射到组件上@PropertySour... 查看详情

springboot的配置文件有哪几种格式?

SpringBoot中的配置文件主要有三种格式,properties、yaml、和xml方式。-其中properties格式配置文件后缀是.properties,配置项为:server.port=9090-yaml格式配置文件后缀是.yml,配置项是:server.port:9090在SpringBoot中,使用最广泛的配置文件是ya... 查看详情

springboot--外部配置的属性使用

SpringBoot允许使用propertities文件、yaml文件或者命令行参数作为外部配置。命令行参数配置SpringBoot可以基于jar包运行,打成jar包的程序可以直接通过下面的命令运行:java-jarxx.jar可以通以下命令修改Tomcat端口号:java-jarxx.jar--server.po... 查看详情

springboot-属性直接注入

SpringBoot-属性直接注入SpringBoot-属性直接注入上面我们说到,如果公共的属性,我们可以使用Java类加载Properties文件,来达到复用的目的,在SpringBoot中,我们提供了更为简单的方法,即直接使用配置文件注入。使用直接注入我们... 查看详情

Spring Boot:自定义属性配置和测试

】SpringBoot:自定义属性配置和测试【英文标题】:SpringBoot:custompropertiesconfigurationandtests【发布时间】:2018-11-1400:49:27【问题描述】:我正在使用带有默认application.yml属性文件的SpringBoot2.0。我想将它拆分为单独的属性文件,因为... 查看详情

springboot获取properties配置文件的属性

自定义properties文件获取属性 使用  @ConfigurationProperties((prefix="demo"))和  @PropertySource("classpath:myconfig.properties")来批量注值到bean中@Component@ConfigurationProperties(prefix="com.jy")@PropertySource(" 查看详情