教你用Mock实现复杂登陆接口下如何优雅的获取Token

2023-11-02

哈喽大家好,我是阿Q。

背景

今天又双叒叕被抓壮丁了,被安排进了新的项目组进行任务开发。加入新项目后的第一件事,当然是先研究下同事的代码喽。

在“学习”代码的过程中竟然惊奇的发现同事写了测试用例,对于一直使用PostMan来进行接口测试的我表示非常不理解,测试用例到底有什么神奇之处?

需求分析

带着疑问翻看了测试用例,发现同事用它来实现了管理后台登录自动生成Token的功能。

生成TokenPostMan不是也很好实现吗?何必要多此一举?

百闻不如见面,直接上图

在这里插入图片描述

看到这张图是不是很熟悉?市面上的大部分登录界面都长这样吧。我们来简单分析下这个登录功能:

  • 调用生成图片验证码接口,将生成的验证码图片返回前端,将验证码的文本保存到Redis缓存中;
  • 调用短信验证码接口,将短信发送到对应的手机号,将验证码也保存到Redis缓存中;
  • 调用登录接口,将填写信息进行校验,返回登录Token

如果我们使用PostMan的话,得写三个请求才能获取到最终需要的Token,比较繁琐,而如果使用同事写的测试用例,可以直接运行获取到Token。那他是如何实现的呢?

Mock

在了解实现之前,我们先来了解下什么是MockMock的翻译是虚假的、模拟的。它的作用就是在测试环境中创建一个类的虚假对象,用来替换掉真实的对象,以达到方便测试的目的。

举个例子:假如你正在开发下订单的需求,此时你需要调用B服务来完成减积分的操作,而此时B服务还在开发中,你就可以Mock一个对象,模拟B服务的返回结果,根据结果来完成自己的逻辑开发。

当然,SpringBoot也为我们提供了Mock单元测试,需要引入依赖

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

该依赖提供了以下类库

  • JUnitJAVA应用单元测试框架,默认依赖版本是4.12(JUnit5JUnit4差别比较大,集成方式不同);
  • Spring Test & Spring Boot Test:测试支持;
  • AssertJ:断言库,提供流式的断言支持;
  • Hamcrest:对象匹配断言和约束组件;
  • MockitoJava mock框架;
  • JSONassertJSON断言库;
  • JsonPathJSON XPath操作类库;

注解

使用Mock之前,我们再来了解几个测试过程中用到的注解。

@SpringBootTest

@SpringBootTestSpringBoot的单元测试环境提供支持。在使用Mock的过程中,我们会发现启动测试程序并不会占用我们的应用端口,本质上来讲就是它不会去启动服务器。

经过翻阅资料发现,它的这一特性跟它的内部属性值webEnvironment息息相关,它提供了四个枚举值供我们选择:

  • MOCK:默认值,如果servlet API在类路径上,则创建一个带有模拟servlet环境的WebApplicationContext,如果Spring WebFlux在类路径上,则创建一个ReactiveWebApplicationContext,否则创建一个常规的ApplicationContext,该选择下不会启动嵌入式服务器;
  • RANDOM_PORT:加载WebServerApplicationContext并提供真实的Web环境,启用的是随机web容器端口;
  • DEFINED_PORT:加载WebServerApplicationContext并提供真实的Web环境,和RANDOM_PORT不同的是启用配置文件中定义的端口;
  • NONE:通过SpringApplication加载ApplicationContext,但不提供任何Web环境;

如果测试时带有@Transactional注解,默认情况下每个测试方法执行完就会回滚事务。但是当webEnvironment设置为RANDOM_PORT或者DEFINED_PORT时,会隐式地提供真实的servlet web环境,此时事务是不会回滚的。

@RunWith(SpringRunner.class)

运行器,选择不同的Runner调用测试代码,此处指定用SpringRunner来运行。有了该注解,测试类要注入的类才能实例化到Spring容器中。

JUnit4需要添加该注解,JUnit5则不需要

方法注解
  • @Test:使用该注解标注的public void方法会表示为一个测试方法;
  • @BeforeClass:表示在类中的任意public static void方法执行之前执行;
  • @AfterClass:表示在类中的任意public static void方法之后执行;
  • @Before:表示在任意使用@Test注解标注的public void方法执行之前执行;
  • @After:表示在任意使用@Test注解标注的public void方法执行之后执行;
  • @Ignore:执行测试时将忽略掉此方法,如果用于修饰类,则忽略整个类;

实战

