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

R-Pursue R-Pursue     2022-12-02     328

关键词:

Spring Boot 属性配置和使用

Spring Boot是由Pivotal团队提供的全新框架,其设计目的是用来简化新Spring应用的初始搭建以及开发过程。该框架使用了特定的方式来进行配置,从而使开发人员不再需要定义样板化的配置。简单说就是可以通过配置文件来注入属性或者修改默认的配置。

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

这些方式优先级如下:

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

命令行参数

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

可以通SpringApplication.setAddCommandLineProperties(false)来取消这种方式的配置

Java系统属性

Java系统属性配置方式为
java -Dname="SpringBoot" -jar app.jar

这和命令行参数可以配置的属性都是一样的,只是优先级不同。

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

操作系统环境变量

操作系统环境变量是设备上的配置的环境变量,各Java开发肯定配置过java_home。这就是一种操作系统环境变量
需要注意的是,有些OS不支持使用.这种名字,如server.port,这种情况可以使用SERVER_PORT来配置。

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

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

.properties配置文件中直接写:

name=SpringBoot
server.port=7001

.yml格式的配置文件:

name: SpringBoot
server:
    port: 7001

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

.yml配置文件用法请戳官方文档

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

属性配置文件的位置

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", "SpringBoot");
//还可以是Properties对象
application.setDefaultProperties(defaultMap);
application.run(args);

使用属性

Value(“$xxx”)

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

ConfigurationProperties

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

my.name=SpringBoot
my.port=7001
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:默认名称方法还可以设置默认值,当找不到引用的属性时,会使用默认的属性。

由于 MavenpomspringbootstarterparentSpringBootmavenresourcesplugins 方式改为了@ @方式,例如@name@。

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

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

server.port=$port:7001

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

属性名匹配规则

例如有如下配置对象:

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

    private String firstName;

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

person.firstName,标准的驼峰式命名

person.first-name,虚线(-)分割方式,推荐在.properties和.yml配置文件中使用

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。文章哪里有不妥之处还烦请指正。

springboot属性配置和使用

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

spring和springboot的属性(代码片段)

...tySource或通过XML和<property-placeholder>,以及属性如何在SpringBoot中工作。2.通过Java注解注册属性文件Spring3.1还引入了新的@PropertySource注解,作为向环境添加属性源的便捷机制。此注解将与基于Java的 查看详情

springboot属性配置和使用(转)

SpringBoot属性配置和使用SpringBoot允许通过外部配置让你在不同的环境使用同一应用程序的代码,简单说就是可以通过配置文件来注入属性或者修改默认的配置。SpringBoot入门 请看:http://blog.csdn.net/isea533/article/details/50278205SpringB... 查看详情

springboot基于zookeeper和curator生成唯一id(代码片段)

目录一、简介二、maven依赖三、配置3.1、属性配置文件3.2、属性配置类3.3、zookeeper配置类(核心)四、具体使用4.1、zookeeperClient(核心)4.2、controller层五、测试5.1、多实例5.2、nginx转发配置5.3、使用jmeter并发测试5.... 查看详情

springboot加载指定的属性文件(properties和yml文件)(代码片段)

springboot提供了多个注解可以将外部的值动态注入到Bean中,最常用的包括@Value注解,@ConfigurationProperties注解。这些注解只能读取默认的配置文件application.properties,要想加载非默认配置文件,需结合@PropertyS... 查看详情

springboot加载指定的属性文件(properties和yml文件)(代码片段)

...3 @PropertySource注解加载yml文件3、@value注解其他形式springboot提供了多个注解可以将外部的值动态注入到Bean中,最常用的包括@Value注解,@ConfigurationProperties注解。这些注解只能读取默认的配置文件application.propert... 查看详情

java后端开发第三篇:springboot中资源属性配置及使用(代码片段)

简单记录Springboot中@Configuration,@ConfigurationProperties等与资源属性配置相关的注解使用:pom.xml中添加依赖<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot- 查看详情

springboot属性配置和使用

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

springboot启动jar包时设置临时属性(代码片段)

什么是临时属性临时属性是指在运行SpringBoot应用程序时,临时指定的一些属性值。临时属性值只对该次运行有效,在下次启动应用程序时将被重置。这种方式可以极大地方便我们测试不同的应用场景和配置,而不需要修改配置... 查看详情

springboot中yml文件的读取(代码片段)

...sprivateStringlocation;privateStringmaxSize;@ConfigurationProperties是SpringBoot中用于从配置文件读取配置属性的注解。当你使用@ConfigurationProperties(prefix=“global.upload”)注解的时候,你可以读取配置文件中以“global.upload”为前缀的... 查看详情

springboot之属性读写详解(代码片段)

SpringBoot之属性读写详解加载property顺序随机属性命令行属性Application属性文件Profile特定属性属性中的占位符YAML属性访问属性多profile配置YAML的缺点属性前缀属性松散绑定规则属性转换时间单位转换数据大小转换校验属性源码引申... 查看详情

springboot属性配置和使用

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

springboot文件的基本属性配置(代码片段)

属性配置1.修改服务器端口号springboot种默认的配置文件是以键值对存在的#服务器端口配置server.port=802.修改banner(刚启动时的login)#修改bannerspring.main.banner-mode=off3.日志级别#日志级别logging.level.root=info4.多种属性的配置方式1... 查看详情

springboot1.x和2.x将配置属性绑定到对象上(代码片段)

一、问题描述1、描述在基于springboot进行封装自定义框架或对某个开源框架进行二次改造时我们经常会涉及到将application.yml或者application.properties中配置的属性绑定到某个类对应的属性上使用@Value或@ConfigurationProperties这种方... 查看详情

springboot1.x和2.x将配置属性绑定到对象上(代码片段)

一、问题描述1、描述在基于springboot进行封装自定义框架或对某个开源框架进行二次改造时我们经常会涉及到将application.yml或者application.properties中配置的属性绑定到某个类对应的属性上使用@Value或@ConfigurationProperties这种方... 查看详情

(拿来主义-8)springboot属性配置文件详解(代码片段)

相信很多人选择SpringBoot主要是考虑到它既能兼顾Spring的强大功能,还能实现快速开发的便捷。我们在SpringBoot使用过程中,最直观的感受就是没有了原来自己整合Spring应用时繁多的XML配置内容,替代它的是在pom.xml中引入模块化的... 查看详情

springboot学习总结外部配置(代码片段)

Springboot允许使用properties文件、yaml文件或者命令行参数作为外部配置(一)常规属性配置(基于properties、yaml文件)请求http://localhost:8090/yml-value-test,返回结果如下:(二)命令行参数配置当Springboot是基于jar包运行时,可以使用... 查看详情

springboot自动配置原理以及手动实现配置类(代码片段)

springboot自动配置原理以及手动实现配置类1、原理spring有一个思想是“约定大于配置”。配置类自动配置可以帮助开发人员更加专注于业务逻辑开发,springboot在启动的时候可以把一些配置类自动注入到spring的IOC容器里,项目运行... 查看详情