Spring-注入外部值

 Spring注入需要初始化，但前面均使用硬编码注入，如：

JavaConfig配置：

package soundSystem;

import org.springframework.stereotype.Component;

/**
 * CompactDisc接口的实现类，此类中定义了CD的名字和作者以及打印相关信息的方法
 * @author yan
 */
@Component("compactd")//用于扫描来动态生成bean
public class SgtPeppers implements CompactDisc{

    private String title="K歌之王";
    private String artist="陈奕迅";
    @Override
    public void cdInfo() {
        System.out.print("This CD's title:"+title+";artist:"+artist);
    }

}

xml配置（需要实现setter方法）：

    <bean id="cd" class="soundSystem.SgtPeppers">
        <property name="title" value="L.O.V.E"></property>
        <property name="artist" value="May Day"></property>
    </bean>

Spring允许注入外部值，这样不用受到硬编码的限制：

--JavaConfig（显式bean）

主要是在配置类中实现：

1.在配置类类名上方添加注解@PropertySource("classpath:/sp.properties")，参数为文件全路径名，properties文件是专门用来存放k-v值对的；

2.在配置类中定义Environment env,并添加@AutoWired注解；

3.在定义bean的方法中使用env.getProperty()方法配置文件（*.properties）中的值来赋给bean作为参数。

package com.spring.config;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;
import org.springframework.core.env.Environment;

import com.spring.custom.Person;

@Configuration("com.spring.custom")
@ComponentScan(basePackages={"com.spring"})
@PropertySource("classpath:/sp.properties")
public class CreatureSpingConfig {
    @Autowired
    Environment env;
    @Bean
    public Person person(){
        return new Person(env.getProperty("name"), env.getProperty("age",Integer.class), env.getProperty("sex"));
    }
}

这样就实现了从外部文件注入的目标了。

注：getProperty("key值")返回的是String类型，但并不是所有参数都是String类型，所以这个方法有几个重载形式

解释如下：

public interface PropertyResolver {  
  
    //是否包含某个属性  
    boolean containsProperty(String key);  
   
        //获取属性值 如果找不到返回null   
    String getProperty(String key);  
       
        //获取属性值，如果找不到返回默认值        
    String getProperty(String key, String defaultValue);  
    
        //获取指定类型的属性值，找不到返回null  
    <T> T getProperty(String key, Class<T> targetType);  
  
        //获取指定类型的属性值，找不到返回默认值  
    <T> T getProperty(String key, Class<T> targetType, T defaultValue);  
  
         //获取属性值为某个Class类型，找不到返回null，如果类型不兼容将抛出ConversionException  
    <T> Class<T> getPropertyAsClass(String key, Class<T> targetType);  
  
        //获取属性值，找不到抛出异常IllegalStateException  
    String getRequiredProperty(String key) throws IllegalStateException;  
  
        //获取指定类型的属性值，找不到抛出异常IllegalStateException         
    <T> T getRequiredProperty(String key, Class<T> targetType) throws IllegalStateException;  
  
        //替换文本中的占位符（${key}）到属性值，找不到不解析  
    String resolvePlaceholders(String text);  
  
        //替换文本中的占位符（${key}）到属性值，找不到抛出异常IllegalArgumentException  
    String resolveRequiredPlaceholders(String text) throws IllegalArgumentException;  
  
} 

这里列举的是PropertyResolver接口中定义的方法，是因为Environment继承了这个接口，上例中我们使用了第7行和第13行的getProperty的两种重载的形式，当然也可是设置默认值。

---

---

 

--JavaConfig(注解生成bean)演示@Value注解使用方式

实现类：

package com.spring.beans;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
@Component//自动生成bean
public class VCD implements CompactDisc{
    
private String title;
private String artist;
private int year;

//定义有参构造
    @Autowired//必须写，不写会报错（目前不知原因）
    public VCD(@Value("${title}")String title, @Value("${artist}")String artist,@Value("${year}")int year) {
    super();
    this.title = title;
    this.artist = artist;
    this.year=year;}
    @Override
    public void play() {
        System.out.println("Playing CD's title is"+title+",the artist is"+artist+",the year is"+year);
        }
    }

 配置类：

