Spring @PropertySource注解示例

转x33g5p2x  于2022-10-06 转载在 Spring  
字(8.3k)|赞(0)|评价(0)|浏览(753)

在Spring中，你可以使用@PropertySource注解来将你的配置外化为一个属性文件。在这篇文章中，我们将讨论如何使用@PropertySource来读取属性文件，并用@Value和Environment来显示其值。

@PropertySource注解为添加e1d5d1到Spring的环境提供了一个方便的声明性机制。要与@Configuration类一起使用。

Spring @PropertySource注解的简单例子

在这个例子中，我们从config.properties文件中读取数据库配置，并使用Environment将这些属性值设定为DataSourceConfig class。

  1. import org.springframework.beans.factory.InitializingBean;
  2. import org.springframework.beans.factory.annotation.Autowired;
  3. import org.springframework.context.annotation.Configuration;
  4. import org.springframework.context.annotation.PropertySource;
  5. import org.springframework.core.env.Environment;
  7. @Configuration
  8. @PropertySource("classpath:config.properties")
  9. public class ProperySourceDemo implements InitializingBean {
  11.     @Autowired
  12.     Environment env;
  14.     @Override
  15.     public void afterPropertiesSet() throws Exception {
  16.         setDatabaseConfig();
  17.     }
  19.     private void setDatabaseConfig() {
  20.         DataSourceConfig config = new DataSourceConfig();
  21.         config.setDriver(env.getProperty("jdbc.driver"));
  22.         config.setUrl(env.getProperty("jdbc.url"));
  23.         config.setUsername(env.getProperty("jdbc.username"));
  24.         config.setPassword(env.getProperty("jdbc.password"));
  25.         System.out.println(config.toString());
  26.     }
  27. }

Spring @PropertySource注解占位符示例

任何存在于@PropertySource资源位置的${...}占位符都将根据已经针对该环境注册的属性源集合进行解析。 

例如。

  1. import org.springframework.beans.factory.InitializingBean;
  2. import org.springframework.beans.factory.annotation.Autowired;
  3. import org.springframework.context.annotation.Configuration;
  4. import org.springframework.context.annotation.PropertySource;
  5. import org.springframework.core.env.Environment;
  7. @Configuration
  8. @PropertySource("classpath:/com/${my.placeholder:default/path}/config.properties")
  9. public class ProperySourceDemo implements InitializingBean {
  11.     @Autowired
  12.     Environment env;
  14.     @Override
  15.     public void afterPropertiesSet() throws Exception {
  16.         setDatabaseConfig();
  17.     }
  19.     private void setDatabaseConfig() {
  20.        DataSourceConfig config = new DataSourceConfig();
  21.        config.setDriver(env.getProperty("jdbc.driver"));
  22.        config.setUrl(env.getProperty("jdbc.url"));
  23.        config.setUsername(env.getProperty("jdbc.username"));
  24.        config.setPassword(env.getProperty("jdbc.password"));
  25.        System.out.println(config.toString());
  26.     }
  27. }

假设 "my.placeholder "存在于一个已经注册的属性源中，例如系统属性或环境变量，该占位符将被解析为相应的值。如果没有，那么 "default/path "将被作为默认值使用。如果没有指定默认值，并且一个属性不能被解析，那么就会抛出一个IllegalArgumentExceptionwil。

@PropertySources 注解 - 包括多个属性文件

引入了新的@PropertySources，以支持Java 8和一个更好的方法来包括多个属性文件。

  1. @Configuration
  2.  @PropertySources({
  3.   @PropertySource("classpath:config.properties"),
  4.   @PropertySource("classpath:db.properties")
  5.  })
  6.  public class AppConfig {
  7.   //...
  8.  }

允许 @PropertySource 忽略未找到的属性文件。

  1. @Configuration
  2.  @PropertySource("classpath:missing.properties")
  3.  public class AppConfig {
  4.   //...
  5.  }

