在 Spring 中使用 Mockito 模拟属性文件

Question

我正在尝试在我的控制器中为以下方法编写单元测试。

@Autowired
    private ApplicationContext context;

    private String getProperty() {
        try {
            Properties props = context.getBean("myProperties", Properties.class);
            String val = props.getProperty("myProperty");
......

Bean 在我的 applicationContext 中是这样声明的：

<util:properties id="myProperties" scope="prototype" location="file:${catalina.base}/webapps/myProperties.properties"/>

我怎样才能模拟这个，以便我可以测试 val 变量的不同值？

我想过创建一个测试属性文件并像这样模拟它：

context = Mockito.mock(ApplicationContext.class);
Mocikto.when(context.getBean("myProperties", Properties.class)).thenReturn(some test file)

但是我必须在某处将测试文件声明为 bean。

我想知道是否有更简单的方法可以做到这一点？

谢谢

Answer 1

如果你使用的是 spring-3，你可以这样做：

<context:property-placeholder location="myprops.properties" />

在你的代码中：

@Value("${myProperty}")
private String myProp;

public String getMyProp() {
    return myProp;
}

这导致 myprops.properties 可用于通过 ${...} 表达式进行变量替换，并且 @Value 注释允许属性的值注入。然后在您的单元测试中，您可以简单地设置不同的 myProp 值。

Answer 2

更简单的方法是使用org.springframework.beans.factory.config.PropertyPlaceholderConfigurer，而不是从 spring 应用程序上下文中显式拉取属性。 PropertyPlaceholderConfigurer 使用您指定的属性注入您的 bean。那么你根本不需要 Mockito，在测试中你将 Controller 中的属性值设置为你想要的任何值。

所以你应该在应用程序上下文 xml 中设置配置器：

<context:property-placeholder 
  location="file:${catalina.base}/webapps/myProperties.properties"/>

并为您的控制器添加一些配置（我希望有一种方法可以使用注释但不知道）：

 <bean id="whateverMyControllerIdIs" class="com.initech.foobar.MyControllerImpl">
   <property name="quux"><value>${myProperty}</value></property>
 </bean>

控制器有一个实例变量，你想用属性填充它，用一个setter，像这样：

String quux;

public void setQuux(String quux) {this.quux = quux;}

刚刚看到a blog post on Spring 3.1 enhancements，这是执行此操作的新的无 xml 方式：

    @Configuration
@PropertySource("classpath:/com/myco/app.properties")
public class AppConfig {
    @Autowired
    Environment env;

    @Bean
    public TestBean testBean() {
        TestBean testBean = new TestBean();
        testBean.setName(env.getProperty("testbean.name"));
        return testBean;
    }
}

Answer 3

所以我可以在无需加载 Spring 上下文的情况下进行测试，我使用 Config 类从代码中访问所有属性文件值。好处是：

1) Spring 不会加载到您的单元测试中

2) 如果该属性缺失并且是必需的，您可以强制异常

3) 您可以从 getter() 方法返回强类型属性值（即转换为日期）

4) 属性文件中预期的“键”值记录在单个 Java 类中（即 public static final PROP_XXX）

@Component
public class Config {

public static final String PROP_USER_NAME = "user.name";

private Properties applicationProperties;


/*** Functional methods ***/

/**
 * Helper method to ensure consistent Exception handling where requested property values are missing
 * from the properties files and they are "required" for the application to function correctly.
 *
 * @param key
 * @return The String value of the property requested
 */
private String readPropertyRequired(String key) {

    String value = readProperty(key);

    if(StringUtils.isBlank(value))  {
        throw new PropertyNotFoundException(key);
    }

    return value;
}

/**
 * Helper method to return String values from the properties files that have been loaded
 *
 * @param key
 * @return The String value of the property requested or NULL if empty
 */
private String readProperty(String key) {
    return applicationProperties.getProperty(key);
}


/*** Getters & Setters ***/

@Autowired
public void setApplicationProperties(Properties applicationProperties) {
    this.applicationProperties = applicationProperties;
}

public String getUserName() {
    return readPropertyRequired(PROP_USER_NAME);
}

}

然后您可以通过简单地注入标准 java.util.Properties 来对此类进行单元测试