Spring读取配置文件的几种方法（从0开始）

新建一个Maven空项目

新建配置文件

在src -> main下新建一个资源目录resources，然后在该资源目录下新建一个application.properties文件。

#自定义内容
student.name = zhangsan
student.age = 18
student.sex = Man

读取配置文件

方法一(ResourceBundle)

使用资源包的方式来实现导入自定义配置。

package com.chen.space;

import java.io.UnsupportedEncodingException;
import java.nio.charset.Charset;
import java.text.SimpleDateFormat;
import java.util.ResourceBundle;

/**
 * @ClassName Solution1
 * @Author 小混子
 * @Description 使用资源包来实现导入配置
 * @Date 2021/8/19 19:41
 * @Version 1.0
 */
public class Solution1 {
    public static void main(String[] args) {

        // 资源包
        ResourceBundle resourceBundle = ResourceBundle.getBundle("application");
        String name = resourceBundle.getString("student.name");
        String age = resourceBundle.getString("student.age");
        String sex = resourceBundle.getString("student.sex");

        System.out.println("姓名：" + name);
        System.out.println("年龄：" + age);
        System.out.println("性别：" + sex);

    }
}

读取其他properties文件，在resources目录下新建一个test.properties文件。

#自定义内容
student.name = LiSi
student.age = 18
student.sex = Man

测试：

package com.chen.space;

import java.io.UnsupportedEncodingException;
import java.nio.charset.Charset;
import java.text.SimpleDateFormat;
import java.util.ResourceBundle;

/**
 * @ClassName Solution1
 * @Author 小混子
 * @Description 使用资源包来实现导入配置
 * @Date 2021/8/19 19:41
 * @Version 1.0
 */
public class Solution1 {
    public static void main(String[] args) {

        // 资源包
        ResourceBundle resourceBundle = ResourceBundle.getBundle("test");
        String name = resourceBundle.getString("student.name");
        String age = resourceBundle.getString("student.age");
        String sex = resourceBundle.getString("student.sex");

        System.out.println("姓名：" + name);
        System.out.println("年龄：" + age);
        System.out.println("性别：" + sex);

    }
}

方法二(@Value)

介绍

需要通过Spring来进行操作，通过@Value("${key}")主键来获取配置文件中的属性值。

引入依赖

    <!-- 引入SpringBoot依赖 -->
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
      <version>2.3.4.RELEASE</version>
    </dependency>

    <!--单元测试-->
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-test</artifactId>
      <version>2.3.4.RELEASE</version>
    </dependency>

创建启动类

修改之前的 App.java 文件，将其改为SpringBoot启动类。

package com.chen;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class App {
    public static void main(String[] args) {
        // System.out.println("Hello World!");
        
        // App类的run方法
        SpringApplication.run(App.class,args);
        
    }
}

创建controller类测试

新建一个com -> chen -> controller包，在新建的controller包下新建一个JavaTestController.java文件。

package com.chen.controller;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @ClassName JavaTestController
 * @Author 小混子
 * @Description TODO
 * @Date 2021/8/20 10:34
 * @Version 1.0
 */
@RestController
public class JavaTestController {

    @Value("${student.name}")
    String name;

    @Value("${student.age}")
    String age;

    @Value("${student.sex}")
    String sex;
    
    @GetMapping("/showInfo")
    public String showInfo(){
        return "name: " + name + " age: " + age + " sex: " + sex;
    }
}

运行效果

方法三(读取不同配置文件)

引入依赖

<!-- 导入配置文件处理器 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
    <optional>true</optional>
</dependency>

<!-- lombok依赖 -->
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.20</version>
</dependency>

编写properties文件

在资源目录下新建一个 newClass.properties 用来作为配置文件。

student2.name=LiSi
student2.age=18

创建实体类

在com -> chen下新建一个pojo包，用来存放实体类，并在该包下新建一个NewClassPoJo.java，注意：NewClassPoJo.java内的成员变量将会取到配置文件的值。

package com.chen.pojo;

import lombok.Data;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.PropertySource;
import org.springframework.stereotype.Component;

/**
 * @ClassName NewClassPoJo
 * @Author 小混子
 * @Description TODO
 * @Date 2021/8/20 12:37
 * @Version 1.0
 */
@Component  // 注册bean
@PropertySource(value = "classpath:newclass.properties")
@Data   // lombok
public class NewClassPoJo {

    @Value("${student2.name}")
    private String name;

    @Value("${student2.age}")
    private String age;

}

创建controller层

在com -> chen -> controller包下新建一个NewClassController.java。

package com.chen.controller;

import com.chen.pojo.NewClassPoJo;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @ClassName NewClassController
 * @Author 小混子
 * @Description TODO
 * @Date 2021/8/20 12:40
 * @Version 1.0
 */
@RestController
public class NewClassController {

    @Autowired
    NewClassPoJo pojo;

    @GetMapping("/hello")
    public String hello(){
        return pojo.toString();
    }
}

运行效果

其余方法(基于方法三)

新建配置文件yml

yml配置文件与ConfigurationProperties注解，在空的springboot项目中新建一个application.yml文件用来作为配置文件。

#自定义内容
student:
  name: ZhangSan
  age: 18
  sex: Man
  other:
    name: LiSi
    age: 19
    sex: Man

• 使用yaml主要是@Value这种方法需要对每个属性单独注解赋值很麻烦，而@ConfigurationProperties只需要写一次即可。
• @ConfigurationProperties支持松散绑定，即如果yml中写的test-hello，这个内容就和testHello一样，因为-后面跟着的字母默认会是大写。
• @ConfigurationProperties支持JSR303数据校验，就是可以在字段是增加一层过滤器验证，保证数据的合法性。
• @ConfigurationProperties支持复杂类型封装，yml中可以封装对象，但是@Value就不行。

新建一个实体类

在com -> chen下新建一个pojo包用来存放项目中的实体类，并在该包下新建一个student.java的类和一个studentMain.java的类。

package com.chen.pojo;

import lombok.Data;
import org.springframework.stereotype.Component;

/**
 * @ClassName student
 * @Author 小混子
 * @Description TODO
 * @Date 2021/8/20 13:00
 * @Version 1.0
 */
@Data // lombok
@Component // 注册bean
public class student {
    private String name;
    private Integer age;
    private  String sex;
}

package com.chen.pojo;

import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;
import org.springframework.stereotype.Component;

/**
 * @ClassName studentMain
 * @Author 小混子
 * @Description TODO
 * @Date 2021/8/20 13:04
 * @Version 1.0
 */
@Data // lombok
@Component // 注册bean
@ConfigurationProperties(prefix = "student")    // 根据前缀（"student"）自动匹配属性
public class studentMain {

    private String name;

    private Integer age;

    private String sex;

    private student other;
    
}

新建一个controller类测试

在com -> chen下新建一个controller包，并在改包下新建一个studentController.java。

package com.chen.controller;

import com.chen.pojo.studentMain;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @ClassName studentController
 * @Author 小混子
 * @Description 控制层
 * @Date 2021/8/20 13:13
 * @Version 1.0
 */
@RestController
public class studentController {

    @Autowired
    studentMain student;

    @GetMapping("show")
    public String show(){
        return student.toString();
    }
}

运行效果

End

每天积累一点点，多学习，多积累。

~

---