Spring读取配置文件的几种方法详解

2022-07-07 09:55:39

新建一个Maven空项目

在这里插入图片描述
在这里插入图片描述
在这里插入图片描述

新建配置文件

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

在这里插入图片描述

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

读取配置文件

方法一(ResourceBundle)

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

packagecom.chen.space;importjava.io.UnsupportedEncodingException;importjava.nio.charset.Charset;importjava.text.SimpleDateFormat;importjava.util.ResourceBundle;/**
 * @ClassName Solution1
 * @Author 小混子
 * @Description 使用资源包来实现导入配置
 * @Date 2021/8/19 19:41
 * @Version 1.0
 */publicclassSolution1{publicstaticvoidmain(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

在这里插入图片描述

测试：

packagecom.chen.space;importjava.io.UnsupportedEncodingException;importjava.nio.charset.Charset;importjava.text.SimpleDateFormat;importjava.util.ResourceBundle;/**
 * @ClassName Solution1
 * @Author 小混子
 * @Description 使用资源包来实现导入配置
 * @Date 2021/8/19 19:41
 * @Version 1.0
 */publicclassSolution1{publicstaticvoidmain(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启动类。

packagecom.chen;importorg.springframework.boot.SpringApplication;importorg.springframework.boot.autoconfigure.SpringBootApplication;@SpringBootApplicationpublicclassApp{publicstaticvoidmain(String[] args){// System.out.println("Hello World!");// App类的run方法SpringApplication.run(App.class,args);}}

在这里插入图片描述

创建controller类测试

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

packagecom.chen.controller;importorg.springframework.beans.factory.annotation.Value;importorg.springframework.web.bind.annotation.GetMapping;importorg.springframework.web.bind.annotation.RestController;/**
 * @ClassName JavaTestController
 * @Author 小混子
 * @Description TODO
 * @Date 2021/8/20 10:34
 * @Version 1.0
 */@RestControllerpublicclassJavaTestController{@Value("${student.name}")String name;@Value("${student.age}")String age;@Value("${student.sex}")String sex;@GetMapping("/showInfo")publicStringshowInfo(){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内的成员变量将会取到配置文件的值。

packagecom.chen.pojo;importlombok.Data;importorg.springframework.beans.factory.annotation.Value;importorg.springframework.context.annotation.PropertySource;importorg.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// lombokpublicclassNewClassPoJo{@Value("${student2.name}")privateString name;@Value("${student2.age}")privateString age;}

在这里插入图片描述

创建controller层

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

packagecom.chen.controller;importcom.chen.pojo.NewClassPoJo;importorg.springframework.beans.factory.annotation.Autowired;importorg.springframework.web.bind.annotation.GetMapping;importorg.springframework.web.bind.annotation.RestController;/**
 * @ClassName NewClassController
 * @Author 小混子
 * @Description TODO
 * @Date 2021/8/20 12:40
 * @Version 1.0
 */@RestControllerpublicclassNewClassController{@AutowiredNewClassPoJo pojo;@GetMapping("/hello")publicStringhello(){return pojo.toString();}}

在这里插入图片描述

运行效果

在这里插入图片描述

其余方法(基于方法三)

新建配置文件yml

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

#自定义内容student:name: ZhangSanage:18sex: Manother:name: LiSiage:19sex: Man

在这里插入图片描述

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

新建一个实体类

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

packagecom.chen.pojo;importlombok.Data;importorg.springframework.stereotype.Component;/**
 * @ClassName student
 * @Author 小混子
 * @Description TODO
 * @Date 2021/8/20 13:00
 * @Version 1.0
 */@Data// lombok@Component// 注册beanpublicclass student{privateString name;privateInteger age;privateString sex;}

在这里插入图片描述

packagecom.chen.pojo;importlombok.Data;importorg.springframework.boot.context.properties.ConfigurationProperties;importorg.springframework.context.annotation.Configuration;importorg.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"）自动匹配属性publicclass studentMain{privateString name;privateInteger age;privateString sex;private student other;}

在这里插入图片描述

新建一个controller类测试

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

packagecom.chen.controller;importcom.chen.pojo.studentMain;importorg.springframework.beans.factory.annotation.Autowired;importorg.springframework.web.bind.annotation.GetMapping;importorg.springframework.web.bind.annotation.RestController;/**
 * @ClassName studentController
 * @Author 小混子
 * @Description 控制层
 * @Date 2021/8/20 13:13
 * @Version 1.0
 */@RestControllerpublicclass studentController{@Autowired
    studentMain student;@GetMapping("show")publicStringshow(){return student.toString();}}

在这里插入图片描述

运行效果

在这里插入图片描述

End

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

~

  • 作者：探索未知领域的小混子
  • 原文链接：https://blog.csdn.net/weixin_60740180/article/details/119821334
    更新时间：2022-07-07 09:55:39