Spring依赖注入与mock

一般使用Spring,都会用到依赖注入(DI)。

@Service
public class SampleService {
    @Autowired
    private SampleDependency dependency;
    public String foo() {
        return dependency.getExternalValue("bar");
    }
}

如果测试中需要对Sping注入的对象进行注入,该怎么做呢?

选择一 修改实现

一种做法是把字段注入改为构造函数注入:

@Service
public class SampleService {
    private SampleDependency dependency;
    @Autowired
    public SampleService(SampleDependency dependency, PersonPoolProvider personPoolProvider) {
        this.dependency = dependency;
    }
}

或者属性注入:

private SampleDependency dependency;
@Autowired
public void setDependency(SampleDependency dependency) {
    this.dependency = dependency;
}

测试就可以写成

SampleDependency dependency = mock(SampleDependency.class);
SampleService service = new SampleService(dependency);

从道理来讲这样更加规范一些。不过事实上会产生更多的代码,在字段增删的时候、构造函数、getter也需要随之维护。

选择二 绕过限制

也可以用一些绕过访问级别的“黑魔法”,比如测试写成这样

SampleDependency dependency = mock(SampleDependency.class);
SampleService service = new SampleService();
ReflectionTestUtils.setField(service, "dependency", dependency);

总感觉不太优雅,而且万一字段改名也很可能漏改。

当然,也可以直接把字段改为package可见甚至public。不过总觉得对不起自己的代码洁癖。

选择三 使用Mockito InjectMocks

这里推荐使用mockito 的InjectMocks注解。测试可以写成

@Rule public MockitoRule rule = MockitoJUnit.rule();
@Mock SampleDependency dependency;
@InjectMocks SampleService sampleService;

对应于实现代码中的每个@Autowired字段,测试中可以用一个@Mock声明mock对象,并用@InjectMocks标示需要注入的对象。

这里的MockitoRule的作用是初始化mock对象和进行注入的。有三种方式做这件事。

  • 测试@RunWith(MockitoJUnitRunner.class)
  • 使用rule @Rule public MockitoRule rule = MockitoJUnit.rule();
  • 调用 MockitoAnnotations.initMocks(this),一般在setup方法中调用

InjectMocks可以和Sping的依赖注入结合使用。比如:

@RunWith(SpringRunner.class)
@DirtiesContext
@SpringBootTest
public class ServiceWithMockTest {
    @Rule public MockitoRule rule = MockitoJUnit.rule();
    @Mock DependencyA dependencyA;
    @Autowired @InjectMocks SampleService sampleService;

    @Test
    public void testDependency() {
        when(dependencyA.getExternalValue(anyString())).thenReturn("mock val: A");
        assertEquals("mock val: A", sampleService.foo());
    }
}

假定Service注入了2个依赖dependencyA, dependencyB。上面测试使用Spring注入了B,把A替换为mock对象。

需要注意的是,Spring test默认会重用bean。如果另有一个测试也使用注入的SampleService并在这个测试之后运行,那么拿到service中的dependencyA仍然是mock对象。一般这是不期望的。所以需要用@DirtiesContext修饰上面的测试避免这个问题。

选择四 Springboot MockBean

如果使用的是Springboot,测试可以用MockBean更简单的写出等价的测试。

@RunWith(SpringRunner.class)
@SpringBootTest
public class ServiceWithMockBeanTest {
    @MockBean SampleDependencyA dependencyA;
    @Autowired SampleService sampleService;

    @Test
    public void testDependency() {
        when(dependencyA.getExternalValue(anyString())).thenReturn("mock val: A");
        assertEquals("mock val: A", sampleService.foo());
    }
}
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,029评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,395评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,570评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,535评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,650评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,850评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,006评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,747评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,207评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,536评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,683评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,342评论 4 330
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,964评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,772评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,004评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,401评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,566评论 2 349

推荐阅读更多精彩内容