springboot:框架想学好,属性配置和使用你都明白了吗?

在昨天介绍springboot框架之后,大家对于这个框架的热度还是不错。那么今天Damon继续更大家介绍下关于springboot更深入的东西。希望能够帮助大家成长以及进步。如果想要了解昨天的文章,可以去github或者翻阅下此前的纪录都能够看到。

Spring Boot 属性配置和使用

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

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

这些方式优先级如下:

    1. 命令行参数
    1. 来自java:comp/env的JNDI属性
    1. Java系统属性(System.getProperties())
    1. 操作系统环境变量
    1. RandomValuePropertySource配置的random.*属性值
    1. jar包外部的application-{profile}.properties或application.yml(带spring.profile)配置文件
    1. jar包内部的application-{profile}.properties或application.yml(带spring.profile)配置文件
    1. jar包外部的application.properties或application.yml(不带spring.profile)配置文件
    1. jar包内部的application.properties或application.yml(不带spring.profile)配置文件
    1. @Configuration注解类上的@PropertySource
    1. 通过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_HOME的应该都了解这一个。
  • 这里需要注意的地方,有些OS可以不支持使用.这种名字,如server.port,这种情况可以使用SERVER_PORT来配置。

应用配置文件(.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对象中。
  • 这种方式比较少见,我们在整合mybatis那章结合Druid的配置来具体演示。

属性占位符

  • 例如:
    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,大写下划线形式,建议在系统环境变量中使用

原文 

https://juejin.im/post/5d653f2de51d4562043f5739

本站部分文章源于互联网,本着传播知识、有益学习和研究的目的进行的转载,为网友免费提供。如有著作权人或出版方提出异议,本站将立即删除。如果您对文章转载有任何疑问请告之我们,以便我们及时纠正。

PS:推荐一个微信公众号: askHarries 或者qq群:474807195,里面会分享一些资深架构师录制的视频录像:有Spring,MyBatis,Netty源码分析,高并发、高性能、分布式、微服务架构的原理,JVM性能优化这些成为架构师必备的知识体系。还能领取免费的学习资源,目前受益良多

转载请注明原文出处:Harries Blog™ » springboot:框架想学好,属性配置和使用你都明白了吗?

赞 (0)
分享到:更多 ()

评论 0

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址