在SpringBoot中,讀取配置檔案屬性的相關注解有:
@Value
@PropertySource
@ConfigurationProperties
接下來,我們對其進行簡單的案例介紹:
功能:@Value先讀預設配置檔案application.properties中定義的屬性。
使用方式:@value(占位符) 該注解加載成員變量上
舉例:@value("${user.name}")
application.properties中配置:
user.username=csp
user.password=123
user.age=22
java代碼讀取:
@Data// lombok插件注解,可替換成setter/getter
@AllArgsConstructor// lombok插件注解,可替換成全參構造函數
@NoArgsConstructor// lombok插件注解,可替換成空參構造函數
@Component
public class User {
@Value("${user.username}")
private String username;//csp
@Value("${user.password}")
private String password;//123
@Value("${user.age}")
private int age;//22
}
功能:@PropertySource讀取自定義的配置檔案中定義的屬性。
使用方式:@PropertySource(value={classpath:/指定配置檔案名稱}) 該注解加載成員變量上
舉例:@PropertySource(value={"classpath:/user.properties"})
user.properties中配置:
user.username=csp1999
user.password=123456
user.age=22
java代碼:
@Data
@AllArgsConstructor
@NoArgsConstructor
@Component
@PropertySource(value={"classpath:/user.properties"})
public class User {
@Value("${user.username}")
private String username;//csp1999
@Value("${user.password}")
private String password;//123456
@Value("${user.age}")
private int age;//22
}
功能:@ConfigurationProperties讀取預設配置檔案中定義的屬性,但是可以指定屬性字首。
使用方式:@ConfigurationProperties(prefix = "字首名稱") 該注解加載成員變量上
舉例:@ConfigurationProperties(prefix = "user")
預設配置檔案application.properties/application.yml中配置:
user.username=csp789
user.password=456
user.age=18
注意:該注解在新版本的springboot中idea視窗會出現
這種提示,解決方法1:
<!--
個人版本踩坑:
不加這個依賴的話,當在配置類中
使用@ConfigurationProperties(prefix = "xxx")注解時,
我這個版本的spring boot會提示有問題
-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artif
<optional>true</optional>
</dependency>
解決方法2:
@Data
@AllArgsConstructor
@NoArgsConstructor
@ConfigurationProperties(prefix = "user")
@Component
public class User {
// 有了字首,可以省去@Value注解
private String username;//csp789
private String password;//456
private int age;//18
}
@ConfigurationProperties 和 @EnableConfigurationProperties 配合使用
單獨使用@ConfigurationProperties時
@Data
@Component // 這時候加該注解 将DemoConfig 交給IOC管理
@ConfigurationProperties(prefix = "csp.user")
public class DemoConfig {
private String username;
private String password;
}
這種情況下,需要使用 DemoConfig時,直接:
@Autowired
private DemoConfig demoConfig;
即可!
@Data
//@Component // 未将DemoConfig1 交給IOC管理
@ConfigurationProperties(prefix = "csp.user2")
public class DemoConfig1 {
private String username1;
private String password1;
}
@Data
//@Component // 未将DemoConfig2 交給IOC管理
@ConfigurationProperties2(prefix = "csp.user2")
public class DemoConfig2 {
private String username2;
private String password2;
}
這種情況下,需要使用 DemoConfig1和DemoConfig2時
@Service // 或者@Configuration/@Componet/@Controller/@Repository 隻需要交給IOC管理即可
@EnableConfigurationProperties({
DemoConfig1.class,
DemoConfig2.class
})
public class TestService{
@Autowired
private DemoConfig1 demoConfig1;
@Autowired
private DemoConfig2 demoConfig2;
}
@PropertySource和@ConfigurationProperties配合使用
@Data
@AllArgsConstructor
@NoArgsConstructor
@ConfigurationProperties(prefix = "user")
@Component
@PropertySource(value={"classpath:/user.properties"})
public class User {
private String username;//csp1999
private String password;//123456
private int age;//22
}
如果文章對您有幫助,還請您一鍵三連!