如果没有找到missing.properties，系统无法启动并抛出FileNotFoundException

  1. Caused by: java.io.FileNotFoundException: 
  2.   classpath resource [missiong.properties] cannot be opened because it does not exist

在Spring 4中，你可以使用e1d15d1来忽略未找到的属性文件

  1. @Configuration
  2.  @PropertySource(value="classpath:missing.properties", ignoreResourceNotFound=true)
  3.  public class AppConfig {
  4.   //...
  5.  }
  7.         @PropertySources({
  8.   @PropertySource(value = "classpath:missing.properties", ignoreResourceNotFound=true),
  9.   @PropertySource("classpath:config.properties")
  10.         })

Spring @PropertySource注解完整示例

让我们创建一个简单的Spring boot maven项目来快速启动。

在这个例子中，我们从文件config.properties文件中读取数据库配置，并将这些属性值设置为DataSourceConfigclass。
使用Spring Initializr在http://start.spring.io/创建一个maven项目，这是一个在线Spring Boot应用程序生成器。

按照上图创建一个打包结构。

pom.xml文件

  1. <?xmlversion="1.0"encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3.  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  4.  <modelVersion>4.0.0</modelVersion>
  6.  <groupId>net.guides.springboot2</groupId>
  7.  <artifactId>spring-propertysource-example</artifactId>
  8.  <version>0.0.1-SNAPSHOT</version>
  9.  <packaging>jar</packaging>
  11.  <name>spring-propertysource-example</name>
  12.  <description>Demo project for Spring Boot</description>
  14.  <parent>
  15.   <groupId>org.springframework.boot</groupId>
  16.   <artifactId>spring-boot-starter-parent</artifactId>
  17.   <version>2.0.5.RELEASE</version>
  18.   <relativePath/> <!-- lookup parent from repository -->
  19.  </parent>
  21.  <properties>
  22.   <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  23.   <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
  24.   <java.version>1.8</java.version>
  25.  </properties>
  27.  <dependencies>
  28.   <dependency>
  29.    <groupId>org.springframework.boot</groupId>
  30.    <artifactId>spring-boot-starter</artifactId>
  31.   </dependency>
  33.   <dependency>
  34.    <groupId>org.springframework.boot</groupId>
  35.    <artifactId>spring-boot-starter-test</artifactId>
  36.    <scope>test</scope>
  37.   </dependency>
  38.  </dependencies>
  40.  <build>
  41.   <plugins>
  42.    <plugin>
  43.     <groupId>org.springframework.boot</groupId>
  44.     <artifactId>spring-boot-maven-plugin</artifactId>
  45.    </plugin>
  46.   </plugins>
  47.  </build>
  48. </project>

创建一个config.properties文件

让我们在classpath中创建一个config.properties文件，我们将使用@PropertySource注解来读取一个属性文件，并用@Value和Environment.

  1. jdbc.driver=com.mysql.jdbc.Driver
  2. jdbc.url=jdbc:mysql://localhost:3306/dev_db
  3. jdbc.username=root
  4. jdbc.password=root

来显示值。

创建DataSourceConfig.java文件

  1. package net.guides.springboot2.springpropertysourceexample;
  3. public class DataSourceConfig {
  4.  private String driver;
  5.  private String url;
  6.  private String username;
  7.  private String password;
  8.  
  9.  @Override
  10.  public String toString()
  11.  {
  12.   return "DataSourceConfig [driver=" + driver + ", url=" + url + ", username=" + username + "]";
  13.  }
  14.  public String getDriver()
  15.  {
  16.   return driver;
  17.  }
  18.  public void setDriver(String driver)
  19.  {
  20.   this.driver = driver;
  21.  }
  22.  public String getUrl()
  23.  {
  24.   return url;
  25.  }
  26.  public void setUrl(String url)
  27.  {
  28.   this.url = url;
  29.  }
  30.  public String getUsername()
  31.  {
  32.   return username;
  33.  }
  34.  public void setUsername(String username)
  35.  {
  36.   this.username = username;
  37.  }
  38.  public String getPassword()
  39.  {
  40.   return password;
  41.  }
  42.  public void setPassword(String password)
  43.  {
  44.   this.password = password;
  45.  }
  46. }

