Spring Boot项目Service类单元测试自动生成

在Spring Boot项目中，对Service类进行单元测试对于开发工程师而言具有重大意义和作用：

  • 验证业务逻辑的正确性和完整性
    • 核心业务逻辑的准确实现：Service类通常包含核心业务逻辑。单元测试确保这些逻辑被正确实现，满足业务需求。
    • 处理各种情况：单元测试可以覆盖各种可能的使用情况，包括正常情况和异常情况，确保服务在各种条件下都能正确执行。
      促进代码质量和可维护性
    • 代码质量：通过单元测试，可以持续监控代码质量，及时发现和修复bug。
      重构和代码改进：单元测试为重构和改进代码提供了安全网，帮助开发者在修改代码时保持自信。
  • 加速开发和反馈周期
    • 快速反馈：单元测试提供即时反馈，帮助开发者快速识别和解决问题。
      减少调试时间：当出现问题时，良好的单元测试可以减少用于查找和修复bug的时间。
      降低后期维护成本
    • 易于维护的代码库：有良好单元测试支持的代码库通常更易于维护和扩展。
      文档的作用：单元测试代码本身可以作为某种形式的文档，说明如何使用代码以及代码的预期行为。
  • 促进良好的设计实践
    • 鼓励良好的设计：为了便于测试，代码往往会被设计得更加模块化和清晰。
    • 依赖注入：Spring Boot鼓励使用依赖注入，这在编写可测试代码时非常有用。
  • 支持敏捷和持续集成
    • 敏捷开发：单元测试支持敏捷开发实践，如测试驱动开发（TDD）。
    • 持续集成：自动化的单元测试是持续集成（CI）的核心部分，确保代码变更不会破坏现有功能。
  • 其他功能
    • 安全性测试：在编写服务层单元测试时，还可以考虑安全性方面的测试，如权限验证、输入验证等。
    • 性能测试：虽然通常不在单元测试的范畴内，但开发者可以通过某些单元测试初步评估代码的性能。
    • 集成测试：除了单元测试，还应考虑编写集成测试，以验证服务层组件与数据库、其他服务或API的集成情况。
    • 行为驱动开发（BDD）：结合行为驱动开发（Behavior-Driven Development）的实践，单元测试可以更贴近业务，提高业务人员和技术人员之间的沟通效率。

单元测试在Spring Boot项目中扮演着至关重要的角色，对于确保代码质量、加速开发过程、降低维护成本以及推动良好的开发实践具有显著影响。

背景

由于所在公司的代码环境切换至内部网络，现有的插件用于生成单元测试变得不再适用。为了解决这一挑战，提高工作效率，我开发了一个单元测试生成Java工具类，专门用于自动生成服务类的单元测试代码。
代码框架：

依赖版本
Spring Boot2.7.12
JUnit5.8.2

目标

我们的主要目标是创建一个尽可能完善的Spring Boot单元测试方法生成器，以减少重复工作并提高工作效率。

实现效果

我们的工具类具备以下特点：

  • 为每个服务方法自动生成对应的请求和响应类。
  • 全面支持原始类型、类类型参数以及枚举类型参数的请求和响应。
  • 当方法参数是类类型时，使用空构造函数进行实例化。
  • 对于常见的基础类型、包装类型和枚举类型，自动设置默认值。
  • 自动打印每个方法的响应结果，以便于调试和验证。

这个工具类的开发旨在提升测试代码的编写效率，同时保持测试覆盖率的完整性，从而避免在单元测试编写方面重复“造轮子”。

代码实现


