美文网首页Java架构师
Springboot:框架想学好,属性配置和使用你都明白了吗?

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

作者: Java耕耘者 | 来源:发表于2019-08-28 14:05 被阅读0次

    点关注,不迷路;持续更新Java相关技术

    喜欢底层源码的朋友可以来交流探讨。交流群:818491202 验证:33

    Spring Boot 属性配置和使用

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

    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_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 defaultMap = new HashMap();  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 servers = new ArrayList();      public String geName(){          return this.name;      }      public Integer gePort(){          return this.port;      }      public List 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,大写下划线形式,建议在系统环境变量中使用

    属性验证

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

    @Component  @ConfigurationProperties(prefix="connection")  public class ConnectionSettings {      @NotNull      private InetAddress remoteAddress;      // ... getters and setters  

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

    总结:

    作为一个新生程序猿,Damon希望能够与大家一同进步。文章或者描述有所不足的地方,希望大家多多提出来,一同进步。

    关注公众号领资料

    搜索公众号【Java耕耘者】,回复【Java】,即可获取大量优质电子书和一份Java高级架构资料、Spring源码分析、Dubbo、Redis、Netty、zookeeper、Spring cloud、分布式等视频资料

    相关文章

      网友评论

        本文标题:Springboot:框架想学好,属性配置和使用你都明白了吗?

        本文链接:https://www.haomeiwen.com/subject/itbpectx.html