SpringBoot基础配置

我的头条:https://www.toutiao.com/c/user/54449368910/#mid=1591720133858307

配置文件

1、配置文件
SpringBoot使用一个全局的配置文件,配置文件名是固定的;
  • •application.properties
  • •application.yml

配置文件的作用:修改SpringBoot自动配置的默认值;SpringBoot在底层都给我们自动配置好;

配置文件放在src/main/resources目录或者类路径/config下

YAML(YAML Ain't Markup Language)
  • YAML A Markup Language:是一个标记语言
  • YAML isn't Markup Language:不是一个标记语言;
标记语言:
以前的配置文件;大多都使用的是 xxxx.xml文件;
.yml是YAML(YAML Ain't Markup Language)语言的文件,以数据为中心,比json、xml等更适合做配置文件

YAML:配置例子

server:
  port: 8081
1、YAML基本语法
  • – 使用缩进表示层级关系
  • – 缩进时不允许使用Tab键,只允许使用空格。
  • – 缩进的空格数目不重要,只要相同层级的元素左侧对齐即可
  • – 大小写敏感
2、YAML 支持的三种数据结构
  • – 对象:键值对的集合
  • – 数组:一组按次序排列的值
  • – 字面量:单个的、不可再分的值

k:(空格)v:表示一对键值对(空格必须有);

以空格的缩进来控制层级关系;只要是左对齐的一列数据,都是同一个层级的

server:
    port: 8081
    path: /hello

属性和值也是大小写敏感;

2、值的写法
字面量:普通的值(数字,字符串,布尔)
k: v:字面直接来写;

字符串默认不用加上单引号或者双引号;

可以使用单引号或者双引号,单引号会转义特殊字符
字符串可以写成多行,从第二行开始,必须有一个单空格缩进。换行符会被转为空格。

"":双引号;不会转义字符串里面的特殊字符;特殊字符会作为本身想表示的意思
name: "zhangsan \n lisi":输出;zhangsan 换行 lisi
'':单引号;会转义特殊字符,特殊字符最终只是一个普通的字符串数据

name: ‘zhangsan \n lisi’:输出;zhangsan \n lisi

对象、Map(属性和值)(键值对):

  • • 对象的一组键值对,使用冒号分隔。如:username: admin
  • • 冒号后面跟空格来分开键值;
  • • {k: v}是行内写法

k: v:在下一行来写对象的属性和值的关系;注意缩进

对象还是k: v的方式

friends:
    lastName: zhangsan        
    age: 20 

行内写法:

friends: {lastName: zhangsan,age: 18}
数组(List、Set):
– 一组连词线(-)开头的行,构成一个数组,[]为行内写法

– 数组,对象可以组合使用

用- 值表示数组中的一个元素

pets:
 ‐ cat
 ‐ dog
 ‐ pig

行内写法

pets: [cat,dog,pig]
注意:Spring Boot使用 snakeyaml 解析yml文件;
https://bitbucket.org/asomov/snakeyaml/wiki/Documentation#markdown-header-yaml-
syntax
  参考语法


在单一文件中,可用连续三个连字号(---)区分多个文件。

另外,还有选择性的连续三个点号( ... )用来表示文件结尾。

YAML 语言教程:http://www.ruanyifeng.com/blog/2016/07/yaml.html

Java 配置是 Spring4.x 推荐的配置方式,可以完全替代 xml 配置
@Configuration 和 @Bean:
Spring的Java配置方式是通过 @Configuration 和 @Bean 这两个注解实现的:
1、@Configuration 作用于类上,相当于一个xml配置文件;
2、@Bean 作用于方法上,相当于xml配置中的<bean>;

Controller类读取配置信息带前缀的字符串:
比如我们要读取girl.cupSize=A和girl.height=160 这些带girl的配置信息,我们该怎么办呢。我们需要定义一个GirlProperties.java。@ConfigurationProperties代表我们要读取带什么前缀的配置信息,@Component代表这个类已经在Spring配置文件中注册过。

Controller类读取GirlProperties,我们要使用@Autowired注入GirlProperties这个类的实例,它是通过bean的类型注入的。启动Spring Boot应用,输出结果。

我们可以导入配置文件处理器,以后在application.yml中文件编写配置就有提示了

<!‐‐导入配置文件处理器,配置文件进行绑定就会有提示‐‐>
<dependency>        
    <groupId>org.springframework.boot</groupId>            
    <artifactId>spring‐boot‐configuration‐processor</artifactId>            
    <optional>true</optional>            
</dependency> 

1、properties配置文件在idea中默认utf-8可能会乱码

person.last-name=张三
person.age=${random.int}
person.birth=2017/12/15
person.boss=false
person.maps.k1=v1
person.maps.k2=14
person.lists=a,b,c
person.dog.age=15

读取外部的资源配置文件:
@ConfigurationProperties
– 与@Bean结合为属性赋值
– 与@PropertySource(只能用于properties文件)结合读取指定文件
通过 @PropertySource可以指定读取的配置文件,通过@Value注解获取值,具体用法:

2、@Value获取值和@ConfigurationProperties获取值比较


松散语法:

属性名匹配规则(Relaxed binding)

  • – person.firstName:使用标准方式
  • – person.first-name:大写用-,在@Value中使用firstName就会报错
  • – person.first_name:大写用_,在@Value中使用firstName就会报错
  • – PERSON_FIRST_NAME:推荐系统属性使用这种写法

配置文件yml还是properties他们都能获取到值;

如果说,我们只是在某个业务逻辑中需要获取一下配置文件中的某项值,使用@Value;

如果说,我们专门编写了一个javaBean来和配置文件进行映射,我们就直接使用@ConfigurationProperties;

@Value("#{11*11}")//SpEL可以使用
private Integer age;
@ConfigurationProperties Validation

– 支持JSR303进行配置文件值校验;


@ImportResource:导入Spring的配置文件,让配置文件里面的内容生效;
Spring Boot里面没有Spring的配置文件,我们自己编写的配置文件,也不能自动识别;
想让Spring的配置文件生效,加载进来;@ImportResource标注在一个配置类上

//@ImportResource(locations = {"classpath:beans.xml"})//导入Spring的配置文件让其生效
@SpringBootApplication
public class SpringBoot02ConfigApplication {
    public static void main(String[] args) {
        SpringApplication.run(SpringBoot02ConfigApplication.class, args);
    }
}
SpringBoot推荐给容器中添加组件的方式;推荐使用全注解的方式
1、配置类@Configuration------>Spring配置文件
2、使用@Bean给容器中添加组件
/**
 * @Configuration:指明当前类是一个配置类;就是来替代之前的Spring配置文件
 *
 * 在配置文件中用<bean><bean/>标签添加组件
 *
 */
@Configuration
public class MyAppConfig {

    //将方法的返回值添加到容器中;容器中这个组件默认的id就是方法名
    @Bean
    public HelloService helloService02(){
        System.out.println("配置类@Bean给容器中添加组件了...");
        return new HelloService();
    }

}

四、配置文件占位符

• RandomValuePropertySource:配置文件中可以使用随机数
${random.value}、${random.int}、${random.long}
${random.int(10)}、${random.int[1024,65536]}

属性配置占位符
– 可以在配置文件中引用前面配置过的属性(优先级前面配置过的这里都能用)。

2、占位符获取之前配置的值,如果没有可以是用:指定默认值

person.last‐name=张三${random.uuid}
person.age=${random.int}
person.birth=2017/12/15
person.boss=false
person.maps.k1=v1
person.maps.k2=14
person.lists=a,b,c
person.dog.name=${person.hello:hello}_dog
person.dog.age=15

${app.name:默认值}来指定找不到属性时的默认值,如:${person.hello:hello}

五、 Profile

我们可以在resources文件夹下面建3个properties, application-dev.properties是开发环境下的配置文件。application-prod.properties是应用环境下的配置文件。Spring Boot默认读取的配置文件是application.properties,我们只需要在application.properties指定使用哪一个环境下的配置文件即可。比如:spring.profiles.active=dev
或者使用命令: java -jar target/demo-0.0.1-SNAPSHOT.jar --spring.profiles.active=prod

Profile是Spring对不同环境提供不同配置功能的支持,可以通过激活、
指定参数等方式快速切换环境,默认使用application.properties的配置;
1、多profile文件形式:
– 格式:application-{profile}.properties/yml:

  • • application-dev.properties、application-prod.properties

2、多profile文档块模式:
3、激活方式:
– 命令行 --spring.profiles.active=dev
– 配置文件 spring.profiles.active=dev
– jvm参数 –Dspring.profiles.active=dev


server:
  port: 8081
spring:
  profiles:
    active: prod
‐‐‐
server:
  port: 8083
spring:
  profiles: dev
‐‐‐
server:
  port: 8084
spring:
  profiles: prod  #指定属于哪个环境

六、配置文件加载位置

• spring boot 启动会扫描以下位置的application.properties或者
application.yml文件作为Spring boot的默认配置文件
– file:./config/
– file:./
– classpath:/config/
– classpath:/
– 以上是按照优先级从高到低的顺序,所有位置的文件都会被加载,高优先级配置内容会覆盖低优先级配置内容。
– 我们也可以通过配置spring.config.location来改变默认配置

spring.config.location=G:/application.properties


SpringBoot会从这四个位置全部加载主配置文件;互补配置;

项目打包好以后,我们可以使用命令行参数的形式,启动项目的时候来指定配置文件的新位置;指定配置文件和默
认加载的这些配置文件共同起作用形成互补配置;

java -jar spring-boot-02-config-02-0.0.1-SNAPSHOT.jar --spring.config.location=G:/application.properties

七、外部配置加载顺序

Spring Boot 支持多种外部配置方式
这些方式优先级如下:
https://docs.spring.io/spring-boot/docs/current-

SNAPSHOT/reference/htmlsingle/#boot-features-external-config

SpringBoot也可以从以下位置加载配置; 优先级从高到低;高优先级的配置覆盖低优先级的配置,所有的配置会
形成互补配置

1. 命令行参数

所有的配置都可以在命令行上进行指定
java -jar spring-boot-02-config-02-0.0.1-SNAPSHOT.jar --server.port=8087 --server.context-path=/abc
多个配置用空格分开; --配置项=值

2. 来自java:comp/env的JNDI属性
3. Java系统属性(System.getProperties())
4. 操作系统环境变量

5. RandomValuePropertySource配置的random.*属性值

由jar包外向jar包内进行寻找;
优先加载带profile

6. jar包外部的application-{profile}.properties或application.yml(带spring.profile)配置文件

7. jar包内部的application-{profile}.properties或application.yml(带spring.profile)配置文件

再来加载不带profile

8. jar包外部的application.properties或application.yml(不带spring.profile)配置文件
9. jar包内部的application.properties或application.yml(不带spring.profile)配置文件

10. @Configuration注解类上的@PropertySource
11. 通过SpringApplication.setDefaultProperties指定的默认属性

所有支持的配置加载来源;参考官方文档

猜你喜欢

转载自blog.csdn.net/qq_35508033/article/details/80707826