import java.io.*;
import java.lang.reflect.Method;
import java.lang.reflect.Modifier;
import java.math.BigDecimal;
import java.util.*;public class TestClassAutoGenerator {// JAVA保留字private static final List<String> keywords = Arrays.asList("abstract", "assert", "boolean", "break", "byte", "case", "catch", "char", "class", "const","continue", "default", "do", "double", "else", "enum", "extends", "final", "finally", "float","for", "goto", "if", "implements", "import", "instanceof", "int", "interface", "long", "native","new", "package", "private", "protected", "public", "return", "short", "static", "strictfp", "super","switch", "synchronized", "this", "throw", "throws", "transient", "try", "void", "volatile", "while");private static final String javatest = "/src/test/java/";// 创建目录public static void createDirectoryIfNeeded(String filePath) {File file = new File(filePath);File directory = file.getParentFile();if (directory != null && !directory.exists()) {// 如果目录不存在，则创建它boolean isCreated = directory.mkdirs();if (isCreated) {System.out.println("目录已创建: " + directory.getAbsolutePath());} else {System.out.println("目录创建失败: " + directory.getAbsolutePath());}} else {assert directory != null;System.out.println("目录已存在: " + directory.getAbsolutePath());}}// 主体方法：按service类在指定项目下自动生成service类 public void generateTestForClass(String outputPath, Class<?> serviceClass) {String packagePath = serviceClass.getPackage().getName().replace(".","/");// 生成路径outputPath = outputPath+javatest+packagePath;String className = serviceClass.getSimpleName();String testClassName = className + "Test";// 测试类的代码内容String content = generateTestClassContent(serviceClass, testClassName);createDirectoryIfNeeded(outputPath + "/" + testClassName + ".java");try (BufferedWriter writer = new BufferedWriter(new FileWriter(outputPath + "/" + testClassName + ".java"))) {writer.write(content);} catch (IOException e) {e.printStackTrace();}}// 测试类的代码生成private String generateTestClassContent(Class<?> serviceClass, String testClassName) {StringBuilder classContent = new StringBuilder();classContent.append("package ").append(serviceClass.getPackage().getName()).append(";\n\n");// 导入请求响应包Set<String> imports = new HashSet<>();for (Method method : serviceClass.getDeclaredMethods()) {Class<?>[] paramTypes = method.getParameterTypes();for (Class<?> paramType : paramTypes) {if (paramType.getPackage() != null && !imports.contains(paramType.getPackage().getName() + "." + paramType.getSimpleName())) {classContent.append("import ").append(paramType.getPackage().getName()).append(".").append(paramType.getSimpleName()).append(";\n");imports.add(paramType.getPackage().getName() + "." + paramType.getSimpleName());}}Class<?> returnType = method.getReturnType();if (returnType.getPackage() !=null && !imports.contains(returnType.getPackage().getName()+"."+returnType.getSimpleName())) {classContent.append("import ").append(returnType.getPackage().getName()).append(".").append(returnType.getSimpleName()).append(";\n");}}// 导入SpringBoot项目运行测试所需的包classContent.append("import lombok.extern.slf4j.Slf4j;\n").append("import ").append(serviceClass.getPackage().getName()).append(".").append(serviceClass.getSimpleName()).append(";\n").append("import org.junit.jupiter.api.Test;\n").append("import org.springframework.boot.test.context.SpringBootTest;\n").append("import com.alibaba.fastjson.JSON;\n").append("import org.springframework.beans.factory.annotation.Autowired;\n\n").append("@Slf4j\n").append("@SpringBootTest\n").append("public class ").append(testClassName).append(" {\n\n").append("    @Autowired\n").append("    private ").append(serviceClass.getSimpleName()).append(" ").append(toCamelCase(serviceClass.getSimpleName())).append(";\n\n");// 遍历生成单元测试for (Method method : serviceClass.getDeclaredMethods()) {if (Modifier.isPublic(method.getModifiers())) {classContent.append("    @Test\n").append("    public void test").append(capitalizeFirstLetter(method.getName())).append("() throws Exception {\n").append(generateMethodTestLogic(method,serviceClass)).append("    }\n\n");}}classContent.append("}\n");return classContent.toString();}// 生成单元测试代码private String generateMethodTestLogic(Method method,Class<?> serviceClass) {StringBuilder testLogic = new StringBuilder();testLogic.append("        // Test logic for ").append(method.getName()).append("\n");Class<?>[] paramTypes = method.getParameterTypes();Class<?> returnType = method.getReturnType();List<String> params = new ArrayList<>();Hashtable<String, Integer> paramCount = new Hashtable<>();for (Class<?> paramType : paramTypes) {String param = getParamName(paramType, paramCount);testLogic.append("        ").append(paramType.getSimpleName()).append(" ").append(param).append("=");testLogic.append(getDefaultValueForType(paramType));testLogic.append(";\n");params.add(param);if (getDefaultValueForType(paramType).startsWith("new")) {testLogic.append("        //TODO set params for ").append(toCamelCase(paramType.getSimpleName())).append("\n\n");}}testLogic.append("        ");if (returnType.getPackage()!=null) {testLogic.append(returnType.getSimpleName()).append(" response = ");}testLogic.append(toCamelCase(serviceClass.getSimpleName())).append(".").append(method.getName()).append("(");for (int i = 0; i < paramTypes.length; i++) {testLogic.append(params.get(i));if (i < paramTypes.length - 1) {testLogic.append(", ");}}testLogic.append(");\n");if (returnType.getPackage()!=null) {testLogic.append("        log.info(\"Response: \" + JSON.toJSONString(response));\n");}return testLogic.toString();}private String getParamName(Class<?> paramType,Hashtable<String, Integer> paramCount) {String name = paramType.getSimpleName();String init = "arg";if (paramType.isPrimitive() ) {if (paramType.equals(boolean.class)) {init = "flag";}} else if (paramType.equals(String.class)) {init = "s";} else {init =toCamelCase(name);}if (keywords.contains(init)) {init =init.substring(0,1);}if (paramCount.get(init)==null) {paramCount.put(init,1);return init;} else {paramCount.replace(init,paramCount.get(init)+1);return init+(paramCount.get(init));}}// 生成默认值private String getDefaultValueForType(Class<?> type) {if (type.isPrimitive()) {if (type.equals(boolean.class)) {return "false";} else if (type.equals(long.class)) {return "0L";}else if (type.equals(float.class)) {return "0F";}else if (type.equals(double.class)) {return "0D";}return "0";} else if (type.equals(String.class)) {return "\"\"";} else if (type.equals(Long.class)) {return "0L";} else if (type.equals(Float.class)) {return "0F";} else if (type.equals(Double.class)) {return "0D";} else if (type.equals(Short.class) || type.equals(Integer.class)) {return "0";} else if (type.equals(BigDecimal.class)) {return "new " + type.getSimpleName() + "(\"0\")";} else if (type.isEnum()) {return type.getSimpleName()+"."+type.getEnumConstants()[0].toString();}else {return "new " + type.getSimpleName() + "()";}}private String toCamelCase(String str) {return Character.toLowerCase(str.charAt(0)) + str.substring(1);}private String capitalizeFirstLetter(String str) {return Character.toUpperCase(str.charAt(0)) + str.substring(1);}// 程序入口public static void main(String[] args) {TestClassAutoGenerator generator = new TestClassAutoGenerator();// 为单一类生成单元测试generator.generateTestForClass("XX-app-service（换成你的单元测试所在项目名称）", XXService.class);}
}

