单元测试：如何编写可测试的代码？

最新推荐文章于 2023-11-21 22:06:06 发布
最新推荐文章于 2023-11-21 22:06:06 发布
阅读量1.1k 收藏
点赞数
分类专栏： java 文章标签： 单元测试 junit java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/zhaoronghui1314/article/details/127340118
版权

在编写代码的时候，大部分时间想的都是如何实现功能，很少会考虑到代码的可测试性。

又因为大部分公司没有要求写单元测试，完成的功能都是通过服务模拟的方式测试，更加不会考虑代码的可测试性了。

常见的可测试性不好的代码，几种情况（取自极客时间王铮设计模式之美）

  • 未决行为，例如时间、随机数等
  • 全局变量，要考虑用例的执行顺序，或者有些mock框架是并发执行的
  • 静态方法，比如耗时长，依赖外部资源、逻辑复杂、行为未决时，需要进行模拟
  • 复杂继承
  • 高度耦合

单元测试编写过程中，经常会遇到下面几类问题。实际上是由于编写的代码可测试性差导致的。

1、单元测试时，维护一个第三方的服务，而且需要按照需要返回各种结果（成功的、失败、异常），成本是比较高的。如果第三方程序不是自己维护的，想要做到，更是不可能的。

      解决方案：新增一个serviceEx类，继承正常运行时调用的service类，然后在serviceEx中重写方法，模拟自己想要的结果，供单元测试用例使用。而运行的程序仍旧使用service类。

2、第三方的类，比如RedisDistributeLock这种类似工具类的锁，要想确定其返回锁成功或者失败，也是很难做到的。

3、一些未决定行为，比如随机数、当前时间System.currentTimeMillis()，因其不确定性，在运行单元测试时，会导致结果不可控

原则：就是把不确定、调用不通的内容进行封装然后通过继承、重写等方式，把封装的内容进行替换，直接返回自己需要的内容。

下面是示例代码，解决以上三类问题，仅供参考

想运行示例可直接下载代码，免费https://download.csdn.net/download/zhaoronghui1314/86765041

不可测试代码示例

package com.zrh.jsd.temp;

import javax.transaction.InvalidTransactionException;
import java.util.UUID;

public class Transaction {
    private String id;
    private Long buyerId;
    private Long createTimestamp;
    private int status;
    private String walletTransactionId;

    public Transaction(String preAssignedId, Long buyerId) {
        if (preAssignedId != null && !preAssignedId.isEmpty()) {
            this.id = preAssignedId;
        } else {
            this.id = UUID.randomUUID().toString();
        }
        if (!this.id.startsWith("t_")) {
            this.id = "t_" + preAssignedId;
        }
        this.buyerId = buyerId;
        this.status = STATUS.TO_BE_EXECUTD;
        this.createTimestamp = System.currentTimeMillis();
    }

    public boolean execute() throws InvalidTransactionException {
        if (buyerId == null) {
            throw new InvalidTransactionException();
        }
        if (status == STATUS.EXECUTED) {
            return true;
        }
        boolean isLocked = false;
        try {
            // 修改点1：可以理解为第三方类，运行单元测试时，需要的lock状态不方便得到
            // 仅做示例，此代码不可运行。按下方修改后可运行。
            isLocked = RedisDistributedLock.getSingletonIntance().lockTransction(id);
            if (!isLocked) {
                return false;
            }
            if (status == STATUS.EXECUTED) {
                return true;
            } ;
            // 修改点2：当前时间未决定的，运行单元测试时，此处不可控。
            long executionInvokedTimestamp = System.currentTimeMillis();
            if (executionInvokedTimestamp - createTimestamp > 14) {
                this.status = STATUS.EXPIRED;
                return false;
            }
            // 修改点3：WalletRpcService是第三方服务，运行单元测试时不一定可以正常调用
            WalletRpcService walletRpcService = new WalletRpcService();
            String walletTransactionId = walletRpcService.moveMoney();
            if (walletTransactionId != null) {
                this.walletTransactionId = walletTransactionId;
                this.status = STATUS.EXECUTED;
                return true;
            } else {
                this.status = STATUS.FAILED;
                return false;
            }
        } finally {
            if (isLocked) {
                // 仅做示例，此代码不可运行。按下方修改后可运行。
                RedisDistributedLock.getSingletonIntance().unlockTransction(id);
            }
        }
    }
}
package com.zrh.jsd.temp;

public class WalletRpcService {
    public String moveMoney() {
        System.out.println("这里是WalletRpcService第三方服务");
        return "asb";
    }
}

package com.zrh.jsd.temp;

public class STATUS {
    static final int TO_BE_EXECUTD = 0;

