《Java工程师必读手册》——Java单元测试系列——Java单元测试技巧之JSON序列化(2)

简介: 《Java工程师必读手册》——Java单元测试系列——Java单元测试技巧之JSON序列化(2)

接上篇:https://developer.aliyun.com/article/1227490?spm=a2c6h.13148508.setting.26.48e04f0eaBVGWH


三、 测试用例及资源命名

 

俗话说:“没有规矩,不成方圆。”所以,为了更好地利用JSON序列化技巧,首先对测试用例和资源文件进行规范化命名。

 

1. 测试类命名

 

按照行业惯例,测试类的命名应以被测试类名开头并以Test结尾。比如UserService用户服务类的测试类需要命名为UserServiceTest用户服务测试类

 

单元测试类应该放在被测试类的同一工程的“src/test/java”目录下,并且要放在被测试类的同一包下。注意,单元测试类不允许写在业务代码目录下,否则在编译时没法过滤这些测试用例。

 

2. 测试方法命名

 

按照行业规范,测试方法命名应以test开头并以被测试方法结尾。比如:batchCreate批量创建的测试方法需要命名为testBatchCreate测试:批量创建,queryByCompanyId根据公司标识查询的测试方法需要命名为testQueryByCompanyId测试:根据公司标识查询

 

当一个方法对应多个测试用例时,就需要创建多个测试方法,原有测试方法命名已经不能满足需求了。有人建议在原有的测试方法命名的基础上,添加123等序号表示不同的用例。比如:testBatchCreate1测试:批量创建1、testBatchCreate2测试:批量创建2……但是,这种方法不能明确每个单元测试的用意。

 

这里,作者建议在原有的测试方法命名的基础上,添加“With+条件”来表达不同的测试用例方法。

 

1) 按照结果命名

 

testBatchCreateWithSuccess测试:批量创建-成功

testBatchCreateWithFailure测试:批量创建-失败

testBatchCreateWithException测试:批量创建-异常

 

2) 按照参数命名

 

testBatchCreateWithListNull测试:批量创建-列表为NULL

testBatchCreateWithListEmpty测试:批量创建-列表为空

testBatchCreateWithListNotEmpty测试:批量创建-列表不为空

 

3) 按照意图命名

 

testBatchCreateWithNormal测试:批量创建-正常

testBatchCreateWithGray测试:批量创建-灰度

testBatchCreateWithException测试:批量创建-异常

 

当然,还有形成其它的测试方法命名方式,也可以把不同的测试方法命名方式混用,只要能清楚地表达出这个测试用例的涵义即可。

 

3. 测试类资源目录命名

 

这里,作者建议的资源目录命名方式为——以test开头且以被测试类名结尾。比如:UserService用户服务类的测试资源目录可以命名为testUserService。

 

那么,这个资源目录应该放在哪儿了?作者提供了2个选择:

 

放在“src/test/java”目录下,跟测试类放在同一目录下——这是作者最喜欢的方式;

放在“src/test/resources”目录下,跟测试类放在同一目录下——建议IDEA用户采用这种方式。

 

4. 测试方法资源目录命名

 

在前面的小节中,我们针对测试方法进行了规范命名。这里,我们可以直接拿来使用——即用测试方法名称来命名测试目录。当然,这些测试方法资源目录应该放在测试类资源目录下。比如:测试类UserServiceTest用户服务测试类的测试方法testBatchCreateWithSuccess测试:批量创建-成功的测试资源目录就是testUserService/testBatchCreateWithSuccess。

 

另外,也可以采用“测试方法名称”+“测试条件名称”二级目录的命名方式。比如测试类UserServiceTest用户服务测试类的测试方法testBatchCreateWithSuccess测试:批量创建-成功的测试资源目录就是testUserService/testBatchCreate/success。

 

这里,作者首推的是第一种方式因为测试方法名称和资源目录名称能够保持一致。

 

5. 测试资源文件命名

 

在被测试代码中,所有参数、变量都已经有了命名。所以,建议优先使用这些参数和变量的名称,并加后缀“.json”标识文件格式。如果这些资源文件名称冲突,可以添加前缀以示区分比如userCreateList的资源文件名称为“userCreateList.json”。

 

另外,在测试用例代码中,把这些测试资源文件加载后,反序列化为对应的数据对象,这些数据对象的变量名称也应该跟资源文件名称保持一致。

 

image.png 

 

6. 测试资源文件存储

 

在测试资源目录和名称定义好之后,就需要存入测试资源文件了。存储方式总结如下:

 

如果是测试类下所有测试用例共用的资源文件,建议存储在测试类资源目录下,比如:testUserService;

如果是测试用例独有的资源文件,建议存储在测试方法资源目录下,比如:testUserService/testBatchCreateWithSuccess;

如果是某一被测方法所有的测试用例共用的资源文件,建议存储在不带任何修饰的测试方法资源目录下,比如:testUserService/testBatchCreate;

如果测试类资源目录下只有一个测试方法资源目录,可以去掉这个测试方法资源目录,把所有资源文件存储在测试类资源目录下。

 

注意

这里的资源文件不光是JSON资源文件,但也可以是其它类型的资源文件。

 

7. 文件名称过长

 

