java之学习记录 9 - 1 - SpringBoot全局配置文件、自定义配置文件_java 配置文件中的一些字段经常用是设置成全局的还是

# 自定义配置信息注入到Person对象中
person.id=100
person.name=张三
# list
person.body=打人,打架,粗狂
# String
person.family=妻,妾
# map
person.map.k1=v1
person.map.k2=v2
# pet对象
person.pet.type=dog
person.pet.name=小王

@RunWith(SpringRunner.class) // @RunWith：运行器 SpringJUnit4ClassRunner.class:Spring运行环境  junit:junit测试环境
@SpringBootTest // 标记当前类为SpringBoot测试类，加载项目的ApplicationContext上下文环境
class Springbootdemo2ApplicationTests {
 
    @Autowired
    private Person person;
    @Test
    void showPersonInfo(){
        System.out.println(person);
    }
}

Person{id=100, name='张三', hobby=[抽烟, 喝酒, 烫头], family=[妻, 妾], map={k1=v1, k2=v2}, pet=com.lagou.pojo.Pet@7e49ded}

#解决中文乱码 
server.tomcat.uri-encoding=UTF-8 
spring.http.encoding.force=true 
spring.http.encoding.charset=UTF-8 
spring.http.encoding.enabled=true

2 application.yaml配置文件

YAML文件格式是Spring Boot支持的一种JSON文件格式，相较于传统的Properties配置文件，YAML文件以数据为核心，是一种更为直观且容易被电脑识别的数据序列化格式。application.yaml配置文件的工作原理和application.properties是一样的，只不过yaml格式配置文件看起来更简洁一些。

当YAML配置文件中配置的属性值为普通数据类型时，可以直接配置对应的属性值，同时对于字符串类型的属性值，不需要额外添加引号，示例代码如下

server:
  port: 8080
  servlet:
    context-path: /hello

person:
  hobby:
    - 抽烟
    - 喝酒
    - 烫头

person:
  hobby:
    抽烟,
    喝酒,
    烫头

person: 
  hobby: [play,read,sleep]

person: 
  map:
    k1: v1 
    k2: v2

person: 
  map: {k1: v1,k2: v2}

如果配置属性是Spring Boot已有属性，例如服务端口server.port，那么Spring Boot内部会自动扫描并读取这些配置文件中的属性值并覆盖默认属性。

如果配置的属性是用户自定义属性，例如刚刚自定义的Person实体类属性，还必须在程序中注入这些配置属性方可生效。

Spring Boot支持多种注入配置文件属性的方式，下面来介绍如何使用注解@ConfigurationProperties和@Value注入属性

Spring Boot提供的@ConfigurationProperties注解用来快速、方便地将配置文件中的自定义属性值批量注入到某个Bean对象的多个对应属性中。假设现在有一个配置文件，如果使用@ConfigurationProperties注入配置文件的属性，示例代码如下：

@Component
// 将配置文件中所有以person开头的配置信息注入当前类中
// 前提1：必须保证配置文件中person.xx与当前Person类中的属性名一致
// 前提2：必须保证当前Person中的属性都具有set方法
@ConfigurationProperties(prefix = "person")
public class Person {
    private int id; //id
    private String name; //名称
    private List hobby; //爱好
    private String[] family; //家庭成员
    private Map map;
    private Pet pet; //宠物
}

上述代码使用@Component和@ConfigurationProperties(prefix = “person”)将配置文件中的每个属性映射到person类组件中。

@Value注解是Spring框架提供的，用来读取配置文件中的属性值并逐个注入到Bean对象的对应属性中，Spring Boot框架从Spring框架中对@Value注解进行了默认继承，所以在Spring Boot框架中还可以使用该注解读取和注入配置文件属性值。使用@Value注入属性的示例代码如下

@Component 
public class Person { 
    @Value("${person.id}") 
    private int id; 
}

上述代码中，使用@Component和@Value注入Person实体类的id属性。其中，@Value不仅可以将配置文件的属性注入Person的id属性，还可以直接给id属性赋值，这点是@ConfigurationProperties不支持的，而@Value注解对于包含Map集合、对象以及YAML文件格式的行内式写法的配置文件的属性注入都不支持，如果赋值会出现错误

自定义配置

spring Boot免除了项目中大部分的手动配置，对于一些特定情况，我们可以通过修改全局配置文件以适应具体生产环境，可以说，几乎所有的配置都可以写在application.yml文件中，Spring Boot会自动加载全局配置文件从而免除我们手动加载的烦恼。但是，如果我们自定义配置文件，Spring Boot是无法识别这些配置文件的，此时就需要我们手动加载。接下来，将针对Spring Boot的自定义配置文件及其加载方式进行讲解

对于这种加载自定义配置文件的需求，可以使用@PropertySource注解来实现。@PropertySource注解用于指定自定义配置文件的具体位置和名称

当然，如果需要将自定义配置文件中的属性值注入到对应类的属性中，可以使用@ConfigurationProperties或者@Value注解进行属性值注入

• 在Spring Boot框架中，推荐使用配置类的方式向容器中添加和配置组件
• 在Spring Boot框架中，通常使用@Configuration注解定义一个配置类，Spring Boot会自动扫描和识别配置类，从而替换传统Spring框架中的XML配置文件。
• 当定义一个配置类后，还需要在类中的方法上使用@Bean注解进行组件配置，将方法的返回对象注入到Spring容器中，并且组件名称默认使用的是方法名，当然也可以使用@Bean注解的name或value属性自定义组件的名称

演示：

package com.lagou.service;
 
public class MyService {
}

package com.lagou.config;
 
import com.lagou.service.MyService;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
 
@Configuration // 标识当前类是一个配置类，SpringBoot会扫描该类，将所有标识@Bean注解的方法返回值注入到容器中
public class MyConfig {
    @Bean // 注入的名称就是方法的名称，注入的类型就是返回值的类型
    public MyService myService(){
        return new MyService();
    }
}

    @Autowired
    private ApplicationContext applicationContext;
 
    @Test
    public void testConfig(){
        System.out.println(applicationContext.containsBean("myService"));
    }