`
xlaohe1
  • 浏览: 128593 次
  • 性别: Icon_minigender_1
  • 来自: 来处
社区版块
存档分类
最新评论

Spring Boot 属性配置和使用 (转)

阅读更多
Spring Boot 属性配置和使用

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

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

Spring Boot 支持多种外部配置方式
这些方式优先级如下:

命令行参数
来自java:comp/env的JNDI属性
Java系统属性(System.getProperties())
操作系统环境变量
RandomValuePropertySource配置的random.*属性值
jar包外部的application-{profile}.properties或application.yml(带spring.profile)配置文件
jar包内部的application-{profile}.properties或application.yml(带spring.profile)配置文件
jar包外部的application.properties或application.yml(不带spring.profile)配置文件
jar包内部的application.properties或application.yml(不带spring.profile)配置文件
@Configuration注解类上的@PropertySource
通过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.properties或application.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默认的${}方式改为了@ @方式,例如@name@。

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

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

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

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

属性名匹配规则
例如有如下配置对象:

@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。

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

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

Spring Boot 入门

Spring Boot 属性配置和使用

Spring Boot 集成MyBatis

Spring Boot 静态资源处理

转: http://blog.csdn.net/isea533/article/details/50281151
分享到:
评论

相关推荐

    Spring Boot自定义配置属性源(PropertySource)

    例如,创建一个`DemoProperties`类,声明对应的getter和setter方法,然后在`DemoAutoConfiguration`类中通过`@Autowired`注入这个对象,Spring Boot会自动将配置文件中的相应属性值填充到这个对象中。 如果需要更...

    Spring boot工具类静态属性注入及多环境配置详解

    Spring Boot工具类静态属性注入是指使用Spring Boot框架时,如何将配置信息注入到工具类的静态变量中,以便在程序中使用这些配置信息。这种方式可以方便地在不同的环境中切换配置信息,例如在开发环境中使用本地的...

    spring-boot-2.7.0.zip源码

    6. **条件注解**:Spring Boot使用`@Conditional`系列注解,如`@ConditionalOnClass`、`@ConditionalOnMissingBean`等,使得配置的启用基于特定条件,增加了代码的灵活性。 7. **属性绑定**:`@Value`和`@...

    十分钟上手spring boot

    在不使用parent POM的情况下玩转Spring Boot** - 也可以选择不使用parent POM。 - **13.2.3. 使用Spring Boot Maven插件** - 使用该插件来简化构建过程。 - **13.3. Gradle** - Gradle也是Spring Boot支持的另...

    Spring Boot环境配置

    总结来说,配置Spring Boot环境涉及Java环境的搭建,Spring Boot项目的创建,配置文件的理解与使用,以及Spring Boot核心特性的掌握。理解并熟练运用这些知识点,将有助于你高效地进行Spring Boot应用的开发工作。

    Spring-Boot-Reference-Guide, Spring Boot Reference Guide中文翻译 -《Spring Boot参考指南》.zip

    Spring Boot是Java开发领域中一个极其流行的轻量级框架,它简化了Spring应用程序的初始设置和配置,使得开发者可以快速启动和运行项目。 一、Spring Boot核心概念 1. 快速起步:Spring Boot通过“起步依赖”...

    详解Spring Boot 属性配置和使用

    Spring Boot 属性配置和使用详解 Spring Boot 框架提供了多种方式来配置属性,包括命令行参数、Java 系统属性、操作系统环境变量、配置文件等。这些配置方式可以让开发者在不同的环境中使用同一应用程序的代码,...

    Spring Boot多模块配置文件读取

    本文将详细探讨如何在Spring Boot的多模块项目中管理和使用不同的配置文件,以实现低耦合的设计。 首先,了解Spring Boot的默认配置机制。Spring Boot的核心理念是简化配置,它通过`application.properties`或`...

    spring boot项目配置通用模板

    - `application.properties`或`application.yml`是Spring Boot应用的主要配置文件,用来设置应用的属性。这些配置可以覆盖默认值,如数据库连接信息、服务器端口等。 4. **Maven或Gradle构建**: - Spring Boot...

    《Spring Boot企业级开发教程》配套资料

    这通常包括Spring Boot的基础概念,如起步依赖、配置属性、Spring Boot的Starter POMs,再到高级主题,如微服务架构、云原生应用、Docker容器化等。大纲有助于学习者规划学习进度,确保全面掌握每个知识点。 课后题...

    浅谈Spring Boot 属性配置和自定义属性配置

    Spring Boot 属性配置和自定义属性配置详解 在 Spring Boot 中,属性配置是一项非常重要的功能,主要用于配置项目中的各种设置,如服务器端口、数据库连接信息、自定义属性等。在本文中,我们将详细介绍 Spring ...

    spring boot 中文文档

    Spring Boot专注于快速和广泛的应用程序开发,它遵循“约定优于配置”的原则,几乎可以实现零配置。 在文档的“开始”部分,介绍了Spring Boot的基础知识,包括系统要求、安装方法以及如何创建和运行第一个Spring ...

    Spring Boot in Action 英文版

    此外,Spring Boot还允许开发者在运行时覆盖应用的配置属性,这种设计允许开发者在不同的环境(如开发环境和生产环境)中部署相同的应用,而无需修改应用代码。 Spring Boot的初始化可以使用Spring Initializr进行...

    Spring Boot读取配置文件常用方式

    Spring Boot提供了多种方式来读取和使用这些配置文件,使其更加便捷和高效。以下将详细介绍Spring Boot读取配置文件的常用方法。 1. **属性文件** Spring Boot默认支持两种主要的属性文件格式:`application....

    Spring boot访问jsp页面

    在本文中,我们将深入探讨如何使用Spring Boot框架访问JSP页面,同时介绍如何结合Maven插件和MyBatis来自动生成Mapper、Model和相关的XML配置文件,以便于简化开发流程。 首先,让我们来理解Spring Boot与JSP的集成...

    Spring Boot 学习笔记完整教程.pdf

    - 自定义属性和配置文件:Spring Boot允许开发者定义自定义的属性文件,并通过@Value注解或Environment对象来加载这些属性。 - 系统启动任务:Spring Boot提供了CommandLineRunner接口,允许开发者在应用启动时执行...

    Spring boot将配置属性注入到bean类中

    在Spring Boot中,属性注入是核心特性之一,它使得我们可以方便地将配置文件中的参数值注入到Bean类的属性中,从而实现灵活的配置管理。本文将详细讲解如何利用`@ConfigurationProperties`注解以及与`@...

    Spring cloud spring boot spring boot admin

    在实际使用中,开发者需要按照官方文档或者示例代码设置相关配置,确保Spring Boot Admin Server能正确发现并监控到Spring Boot应用实例。这对于微服务架构的监控和运维来说非常实用,可以帮助开发者及时发现问题并...

    Spring Boot参考指南(2.0.1)中文版.pdf

    1. 属性配置:Spring Boot 支持多种配置方式,例如 properties 文件、YAML 文件和环境变量。 2. 自动配置:Spring Boot 提供了自动配置功能,可以根据依赖关系自动配置应用程序。 3. 外部化配置:Spring Boot 支持...

    spring-boot-中文参考手册

    Spring Boot是Java开发中的一个热门框架,由Pivotal团队创建,旨在简化Spring应用程序的初始设置和常规配置。它提供了一种快速构建独立运行的、生产级别的基于Spring的应用程序的方法。Spring Boot的核心特性包括...

Global site tag (gtag.js) - Google Analytics