3.1 环境与profile
3.1.1 配置profile bean
Spring为环境相关的bean所提供的解决方案其实与构建时的方案没有太大的差别。当然,在这个过程中需要根据环境决定该创建哪个bean和不创建哪个bean。不过Spring并不是在构建的时候做出这样的决策,而是等到运行时再来确定。这样的结果就是同一个部署单元(可能会是WAR文件)能够适用于所有的环境,没有必要进行重新构建。
在3.1版本中,Spring引入了bean profile的功能。要使用profile,你首先要将所有不同的bean定义整理到一个或多个profile之中,在将应用部署到每个环境时,要确保对应的profile处于激活(active)的状态。
在Java配置中,可以使用@Profile
注解指定某个bean属于那一个profile。例如,在配置类中,嵌入式数据库的DataSource可能会配制成如下:
package myapp;
import javax.activation.DataSource;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Profile;
import org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseBuilder;
import org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseType;
@Configuration
@Profile("dev")
public class DevelopmentProfileConfig {
@Bean(destroyMethod="shutdown")
public DataSource dataSource() {
return (DataSource) new EmbeddedDatabaseBuilder()
.setType(EmbeddedDatabaseType.H2)
.addScript("classpath:schema.sql")
.addScript("classpath:test-data.sql")
.build();
}
}
注意的是@Profile
注解应用在了类级别上。它会告诉Spring这个配置类中的bean只有在dev
profile激活时才会创建。如果dev
profile没有激活的话,那么带有@Bean
注解的方法都会被忽略掉。
同时,还需要一个适用于生产环境的配置:
package myapp;
import javax.activation.DataSource;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Profile;
import org.springframework.jndi.JndiObjectFactoryBean;
@Configuration
@Profile("prod")
public class ProductionProfileConfig {
@Bean
public DataSource dataSource() {
JndiObjectFactoryBean jndiObjectFactoryBean = new JndiObjectFactoryBean();
jndiObjectFactoryBean.setJndiName("jdbc/myDS");
jndiObjectFactoryBean.setResourceRef(true);
jndiObjectFactoryBean.setProxyInterface(javax.sql.DataSource.class);
return (DataSource) jndiObjectFactoryBean.getObject();
}
}
同样,只有prof
profile被激活才会创建对应的bean。
在Spring 3.1中,只能在类级别上使用@Profile
注解。不过,从Spring 3.2开始,你也可以在方法级别上使用@Profile
注解,与@Bean
注解一同使用。这样的话,就能将这两个bean的声明放到同一个配置类之中,如下所示:
package myapp;
import javax.activation.DataSource;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Profile;
import org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseBuilder;
import org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseType;
import org.springframework.jndi.JndiObjectFactoryBean;
@Configuration
public class DataSourceConfig {
@Bean
@Profile("prod")
public DataSource jndiDataSource() {
JndiObjectFactoryBean jndiObjectFactoryBean = new JndiObjectFactoryBean();
jndiObjectFactoryBean.setJndiName("jdbc/myDS");
jndiObjectFactoryBean.setResourceRef(true);
jndiObjectFactoryBean.setProxyInterface(javax.sql.DataSource.class);
return (DataSource) jndiObjectFactoryBean.getObject();
}
@Bean(destroyMethod = "shutdown")
@Profile("dev")
public DataSource embeddedDataSource() {
return (DataSource) new EmbeddedDatabaseBuilder()
.setType(EmbeddedDatabaseType.H2)
.addScript("classpath:schema.sql")
.addScript("classpath:test-data.sql")
.build();
}
}
这里有个问题需要注意,尽管每个DataSource bean都被声明在一个profile中,并且只有当规定的profile激活时,相应的bean才会被创建,但是可能会有其他的bean并没有声明在一个给定的profile范围内。没有指定profile的bean始终都会被创建,与激活哪个profile没有关系。
在XML中配置profile
我们也可以通过<beans>
元素的profile属性,在XML中配置profile bean。例如,为了在XML中定义适用于开发阶段的嵌入式数据库DataSourcebean,我们可以创建如下所示的XML文件:
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:jdbc="http://www.springframework.org/schema/jdbc"
xsi:schemaLocation="http://www.springframework.org/schema/jdbc
http://www.springframework.org/schema/jdbc/spring-jdbc.xsd
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd"
profile="dev">
<jdbc:embedded-database id="dataSource">
<jdbc:script location="classpath:schema.sql" />
<jdbc:script location="classpath:test-data.sql" />
</jdbc:embedded-database>
</beans>
当然,也可以配置到同一个配置文件中:
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:jdbc="http://www.springframework.org/schema/jdbc"
xmlns:jee="http://www.springframework.org/schema/jee" xmlns:p="http://www.springframework.org/schema/p"
xsi:schemaLocation="http://www.springframework.org/schema/jdbc
http://www.springframework.org/schema/jdbc/spring-jdbc.xsd
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/jee
http://www.springframework.org/schema/jee/spring-jee.xsd">
<beans profile="dev">
<jdbc:embedded-database id="dataSource">
<jdbc:script location="classpath:schema.sql" />
<jdbc:script location="classpath:test-data.sql" />
</jdbc:embedded-database>
</beans>
<beans profile="qa">
<bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource" destory-method="close"
p:url="jdbc:h2:tcp://dbserver/~test"
p:driverClassName="org.h2.Driver"
p:username="username"
p:password="password"
p:initialSize="20"
p:maxActive="30" />
</beans>
<beans profile="prod">
<jee:jndi-lookup id="dataSource"
jndi-name="jdbc/myDatabase"
resource-ref="true"
proxy-interface="javax.sql.DataSource" />
</beans>
</beans>
3.1.2 激活profile
Spring在确定哪个profile处于激活状态时,需要依赖两个独立的属性:spring.profiles.active
和spring.profiles.default
。如果设置了spring.profiles.active
属性的话,那么它的值就会用来确定哪个profile是激活的。但如果没有设置spring.profiles.active
属性的话,那Spring将会查找spring.profiles.default
的值。如果spring.profiles.active
和spring.profiles.default
均没有设置的话,那就没有激活的profile,因此只会创建那些没有定义在profile中的bean。
设置这两个属性的方法:
- 作为DispatcherServlet的初始化参数
- 作为Web应用的上下文参数
- 作为JNDI条目
- 作为环境变量
- 作为JVM的系统属性
- 在集成测试类上,使用@ActiveProfiles注解设置
在web应用的web.xml文件中设置默认的profile:
<?xml version="1.0" encoding="UTF-8"?>
<web-app version="2.5"
xmlns="http://java.sun.com/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">
<contex-param>
<param-name>contextConfigLocation</param-name>
<param-value>/WEB-INF/spring/root-context.xml</param-value>
</contex-param>
<contex-param>
<param-name>spring.profiles.default</param-name>
<param-value>dev</param-value>
</contex-param>
<listener>
<listener-class>
org.springframework.web.context.ContextLoaderListener
</listener-class>
</listener>
<servlet>
<servlet-name>appServlet</servlet-name>
<servlet-class>
org.springframework.web.servlet.DispatcherServlet
</servlet-class>
<init-param>
<param-name>spring.profiles.default</param-name>
<param-value>dev</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>appServlet</servlet-name>
<url-pattern>/</url-pattern>
</servlet-mapping>
</web-app>
当应用程序部署到QA、生产或其他环境之中时,负责部署的人根据情况使用系统属性、环境变量或JNDI设置spring.profiles.active
即可。当设置spring.profiles.active
以后,至于spring.profiles.default
置成什么值就已经无所谓了;系统会优先使用spring.profiles.active
中所设置的profile。
使用profile进行测试
Spring提供了@ActiveProfiles
注解,我们可以使用它来指定运行测试时要激活哪个profile。在集成测试时,通常想要激活的是开发环境的profile。例如,下面的测试类片段展现了使用@ActiveProfiles
激活dev
profile:
@RunWith(SpringJunit4ClassRunner.class)
@ContextConfiguration(classes={PersistenceTestConfig.class})
@ActiveProfiles("dev")
public class PersistenceTest {
...
}
3.2 条件化的bean
当我们需要在特定情况下才创建某个bean,Spring 4引入了一个新的@Conditional
注解,他可以用到带有@Bean
注解的方法上。如果给定的计算结果为true
,就会创建这个bean,否则这个bean就会被忽略。
例如,假设有一个名为MagicBean的类,我们希望只有设置了magic环境属性的时候,Spring才会实例化这个类。如果环境中没有这个属性,那么MagicBean将会被忽略。
@Bean
@Conditional(MagicExistsCondition.class)
public MagicBean magicBean() {
return new MagicBean();
}
@Conditional
中指定了一个Class,它指明了条件。@Conditional
将会通过Condition接口进行条件对比:
public interface Condition {
boolean matches(ConditionContext ctxt, AnnotatedTypeMetadata metadata);
}
如MagicExistsCondition:
package myapp;
import org.springframework.context.annotation.Condition;
import org.springframework.context.annotation.ConditionContext;
import org.springframework.core.env.Environment;
import org.springframework.core.type.AnnotatedTypeMetadata;
public class MagicExistsCondition implements Condition {
@Override
public boolean matches(ConditionContext ctxt, AnnotatedTypeMetadata metadata) {
Environment env = ctxt.getEnvironment();
return env.containsProperty("magic");
}
}
ConditionContext是一个接口,大致如下:
public interface ConditionContext {
BeanDefinitionRegistry getRegistry();
ConfigurableListableBeanFactory getBeanFactory();
Environment getEnvironment();
ResourceLoader getResourceLoader();
ClassLoader getClassLoader();
}
通过ConditionContext,我们可以做到以下几点:
- 借助getRegistry()返回的BeanDefinitionRegistry检查bean定义
- 借助getBeanFactory()返回的ConfigurableListableBeanFactory检查bean是否存在,甚至探查bean的属性
- 借助getEnvironment()返回的Environment检查环境变量是否存在以及它的值是什么
- 读取并探查getResourceLoader()返回的ResourceLoader所加载的资源
- 借助getClassLoader()返回的ClassLoader加载并检查类是否存在
AnnotatedTypeMetadata则能够让我们检查带有@Bean
注解的方法上还有什么其他的注解。
public interface AnnotatedTypeMetadata {
boolean isAnnotated(String annotationType);
Map<String, Object> getAnnotationAttributes(String annotationType);
Map<String, Object> getAnnotationAttributes(String annotationType, boolean classValuesAsString);
MultiValueMap<String, Object> getAllAnnotationAttributes(String annotationType);
MultiValueMap<String, Object> getAllAnnotationAttributes(String annotationType, boolean classValuesAsString);
}
借助isAnnotated()
方法,我们可以判断带有@Bean
的方法是不是还有其他特定的注解。借助其他的方法,我们可以检查@Bean
的方法上的其他注解的属性。
从Spring 4开始,@Profile
注解进行了重构,使其基于@Conditional
和Condition
实现。
ProfileCondition
通过AnnotatedTypeMetadata
得到了用于@Profile
注解的所有属性。借助该信息,它会明确地检查value
属性,该属性包含了bean的profile名称。然后,它根据通过ConditionContext
得到的Environment
来检查(借
助acceptsProfiles()
方法)该profile是否处于激活状态。
3.3 处理自动装配的歧义性
自动装配能够提供很大的帮助,因为它会减少装配应用程序组件时所需要的显式配置的数量。不过,仅有一个bean匹配所需的结果时,自动装配才是有效的。如果不仅有一个bean能够匹配结果的话,这种歧义性会阻碍Spring自动装配属性、构造器参数或方法参数。
所以Spring中引入@Primary
注解来指定首先bean。
@Component
@Primary
public class IceCream implements Dessert {...}
或者,在JavaConfig中:
@Bean
@Primary
public IceCream iceCream{
return new IceCream();
}
XML中:
<bean id="iceCream" class="dessert.IceCream" primary="true" />
当然,primary
也只能指定一个,否则也会产生歧义。
3.2.2 限定自动装配的bean
设置首选bean的局限性在于@Primary
无法将可选方案的范围限定到唯一一个无歧义性的选项中。它只能标示一个优先的可选方案。当首选bean的数量超过一个时,我们并没有其他的方法进一步缩小可选范围。
与之相反,Spring的限定符能够在所有可选的bean上进行缩小范围的操作,最终能够达到只有一个bean满足所规定的限制条件。如果将所有的限定符都用上后依然存在歧义性,那么你可以继续使用更多的限定符来缩小选择范围。
@Qualifier
注解是使用限定符的主要方式。它可以与@Autowired
和@Inject
协同使用,在注入的时候指定想要注入进去的是哪个bean。
例如,我们想要确保要将IceCream注入到setDessert()
之中:
@AutoWired
@Qualifier("iceCream")
public void setDessert(Dessert desert) {
this.dessert = dessert;
}
为@Qualifier
注解所设置的参数就是想要注入的bean的ID。所有使用@Component
注解声明的类都会创建为bean,并且bean的ID为首字母变为小写的类名。因此,@Qualifier("iceCream")
指向的是组件扫描时所创建的bean,并且这个bean是IceCream类的实例。
更准确地讲,@Qualifier("iceCream")
所引用的bean要具有String类型的"iceCream"
作为限定符。如果没有指定其他的限定符的话,所有的bean都会给定一个默认的限定符,这个限定符与bean的ID相同。因此,框架会将具有"iceCream"
限定符的bean注入到setDessert()
方法中。这恰巧就是ID为iceCream
的bean,它是IceCream类在组件扫描的时候创建的。
基于默认的bean ID作为限定符是非常简单的,但这有可能会引入一些问题。如果你重构了IceCream类,将其重命名为Gelato的话,那此时会发生什么情况呢?如果这样的话,bean的ID和默认的限定符会变为gelato
,这就无法匹配setDessert()
方法中的限定符。自动装配会失败。
这里的问题在于setDessert()
方法上所指定的限定符与要注入的bean的名称是紧耦合的。对类名称的任意改动都会导致限定符失效!
创建自定义的限定符
我们可以为bean设置自己的限定符,而不是依赖于将bean ID作为限定符。在这里所需要做的就是在bean声明上添加@Qualifier
注解。例如,它可以与@Component
组合使用,如下所示:
@Component
@Qualifier("cold")
public class IceCream implements Dessert {...}
在这种情况下,cold
限定符分配给了IceCreambean。因为它没有耦合类名,因此你可以随意重构IceCream的类名,而不必担心会破坏自动装配。在注入的地方,只要引用cold
限定符就可以了。
@AutoWired
@Qualifier("cold")
public void setDessert(Dessert desert) {
this.dessert = dessert;
}
同样也有:
@Bean
@Qualifier("cold")
public IceCream iceCream{
return new IceCream();
}
使用自定义的限定符注解
由于Java注解不允许在同一条目上重复出现,所以我们不能使用多个@Qualifier
注解。因此我们需要创建自己的注解。
Java 8允许出现重复的注解,只要这个注解本身在定义的时候带有@Repeatable
注解就可以。不过,Spring的@Qualifier
注解并没有在定义时添加@Repeatable
注解。
这里所需要做的就是创建一个注解,它本身要使用@Qualifier
注解来标注。这样我们将不再使用@Qualifier("cold")
,而是使用自定义的@Cold
注解,该注解的定义如下所示:
package myapp;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.springframework.beans.factory.annotation.Qualifier;
@Target({ ElementType.CONSTRUCTOR, ElementType.FIELD, ElementType.METHOD, ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
@Qualifier
public @interface Cold {
}
同样,创建一个新的@Creamy
来替代@Qualifier("creamy")
。然后我们便可以为同一个bean添加多个Qualifier
。
3.4 bean的作用域
在默认情况下,Spring应用上下文中所有bean都是作为以单例(singleton)的形式创建的。也就是说,不管给定的一个bean被注入到其他bean多少次,每次所注入的都是同一个实例。
对于多变的对象,Spring定义了多种作用域,可以基于这些作用域创建bean:
- 单例(Singleton):在整个应用中,只创建bean的一个实例
- 原型(Prototype):每次注入或者通过Spring应用上下文获取的时候,都会创建一个新的bean实例
- 会话(Session):在Web应用中,为每个会话创建一个bean实例
- 请求(Request):在Web应用中,为每个请求创建一个bean实例
可以通过@Scope
注解:
@Component
@Scope(ConfigurableBeanFactory.SCOPE_PROTOTYPE)
public class Notepad {...}
这里,使用ConfigurableBeanFactory类的SCOPE_PROTOTYPE
常量设置了原型作用域。你当然也可以使用@Scope("prototype")
,但是使用SCOPE_PROTOTYPE
常量更加安全并且不易出错。
也可以在JavaConfig或XML中配置Scope
。
3.4.1 使用会话和请求作用域
在Web应用中,如果能够实例化在会话和请求范围内共享的bean,那将是非常有价值的事情。例如,在典型的电子商务应用中,可能会有一个bean代表用户的购物车。如果购物车是单例的话,那么将会导致所有的用户都会向同一个购物车中添加商品。另一方面,如果购物车是原型作用域的,那么在应用中某一个地方往购物车中添加商品,在应用的另外一个地方可能就不可用了,因为在这里注入的是另外一个原型作用域的购物车。
就购物车bean来说,会话作用域是最为合适的,因为它与给定的用户关联性最大。要指定会话作用域,我们可以使用@Scope注解,它的使用方式与指定原型作用域是相同的:
@Bean
@Scope(value=WebApplicationContext.SCOPE_SESSION, proxyMode=ScopedProxyMode.INTERFACES)
public ShoppingCart cart() {
...
}
我们将value设置成了WebApplicationContext
中的SCOPE_SESSION
常量(它的值是session
)。这会告诉Spring为Web应用中的每个会话创建一个ShoppingCart。这会创建多个ShoppingCart bean的实例,但是对于给定的会话只会创建一个实例,在当前会话相关的操作中,这个bean实际上相当于单例的。
要注意的是,@Scope
同时还有一个proxyMode
属性,它被设置成了ScopedProxyMode.INTERFACES
。这个属性解决了将会话或请求作用域的bean注入到单例bean中所遇到的问题。在描述proxyMode
属性之前,我们先来看一下proxyMode
所解决问题的场景。
假设我们要将ShoppingCart bean注入到单例StoreService bean的Setter方法中,如下所示:
package shopping;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
@Component
public class StoreService {
private ShoppingCart shoppingCart;
@Autowired
public void setShoppingCart(ShoppingCart shoppingCart) {
this.shoppingCart = shoppingCart;
}
}
因为StoreService是一个单例的bean,会在Spring应用上下文加载的时候创建。当它创建的时候,Spring会试图将ShoppingCart bean注入到setShoppingCart()
方法中。但是ShoppingCart bean是会话作用域的,此时并不存在。直到某个用户进入系统,创建了会话之后,才会出现ShoppingCart实例。
另外,系统中将会有多个ShoppingCart实例:每个用户一个。我们并不想让Spring注入某个固定的ShoppingCart实例到StoreService中。我们希望的是当StoreService处理购物车功能时,它所使用的ShoppingCart实例恰好是当前会话所对应的那一个。
Spring并不会将实际的ShoppingCart bean注入到StoreService中,Spring会注入一个到ShoppingCart bean的代理,如图3.1所示。这个代理会暴露与ShoppingCart相同的方法,所以StoreService会认为它就是一个购物车。但是,当StoreService调用ShoppingCart的方法时,代理会对其进行懒解析并将调用委托给会话作用域内真正的ShoppingCart bean。
现在,我们带着对这个作用域的理解,讨论一下proxyMode
属性。如配置所示,proxyMode
属性被设置成了ScopedProxyMode.INTERFACES
,这表明这个代理要实现ShoppingCart接口,并将调用委托给实现bean。如果ShoppingCart是接口而不是类的话,这是可以的(也是最为理想的代理模式)。但如果ShoppingCart是一个具体的类的话,Spring就没有办法创建基于接口的代理了。此时,它必须使用CGLib来生成基于类的代理。所以,如果bean类型是具体类的话,我们必须要将proxyMode
属性设置为ScopedProxyMode.TARGET_CLASS
,以此来表明要以生成目标类扩展的方式创建代理。
尽管我主要关注了会话作用域,但是请求作用域的bean会面临相同的装配问题。因此,请求作用域的bean应该也以作用域代理的方式进行注入。
3.4.2 在XML中声明作用域代理
<bean>
的scope
属性能够设置bean的作用域,而proxyMode
则需要使用aop
命名空间:
<bean id="cart" class="shopping.ShoppingCart" scope="session">
<aop:scoped-proxy />
</bean>
<aop:scoped-proxy>
是与@Scope
注解的proxyMode
属性功能相同的Spring XML配置元素。它会告诉Spring为bean创建一个作用域代理。默认情况下,它会使用CGLib创建目标类的代理。但是我们也可以将proxy-target-class
属性设置为false,进而要求它生成基于接口的代理:
<bean id="cart" class="shopping.ShoppingCart" scope="session">
<aop:scoped-proxy proxy-target-class="false" />
</bean>
3.5 运行时注入
当讨论依赖注入的时候,我们通常所讨论的是将一个bean引用注入到另一个bean的属性或构造器参数中。它通常来讲指的是将一个对象与另一个对象进行关联。
但是bean装配的另外一个方面指的是将一个值注入到bean的属性或者构造器参数中。我们在第2章中已经进行了很多值装配,如将专辑的名字装配到BlankDisc bean的构造器或title属性中。例如,我们可能按照这样的方式来组装BlankDisc:
@Bean
public CompactDisc compactDisc() {
return new BlankDisc(
"Sgt. Pepper's Lonely Hearts Club Band",
"The Beatles");
}
或者XML:
<bean id="compactDisc" class="soundsystem.BlankDisc"
c:_0="Sgt. Pepper's Lonely Hearts Club Band" c:_1="The Beatles" />
不过此时都是硬编码,有时候我们想让某些值在运行时再确定,Spring提供了两种方式:
- 属性占位符(Property placeolder)
- Spring 表达式(SpEL)
3.5.1 注入外部的值
在Spring中,处理外部值的最简单方式就是声明属性源并通过Spring的Environment来检索属性:
package soundsystem;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;
import org.springframework.core.env.Environment;
@Configuration
@PropertySource("classpath:/soundsystem/app.properties")
public class ExpressiveConfig {
@Autowired
Environment env;
@Bean
public BlankDisc disc() {
return new BlankDisc(
env.getProperty("disc.title"),
env.getProperty("disc.artist"));
}
}
然后在app.properties
中写入:
disc.title="Sgt. Pepper's Lonely Hearts Club Band"
disc.artist="The Beatles"
深入学习Spring的Environment
Environment中getProperty()
有四个重载的变种形式:
String getProperty(String key);
String getProperty(String key, String defaultValue);
T getProperty(String key, Class<T> type);
T getProperty(String key, Class<T> type, T defaultValue);
Environment还提供了几个与属性相关的方法,如果你在使用getProperty()
方法的时候没有指定默认值,并且这个属性没有定义的话,获取到的值是null
。如果你希望这个属性必须要定义,那么可以使用getRequiredProperty()
方法,如果属性不存在,将会抛出IllegalStateException
。
如果想检查一下某个属性是否存在的话,那么可以调用Environment的containsProperty()
方法。
如果想将属性解析为类的话,可以使用getPropertyAsClass()
方法。
除了属性相关的功能以外,Environment还提供了一些方法来检查哪些profile
处于激活状态:
String[] getActiveProfiles()
:返回激活profile
名称的数组String[] getDefaultProfiles()
:返回默认profile
名称的数组boolean acceptsProfiles(String... profiles)
:如果Environment支持给定profile
的话,就返回true
解析属性占位符
Spring一直支持将属性定义到外部的属性的文件中,并使用占位符值将其插入到Spring bean中。在Spring装配中,占位符的形式为使用${... }
包装的属性名称。作为样例,我们可以在XML中按照如下的方式解析BlankDisc构造器参数:
<bean id="compactDisc" class="soundsystem.BlankDisc"
c:_0="${disc.title}" c:_1="${disc.artist}" />
如果我们依赖于组件扫描和自动装配来创建和初始化应用组件的话,那么就没有指定占位符的配置文件或类了。在这种情况下,我们可以使用@Value
注解,它的使用方式与@Autowired
注解非常相似。比如,在BlankDisc类中,构造器可以改成如下所示:
public BlankDisc(@Value("${disc.title}") String title, @Value("${disc.artist}") String artist) {
this.title = title;
this.artist = artist;
}
为了使用占位符,我们必须要配置一个PropertyPlaceholderConfigurer bean或PropertySourcesPlaceholderConfigurer bean。从Spring 3.1开始,推荐使用PropertySourcesPlaceholderConfigurer,因为它能够基于Spring Environment及其属性源来解析占位符。
如下的@Bean
方法在Java中配置了PropertySourcesPlaceholderConfigurer:
@Bean
static PropertySourcesPlaceholderConfigurer placeholderConfigurer() {
return new PropertySourcesPlaceholderConfigurer();
}
如果你想使用XML配置的话,Spring context命名空间中的<context:propertyplaceholder>
元素将会为你生成PropertySourcesPlaceholderConfigurer bean:
<context:property-placeholder />
3.5.2 使用Spring表达式语言进行装配
SpEL拥有很多特性:
- 使用bean的ID来引用bean
- 调用方法和访问对象的属性
- 对值进行算术、关系和逻辑运算
- 正则表达式匹配
- 集合操作
Spring Security支持使用SpEL表达式定义安全限制规则。另外,如果你在Spring MVC应用中使用Thymeleaf模板作为视图的话,那么这些模板可以使用SpEL表达式引用模型数据。
SpEL样例
SpEL是一种非常灵活的表达式语言。SpEL表达式要放到#{ ... }
之中,这与属性占位符有些类似,属性占位符需要放到${ ... }
之中。
#{1}
除去#{...}
标记之后就是SpEL表达式体。
#{T(System).currentTimeMillis()}
它的最终结果是计算表达式的那一刻当前时间的毫秒数。T()
表达式会将java.lang.System
视为Java中对应的类型,因此可以调用其static
修饰的currentTimeMillis()
方法。
SpEL表达式也可以引用其他的bean或其他bean的属性。例如,如下的表达式会计算得到ID为sgtPeppers
的bean的artist
属性:
#{sgtPeppers.artist}
我们还可以通过systemProperties
对象引用系统属性:
#{systemProperties['disc.title']}
如果通过组件扫描创建bean的话,在注入属性和构造器参数时,我们可以使用@Value
注解,这与之前看到的属性占位符非常类似。不过,在这里我们所使用的不是占位符表达式,而是SpEL表达式。例如,下面的样例展现了BlankDisc,它会从系统属性中获取专辑名称和艺术家的名字:
public BlankDisc(@Value("#{systemProperties['disc.title']}") String title, @Value("#{systemProperties['disc.artist']}") String artist) {
this.title = title;
this.artist = artist;
}
中XML中:
<bean id="compactDisc" class="soundsystem.BlankDisc"
c:_0="#{systemProperties['disc.title']}" c:_1="#{systemProperties['disc.artist']}" />
表示字面量
#{3.14159}
#{9.87E4}
#{'hello'}
#{false}
引用bean、属性和方法
#{artistSelector.selectArtist().toUpperCase()}
为了避免出现NullPointerException
,我们可以使用:
#{artistSelector.selectArtist()?.toUpperCase()}
如果为null
,?.
运算符后面的方法调用将不会执行。表达式返回null
。
在表达式中使用类型
如果要在SpEL中访问类作用域的方法和常量的话,要依赖T()
这个关键的运算符。例如,为了在SpEL中表达Java的Math类,需要按照如下的方式使用T()
运算符:
#{T(java.lang.Math)}
T()
运算符结果为一个Class对象。
#{T(java.lang.Math).PI}
#{T(java.lang.Math).random()}
SpEL运算符
运算符类型 | 运算符 |
---|---|
算术运算符 | + - * / % ^ |
比较级运算符 | < > == <= >= lt gt eq le ge |
逻辑运算符 | and or not ¦ |
条件运算符 | ?: (ternary) ?: (Elvis) |
正则运算符 | matches |
例如:
#{2 * T(java.lang.Math).PI * circle.radius}
#{T(java.lang.Math).PI * circle.radius ^ 2}
#{disc.title + ' by ' + disc.artist}
#{counter.total == 100}
#{counter.total eq 100}
#{scoreboard.score > 1000 ? "Winner!" : "Loser"}
//如果disc.title是null,则结果为'Rattle and Hum'
#{disc.title ?: 'Rattle and Hun'}
计算正则表达式
#{admin.email matches '[a-zA-Z0-9.+_%+-]+@[a-zA-Z0-9.-]+\\.com'}
计算集合
#{jukebox.songs[4].title}
#{jukebox.songs[T(java.lang.Math).random() * jukebox.songs.size()].title}
#{'This is a test'[3]}
//获得artist为Aerosmith的所有歌曲
#{jukebox.songs.?[artist eq 'Aerosmith']}
//获得artist为Aerosmith的第一首歌曲
#{jukebox.songs.^[artist eq 'Aerosmith']}
//获得artist为Aerosmith的最后一首歌曲
#{jukebox.songs.$[artist eq 'Aerosmith']}
//获得所有歌曲的artist并打包为一个新的集合
#{jukebox.songs.![artist]}
//获得artist为Aerosmith的所有歌曲,并将他们的title打包为一个新的集合
#{jukebox.songs.?[artist eq 'Aerosmith'].![title]}