package com.spring.config;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Configurable;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
//import org.springframework.context.annotation.ImportResource;
import org.springframework.context.annotation.PropertySource;
import org.springframework.context.support.PropertySourcesPlaceholderConfigurer;
import org.springframework.core.env.Environment;


@Configuration//表明这是一个Spring的配置类
@ComponentScan(value="com.spring")//表示需要扫描的包，因为演示所用为显式bean，所以其实这里没必要添加此注解
@PropertySource(value="classpath:propertiesSource.properties")
//@ImportResource("classpath:spring.xml")//引入XML配置文件
public class SpringConfig {
    /**
     * 因为采用混合配置，故注释掉重复bean及无用变量
     */
    @Autowired 
    private Environment e;
    
    @Bean//要使用@Value注解需要添加此bean
    public static PropertySourcesPlaceholderConfigurer pc(){
        return new PropertySourcesPlaceholderConfigurer();
    }
}

配置文件：

title=L.O.V.E
artist=May Day
year=2006

注：

1. 要使用@Value需要添加PropertySourcesPlaceholderConfigurer类的bean；
2. 需要在使用@Value处添加@AutoWired注解，否则会出错。

---

---

 

 --XML（显式bean）

此处使用混合配置，以CD为例。

配置类：

package com.spring.config;

//import org.springframework.beans.factory.annotation.Autowired;
//import org.springframework.beans.factory.annotation.Configurable;
//import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.ImportResource;
//import org.springframework.context.annotation.PropertySource;
//import org.springframework.core.env.Environment;


@Configuration//表明这是一个Spring的配置类
@ComponentScan(value="com.spring")//表示需要扫描的包，因为演示所用为显式bean，所以其实这里没必要添加此注解
//@PropertySource(value="classpath:propertiesSource.properties")
@ImportResource("classpath:spring.xml")//引入XML配置文件
public class SpringConfig {
    /**
     * 因为采用混合配置，故注释掉重复bean及无用变量
     */
//    @Autowired 
//    private Environment e;
    
//    @Bean
//    public CompactDisc cd(){
//        return new VCD(e.getProperty("title"),e.getProperty("artist"));
//    }
}

 

实现类：

package com.spring.beans;
public class VCD implements CompactDisc{
    
private String title;
private String artist;
private int year;
//定义有参构造
    public VCD(String title, String artist,int year) {
    super();
    this.title = title;
    this.artist = artist;
    this.year=year;
    System.out.println("Playing CD's title is"+this.title+",the artist is"+this.artist+",the year is"+this.year);}
    @Override
    public void play() {}
}

 

在XML中：

<?xml version="1.0" encoding="UTF-8"?>
 <beans
      xmlns="http://www.springframework.org/schema/beans"
      xmlns:c="http://www.springframework.org/schema/c"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xmlns:p="http://www.springframework.org/schema/p"
      xmlns:context="http://www.springframework.org/schema/context"
      xsi:schemaLocation="http://www.springframework.org/schema/beans 
      http://www.springframework.org/schema/beans/spring-beans.xsd
     http://www.springframework.org/schema/context 
     http://www.springframework.org/schema/context/spring-context.xsd
     ">
     <context:property-placeholder location="classpath:propertiesSource.properties"/>
     <bean id="cd" class="com.spring.beans.VCD" c:_0="${title}" c:_1="${artist}" c:_2="${year}">
     </bean>
 </beans>

 

配置文件中：

title=L.O.V.E
artist=May Day
year=2006

 

这样便可以实现从外部注入属性值了。

注意：

1. 在XML配置中，要添加<context:property-placeholder/>标签，其属性location的值便为配置文件的路径，这与JavaConfig中的@PropertySource起同样的作用；
2. 从例子中可以看出，构造器注入，可以使用c-命名空间来设置初始值，格式如：c:_index，index为构造器中参数的索引值，从0开始。而<context:property-placeholder/>标签是专门用来匹配属性占位符的，缺少此标签则不起作用。

2016-10-25 21:20:52

资料参考：

1. Environment用法：http://blog.csdn.net/hdngbj/article/details/18003001#
2. 混合配置用法：http://www.cnblogs.com/yw0219/p/5989865.html