读取Spring配置文件几种方式

读取Spring配置文件几种方式  

2011-12-01 11:59:41|  分类: Spring |  标签:spring  |举报|字号 订阅

获取Spring框架管理的类实例的方法有多种,如下: 

方法一:在初始化时保存ApplicationContext对象 
代码: 
ApplicationContext ac = new FileSystemXmlApplicationContext("applicationContext.xml"); 
ac.getBean("beanId"); 
说明: 
这种方式适用于采用Spring框架的独立应用程序,需要程序通过配置文件手工初始化Spring的情况。 

方法二:通过Spring提供的工具类获取ApplicationContext对象 
代码: 
import org.springframework.web.context.support.WebApplicationContextUtils; 
ApplicationContext ac1 = 
WebApplicationContextUtils.getRequiredWebApplicationContext(ServletContext sc) 
ApplicationContext ac2 = WebApplicationContextUtils.getWebApplicationContext(ServletContext 
sc) 
ac1.getBean("beanId"); 
ac2.getBean("beanId"); 
说明: 
这种方式适合于采用Spring框架的B/S系统,通过ServletContext对象获取ApplicationContext对象,然后 
在通过它获取需要的类实例。 
上面两个工具方式的区别是,前者在获取失败时抛出异常,后者返回null。 

方法三:继承自抽象类ApplicationObjectSupport 
说明: 
抽象类ApplicationObjectSupport提供getApplicationContext()方法,可以方便的获取到ApplicationCont 
ext。Spring初始化时,会通过该抽象类的setApplicationContext(ApplicationContext 
context)方法将ApplicationContext 对象注入。 

方法四:继承自抽象类WebApplicationObjectSupport 
说明: 
类似上面方法,调用getWebApplicationContext()获取WebApplicationContext 

方法五:实现接口ApplicationContextAware 
说明: 
实现该接口的setApplicationContext(ApplicationContext context)方法,并保存ApplicationContext 对 

象。Spring初始化时,会通过该方法将ApplicationContext 对象注入。 

以上方法适合不同的情况,请根据具体情况选用相应的方法。 

这里值得提一点的是,系统中用到上述方法的类实际上就于Spring框架紧密耦合在一起了,因为这些类是知 

道它们是运行在Spring框架上的,因此,系统中,应该尽量的减少这类应用,使系统尽可能的独立于当前运 

行环境,尽量通过DI的方式获取需要的服务提供者。 



1.利用ClassPathXmlApplicationContext 

可以从classpath中读取XML文件 

(1) ApplicationContext context = new ClassPathXmlApplicationContext("applicationContext.xml"); 
UserDao userDao = (UserDao)context.getBean("userDao"); 

(2) ClassPathXmlApplicationContext resource = new ClassPathXmlApplicationContext(new  String[]{"applicationContext-ibatis-oracle.xml","applicationContext.xml","applicationContext-data-oracle.xml"}); 

       BeanFactory factory = resource; 
       UserDao userDao = (UserDao) factory.getBean("userDao"); 

2. 利用ClassPathResource 

可以从classpath中读取XML文件 

Resource cr = new ClassPathResource("applicationContext.xml"); 
BeanFactory bf=new XmlBeanFactory(cr); 
UserDao userDao = (UserDao)bf.getBean("userDao"); 
加载一个xml文件org.springframework.beans.factory.config.PropertyPlaceholderConfigurer不起作用 

3.利用XmlWebApplicationContext读取 

从Web应用程序的文件架构中,指定相对位置来读取定义文件。 

XmlWebApplicationContext 的建構子無法帶參數,參考API文件會發現,預設的location會指向/WEB-INF/applicationContext.xml檔案。使用其 public static屬性DEFAULT_CONFIG_LOCATION可取得此預設檔名。由於我使用MyEclipse,預設會多一個"/WebRoot"的 目錄在WEB-INF之前,因此若在web project裡有一些與web無關的程式要使用context時(例如處理一些MVC架構中的"M"的部份),就無法使用 XmlWebApplicationContext來讀取bean定義檔,因為default location會差一個"WebRoot"的目錄。 
即 使在web.xml裡面,在DispatcherServlet定義中重新定義contextConfigLocation也一樣(此定義可以 override掉XmlWebApplicationContext中的DEFAULT_CONFIG_LOCATION值),因為與web無關的程式 並不會經過web.xml的定義檔設定。目前我還沒試成功過XmlWebApplicationContext取得bean定義檔,使用 ClassPathXmlApplicationContext反而會快一些。 