由于资源目录名称较长(大概超过50个字符),可能会导致git检出代码时出现以下错误:

 

image.png 

 

或者,在添加文件时出现以下错误:

 

image.png 

 

可以通过以下git设置参数解决:

 

image.png 

 

当然,测试用例名称和资源目录名称没必要太长,可以进行一些精简使其小于等于50个字符。

 

8. JSON资源文件格式

 

关于JSON资源文件是否格式化的建议:不要格式化JSON资源文件内容,否则会占用更多的代码行数,还会导致无法直接进行文本比较。


  接下篇:https://developer.aliyun.com/article/1227488?groupCode=java

相关文章
|
3天前
|
存储 安全 Java
🌟Java零基础-反序列化:从入门到精通
【10月更文挑战第21天】本文收录于「滚雪球学Java」专栏,专业攻坚指数级提升,希望能够助你一臂之力,帮你早日登顶实现财富自由🚀;同时,欢迎大家关注&&收藏&&订阅!持续更新中,up!up!up!!
21 5
|
4天前
|
存储 缓存 安全
🌟Java零基础:深入解析Java序列化机制
【10月更文挑战第20天】本文收录于「滚雪球学Java」专栏,专业攻坚指数级提升,希望能够助你一臂之力,帮你早日登顶实现财富自由🚀;同时,欢迎大家关注&&收藏&&订阅!持续更新中,up!up!up!!
14 3
|
7天前
|
存储 安全 Java
Java编程中的对象序列化与反序列化
【10月更文挑战第22天】在Java的世界里,对象序列化和反序列化是数据持久化和网络传输的关键技术。本文将带你了解如何在Java中实现对象的序列化与反序列化,并探讨其背后的原理。通过实际代码示例,我们将一步步展示如何将复杂数据结构转换为字节流,以及如何将这些字节流还原为Java对象。文章还将讨论在使用序列化时应注意的安全性问题,以确保你的应用程序既高效又安全。
|
20天前
|
存储 Java
Java编程中的对象序列化与反序列化
【10月更文挑战第9天】在Java的世界里,对象序列化是连接数据持久化与网络通信的桥梁。本文将深入探讨Java对象序列化的机制、实践方法及反序列化过程,通过代码示例揭示其背后的原理。从基础概念到高级应用,我们将一步步揭开序列化技术的神秘面纱,让读者能够掌握这一强大工具,以应对数据存储和传输的挑战。
|
26天前
|
存储 安全 Java
Java编程中的对象序列化与反序列化
【10月更文挑战第3天】在Java编程的世界里,对象序列化与反序列化是实现数据持久化和网络传输的关键技术。本文将深入探讨Java序列化的原理、应用场景以及如何通过代码示例实现对象的序列化与反序列化过程。从基础概念到实践操作,我们将一步步揭示这一技术的魅力所在。
|
26天前
|
消息中间件 存储 Java
大数据-58 Kafka 高级特性 消息发送02-自定义序列化器、自定义分区器 Java代码实现
大数据-58 Kafka 高级特性 消息发送02-自定义序列化器、自定义分区器 Java代码实现
32 3
|
26天前
|
分布式计算 资源调度 Hadoop
Hadoop-10-HDFS集群 Java实现MapReduce WordCount计算 Hadoop序列化 编写Mapper和Reducer和Driver 附带POM 详细代码 图文等内容
Hadoop-10-HDFS集群 Java实现MapReduce WordCount计算 Hadoop序列化 编写Mapper和Reducer和Driver 附带POM 详细代码 图文等内容
78 3
|
1月前
|
Java 数据库 对象存储
Java 序列化详解
本文详细解析了Java序列化的概念与应用。通过具体实例,深入探讨了其在对象存储和传输中的作用及实现方法,帮助读者理解如何有效利用这一特性来简化数据交换,并对其实现机制有了更深入的认识。
|
7天前
|
存储 缓存 NoSQL
一篇搞懂!Java对象序列化与反序列化的底层逻辑
本文介绍了Java中的序列化与反序列化,包括基本概念、应用场景、实现方式及注意事项。序列化是将对象转换为字节流,便于存储和传输;反序列化则是将字节流还原为对象。文中详细讲解了实现序列化的步骤,以及常见的反序列化失败原因和最佳实践。通过实例和代码示例,帮助读者更好地理解和应用这一重要技术。
7 0
|
2月前
|
JSON NoSQL Java
redis的java客户端的使用(Jedis、SpringDataRedis、SpringBoot整合redis、redisTemplate序列化及stringRedisTemplate序列化)
这篇文章介绍了在Java中使用Redis客户端的几种方法,包括Jedis、SpringDataRedis和SpringBoot整合Redis的操作。文章详细解释了Jedis的基本使用步骤,Jedis连接池的创建和使用,以及在SpringBoot项目中如何配置和使用RedisTemplate和StringRedisTemplate。此外,还探讨了RedisTemplate序列化的两种实践方案,包括默认的JDK序列化和自定义的JSON序列化,以及StringRedisTemplate的使用,它要求键和值都必须是String类型。
redis的java客户端的使用(Jedis、SpringDataRedis、SpringBoot整合redis、redisTemplate序列化及stringRedisTemplate序列化)