欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

SpringBoot(三) 配置文件 篇章

程序员文章站 2022-03-25 22:50:14
SpringBoot 配置文件默认为application.properties,但是本章节主要讲解yaml文件配置,因为现在的趋势是使用yaml,它是类似于标准通用标记语言的子集XML的数据描述语言,语法比XML简单很多。 pom文件贴在最后面: 一、自定义属性与加载我们把之前项目中的配置文件ap ......

springboot 配置文件默认为application.properties,但是本章节主要讲解yaml文件配置,因为现在的趋势是使用yaml,它是类似于标准通用标记语言的子集xml的数据描述语言,语法比xml简单很多。

pom文件贴在最后面:

一、自定义属性与加载
我们把之前项目中的配置文件application.properties改成application.yml

test:
user:
username : zhangsan
age : 18
tostring: the age of ${test.user.username} is ${test.user.age}

属性类

package cn.saytime.bean;

import org.springframework.beans.factory.annotation.value;
import org.springframework.stereotype.component;

@component
public class propertiesconfig {

@value("${test.user.username}")
private string username;

@value("${test.user.age}")
private string age;

@value("${test.user.tostring}")
private string tostring;

// ... getter setter

}

 


测试controller

package cn.saytime.web;

import cn.saytime.bean.propertiesconfig;
import org.springframework.beans.factory.annotation.autowired;
import org.springframework.web.bind.annotation.requestmapping;
import org.springframework.web.bind.annotation.requestmethod;
import org.springframework.web.bind.annotation.restcontroller;

@restcontroller
public class testcontroller {

@autowired
private propertiesconfig propertiesconfig;

@requestmapping(value = "test", method = requestmethod.get)
public string test(){
//    return propertiesconfig.getusername() + ":" + propertiesconfig.getage();
return propertiesconfig.gettostring();
}
}

访问 http://127.0.0.1/test 

或者测试单元: 注意:要在springboot启动类下面新建测试类

package cn.demo;

import java.util.properties;

import org.junit.test;
import org.junit.runner.runwith;
import org.springframework.beans.factory.annotation.autowired;
import org.springframework.boot.test.context.springboottest;
import org.springframework.test.context.junit4.springrunner;

import cn.demo.bean.config;
import cn.demo.bean.person;
import cn.demo.bean.user;

@runwith(springrunner.class)
@springboottest
public class propertiestest {
    
    @autowired
    private user user;
    
    @autowired
    private person person;
    
  //新建的test.yml和 person.yml文件,取不到值,都是null,但是新建的person.properies可以取值。
    
    @test
    public void test() {
        system.out.println("server display name:" + user.getusername());
        system.out.println("server address:" + user.getage());
        system.out.println("server emain:" + user.getemail());
    }
    
    @test
    public void test2() {
        system.out.println("person-infomation:" + person.tostring());
    }
    
    
}

二、自定义属性注入bean
将上面application.yml文件中的test.user注入到user对象里,注意这里的prefix指定的是test.user,对应配置文件中的结构

@component
@configurationproperties(prefix = "test.user")
public class user {

private string username;

private int age;

public string getusername() {
return username;
}

// getter setter
}
@restcontroller
public class testcontroller {

@autowired
private user user;

@requestmapping(value = "test2", method = requestmethod.get)
public string test2(){
return user.getusername() + ":" + user.getage();
}
}

访问 http://localhost:8080/test2 ==> zhangsan : 18

 

三、自定义额外的配置文件
比如我们不想把有些配置配置在application.yml/properties中。新建其他配置文件。这里比如新建test.yml文件。配置内容如上面的application.yml一样。那么我们注入对象时,应该这么写

@configuration
@propertysource(value = "classpath:test.yml")
@configurationproperties(prefix = "test.user")
四、多个环境配置文件
在现实的开发环境中,我们需要不同的配置环境;格式为application-{profile}.properties,其中{profile}对应你的环境标识,比如:

application-test.properties:测试环境
application-dev.properties:开发环境
application-prod.properties:生产环境
怎么使用?只需要我们在application.yml中加:

spring:
profiles:
active: dev

因为主入口都是application.yml,这里指定配置文件为dev,即启用application-dev.yml文件

其中application-dev.yml:

server:
port: 8888

启动工程,发现程序的端口不再是8080,而是8888,表示开发环境配置成功。

六、官方支持默认配置文件属性
http://docs.spring.io/spring-boot/docs/1.5.4.release/reference/htmlsingle/#common-application-properties

