Spring Boot 中读取配置文件有以下 5 种办法:
- 应用 @Value 读取配置文件。
- 应用 @ConfigurationProperties 读取配置文件。
- 应用 Environment 读取配置文件。
- 应用 @PropertySource 读取配置文件。
- 应用原生形式读取配置文件。
它们的具体应用办法如下,为了不便测试,咱们在 Spring Boot 配置文件 application.properties 增加以下内容:
profile.name=Spring Boot Profileprofile.desc=Spring Boot Profile Desc.
1.应用 @Value 读取配置文件
应用 @Value 能够读取单个配置项,如下代码所示:
@SpringBootApplicationpublic class DemoApplication implements InitializingBean { @Value("${profile.name}") private String name; public static void main(String[] args) { SpringApplication.run(DemoApplication.class, args); } @Override public void afterPropertiesSet() throws Exception { System.out.println("My Profile Name:" + name); }}
以上程序的执行后果如下图所示:
2.应用 @ConfigurationProperties 读取配置文件
@ConfigurationProperties 和 @Value 的应用稍微不同,@Value 是读取单个配置项的,而 @ConfigurationProperties 是读取一组配置项的,咱们能够应用 @ConfigurationProperties 加实体类读取一组配置项,如下代码所示:
import lombok.Data;import org.springframework.boot.context.properties.ConfigurationProperties;import org.springframework.stereotype.Component;@Component@ConfigurationProperties(prefix = "profile")@Datapublic class Profile { private String name; private String desc;}
其中 prefix 示意读取一组配置项的根 name,相当于 Java 中的类名,最初再把此配置类,注入到某一个类中就能够应用了,如下代码所示:
@SpringBootApplicationpublic class DemoApplication implements InitializingBean { @Autowired private Profile profile; public static void main(String[] args) { SpringApplication.run(DemoApplication.class, args); } @Override public void afterPropertiesSet() throws Exception { System.out.println("Profile Object:" + profile); }}
以上程序的执行后果如下图所示:
3.应用 Environment 读取配置文件
Environment 是 Spring Core 中的一个用于读取配置文件的类,将此类应用 @Autowired 注入到类中就能够应用它的 getProperty 办法来获取某个配置项的值了,如下代码所示:
import org.springframework.beans.factory.InitializingBean;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.boot.SpringApplication;import org.springframework.boot.autoconfigure.SpringBootApplication;import org.springframework.core.env.Environment;@SpringBootApplicationpublic class DemoApplication implements InitializingBean { @Autowired private Environment environment; public static void main(String[] args) { SpringApplication.run(DemoApplication.class, args); } @Override public void afterPropertiesSet() throws Exception { System.out.println("Profile Name:" + environment.getProperty("profile.name")); }}
以上程序的执行后果如下图所示:
4.应用 @PropertySource 读取配置文件
应用 @PropertySource 注解能够用来指定读取某个配置文件,比方指定读取 application.properties 配置文件的配置内容,具体实现代码如下:
@SpringBootApplication@PropertySource("classpath:application.properties")public class DemoApplication implements InitializingBean { @Value("${profile.name}") private String name; public static void main(String[] args) { SpringApplication.run(DemoApplication.class, args); } @Override public void afterPropertiesSet() throws Exception { System.out.println("Name:" + name); }}
以上程序的执行后果如下图所示:
中文乱码
如果配置文件中呈现中文乱码的状况,可通过指定编码格局的形式来解决中文乱码的问题,具体实现如下:
@PropertySource(value = "dev.properties", encoding = "utf-8")
注意事项
@PropertySource 注解默认是只反对 properties 格局配置文件的读取的。
5.应用原生形式读取配置文件
咱们还能够应用最原始的形式 Properties 对象来读取配置文件,如下代码所示:
import org.springframework.beans.factory.InitializingBean;import org.springframework.boot.SpringApplication;import org.springframework.boot.autoconfigure.SpringBootApplication;import java.io.IOException;import java.io.InputStreamReader;import java.nio.charset.StandardCharsets;import java.util.Properties;@SpringBootApplicationpublic class DemoApplication implements InitializingBean { public static void main(String[] args) { SpringApplication.run(DemoApplication.class, args); } @Override public void afterPropertiesSet() throws Exception { Properties props = new Properties(); try { InputStreamReader inputStreamReader = new InputStreamReader( this.getClass().getClassLoader().getResourceAsStream("application.properties"), StandardCharsets.UTF_8); props.load(inputStreamReader); } catch (IOException e1) { System.out.println(e1); } System.out.println("Properties Name:" + props.getProperty("profile.name")); }}
以上程序的执行后果如下图所示:
总结
在 Spring Boot 中读取配置文件有以下 5 种办法:
- 应用 @Value 读取配置文件。
- 应用 @ConfigurationProperties 读取配置文件。
- 应用 @PropertySource 读取配置文件。
- 应用 Environment 读取配置文件。
- 应用原生形式读取配置文件。
其中最罕用的是前 3 种,如果读取某一个配置项可应用 @Value,如果读取一组配置项可应用 @ConfigurationProperties,如果要指定读取某一个具体的配置文件可应用 @PropertySource 来指定。
是非审之于己,毁誉听之于人,得失安之于数。
公众号:Java面试真题解析
面试合集:https://gitee.com/mydb/interview