优缺点分析

优点

  1. 环境兼容性强：该工具仅需Java环境即可运行，不依赖于特定的开发环境或额外的软件，强化了其在不同系统环境下的适用性。
  2. 操作简便：简化操作流程，无需外部网络连接或依赖，提高了工具的可访问性和易用性。
  3. 高度可定制：提供代码模板定制功能，允许用户根据具体的代码环境和需求进行个性化调整，增加了工具的灵活性。

缺点

  1. 手动干预需求：自动生成的测试参数可能不符合实际需求，需手动调整，这增加了使用者的工作量。
  2. 单一类别限制：每次只能生成一个类的单元测试，限制了工具的效率，特别是在处理大型项目时。
  3. 潜在的重写风险：如果存在同名的单元测试类，新生成的测试类可能会覆盖原有测试，导致数据丢失。

未来可拓展方向

  • 批量处理功能：增加按路径批量生成测试类的功能，以减少重复性工作，提高效率。
  • 构造方法的灵活性：提供对不同构造方法参数的支持，以适应那些不能仅用空构造方法实例化的类。
  • 智能参数填充：根据参数名称，使用生成随机数或适当的随机值进行填充，以更贴近实际使用情况，减少手动调整的需求。

通过这些拓展，工具将更加智能化和自动化，能够更有效地适应复杂的测试环境和多样化的需求。

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/news/183542.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

P8A012-A016组策略安全

P8A012-A016组策略安全

账户策略 【预备知识】 组策略&#xff08;Group Policy&#xff09;是Microsoft Windows系统管理员为用户和计算机定义并控制程序、网络资源及操作系统行为的主要工具。通过使用组策略可以设置各种软件、计算机和用户策略。 【实验步骤】 网络拓扑&#xff1a;server2008A…
阅读更多...
用Java制作简易版的王者荣耀

用Java制作简易版的王者荣耀

第一步是创建项目 项目名自拟 第二部创建个包名 来规范class 创建类 GameFrame 运行类 package com.sxt;import java.awt.Graphics; import java.awt.Image; import java.awt.Toolkit; import java.awt.event.ActionEvent; import java.awt.event.ActionListener; import j…
阅读更多...
vivado综合分析与收敛技巧2