    static final int EXECUTED = 1;

    static final int EXPIRED = 2;

    static final int FAILED = 3;

}

优化之后可测试的代码，包含单元测试用例

package org.example;

import javax.transaction.InvalidTransactionException;
import java.util.UUID;

public class Transaction {
    private String id;
    private Long buyerId;
    private Long createTimestamp;
    private int status;
    private String walletTransactionId;

    // 添加一个成员变量及其 set 方法。就可以将对象放到外面
    private WalletRpcService walletRpcService;

    private TransactionLock lock;
    // 修改点2,提出方法，在test类中重写此方法。
    protected boolean isExpired() {
        long executionInvokedTimestamp = System.currentTimeMillis();
        System.out.println("=======方法内部的isExpired==");
        return executionInvokedTimestamp - createTimestamp > 14;
    }

    public void setTransactionLock(TransactionLock lock) {
        this.lock = lock;
    }
    // 修改点3：WalletRpcService改为注入的方式，通过构造传入，避免在类中new
    public Transaction(String preAssignedId, Long buyerId, WalletRpcService walletRpcService) {
        if (preAssignedId != null && !preAssignedId.isEmpty()) {
            this.id = preAssignedId;
        } else {
            this.id = UUID.randomUUID().toString();
        }
        if (!this.id.startsWith("t_")) {
            this.id = "t_" + preAssignedId;
        }
        this.buyerId = buyerId;
        this.status = STATUS.TO_BE_EXECUTD;
        this.createTimestamp = System.currentTimeMillis();
        this.walletRpcService = walletRpcService;
    }

    public boolean execute() throws InvalidTransactionException {
        if (buyerId == null) {
            throw new InvalidTransactionException();
        }
        if (status == STATUS.EXECUTED) {
            return true;
        }
        boolean isLocked = false;
        try {
            isLocked = lock.lock(id);
            if (!isLocked) {
                return false; // 锁定未成功，返回 false，job 兜底执行
            }
            if (status == STATUS.EXECUTED) {
                return true;
            }
            // createTimestamp 临时
            if (isExpired()) {
                this.status = STATUS.EXPIRED;
                return false;
            }

            String walletTransactionId = walletRpcService.moveMoney();
            if (walletTransactionId != null) {
                this.walletTransactionId = walletTransactionId;
                this.status = STATUS.EXECUTED;
                return true;
            } else {
                this.status = STATUS.FAILED;
                return false;
            }
        } finally {
            if (isLocked) {
                lock.unlock(id);
            }
        }
    }
}

package org.example;

public class MockWalletRpcServiceOne extends WalletRpcService {
    @Override
    public String moveMoney() {
        System.out.println("这里是WalletRpcService模拟服务");
        return "asb";
    }
}

package org.example;

public class RedisDistributedLock {
    public static RedisDistributedLock getSingletonIntance() {
        return new RedisDistributedLock();
    }

    boolean lockTransction(String id) {
        return true;
    }

    boolean unlockTransction(String id) {
        return true;
    }
}
package org.example;

public class STATUS {
    static final int TO_BE_EXECUTD = 0;

    static final int EXECUTED = 1;

    static final int EXPIRED = 2;

    static final int FAILED = 3;

}

package org.example;

public class TransactionLock {
    public boolean lock(String id) {
        return RedisDistributedLock.getSingletonIntance().lockTransction(id);
    }

    public boolean unlock(String id) {
        return RedisDistributedLock.getSingletonIntance().unlockTransction(id);
    }
}
package org.example;

public class WalletRpcService {
    public String moveMoney() {
        System.out.println("这里是WalletRpcService第三方服务");
        return "asb";
    }
}

单元测试用例

package org.example;

import org.junit.jupiter.api.Test;

import javax.transaction.InvalidTransactionException;

import static org.junit.jupiter.api.Assertions.assertTrue;

public class TransactionTest {
    @Test
    public void testExecute() throws InvalidTransactionException {
        Long buyerId = 123L;
        // 修改点3：出入service,重写service中的方法，直接返回模拟结果，不依赖第三方服务
        WalletRpcService walletRpcService = new MockWalletRpcServiceOne();
        // 修改点2：模拟lock，重写方法，模拟返回的结果
        TransactionLock mockLock = new TransactionLock() {
            public boolean lock(String id) {
                System.out.println("这里是模拟的lock");
                return true;
            }

            public boolean unlock(String id) {
                System.out.println("这里是模拟的unlock");
                return true;
            }
        };
        // walletRpcService 可以通过构造方法注入或者通过set方法注入
        Transaction transaction = new Transaction(null, buyerId, walletRpcService) {
            // 这里必须是protect以上的级别。private不可
            // 修改点1：重写isExpired，返回期望的内容
            protected boolean isExpired() {
                System.out.println("这里是外部的isExpired方法");
                return false;
            }
        };
        transaction.setTransactionLock(mockLock);
        boolean executedResult = transaction.execute();
        assertTrue(executedResult);
    }
}

