【SpringBoot配置文件】：yaml和properties和几类配置注解

最新推荐文章于 2024-04-04 07:34:21 发布

JH灰色

最新推荐文章于 2024-04-04 07:34:21 发布

阅读量284

点赞数

分类专栏： JavaEE核心技术（spring全家桶+boot）

本文链接：https://blog.csdn.net/JH39456194/article/details/105891706

版权

JavaEE核心技术（spring全家桶+boot）专栏收录该内容

59 篇文章 0 订阅

订阅专栏

文章目录

一. 配置文件

SpringBoot使用一个全局的配置文件，配置文件名是固定的；
•application.properties
•application.yml
配置文件的作用：修改SpringBoot自动配置的默认值；
在这里插入图片描述
标记语言：
以前的配置文件；大多都使用的是 xxxx.xml文件；
YAML：以数据为中心，比json、xml等更适合做配置文件；
YAML：配置例子

server:
port: 8081

XML：

<server>
<port>8081</port>
</server>

二. YAML语法：

1. 基本语法

k:(空格)v：表示一对键值对（空格必须有）；
以空格的缩进来控制层级关系；只要是左对齐的一列数据，都是同一个层级的

server:
    port: 8081
    path: /hello

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

2. 值的写法

2.1 字面量：普通的值（数字，字符串，布尔）

k: v：字面直接来写；
　字符串默认不用加上单引号或者双引号；
　　""：双引号；不会转义字符串里面的特殊字符；特殊字符会作为本身想表示的意思
　　　name: “zhangsan \n lisi”：输出；zhangsan 换行 lisi
　　''：单引号；会转义特殊字符，特殊字符最终只是一个普通的字符串数据
　　　name: ‘zhangsan \n lisi’：输出；zhangsan \n lisi

2.2 对象、Map（属性和值）（键值对）

k: v：在下一行来写对象的属性和值的关系；注意缩进
　　对象还是k: v的方式

friends:
		lastName: zhangsan
		age: 20

行内写法：

friends: {lastName: zhangsan,age: 18}

2.3 数组（List、Set）

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

pets:
 - cat
 - dog
 - pig

行内写法：

pets: [cat,dog,pig]

三. 配置文件值注入

1. 在application.yml中写配置

Person类对象的配置文件：application.yml

	person:
	  lastName: zhangsan
	  age: 19
	  boss: false
	  birth: 2020/2/20
	  maps: {k1: v1,k2: v2}
	  lists:
	    - lisi
	    - ahua
	  dog:
	    name: 小狗
	    age: 2

javaBean：

/**
 * 将配置文件中配置的每一个属性的值，映射到这个组件（Person)中
 * @ConfigurationProperties:可以将配置文件中的配置绑定到一个类中
 * @ConfigurationProperties:告诉springboot将本类中的所有属性和配置文件中相关的配置进行绑定
 * prefix = "person"：配置文件中哪个相关属性进行一一映射
 *
 * 只有这个组件是容器中的组件，才能使用容器提供的@ConfigurationProperties功能
 * 所以需要使用@Component注解把当前类存入Spring的IOC容器中
 */
@Data
@ConfigurationProperties(prefix = "person")
@Component
public class Person {
    private String lastName;
    private int age;
    private boolean boss;
    private Date birth;

    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;
}

说明1：如果只加入@ConfigurationProperties(prefix = "person")会报红，这个注解使用的前提是当前类在IOC容器中，必须和其他注解联合使用。把类加入到IOC容器中的注解有：@Component，@Repository，@Service，@Controller，这里是实体类不属于三层模型的任何一层因此建议使用@Component。
说明2：因为不想重写getter()，setter()，toString()等方法，使用了lombok插件，使用这个插件需要导入依赖：

	<!--导入lombok，可以不用写setter/getter/..方法 -->
       <dependency>
           <groupId>org.projectlombok</groupId>
           <artifactId>lombok</artifactId>
       </dependency>

导入依赖后在当前类上加入@Data注解即可
说明3：导入配置文件处理器，配置文件进行绑定就会有提示

  	<dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-configuration-processor</artifactId>
       <optional>true</optional>
    </dependency>

在加入新的配置文件后，最好重新导入配置文件：
在这里插入图片描述
使用SpringBoot单元测试：

@RunWith(SpringRunner.class)
@SpringBootTest
class Springboot02ConfigurationsApplicationTests {
    @Autowired
    Person person;

    @Test
    void contextLoads() {
        System.out.println(person);
    }
}

输出：

Person(lastName=zhangsan, age=19, boss=false, birth=Thu Feb 20 00:00:00 CST 2020, 
maps={k1=v1, k2=v2}, lists=[lisi, ahua], dog=Dog(name=小狗, age=2))

说明：在高版本中自动创建的项目@Runwith注解无法识别，
解决方法：将pom中原来的这段配置删除掉（也可以在pom文件中换成低版本）

<dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-test</artifactId>
     <scope>test</scope>
     <exclusions>
         <exclusion>
             <groupId>org.junit.vintage</groupId>
             <artifactId>junit-vintage-engine</artifactId>
         </exclusion>
     </exclusions>
 </dependency>

添加新的配置：

   <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-test</artifactId>
       <scope>test</scope>
   </dependency>

2. 在application.properties中写配置

除了在application.yml中写配置文件，同样也可以在application.properties中写配置：

	# 配置person的值
	person.last-name=张三
	person.age=12
	person.birth=2020/12/12
	person.boss=false
	person.maps.k1=v1
	person.maps.k2=v2
	person.lists=a,b,c
	person.dog.name=dog
	person.dog.age=3