vivado综合分析与收敛技巧2

1、分解深层存储器配置 &#xff0c; 实现功耗与性能平衡 在深层存储器配置中 &#xff0c; 可使用综合属性 RAM_DECOMP 实现更好的存储器分解并降低功耗。此属性可在 RTL 中设置。将RAM_DECOMP 属性应用于存储器时 &#xff0c; 存储器是在较宽的原语配置中设置的 &#x…
阅读更多...
JRT实现缓存协议

JRT实现缓存协议

上一篇介绍的借助ORM的增、删、改和DolerGet方法&#xff0c;ORM可以很精准的知道热点数据做内存缓存。那么就有一个问题存在&#xff0c;即部署了多个站点时候&#xff0c;如果用户在一个Web里修改数据了&#xff0c;那么其他Web的ORM是不知道这个变化的&#xff0c;其他Web还…
阅读更多...
rpc服务、微服务架构、分布式应用是什么

rpc服务、微服务架构、分布式应用是什么

RPC&#xff08;Remote Procedure Call&#xff09;是远程过程调用的简称&#xff0c;它是一种通过网络从远程计算机程序上请求服务&#xff0c;而不需要了解底层网络技术的协议。简单来说&#xff0c;就是调用远程计算机上的函数或方法&#xff0c;就像调用本地的函数或方法一…
阅读更多...
webpack如何处理浏览器的样式兼容问题postcss

webpack如何处理浏览器的样式兼容问题postcss

一、准备工作 css/index.css添加样式 .word {color: red;user-select: none; } 为了兼容不同的浏览器我们需要添加前缀比如&#xff1a; -webkit-user-select: none; 这个工作可以通过postcss的插件postcss-preset-env处理 二、安装依赖 pnpm i -D postcss postcss-loader…
阅读更多...
接口测试用例编写和接口测试模板

接口测试用例编写和接口测试模板

一、简介 接口测试区别于传统意义上的系统测试&#xff0c;下面介绍接口测试用例和接口测试报告。 二、接口测试用例模板 功能测试用例最重要的两个因素是测试步骤和预期结果&#xff0c;接口测试属于功能测试&#xff0c;所以同理。接口测试的步骤中&#xff0c;最重要的是将…
阅读更多...
MySQL中的JOIN与IN：性能对比与最佳实践

MySQL中的JOIN与IN：性能对比与最佳实践