zhaoronghui1314
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
专栏目录
编写可测试的Javascript代码
01-30
1.内联Javascript–嵌入在HTML文件中的Javascript代码是无法包含在外部单元测试工具中的。2.无法复用的代码–即使Javascript代码单独放在外面，也没有提供公共的接口供其他人调用。3.没有构造函数/原型对象–个人的单元测试就意味着独立的操作。测试一个单例是很困难的，因为一个测试的结果可能会影响到其他测试的结果。4.金字塔厄运–深层的嵌套在Javascript开发中非常多见，但是他们是让人各种担忧的抓狂的东西。深层嵌套在内部的代码逻辑是很难进行单独测试的，并且随着时间的推移，会有变得像意大利面条式的难以维护的倾向。5.拙劣的DOM事件处理程序–事件处
如何编写测试代码
wangwencong的专栏
11-12 1万+
本文通过介绍简单测试代码的编写来进一步阐述单元测试的基本原理和方法，在实际工作中，测试代码可以由工具生成。 下面用最容易理解和测试的加法函数来介绍测试代码的编写，函数代码如下： int add(int a,int b) { return a + b; } 测试代码如下： void test_add() { //设定输入 int a = 1; int b = 1; //执
单元测试——测试代码功能及代码覆盖率
qq_68619457的博客
01-10 2309
单元测试，代码覆盖率，代码功能测试，具体代码示例
测试代码（测试函数、测试类）
stadfast的博客
11-24 1859
如何使用模块unittest中的工具来为函数和类编写测试；如何编写继承nittest.TestCase的类，以及如何编写测试方法，以核实函数和类的行为符合预期；如何使用方法setUp()来根据类高效地创建实例并设置其属性，以便在类的所有测试方法中都可使用它们。
如何代码进行单元测试？
后端开发
01-28 1万+
1.我们在验证自己代码的运行是否与预期运行结果一致时，往往在main函数里面调用自己写的方法运行，这是比较常用的一种方法。 2.如果我们不使用main方法进行测试呢？以数据库连接为例，写一个测试类，包含一个主函数这是常用的方法 package com.zhouquan.jdbc.util; import java.sql.Connection; import java.sql.PreparedSt...
Python 单元测试
hj1993的博客
02-25 2817
编写函数或类时，可以为其编写测试单元，通过测试，可以确定代码面对各种输入都能按照要求那样工作，在添加新代码时也可以对其进行测试，确保不会破坏既有程序。
如何编写单元测试
DaFengWangNanGua的博客
05-29 3628
如何编写单元测试 燕双龙 一 单元测试简介 单元测试是代码正确性验证的最重要的工具，也是系统测试当中最重要的环节。也是唯一需要编写代码才能进行测试的一种测试方法。在标准的开发过程中，单元测试的代码与实际程序的代码具有同等的重要性。每一个单元测试，都是用来定向测试其所对应的一个单元的数据是否正确。 单元测试是由程序员自己来完成，最终受益的也是程序员自己。可以这么说，程序员有责任编写功能代码，同时也就有责任为自己的代码编写单元测试。执行单元测试，就是为了证明这段代码的行为和我们期望的一致。 单元测试还具
编写可测试的JavaScript代码
02-01
无论我们使用和Node配合在一起的测试框架，例如Mocha或者Jasmine，还是在像PhantomJS这样的无头浏览器中运行依赖于DOM的测试，和以前相比，我们有更好的方式来对JavaScript进行单元测试。然而，这并不意味着我们要...
什么是单元测试:单元测试基础
03-23
什么是单元测试如果你对单元测试已经有概念了，就请跳过本章。简单地说，单元测试是用代码测试代码... 　使用这些工具编写测试代码后，你就可以非常方便地进行自动、重复的单元测试。通过编写单元测试代码，你可以保证
Python编写单元测试代码实例
09-16
主要介绍了Python编写单元测试代码实例,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
写好单元测试的8个小技巧，一文1800字总结
测试界的彭于晏的博客
06-07 601
想必金字塔测试原理大家已经很熟悉了，近年来的测试驱动开放在各个公司开始盛行，测试代码先写的倡议被反复提及。鉴于此，许多中大型软件公司对单元测试的要求也逐渐提高。那么，编写单元测试有哪些小技巧可以借鉴和学习的呢？01、测试代码文件路径与开发代码文件路径“相同”这里的“相同”并不是完全意义的一摸一样，测试代码和开发代码处于同一目录，而是指的测试代码文件路径你与开发代码文件路径“大体相同”。如下图1、2所示，开发代码路径和测试代码路径都包括/java/ru/yandex/clickhouse/。图1 开发代码路径
如何正确编写单元测试？
Error的博客
11-24 6765
国内的大多数互联网公司只注重软件功能，却往往忽略了极为重要的软件质量，在一个月以前，我认为遵循了代码规范（阿里规约、sonar）的软件系统已经算是一个质量比较好的软件系统了，但是在我了解单元测试以后，才发现自己以前的想法有多么愚蠢，单元测试的作用远比我想象的要重要许多。经过一段时间的研究，总算对单元测试有了一个大概的了解，然而网上的文章零零散散，大多是讲解一些比较简单的demo，参考价值比较有限，因此我决定写一篇关于单元测试的文章来总结自己这段时间的收获与心得。
该怎么写单元测试呢
热门推荐
LoveSummer
07-26 2万+
然后掌握mock的技巧，写新方法的时候，尝试设计完接口后，先写下单测，慢慢的你就会有感觉了，在写单测时，你自然而然的会考虑到诸多边界值的处理，你写的代码质量也会提高，渐渐地就会感受到单测的好处。还有一点也很重要，其实我们写单测的时候，不应该过多的关注内部的逻辑，举个非常简单的加法例子，我们单测只关心add(1,1)的结果是2，我管你里面是的实现到底是位运算还是啥运算？好吧，这里需要强调一下，逻辑简单的类，其实没必要写单测，一般只是领导要求纯粹的追求覆盖率的时候，才会把这种简单的类补上去。...
自动化测试代码怎么写
weixin_35753291的博客
01-03 478
自动化测试代码的编写取决于你使用的测试框架和编程语言。具体来说，你可以使用一些流行的自动化测试框架，例如 JUnit 或 TestNG 在 Java 中，unittest 或 nose 在 Python 中等等。 在编写自动化测试代码时，你需要考虑以下几个方面： 导入所需的测试框架和库 编写测试用例，测试用例是你希望测试的功能的独立函数。 编写测试函数，它用于设置测试环境，执行测试用例并验证测试...
Java之----如何进行单元测试来测试代码
aaa123_456aaa的博客
12-04 1941
我们可以看一个例子： 1)创建一个工程，叫SuiteUnitTesting，在这个工程中创建4个类，如下图所示： 代码清单如下： public abstract class Shape { public abstract double perimeter();//计算周长，抽象方法 public abstract double area();//计算面积，抽象方法 } public class Rectangle extends Shape { int a;//边长 int
单元测试代码编写
10-21 8184
单元测试是在软件开发过程中要进行的最低级别的测试活动，在单元测试活动中，软件的独立单元将在与程序的其他部分相隔离的情况下进行测试。 单元测试不仅仅是作为无错编码一种辅助手段在一次性的开发过程中使用，单元测试必须是可重复的，无论是在软件修改，或是移植到新的运行环境的过程中。因此，所有的测试都必须在整个软件系统的生命周期中进行维护。       多数讲述单元测试的文章都是以Java为例，本文以C++
python-测试代码
qq_61706112的博客
01-23 1713
python—测试代码
互联网业务中单元测试
gd2413cn的博客
11-21 19
今天总结一篇互联网业务实践单元测试杂文，内容为网络学习所得
Java单元测试实战（二）编写流程
qq_36188127的博客
04-20 1371
Mockito 是一个单元测试模拟框架，可以让你写出优雅、简洁的单元测试代码。Mockito 采用了模拟技术，模拟了一些在应用中依赖的复杂对象，从而把测试对象和依赖对象隔离开来。直接构建对象，简单直接利用Mockito.spy 方法Mockito 提供一个spy 功能，用于拦截那些尚未实现或不期望被真实调用的方法，默认所有方法都是真实方法，除非主动去模拟对应方法。所以，利用spy 功能来定义被测对象，适合于需要模拟被测类自身方法的情况，适用于普通类、接口和虚基类。
单元测试由谁来编写？
最新发布
02-19
单元测试通常由开发人员来编写。开发人员在编写代码的同时，会编写相应的单元测试来验证代码的正确性。这样可以确保代码在开发过程中就能够被及早地测试和调试，减少后期出现的问题。编写单元测试的开发人员需要了解代码的逻辑和功能，并根据需求编写相应的测试用例来覆盖各种情况。通过运行单元测试，开发人员可以快速发现和修复代码中的问题，提高代码的质量和稳定性。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值