运行SpringBoot测试类输出结果：发现中文乱码

Person(lastName=ï¿½ï¿½ï¿½ï¿½, age=12, boss=false, birth=Sat Dec 12 00:00:00 
CST 2020, maps={k1=v1, k2=v2}, lists=[a, b, c], dog=Dog(name=dog, age=3))

解决方法：idea的默认编码为utf-8，修改这个配置
在这里插入图片描述

3. @Value获取值和@ConfigurationProperties获取值比较

除了@ConfigurationProperties注解从配置文件中获取值，还可以使用@Value注解。

	person.last-name=张三
	person.age=12
	person.birth=2020/12/12
	person.boss=false
	person.maps.k1=v1
	person.maps.k2=v2
	person.lists=a,b,c
	person.dog.name=dog
	person.dog.age=3

在xml中进行配置属性名和属性值：

	<bean class="Person">
	     <property name="lastName" value="字面量 / ${key} / #{key}从配置文件中取值"/>
	<bean/>

如果不想使用xml，就可以使用@Value注解：

@Component
public class Person {
    @Value("#{person.last-name}")
    private String lastName;
    @Value("${age}")
    private int age;
    @Value("true")
    private boolean boss;

由此可见，@Value注解只能一个个获取属性的值，@ConfigurationProperties可以批量获取配置文件中属性的值

使用@Value注解，要使得key与配置文件中的key保持一致。但是如果使用@ConfigurationProperties注解下面的语法都可以：

person.last-name=张三
person.last_name=张三
person.lastName=张三

@ConfigurationProperties支持数据校验，但是@Value注解不支持

@ConfigurationProperties(prefix = "person")
@Component
@Validated//加入数据校验
public class Person {
    @Email //lastName必须是一个邮箱格式
    private String lastName;
    @Value("${age}")
    private int age;
    @Value("true")
    private boolean boss;

@Value注解在复杂类型的封装时不支持：比如下面就会报错

    @Value("#{person.maps}")
    private Map<String,Object> maps;

总结：

	@ConfigurationProperties	@Value
功能	批量注入配置文件中的属性	一个个指定
松散绑定（松散语法）	支持	不支持
SpEL	不支持	支持
JSR303数据校验	支持	不支持
复杂类型封装	支持	不支持

配置文件yml和properties他们都能获取到值；
如果说，我们专门编写了一个javaBean来和配置文件进行映射，我们就直接使用@ConfigurationProperties；
如果说，我们只是在某个业务逻辑中需要获取一下配置文件中的某项值，使用@Value；

@RestController
public class HelloController {

    @Value("${person.last-name}")
    private String name;

    @RequestMapping("/sayHello")
    public String sayHello(){
        return "hello"+name;
    }
}

在这里插入图片描述

4. @PropertySource&@ImportResource&@Bean

@ConfigurationProperties：默认加载全局配置文件applicaiton.properties；
@PropertySource：加载指定的配置文件；例如将Person类的信息配置在person.properties中而不是application.properties中，就要加载这个配置文件

@Data
@ConfigurationProperties(prefix = "person")
@Component
@PropertySource(value={"classpath:person.properties"})
public class Person {
    private String lastName;
    private int age;
    private boolean boss;
    private Date birth;

@ImportResource：导入Spring的配置文件，让配置文件里面的内容生效；
例如：
在这里插入图片描述
配置Spring的配置文件bean.xml文件：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans.xsd">
        
    <bean id="helloService" class="com.hh.springboot.service.HelloService"/>
</beans>

在Springboot的测试类中验证是否含有helloService这个类：

    @Autowired
    ApplicationContext ioc;

    @Test
    public void testHelloService(){
        boolean b = ioc.containsBean("helloService");
        System.out.println(b);//false
    }

结果为false，是因为Spring Boot里面没有Spring的配置文件，我们自己编写的配置文件，也不能自动识别；想让Spring的配置文件生效，就要将@ImportResource标注在一个配置类上。

@ImportResource(locations = "classpath:bean.xml")
@SpringBootApplication
public class Springboot02ConfigurationsApplication {
    public static void main(String[] args) {
        SpringApplication.run(Springboot02ConfigurationsApplication.class, args);
    }
}

但是在实际开发中，为了给容器加组件，不可能自己写一个Spring的配置文件，再把配置文件导进来，这样太麻烦了。

SpringBoot推荐全注解方式来给容器中添加组件：

package com.hh.springboot.config;
/**
 * @Configuration:指明当前类是一个配置类
 *
 * 在Spring配置文件中使用bean标签来给容器添加组件
 * 在SpringBoot中使用Bean注解
 */
@Configuration
public class MyAppConfig {

    /**
     *  @Bean:将方法的返回值添加到容器中,容器默认的id就是方法名
     * 本题返回的对象类型是HelloService
     */
    @Bean
    public HelloService helloService(){
        return new HelloService();
    }
}

JH灰色

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
【SpringBoot配置文件】：yaml和properties和几类配置注解

文章目录一. 配置文件二. YAML语法：1. 基本语法2. 值的写法2.1 字面量：普通的值（数字，字符串，布尔）2.2 对象、Map（属性和值）（键值对）2.3 数组（List、Set）三. 配置文件值注入1. 在application.yml中写配置2. 在application.properties中写配置3. @Value获取值和@ConfigurationProperties获取值比...
复制链接

扫一扫