文章目录 JOIN与IN的基本介绍JOININ JOIN与IN性能对比使用JOIN的查询使用IN的查询 何时使用JOIN何时使用IN性能优化的其他考虑因素总结 &#x1f389;MySQL中的JOIN与IN&#xff1a;性能对比与最佳实践 ☆* o(≧▽≦)o *☆嗨~我是IT陈寒&#x1f379;✨博客主页&#xff1a;IT陈…
阅读更多...
nginx: [error] open() “/usr/local/openresty/nginx/logs/nginx.pid“ failed (2:

nginx: [error] open() “/usr/local/openresty/nginx/logs/nginx.pid“ failed (2:

错误原因&#xff1a;nginx: [error] open() "/usr/local/nginx/logs/nginx.pid" failed (2: No such file or directory)&#xff0c;logs目录下缺少pid文件。 解决方法&#xff1a; 使用指定nginx.conf文件的方式重启nginx roothadoop100 conf]# /usr/local/openr…
阅读更多...
＜蓝桥杯软件赛＞零基础备赛20周--第8周第1讲--十大排序

＜蓝桥杯软件赛＞零基础备赛20周--第8周第1讲--十大排序

报名明年4月蓝桥杯软件赛的同学们&#xff0c;如果你是大一零基础&#xff0c;目前懵懂中&#xff0c;不知该怎么办&#xff0c;可以看看本博客系列&#xff1a;备赛20周合集 20周的完整安排请点击&#xff1a;20周计划 每周发1个博客&#xff0c;共20周&#xff08;读者可以按…
阅读更多...
香港服务器运行缓慢的原因是什么_Maizyun

香港服务器运行缓慢的原因是什么_Maizyun

香港服务器运行缓慢的原因是什么&#xff1f; 随着互联网的蓬勃发展&#xff0c;越来越多的企业和个人选择使用香港服务器来托管他们的网站或应用程序。 不过&#xff0c;在使用过程中&#xff0c;你可能会遇到一些问题&#xff0c;其中最常见的就是香港服务器运行缓慢。 本文…
阅读更多...
Java中的单元测试，反射和枚举

Java中的单元测试，反射和枚举

知识模块 一.Junit单元测试 二.反射 三.枚举一.Junit单元测试a.概述Junit是一种Java写的单元测试框架&#xff0c;专门用来测试Java程序&#xff0c;它可以取代main方法b.Junit环境搭建由于Junit使用的类不属于我们JDK的类库&#xff0c;需要引入第三方jar包才能使用c.Junit使用…
阅读更多...
身份验证和电子邮件的网络安全即将迎来地震

身份验证和电子邮件的网络安全即将迎来地震

任何拥有 Gmail 或 Yahoo 电子邮件帐户的人都清楚&#xff0c;如果不是明确的欺诈企图&#xff0c;他们的收件箱中可能充满了未经请求的邮件。 这些服务的用户很可能多次想知道他们的提供商是否可以采取措施至少减少垃圾邮件的数量以及随之而来的诈骗风险。 好消息是&#xf…
阅读更多...
AI查gdb使用

AI查gdb使用

AI查询了一波GDB的使用&#xff0c;发现基础的命令还是很够的&#xff0c;不过给的都是全称&#xff0c;实际使用时都是用首字母查询问题的。 gdb是GNU调试器&#xff0c;是一种基于命令行的调试工具&#xff0c;可以用于调试C、C、Fortran、Assembly等编程语言编写的程序&…
阅读更多...
多模态大模型总结1（2021和2022年）

多模态大模型总结1（2021和2022年）

常用损失函数 ITC &#xff08;image-text contrasctive loss&#xff09; CLIP中采用的对比损失&#xff0c;最大化配对文本对的余弦相似度&#xff0c;最小化非配对文本对的余弦相似度&#xff0c;采用交叉熵损失实现 MLM &#xff08;masked language modeling&#xff0…
阅读更多...
Elasticsearch 相似度评分模型介绍

Elasticsearch 相似度评分模型介绍

前言 Elasticsearch 是基于 Lucene 的世界范围内最流行的全文检索框架&#xff0c;其文档相似度算法包含 TF/IDF 和 BM25&#xff0c;从 ES 5.0开始 BM25 算法已经成为 ES 默认的相似度评分模块。 TF-IDF 与 BM25 的区别 TF-IDF 和 BM25 都是计算文本相似性的常用算法。TF-ID…
阅读更多...
ESP32-S3 上电不断输出invalid header: 0xffffffff

ESP32-S3 上电不断输出invalid header: 0xffffffff

现象如下&#xff1a; ESP-ROM:esp32s3-20210327 Build:Mar 27 2021 rst:0x1 (POWERON),boot:0x8 (SPI_FAST_FLASH_BOOT) invalid header: 0xffffffff invalid header: 0xffffffff invalid header: 0xffffffff invalid header: 0xffffffff 原因&#xff1a;芯片内部固件问题…
阅读更多...
统计英语单词

统计英语单词

使用Scanner类和正则表达式统计一篇英文中的单词&#xff0c;要求如下&#xff1a; 1、一共出现了多少个单词。 2、有多少个互不相同的单词。 3、按单词出现的频率大小输出单词。 package 第七次; import java.util.*; import java.io.*; import java.util.regex.*;public …
阅读更多...
人工智能助力医疗：科技护航健康未来

人工智能助力医疗：科技护航健康未来

欢迎大家浏览我的博客。YinKais Blog | YinKais Blog 人工智能的魔法不仅仅体现在解决问题、提供建议的方面&#xff0c;更深刻地改变了医疗领域&#xff0c;成为我们健康的科技守护者。本文将聚焦于人工智能在医疗领域的应用&#xff0c;探讨它是如何助力医疗事业&#xff0c;…
阅读更多...
重生奇迹mu召唤师攻略

重生奇迹mu召唤师攻略

一、技能系统 1、技能大类&#xff1a;召唤师主要有火焰职业技能和水元素技能。 2、火焰职业技能&#xff1a;主要是使用火焰元素进行攻击&#xff0c;可以攻击单个目标&#xff0c;也可以同时攻击多个目标。 3、水元素技能&#xff1a;主要是对多个敌方单位使用水元素&…
阅读更多...
最新文章

Copyright @ 2022~2023