XmlWebApplicationContext ctx = new XmlWebApplicationContext(); 
    ctx.setConfigLocations(new String[] {"/WEB-INF/ applicationContext.xml"); 
    ctx.setServletContext(pageContext.getServletContext()); 
    ctx.refresh(); 
    UserDao  userDao = (UserDao ) ctx.getBean("userDao "); 

4.利用FileSystemResource读取 

Resource rs = new FileSystemResource("D:/tomcat/webapps/test/WEB-INF/classes/ applicationContext.xml"); 
  BeanFactory factory = new XmlBeanFactory(rs); 
  UserDao  userDao  = (UserDao )factory.getBean("userDao"); 

值得注意的是:利用FileSystemResource,则配置文件必须放在project直接目录下,或者写明绝对路径,否则就会抛出找不到文件的异常 

5.利用FileSystemXmlApplicationContext读取 

可以指定XML定义文件的相对路径或者绝对路径来读取定义文件。 

方法一: 
String[]   path={"WebRoot/WEB-INF/applicationContext.xml","WebRoot/WEB-INF/applicationContext_task.xml"}; 
ApplicationContext context = new FileSystemXmlApplicationContext(path); 

方法二: 
  String path="WebRoot/WEB-INF/applicationContext*.xml"; 
  ApplicationContext context = new FileSystemXmlApplicationContext(path); 

方法三: 
ApplicationContext ctx = 
new FileSystemXmlApplicationContext("classpath:地址"); 
没有classpath的话就是从当前的工作目录
### Spring Boot 读取配置文件方式总结 #### 方法一:`@Value` 注解 通过 `@Value` 注解可以方便地注入单个属性到类的字段中。这种方式适用于简单场景,尤其是只需要获取少量配置项的情况。例如,在 `application.properties` 或 `application.yml` 中定义如下配置: ```properties my.property=Hello, Spring Boot! ``` 或者使用 YAML 格式: ```yaml my: property: Hello, Spring Boot! ``` 可以在 Java 类中这样读取该配置: ```java @Component public class MyConfig { @Value("${my.property}") private String myProperty; public void printProperty() { System.out.println(myProperty); } } ``` 这种方法的优点在于实现简单,缺点是支持复杂的数据结构绑定[^2]。 --- #### 方法二:`@ConfigurationProperties` 注解 当需要处理一组具有相同前缀的配置时,推荐使用 `@ConfigurationProperties` 注解。它允许将多个相关联的配置映射到一个 POJO 对象上。例如,假设存在以下配置: ```yaml my: app: name: MyApp version: 1.0.0 list: - item1 - item2 ``` 可以通过创建对应的实体类来绑定这些配置: ```java @ConfigurationProperties(prefix = "my.app") @Data // Lombok 自动生成 getter 和 setter public class AppConfig { private String name; private String version; private List<String> list; } ``` 接着将其注册为 Bean 并启用配置加载功能: ```java @Configuration @EnableConfigurationProperties(AppConfig.class) public class Configurer {} ``` 此方法的优势是可以轻松管理复杂的嵌套数据结构并提供类型安全的支持[^1]。 --- #### 方法三:`Environment` 接口 Spring 的 `Environment` 接口提供了另一种灵活的方式来访问应用上下文中所有的属性值。无论是在开发阶段还是生产环境中都可以利用这一机制动态调整行为逻辑。比如要获取某个特定键对应的内容可以直接调用其相应的方法: ```java @Autowired private Environment environment; public void printProperty() { String value = environment.getProperty("my.property"); System.out.println(value); } ``` 相比其他两种方式而言,虽然灵活性更高但也稍微显得够直观简洁一些。 --- #### 方法四:`@PropertySource` 自定义资源位置 如果项目中有额外的需求需要用到外部自定义 `.properties` 文件而是默认路径下提供的那些,则可通过声明 `@PropertySource` 来引入新的资源配置源。注意此时还需要配合 `@ComponentScan` 扫描包以及确保正确设置编码格式防止乱码等问题发生。 假设有这样一个名为 `custom-config.properties` 的文件位于项目的根目录之外的地方,并且里面包含了这样的条目: ```properties external.config=value-from-external-source ``` 那么我们就可以按照下面的样子编写代码去加载这个特殊的配置文档了: ```java @Configuration @PropertySource("file:/path/to/custom-config.properties") public class ExternalConfig { @Autowired private Environment env; public void displayExternalConfig() { System.out.println(env.getProperty("external.config")); } } ``` 这里需要注意的是,对于相对路径来说可能需要考虑同操作系统之间的差异性;而对于绝对路径则可能会带来部署上的便之处[^3]。 --- ### 总结表格对比 | **特性/方法** | **@Value** | **@ConfigurationProperties** | **Environment** | **@PropertySource** | |-----------------------|--------------------------|----------------------------------|---------------------------|------------------------------| | **适用范围** | 单独属性 | 复杂对象 | 动态运行期 | 非标准位置 | | **优点** | 实现简单 | 支持复杂数据 | 灵活 | 可导入外部文件 | | **局限性** | 支持复杂结构 | 需要显式开启 | 较繁琐 | 路径依赖可能导致移植困难 | ---
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值