如何使用Mock/Stub模拟对象来对FeignClient进行单元测试(UnitTest)

2018.01.15更新

后来在我司架构师的指点下,我改用了一种更优雅友好的方式来对FeignClient对象进行Mock。
首先我们需要一个jar包

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
    <scope>test</scope>
</dependency>

spring的这个jar包下自带Mock相关内容。只需要在Test类中使用@MockBean声明我们所要Mock的FeignClient对象即可。
如:

@MockBean
private IPromotionController feignPromotionMock

PS:当你需要进一步使用这个对象时,你需要自己写相应的断言。
以上。

--------------------------------------2018.01.15更新分割线------------------------------------------------

前言

在搜索引擎使用关键词mock+feignclient搜索,搜索结果中最相关的就是StackOverFlow上的《How to mock feign.Client.Default with Mockito》了。
本文将会基于此问答中,用户yuz的回答展开。

该回答提供了一种手动模拟对象的实现方式。至于这种方式属于mock还是stub,就见仁见智了。

本文由作者三汪首发于简书。

扩展阅读:

正文

yuz的回答内容如下:

As mentioned before, Mockito is not powerful enough. I solved this with a manual mock.
It's easier than it sounds:

MyService.Java

public class MyService{
    //My service stuff      

    private MyFeignClient myFeignClient;

    @Inject //this will work only with constructor injection
    public MyService(MyFeignClient myFeignClient){
        this.MyFeignClient = myFeignClient
    }


    public void myMethod(){
        myFeignClient.remoteMethod(); // We want to mock this method
    }
}

MyFeignClient.Java

@FeignClient("target-service")
public interface MyFeignClient{

    @RequestMapping(value = "/test" method = RequestMethod.GET)
    public void remotemethod();
}

If you want to test the code above while mocking the feignclient, do this:

MyFeignClientMock.java

@Component
public class MyFeignClientMock implements MyFeignClient {

    public void remoteMethod(){
         System.out.println("Mocked remoteMethod() succesfuly");
    }
}

MyServiceTest.java

@RunWith(SpringJUnit4ClassRunner.class)
public class MyServiceTest {

    private MyService myService;

    @Inject
    private MyFeignClientMock myFeignClientMock;

    @Before
    public void setUp(){
       this.myService = new MyService(myFeignClientMock); //inject the mock
    }

    //Do tests normally here...
}

补充和说明

上面的答案可以很好地实现对FeignClient的mock,但我们需要作进一步的补充,如下。具体的修改原因随后附上。

MyService.Java

@Service
public class MyService{
    //My service stuff      
    @Autowired
    private MyFeignClient myFeignClient;
    @Autowired
    private MyRepository myRepository;

    @Autowired
    public MyService(MyFeignClient myFeignClient,MyRepository myRepository){
        this.myFeignClient = myFeignClient;
        this.myRepository = myRepository;
    }


    public void myMethod(){
        myFeignClient.remoteMethod(); // We want to mock this method
        myRepository.findAll();
    }
}

MyFeignClient.Java

@FeignClient("target-service")
public interface MyFeignClient{

    @RequestMapping(value = "/test" method = RequestMethod.GET)
    public void remotemethod();
}

MyFeignClientMock.java

@Component
public class MyFeignClientMock implements MyFeignClient {

    public void remoteMethod(){
         System.out.println("Mocked remoteMethod() succesfuly");
    }
}

MyServiceTest.java

@RunWith(SpringJUnit4ClassRunner.class)
public class MyServiceTest {

    private MyService myService;

    @Autowired
    private MyFeignClientMock myFeignClientMock;
    @Autowired
    private MyRepository myRepository;

    @Before
    public void setUp(){
       this.myService = new MyService(myFeignClientMock,myRepository); //inject the mock
    }

    @Test
    public void Test(){
        myService.myMethod();
    }

    //Do  other tests normally here...
}

说明:

  • @Inject是jsr330中的东西。由于Spring支持这个规范,也可以使用@Inject来实现注入。但是通常在Spring中习惯使用@Autowired来实现注入,能用一个东西解决就用一个东西解决,我们没有必要让代码更复杂。因此建议使用@Autowired来替代原文中的@Inject。
    扩展阅读:《@Inject和@Autowired以及@Resource区别》

  • MyService.java中原文可能漏掉了@Service注解,在此做了补充。

  • 【重要】:通过构造函数new出来的service对象,没有在构造函数中初始化的其他注入会为空。
    在此我特地在MyService.java中注入了MyRepository并修改了相应构造函数进行示例。
    如果构造函数中像原文一样只传入MyFeignClient的实现,那么由于MyRepository没有被初始化,在调用myMethod()时会出现NullPointerException。
    同时,这也提现了这种实现方式的一个弊端:对注入对象多的Service不友好。望周知。


以上。
希望我的文章对你能有所帮助。
我不能保证文中所有说法的百分百正确,但我能保证它们都是我的理解和感悟以及拒绝复制黏贴。
有什么意见、见解或疑惑,欢迎留言讨论。

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

推荐阅读更多精彩内容