因为使用的是SpringSecurity鉴权,所以还得引入依赖

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

首先,我们先来初始化MockMvc对象

//wac 是 WebApplicationContext 对象
MockMvc mvc = MockMvcBuilders.webAppContextSetup(wac).
                apply(springSecurity())
                .build(); 
图形验证码

调用图形验证码接口

//perform:执行一个RequestBuilders请求,会自动执行SpringMVC的流程并映射到相应的控制器执行处理
MvcResult mvcResult = mvc.perform(
    		   //模拟发送 GET 请求
                MockMvcRequestBuilders.get("/login/capture").
    				     //接受参数
                        .accept(MediaType.APPLICATION_JSON_UTF8)
    					//请求类型
                        .contentType(MediaType.APPLICATION_JSON)
                        .session(session)
        )
    			//期待的结果状态值 200
                .andExpect(MockMvcResultMatchers.status().isOk())
    			//获取方法的返回值 MvcResult
                .andReturn();

获取到返回结果之后进行解析,并保存到Redis缓存中。

短信验证码
mvc.perform(
    //模拟发送 POST 请求
	MockMvcRequestBuilders.post("/login/sendSmsCode")
		.accept(MediaType.APPLICATION_JSON_UTF8)
		.contentType(MediaType.APPLICATION_JSON)
		// 填充内容
		.content(JsonUtils.toString(req))
		.session(session)
)
		.andExpect(MockMvcResultMatchers.status().isOk())
		.andReturn();

模拟发送短信验证码接口,可以从Redis缓存中获取到短信验证码。

登录
MvcResult mResult = mvc.perform(
                MockMvcRequestBuilders.post("/login")
                        .accept(MediaType.APPLICATION_JSON_UTF8)
                        .contentType(MediaType.APPLICATION_JSON)
                        .content(JsonUtils.toString(smsLoginDto))
                        .session(session)
        )
                .andExpect(MockMvcResultMatchers.status().isOk())
                .andReturn();

我们解析返回结果就可以获取Token了。

为了让需要登录的接口直接使用我们生成的Token,我们可以把获取图形验证码、短信验证码、登录的接口放在一个方法中,用@Before注释,这样在调用接口之前都会去获取一下Token。我们再把它放到MockHttpSession中,使用的时候直接获取即可。

测试

为了便于测试,我们将上边的方法封装成一个基础类,让使用Token的方法所在的类继承一下该类,就可以使用Token了。

@Test
public void test() throws Exception {
	PageDTO req = new PageDTO();
	req.setPageSize(10);
	req.setPageNo(1);
	WrapperResult<PageInfo<PostResumeVO>> iPageWrapperResult = this.doPost(
			req,
			"/resume/mid/getPage",
			new TypeReference<WrapperResult<PageInfo<PostResumeVO>>>() {
			});
	this.outputPretty(iPageWrapperResult);
}

查看执行结果执行成功。

在这里插入图片描述

当然你也可以只在test()方法中获取Token,然后用其他工具去调用接口。

看到这儿,你是不是也摩拳擦掌,想把自己获取复杂Token的操作改成Mock方式?心动不如行动,GO!

阿Q将持续更新java实战方面的文章,感兴趣的可以关注下!

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

教你用Mock实现复杂登陆接口下如何优雅的获取Token 的相关文章