七、属性加载优先级
1. @testpropertysource 注解
2. 命令行参数
3. java系统属性(system.getproperties())
4. 操作系统环境变量
5. 只有在random.*里包含的属性会产生一个randomvaluepropertysource
6. 在打包的jar外的应用程序配置文件(application-{profile}.properties,包含yaml和profile变量)
7. 在打包的jar内的应用程序配置文件(application-{profile}.properties,包含yaml和profile变量)
8. 在@configuration类上的@propertysource注解
9. 默认属性(使用springapplication.setdefaultproperties指定)
也就是说比如我配置文件配置了一个name=zhangsan,然后将项目打成jar,运行的时候,如果我们使用 java -jar app.jar --name="spring",那么注入的进去的就是spring,优先级高

八、配置文件优先级
查看springboot官方文档,可以发现

 

翻译:

当前目录下的一个/config子目录
当前目录
一个classpath下的/config包
classpath根路径(root)
也就是说:如果我们有多个配置文件,比如 src/main/resource/application.yml

test:
user:
username : zhangsan
age : 18
tostring: the age of ${test.user.username} is ${test.user.age}

name: springboot-root

test2: ${test1}-root

test3: springcloud-root

server:
port: 8080
src/main/resource/config/application.yml

test:
user:
username: lisi-config

name: springboot-config

test1: ${name}-config

test4: ${test3}-config

server:
port: 9090

根据优先级,可以得到能够加载到springboot应用的属性为:

test:
user:
username : lisi
age : 18
tostring: the age of lisi is 18

name: springboot-config
test1: springboot-config-config
test2: springboot-config-config-root
test3: springcloud-root
test4: springcloud-root-config

server:
port: 9090


如果你能够得到上面的结果,表示你已经懂了。

注意优先级高的配置文件中存在和优先级低的配置文件相同属性时,取优先级高配置文件的,不冲突的时候,优先级低的配置文件属性同样会被加载,而不是只加载优先级高的配置文件属性。

九、简单总结
1、普通自定义属性,使用@value("${xxx}")注入 2、注入对象,使用@configurationproperties(prefix="test.user")


pom:

<project xmlns="http://maven.apache.org/pom/4.0.0" xmlns:xsi="http://www.w3.org/2001/xmlschema-instance"
  xsi:schemalocation="http://maven.apache.org/pom/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelversion>4.0.0</modelversion>
  <groupid>cn.demo</groupid>
  <artifactid>springboot_peizhi</artifactid>
  <version>0.0.1-snapshot</version>
  <packaging>jar</packaging>
  <name>springboot_peizhi</name>
  <url>http://maven.apache.org</url>

  <parent>
        <groupid>org.springframework.boot</groupid>
        <artifactid>spring-boot-starter-parent</artifactid>
       <version>2.0.4.release</version>
    </parent>
    <properties>
        <project.build.sourceencoding>utf-8</project.build.sourceencoding>
        <project.reporting.outputencoding>utf-8</project.reporting.outputencoding>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupid>org.springframework.boot</groupid>
            <artifactid>spring-boot-configuration-processor</artifactid>
            <optional>true</optional>
        </dependency>
        <!-- https://mvnrepository.com/artifact/org.apache.logging.log4j/log4j-api -->
        <dependency>
            <groupid>org.apache.logging.log4j</groupid>
            <artifactid>log4j-api</artifactid>
            <version>2.11.2</version>
        </dependency>
        <!-- spring-mybatis -->
        <dependency>
            <groupid>org.mybatis.spring.boot</groupid>
            <artifactid>mybatis-spring-boot-starter</artifactid>
            <version>1.3.0</version>
            </dependency>
        <!-- mysql -->
        <dependency>
            <groupid>mysql</groupid>
            <artifactid>mysql-connector-java</artifactid>
         </dependency>    
        <dependency>
            <groupid>org.springframework.boot</groupid>
            <artifactid>spring-boot-starter-web</artifactid>
        </dependency>
        <dependency>
            <groupid>org.springframework.boot</groupid>
            <artifactid>spring-boot-starter-test</artifactid>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupid>org.springframework.boot</groupid>
            <artifactid>spring-boot-configuration-processor</artifactid>
            <optional>true</optional>
         </dependency>
         <dependency>
            <groupid>org.springframework.boot</groupid>
            <artifactid>spring-boot-devtools</artifactid>
            <optional>true</optional>
         </dependency>
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupid>org.springframework.boot</groupid>
                <artifactid>spring-boot-maven-plugin</artifactid>
                <configuration>
                <fork>true</fork>
                </configuration>
            </plugin>
        </plugins>
  </build>
</project>