如何使用Powermock对静态方法进行mock

  在平常工作过程中,总会设计些工具类,里面通常使用静态方法来实现。那么如何来对这些静态方法进行mock,以及如何验证静态方法被调用?下面简单介绍下如何使用Powermock来实现针对静态方法的mock。

  首先我们设计一个静态类如下(Utility.java):

public class Utility {
    public static <T> boolean listIsNullOrEmpty(List<T> objectList) {
        return objectList == null || objectList.isEmpty();
    }

    public static <T> boolean listIsNotNullOrEmpty(List<T> objectList) {
        return objectList != null && !objectList.isEmpty();
    }
}

  被测试类如下(UtilityHelper.java):

public class UtilityHelper {
    public int sum(List<Integer> dataLst) {
        if (Utility.listIsNullOrEmpty(dataLst)) {
            return 0;
        }

        int total = 0;
        for (Integer data : dataLst) {
            total += data;
        }

        return total;
    }

    public int product(List<Integer> dataList) {
        int total = 1;
        if (Utility.listIsNotNullOrEmpty(dataList)) {
            for (Integer data : dataList) {
                total *=data;
            }
        }

        return total;
    }
}

  在被测试类中分别定义了两个方法,分别调用了Utility类里面的两个静态方法,下面我们通过对这两个方法进行测试,来介绍下使用Powermock对静态方法进行mock的各种用法。

  测试类如下(UtilityHelperTest.java):

@RunWith(PowerMockRunner.class)
@PrepareForTest({Utility.class})
public class UtilityHelperTest {
    private UtilityHelper utilityHelper;
    private List<Integer> dataList;
    @Before
    public void setUp() {
        PowerMockito.mockStatic(Utility.class);

        dataList = new ArrayList<Integer>();
        dataList.add(1);
        dataList.add(2);
        dataList.add(3);

        utilityHelper = new UtilityHelper();
    }

    @Test
    public void testSum_1() {
        PowerMockito.when(Utility.listIsNullOrEmpty(Mockito.anyList())).thenReturn(true);

        int sum = utilityHelper.sum(dataList);

        Assert.assertEquals(0, sum);

        PowerMockito.verifyStatic(Mockito.times(1));
        Utility.listIsNullOrEmpty(Mockito.anyList());
    }

    @Test
    public void testSum_2() {
        PowerMockito.when(Utility.listIsNullOrEmpty(Mockito.anyList())).thenReturn(false);

        int sum = utilityHelper.sum(dataList);

        Assert.assertEquals(6, sum);
    }

    @Test
    public void testProduct_1() {
        int product = utilityHelper.product(dataList);

        Assert.assertEquals(1, product);
    }

    @Test
    public void testProduct_2() {
        PowerMockito.spy(Utility.class);

        int product = utilityHelper.product(dataList);

        Assert.assertEquals(6, product);
    }

    @Test
    public void testProduct_3() {
        PowerMockito.when(Utility.listIsNotNullOrEmpty(Mockito.anyList())).thenCallRealMethod();

        int product = utilityHelper.product(dataList);

        Assert.assertEquals(6, product);
    }
}
  1. 如果想要对某个类的静态方法进行mock,则必须在PrepareForTest后面加上相应的类名, 比如此例的Utility.class。

  2. 在对该类的某个方法进行mock之前,还必须先对整个类进行mock:

PowerMockito.mockStatic(Utility.class);
  1. 在testSum_1方法中,我们对listIsNullOrEmpty进行了mock:
PowerMockito.when(Utility.listIsNullOrEmpty(Mockito.anyList())).thenReturn(true);

可以看到虽然入参非空,但是由于返回值返回了true,使得调用sum方法返回的值是0。
  另外,如果我们想要验证某静态方法是否被调用,或者被调用了几次,我们可以用如下方式验证:

PowerMockito.verifyStatic(Mockito.times(1));
Utility.listIsNullOrEmpty(Mockito.anyList());

  先使用verifyStatic方法表明要验证静态方法,可以带参数,也可以不带参数,其参数可以使用Mockito的times方法或never方法来表示其调用次数。下面紧跟着的一行则表示要验证的是哪个已经mock的静态方法。

  1. 在test_sum2方法中,由于我们mock的返回值为false,所以调用sum方法返回的是实际值。
  2. 在test_product1中,我们可以看到并没有对product中调用的listIsNotNullOrEmpty进行mock,那么为什么返回值是 1 呢?
      这个主要是因为我们在setup方法中对使用mockStatic方法对Utility.class进行了mock,那么此时该类中的所有方法实际上都已经被mock了,如果没有对某个方法进行具体mock返回值,则调用该方法时,会直接返回对应返回类型的默认值,并不会执行真正的方法。此例对于listIsNotNullOrEmpty方法来说,其返回类型为boolean型,其默认值为false,所以product方法返回 1

  那么如果我们想对已经mock的类的某个方法调用真实的方法,而不是调用mock方法,那么该如何处理呢?此处我们介绍两种实现:

  1. 在test_product2中,我们看到相对test_product1来说,多了一行:
PowerMockito.spy(Utility.class);

  加了上面一行后,虽然也没有对listIsNotNullOrEmpty进行mock,但此时返回值是真正的值,说明没有调用默认的mock方法。使用spy后,虽然已经对该类做了mockStatic处理,但此时该类中的所有方法仍然都会调用真实的方法,而不是默认的mock方法。这种用法主要适用于只想要对某个类的少量方法进行mock,其他方法仍然执行真正的方法,平常写时,可以紧跟在mockStatic方法后。

  1. 我们在看下test_product3中,该方法相对test_product1中,多了一行:
PowerMockito.when(Utility.listIsNotNullOrEmpty(Mockito.anyList())).thenCallRealMethod();

  此行的含义就是调用到mock类的该方法执行真正的方法,而不是mock方法。这种方式就是需要对每个要执行的方法都要进行相应的mock处理。
  上述两种方式,可以根据自己的需要进行选择使用哪一种。但是一定要记得,只要使用了mockStatic某类时,该类中的所有方法就已经都默认被mock了, 在调用该类的方法时,必须根据具体方法进行相应的处理。
  另外,重要的事说三遍: 如果要mock静态方法,必须要在PrepareForTest后面加上该方法所在的类

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

推荐阅读更多精彩内容