随机推荐

  • 搭建三节点的kubernetes(K8S)集群

    Kubernates安装配置文档 先决条件 1 需要的yaml文件所在的github地址如下 https github com luckylucky421 kubernetes1 17 3 tree master 2 下文里初始化k8s集群
  • Jupyter notebook快速入门教程

    本篇将给大家介绍一款超级好用的工具 Jupyter notebook 为什么要介绍这款工具呢 如果你想使用Python学习数据分析或数据挖掘 那么它应该是你第一个应该知道并会使用的工具 它很容易上手 用起来非常方便 是个对新手非常友好的工具
  • Matlab快速创建矩阵的方法(创建特殊矩阵)

    在matlab的使用过程中经常会需要用到矩阵 有时想要创建一些数据比较多的矩阵 对矩阵的内容要求可能并不高或者要创建一些特殊矩阵 下面将提供一些matlab内部提供的一些快速创建矩阵的方法 1 创建单位矩阵 eye n 创建n n的单位矩阵
  • GitHub托管HTML页面,让其他人轻松访问自己的页面

    如何通过GitHub来托管自己写的HTML页面 能够轻松让其他人访问你的页面 还可以通过GitHub让多人参与进来你的项目 以下是详细步骤 1 创建账户 登陆https github com 注册成功 1 https guides gith
  • SpringBoot2.0学习笔记:(九) Spring Boot中集成Mybatis与Druid

    一 项目的搭建 Druid对Spring boot做了很好的适配 所有的工作都只需要在配置文件中完成 具体的Druid在Spring Boot中的配置可以看 GitHub文档 首先看一下项目引入的jar包
  • flink学习46:flinkSQL自定义函数

    标量函数 实例 表值函数 聚合函数
  • 点击登录按钮弹出登录模态框

  • 拯救者y7000笔记本VMware虚拟机打开蓝屏问题

    VMware虚拟机安装后开启虚拟机蓝屏检查步骤 一 必须确定你的CPU开启了虚拟化才行 要先开启虚拟化再去控制面板里设置 查看是否开启虚拟化方法 在win10系统最下方任务栏空白处 右键鼠标打开任务管理器 也可以点击快捷键Ctrl Alt
  • go语言实现邮件发送

    go语言实现邮件发送 安装相关的包 go get github com jordan wright email 代码篇 package main import fmt github com jordan wright email log n
  • Zotero软件与ChatGPT连用模版

    Zotero软件与ChatGPT连用模版 整体流程 其他配置 全文 AskPDF position 10 color 0EA293 trigger 本文 这篇文章 论文 You are a helpful assistant Context
  • 缓存一致性问题解决方案

    通常情况下 我们使用缓存的主要目的是为了提升查询的性能 大多数情况下 是这样使用缓存的 当数据库有数据更新时 在很长的一段时间内 决定于缓存的过期时间 用户请求从缓存中获取到的都可能是旧值 而非数据库的最新值 那么 该如何更新缓存呢 目前有
  • Python实现电商订单的数据分析

    一 数据信息 数据集 阿里云天池 数据来源 说明 本数据集共有104557条数据 共计11个字段 字段 id 序号 orderID 订单id userID 用户id goodsID 商品id orderAmount 订单总额 payment
  • 【Python刷题】P1

    Python刷题P1 第一题 第二题 第一题 1 给定一个非空的字符串 s 检查是否可以通过由它的一个子串重复多次构成 示例 1 输入 s abab 输出 true 解释 可由子串 ab 重复两次构成 示例 2 输入 s aba 输出 fa
  • C语言程序设计(谭浩强第五版)——例题

    C语言程序设计 谭浩强第五版 例题 第1章 程序设计和C语言 第2章 算法 程序的灵魂 第3章 最简单的C程序设计 顺序程序设计 第4章 选择结构程序设计 第5章 循环结构程序设计 第6章 利用数组处理批量数据 第7章 用函数实现模块化程序
  • 【算法基础】基于pytorch的BP神经网络算法代码+数据集

    实现功能 1 数据回归 基于多输入单输出数据集 2 代码最后使用matplotlib绘制了 训练次数 loss值 折线图进行训练结果展示 注 1 代码亲测可成功运行 2 以下代码通过cuda调用GPU训练 如果cuda报错则需检查GPU训练
  • python基础学习06_if条件判断(多重判断、嵌套、三目运算)

    一 条件语句 条件成立执行某些代码 条件不成立执行哪些代码 二 IF 条件判断 IF简单条件判断 多重判断 IF嵌套 三目运算符 1 if 简单条件判断 if if True print 条件成 执 的代码1 print 条件成 执 的代码
  • 微信小程序开发记录(一)弹出框和模态框介绍

    弹出框和模态框的简介和使用方法如下
  • k8s踩坑2——scheduler 、controller-manager Unhealthy

    查看master组件状态时出现错误 root k8s master kubectl get cs Warning v1 ComponentStatus is deprecated in v1 19 NAME STATUS MESSAGE E
  • ActiveMQ Redelivery Policy(消息重发策略)

    官方文档 http activemq apache org redelivery policy html 在事务控制里抛出异常 txManager会进行rollback处理 在activeMQ里 消息默认会redelivery到客户端6次
  • 教你用Mock实现复杂登陆接口下如何优雅的获取Token

    哈喽大家好 我是阿Q 背景 今天又双叒叕被抓壮丁了 被安排进了新的项目组进行任务开发 加入新项目后的第一件事 当然是先研究下同事的代码喽 在 学习 代码的过程中竟然惊奇的发现同事写了测试用例 对于一直使用PostMan来进行接口测试的我表示