Spring Boot基础学习笔记04

1、熟悉使用@PropertySource加载配置文件
2、熟悉使用@ImportResource加载XML配置文件
3、掌握使用@Configuration编写自定义配置类

一、为什么需要加载自定义配置文件

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

二、使用@PropertySource加载自定义配置文件

1、创建Spring Boot Web项目ConfigDemo01

设置项目元数据

添加项目依赖

设置项目名称与保存位置

完成项目初始化工作

2、创建自定义配置文件

在resources下创建myconfig.properties文件

说明：如果在配置文件里使用user.name，通过配置文件获取的值可能是操作系统中的用户名，因为操作系统中也是有user.name属性的。

3、创建自定义配置类

在net.wz.lesson04包里创建配置类StudentConfig

package net.wz.lesson04;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.PropertySource;
import org.springframework.stereotype.Component;

/**
 * 功能：学生配置类
 * 作者：吴钊
 * 日期：2021年05月07日
 */
@Component//让Spring容器来管理Bean
@PropertySource("classpath:myconfig.properties")//加载自定义配置文件
@ConfigurationProperties(prefix = "student")//配置属性，设置前缀
public class StudentConfig {
    private String id;
    private String name;
    private  int age;

    public String getId() {
        return id;
    }

    public void setId(String id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    @Override
    public String toString() {
        return "StudentConfig{" +
                "id='" + id + '\'' +
                ", name='" + name + '\'' +
                ", age=" + age +
                '}';
    }
}

4、编写测试方法

点开测试类ConfigDemo01ApplicationTests

编写测试方法
注入学生配置实体
输出学生配置实体信息

package net.wz.lesson04;

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
class ConfigDemo01ApplicationTests {
    @Autowired//注入学生配置实体
    private  StudentConfig studentConfig;

    @Test
    void contextLoads() {

    }

    @Test
    private void testStudentConfig(){
        //输出学生配置实体信息
        System.out.println(studentConfig);
    }

}

4、运行测试方法

5、修改测试方法代码

说明：注入的StudentConfig名称不必是studentConfig，在Spring Boot 2.3.2里，StudentConfig的注解@Component默认是单例的，因此不会因为注入名称是studentConfig1而产生的两个StudentConfig实例。

• 可以看到，StudentConfig注入名称改成studentConfig1之后，测试结果依然相同，不受注入名称变化的任何影响。

课堂练习：在Web页面显示学生配置信息

在net.wz.lesson04创建Controller子包，在子包里创建控制器StudentController

package net.wz.lesson04.controller;

import net.wz.lesson04.StudentConfig;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;

import org.springframework.web.bind.annotation.RestController;

@RestController
public class StudentController {
    @Autowired
    private StudentConfig studentConfig;
   
    @GetMapping("/StudentConfig")
    public String StudentConfig(){
        return studentConfig.toString();
    }
}

运行启动类ConfigDemo01Application

在浏览器里访问http://localhost:8080/StudentConfig

三、使用@ImportResource加载XML配置文件

1、创建创建Spring Boot Web项目ConfigDemo02

设置项目元数据

添加项目依赖

设置项目名称与保存位置

完成项目初始化工作

2、创建Bean - 自定义服务类

在net.wz.lesson04包里创建service子包在子包里CustomService类

3、创建自定义JavaBean配置文件

在resources目录里创建配置文件spring-config.xml

在元素里添加子元素，定义自定义服务类的JavaBean

4、在启动类上添加注解，加载自定义JavaBean配置文件

在启动类上添加注解@ImportResource(“classpath:beans.xml”)

在Spring Boot启动后，Spring容器中就会自动实例化一个名为customService的JavaBean

5、打开测试类，编写测试方法

点开测试类ConfigDemo02ApplicationTests

package net.wz.lesson04;

import net.wz.lesson04.service.CustomService;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
class Configdemo02ApplicationTests {
    @Autowired
    private CustomService customService;
    @Test
    void contextLoads() {
    }
    @Test
    public void testCustomService(){
        customService.welcome();
    }

}

运行测试方法

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

使用@Configuration编写自定义配置类，这是Spring Bboot的推荐方式

1、创建Spring Boot Web项目ConfigDemo03

设置项目元数据

添加项目依赖

配置项目名称与保存位置

2、创建Bean - 自定义服务类

在net.wz.lesson04包里创建service在子包里创建CustomService类

package net.wz.lesson04.service;

/**
 * 功能：自定义服务类
 * 作者：吴钊
 * 日期：2021年05月07日
 */
public class CustomService {
    public void welcome() {
        System.out.println("欢迎您访问泸职院信息工程学院");
    }
}

3、创建自定义配置类MyConfig

在net.wz.lesson04包里创建config子包，在子包里创建自定义配置类MyConfig

添加注解@Configuration，指定配置类

创建获取Bean的方法getCustomService()

4、打开测试类，编写测试方法

点开测试类ConfigDemo03ApplicationTests

注入在MyConfig配置类里定义的Bean，然后调用其方法

package net.wz.lesson04;

import net.wz.lesson04.service.CustomService;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
class ConfigDemo03ApplicationTests {
    @Autowired
    private CustomService customService;


    @Test
    void contextLoads() {
    }

    @Test
    public void testCustomService(){
        customService.welcome();
    }
}

运行测试方法contextLoads()，查看结果