自定义配置

1.7 自定义配置

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

1.7.1 使用@PropertySource加载配置文件

​
对于这种加载自定义配置文件的需求，可以使用@PropertySource注解结合@Configuration注解配置类的方式来实现。@PropertySource注解用于指定自定义配置文件的具体位置和名称。同时，为了保证Spring Boot能够扫描该注解，还需要类上添加@Configuration注解将实体类作为自定义配置类。

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

演示：

​
（1）打开Spring Boot项目的resources目录，在项目的类路径下新建一个test.properties自定义配置文件，在该配置文件中编写需要设置的配置属性

#对实体类对象MyProperties进行属性配置

test.id=110

test.name=test

​
（2）在com.lagou.pojo包下新创建一个配置类MyProperties，提供test.properties自定义配置文件中对应的属性，并根据@PropertySource注解的使用进行相关配置

      @Configuration    // 自定义配置类

      @PropertySource("classpath:test.properties")   // 指定自定义配置文件位置和名称

      @EnableConfigurationProperties(MyProperties.class)
// 开启对应配置类的属性注入功能

      @ConfigurationProperties(prefix =
"test")      // 指定配置文件注入属性前缀

      public class MyProperties {

         
private int id;

         
private String name;

         
// 省略属性getXX()和setXX()方法

         
// 省略toString()方法

 }

​
主要是一个自定义配置类，通过相关注解引入了自定义的配置文件，并完成了自定义属性值的注入。针对示例中的几个注解，具体说明如下

• @Configuration注解表示当前类是一个自定义配置类，并添加为Spring容器的组件，这里也可以使用传统的@Component注解；

@PropertySource(“classpath:test.properties”)注解指定了自定义配置文件的位置和名称，此示例表示自定义配置文件为classpath类路径下的test.properties文件；

• @ConfigurationProperties(prefix =
  “test”)注解将上述自定义配置文件test.properties中以test开头的属性值注入到该配置类属性中。

• 如果配置类上使用的是@Component注解而非@Configuration注解，那么@EnableConfigurationProperties注解还可以省略

（3）进行测试

 
@Autowired

 
private MyProperties myProperties;

 
@Test

 
public void myPropertiesTest() {

   
System.out.println(myProperties);

  }

打印结果：

1.7.2

使用@Configuration编写自定义配置类

在Spring Boot框架中，推荐使用配置类的方式向容器中添加和配置组件

在Spring Boot框架中，通常使用@Configuration注解定义一个配置类，Spring Boot会自动扫描和识别配置类，从而替换传统Spring框架中的XML配置文件。

当定义一个配置类后，还需要在类中的方法上使用@Bean注解进行组件配置，将方法的返回对象注入到Spring容器中，并且组件名称默认使用的是方法名，当然也可以使用@Bean注解的name或value属性自定义组件的名称

演示：

（1）在项目下新建一个com.lagou.config包，并在该包下新创建一个类MyService，该类中不需要编写任何代码

public class MyService {

}

创建了一个空的MyService类，而该类目前没有添加任何配置和注解，因此还无法正常被Spring Boot扫描和识别

（2） 在项目的com.lagou.config包下，新建一个类MyConfig，并使用@Configuration注解将该类声明一个配置类，内容如下：

      @Configuration  // 定义该类是一个配置类

      public class MyConfig {

         
@Bean        // 将返回值对象作为组件添加到Spring容器中，该组件id默认为方法名

         
public MyService myService(){

             
return new MyService();

          }

       }

​
MyConfig是@Configuration注解声明的配置类（类似于声明了一个XML配置文件），该配置类会被Spring Boot自动扫描识别；使用@Bean注解的myService()方法，其返回值对象会作为组件添加到了Spring容器中（类似于XML配置文件中的标签配置），并且该组件的id默认是方法名myService

（3）测试类

@Autowired

private ApplicationContext
applicationContext;

@Test

public void iocTest() {

       System.out.println(applicationContext.containsBean("myService"));

}

上述代码中，先通过@Autowired注解引入了Spring容器实例ApplicationContext，然后在测试方法iocTest()中测试查看该容器中是否包括id为myService的组件。

执行测试方法iocTest() ，查看控制台输出效果，结果如下：

从测试结果可以看出，测试方法iocTest()运行成功，显示运行结果为true，表示Spirng的IOC容器中也已经包含了id为myService的实例对象组件，说明使用自定义配置类的形式完成了向Spring容器进行组件的添加和配置

刚学了拉勾教育的《Java工程师高薪训练营》，看到刚学到的点就回答了。希望拉勾能给我推到想去的公司，目标：字节！！