创建 ProperySourceDemo.java 文件

  1. package net.guides.springboot2.springpropertysourceexample;
  3. import org.slf4j.Logger;
  4. import org.slf4j.LoggerFactory;
  5. import org.springframework.beans.factory.InitializingBean;
  6. import org.springframework.beans.factory.annotation.Autowired;
  7. import org.springframework.beans.factory.annotation.Value;
  8. import org.springframework.context.annotation.Configuration;
  9. import org.springframework.context.annotation.PropertySource;
  10. import org.springframework.core.env.Environment;
  12. @Configuration
  13. @PropertySource("classpath:config.properties")
  14. public class ProperySourceDemo implements InitializingBean {
  16.  private static final Logger LOGGER = LoggerFactory.getLogger(ProperySourceDemo.class);
  18.  @Value("${jdbc.driver}")
  19.  private String driver;
  21.  @Value("${jdbc.url}")
  22.  private String url;
  24.  @Value("${jdbc.username}")
  25.  private String username;
  27.  @Value("${jdbc.password}")
  28.  private String password;
  30.  @Autowired
  31.  Environment env;
  33.  @Override
  34.  public void afterPropertiesSet() throws Exception {
  35.   LOGGER.info(driver);
  36.   LOGGER.info(url);
  37.   LOGGER.info(password);
  38.   LOGGER.info(username);
  39.   setDatabaseConfig();
  40.  }
  42.  private void setDatabaseConfig() {
  43.   DataSourceConfig config = new DataSourceConfig();
  44.   config.setDriver(env.getProperty("jdbc.driver"));
  45.   config.setUrl(env.getProperty("jdbc.url"));
  46.   config.setUsername(env.getProperty("jdbc.username"));
  47.   config.setPassword(env.getProperty("jdbc.password"));
  48.   System.out.println(config.toString());
  49.  }
  50. }

The Application.java File

这个spring boot应用程序有一个名为Application.java的入口点Java类，其中有一个公共静态void main(String[] args)方法，你可以运行它来启动应用程序。

  1. package net.guides.springboot2.springpropertysourceexample;
  3. import org.springframework.boot.SpringApplication;
  4. import org.springframework.boot.autoconfigure.SpringBootApplication;
  6. @SpringBootApplication
  7. public class Application {
  9.  public static void main(String[] args) {
  10.   SpringApplication.run(Application.class, args);
  11.  }
  12. }

@SpringBootApplication是一个方便的注解，添加了以下所有内容。

@Configuration 将该类标记为应用程序上下文的Bean定义的来源。
@EnableAutoConfiguration告诉Spring Boot开始根据classpath设置、其他bean和各种属性设置来添加bean。

通常你会为Spring MVC应用添加@EnableWebMvc，但Spring Boot在classpath上看到spring-webmvc时就会自动添加它。这标志着该应用是一个Web应用，并激活了关键行为，如设置DispatcherServlet。
@ComponentScan告诉Spring去寻找hello包中的其他组件、配置和服务，从而使它能够找到控制器。

让我们运行Application.java类并观察控制台的输出。

输出

版权说明 : 本文为转载文章, 版权归原作者所有 版权申明

原文链接 : https://www.javaguides.net/2018/09/spring-propertysource-annotation-with-example.html

内容来源于网络，如有侵权，请联系作者删除！

相关文章

    查看更多

    热门标签

    更多
    JavaquerypythonNode开发语言requestUtil数据库Table后端算法LoggerMessageElementParser

    最新文章

    更多
    • 蜀ICP备13028337号-1 大数据知识库 https://www.saoniuhuo.com © All rights reserved
    • 本站内容来源互联网,如果侵犯您的权益请联系我们删除, 联系方式：448109455@qq.com