P02项目诊断报警组件（学习操作日志记录、单元测试开发）

2023-11-08 17:04
文章标签 学习 日志 组件 项目 操作 开发 记录 单元测试 诊断 报警 p02

本文主要是介绍P02项目诊断报警组件（学习操作日志记录、单元测试开发），希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

★ P02项目诊断报警组件

诊断报警组件的主要功能有：

  1. 接收、记录硬件设备上报的报警信息。
  2. 从预先设定的错误码对照表中找到对应的声光报警和蜂鸣器报警策略，结合当前的报警情况对设备下发报警指示。
  3. 将报警消息发送到消息队列，由其它组件发送给前端。
  4. 从消息队列获取用户通过前端进行的报警处理操作，更新故障报警表对应记录的处理信息，并根据预定规则调整当前的声光报警、蜂鸣器报警策略。
  5. 定期往Redis缓存写入数据，并将该数据的有效期设为写入周期的3倍。
  6. 定期从Redis缓存中获取系统监视组件写入的标志信息，如果获取失败则表示系统监视组件出现故障，产生报警记录并对设备下发报警指示。
  7. 系统监视组件产生的后端组件故障报警信息的记录和处理。
  8. 从Redis缓存获取当前系统配置参数中的各优先级报警循环时间，并在配置参数有改动时及时更新。
  9. 用户通过前端页面对历史报警信息进行查询。

职责描述:
1、学习项目。
2、单元测试

学习别人的如何操作日志记录注解

package com.wg.common.annotation;import java.lang.annotation.*;/*** 自定义操作日志记录注解*/
@Target({ ElementType.PARAMETER, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Log {/*** 模块*/String title() default "";/*** 功能*/String business() default "";
}
package com.wg.common.aspectj;import cn.dev33.satoken.stp.StpUtil;
import cn.hutool.core.util.ObjectUtil;
import cn.hutool.core.util.StrUtil;
import com.wg.common.annotation.Log;
import com.wg.common.constant.Constants;
import com.wg.common.entity.OperationLog;
import com.wg.common.entity.User;
import com.wg.common.service.IOperationLogService;
import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.AfterThrowing;
import org.aspectj.lang.annotation.Aspect;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;import java.util.Date;/*** 日志aop信息
**/
@Slf4j
@Aspect
@Component
public class LogAspect {@Autowiredprivate IOperationLogService operationLogService;@AfterReturning(pointcut = "@annotation(controllerLog)", returning = "jsonResult")public void doAfterReturning(Log controllerLog, Object jsonResult) {handleLog(controllerLog, null, jsonResult);}@AfterThrowing(value = "@annotation(controllerLog)", throwing = "e")public void doAfterThrowing(Log controllerLog, Exception e){handleLog(controllerLog, e, null);}protected void handleLog(Log controllerLog, final Exception e, Object jsonResult){try{User user = (User) StpUtil.getSession().get("user");OperationLog operationLog = new OperationLog();operationLog.setStatus(Constants.SUCCESS);if (ObjectUtil.isNotNull(user)){operationLog.setUserName(user.getUserName());operationLog.setNickName(user.getNickName());}if (e != null){operationLog.setStatus(Constants.FAIL);operationLog.setErrorMsg(StrUtil.sub(e.getMessage(), 0, 2000));}operationLog.setTitle(controllerLog.title());operationLog.setOperationTime(new Date());operationLogService.save(operationLog);}catch (Exception exp){log.error("==前置通知异常==");log.error("异常信息:{}", exp.getMessage());exp.printStackTrace();}}
}

在这里插入图片描述

学习单元测试

首先实际完成的时候偷懒的方式就是用SquareTest生成。

Controller 测试

Spring 提供了 MockMVC 用于支持 RESTful 风格的 Spring MVC 测试，使用 MockMvcBuilder 来构造MockMvc 实例。MockMvc 有两个实现：

StandaloneMockMvcBuilder：指定 WebApplicationContext，它将会从该上下文获取相应的控制器并得到相应的 MockMvc

@RunWith(SpringRunner.class)
@SpringBootTest
public class UserControllerTest  {@Autowiredprivate WebApplicationContext webApplicationContext;private MockMvc mockMvc;@Beforepublic void setUp() throws Exception {mockMvc = MockMvcBuilders.webAppContextSetup(webApplicationContext).build();
}

DefaultMockMvcBuilder：通过参数指定一组控制器，这样就不需要从上下文获取了

@RunWith(SpringRunner.class)
@SpringBootTest
public class UserControllerTest  {private MockMvc mockMvc;@Beforepublic void setUp() throws Exception {mockMvc = MockMvcBuilders.standaloneSetup(new UserController()).build();} 
}

下面是一个简单的用例，对 UserController 的 /user/{id} 接口进行测试。

@RestController
@RequestMapping("user")
public class UserController {@GetMapping("/{id}")public User get(@PathVariable("id") String id) {return new User(1, "lst");}@Data@AllArgsConstructorpublic class User {private Integer id;private String name;}}

import static org.hamcrest.Matchers.containsString;
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.content;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;@RunWith(SpringRunner.class)
@SpringBootTest
public class UserControllerTest {@Autowiredprivate WebApplicationContext webApplicationContext;private MockMvc mockMvc;@Beforepublic void setUp() {mockMvc = MockMvcBuilders.webAppContextSetup(webApplicationContext).build();}@Testpublic void getUser() {mockMvc.perform(get("/user/1").accept(MediaType.APPLICATION_JSON_UTF8)).andExpect(status().isOk()).andExpect(content().string(containsString("\"name\":\"lst\"")));}}
方法描述

perform：执行一个 RequestBuilder 请求，返回一个 ResultActions 实例对象，可对请求结果进行期望与其它操作

get：声明发送一个 get 请求的方法，更多的请求类型可查阅→MockMvcRequestBuilders 文档

andExpect：添加 ResultMatcher 验证规则，验证请求结果是否正确，验证规则可查阅→MockMvcResultMatchers 文档

andDo：添加 ResultHandler 结果处理器，比如调试时打印结果到控制台，更多处理器可查阅→MockMvcResultHandlers 文档

andReturn：返回执行请求的结果，该结果是一个恩 MvcResult 实例对象→MvcResult 文档

Mock 数据

在单元测试中，Service 层的调用往往涉及到对数据库、中间件等外部依赖。
如果不需要对静态方法，私有方法等特殊进行验证测试，则仅仅使用 Spring boot 自带的 Mockito 即可完成相关的测试数据 Mock。若需要则可以使用 PowerMock，简单实用，结合 Spring 可以使用注解注入。

@MockBean
SpringBoot 在执行单元测试时，会将该注解的 Bean 替换掉 IOC 容器中原生 Bean。

例如下面代码中， ProjectService 中通过 ProjectMapper 的 selectById 方法进行数据库查询操作：

@Service
public class ProjectService {@Autowiredprivate ProjectMapper mapper;public ProjectDO detail(String id) {return mapper.selectById(id);}}

此时我们可以对 Mock 一个 ProjectMapper 对象替换掉 IOC 容器中原生的 Bean，来模拟数据库查询操作，如：
复制代码

@RunWith(SpringRunner.class)
@SpringBootTest
public class ProjectServiceTest {@MockBeanprivate ProjectMapper mapper;@Autowiredprivate ProjectService service;@Testpublic void detail() {ProjectDemoDO model = new ProjectDemoDO();model.setId("1");model.setName("dubbo-demo");Mockito.when(mapper.selectById("1")).thenReturn(model);ProjectDemoDO entity = service.detail("1");assertThat(entity.getName(), containsString("dubbo-demo"));}}
Mockito 常用方法

mock() 对象
List list = mock(List.class);

verify() 验证互动行为

@Test
public void mockTest() {List list = mock(List.class);list.add(1);// 验证 add(1) 互动行为是否发生Mockito.verify(list).add(1);
}

when() 模拟期望结果

@Test
public void mockTest() {List list = mock(List.class);when(mock.get(0)).thenReturn("hello");assertThat(mock.get(0),is("hello"));
}

doThrow() 模拟抛出异常

@Test(expected = RuntimeException.class)
public void mockTest(){List list = mock(List.class);doThrow(new RuntimeException()).when(list).add(1);list.add(1);
}
@Mock 注解

在上面的测试中我们在每个测试方法里都 mock 了一个 List 对象，为了避免重复的 mock，使测试类更具有可读性，我们可以使用下面的注解方式来快速模拟对象：

 @RunWith(MockitoJUnitRunner.class) 
public class MockitoTest {@Mockprivate List list;public MockitoTest(){// 初始化 @Mock 注解MockitoAnnotations.initMocks(this);}@Testpublic void shorthand(){list.add(1);verify(list).add(1);}
}

when() 参数匹配

@Test
public void mockTest(){Comparable comparable = mock(Comparable.class);//预设根据不同的参数返回不同的结果when(comparable.compareTo("Test")).thenReturn(1);when(comparable.compareTo("Omg")).thenReturn(2);assertThat(comparable.compareTo("Test"),is(1));assertThat(comparable.compareTo("Omg"),is(2));//对于没有预设的情况会返回默认值assertThat(list.get(1),is(999));assertThat(comparable.compareTo("Not stub"),is(0));
}
spy() 监控真实对象

Mock 不是真实的对象，它只是创建了一个虚拟对象，并可以设置对象行为。而 Spy是一个真实的对象，但它可以设置对象行为。

@Test(expected = IndexOutOfBoundsException.class)
public void mockTest(){List list = new LinkedList();List spy = spy(list);//下面预设的spy.get(0)会报错，因为会调用真实对象的get(0)，所以会抛出越界异常when(spy.get(0)).thenReturn(3);//使用doReturn-when可以避免when-thenReturn调用真实对象apidoReturn(999).when(spy).get(999);//预设size()期望值when(spy.size()).thenReturn(100);//调用真实对象的apispy.add(1);spy.add(2);assertThat(spy.size(),is(100));assertThat(spy.size(),is(1));assertThat(spy.size(),is(2));verify(spy).add(1);verify(spy).add(2);assertThat(spy.get(999),is(999));
}

reset() 重置 mock

@Test
public void reset_mock(){List list = mock(List.class);when(list.size()).thenReturn(10);list.add(1);assertThat(list.size(),is(10));//重置mock，清除所有的互动和预设reset(list);assertThat(list.size(),is(0));
}

times() 验证调用次数

@Test
public void verifying_number_of_invocations(){List list = mock(List.class);list.add(1);list.add(2);list.add(2);list.add(3);list.add(3);list.add(3);//验证是否被调用一次，等效于下面的times(1)verify(list).add(1);verify(list,times(1)).add(1);//验证是否被调用2次verify(list,times(2)).add(2);//验证是否被调用3次verify(list,times(3)).add(3);//验证是否从未被调用过verify(list,never()).add(4);//验证至少调用一次verify(list,atLeastOnce()).add(1);//验证至少调用2次verify(list,atLeast(2)).add(2);//验证至多调用3次verify(list,atMost(3)).add(3);
}

inOrder() 验证执行顺序

@Test
public void verification_in_order(){List list = mock(List.class);List list2 = mock(List.class);list.add(1);list2.add("hello");list.add(2);list2.add("world");//将需要排序的mock对象放入InOrderInOrder inOrder = inOrder(list,list2);//下面的代码不能颠倒顺序，验证执行顺序inOrder.verify(list).add(1);inOrder.verify(list2).add("hello");inOrder.verify(list).add(2);inOrder.verify(list2).add("world");
}

这篇关于P02项目诊断报警组件（学习操作日志记录、单元测试开发）的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/371266。

相关文章

Python正则表达式匹配和替换的操作指南

Python正则表达式匹配和替换的操作指南

《Python正则表达式匹配和替换的操作指南》正则表达式是处理文本的强大工具,Python通过re模块提供了完整的正则表达式功能,本文将通过代码示例详细介绍Python中的正则匹配和替换操作,需要的朋... 目录基础语法导入re模块基本元字符常用匹配方法1. re.match() - 从字符串开头匹配2.
阅读更多...
基于 Cursor 开发 Spring Boot 项目详细攻略

基于 Cursor 开发 Spring Boot 项目详细攻略

《基于Cursor开发SpringBoot项目详细攻略》Cursor是集成GPT4、Claude3.5等LLM的VSCode类AI编程工具,支持SpringBoot项目开发全流程,涵盖环境配... 目录cursor是什么？基于 Cursor 开发 Spring Boot 项目完整指南1. 环境准备2. 创建
阅读更多...
Vue和React受控组件的区别小结

Vue和React受控组件的区别小结

《Vue和React受控组件的区别小结》本文主要介绍了Vue和React受控组件的区别小结,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学... 目录背景React 的实现vue3 的实现写法一：直接修改事件参数写法二：通过ref引用 DOMVu
阅读更多...
Java实现在Word文档中添加文本水印和图片水印的操作指南

Java实现在Word文档中添加文本水印和图片水印的操作指南

《Java实现在Word文档中添加文本水印和图片水印的操作指南》在当今数字时代,文档的自动化处理与安全防护变得尤为重要,无论是为了保护版权、推广品牌,还是为了在文档中加入特定的标识,为Word文档添加... 目录引言Spire.Doc for Java：高效Word文档处理的利器代码实战：使用Java为Wo
阅读更多...
SpringBoot日志级别与日志分组详解

SpringBoot日志级别与日志分组详解

《SpringBoot日志级别与日志分组详解》文章介绍了日志级别（ALL至OFF）及其作用,说明SpringBoot默认日志级别为INFO,可通过application.properties调整全局或... 目录日志级别1、级别内容2、调整日志级别调整默认日志级别调整指定类的日志级别项目开发过程中，利用日志
阅读更多...
SpringBoot 多环境开发实战(从配置、管理与控制)

SpringBoot 多环境开发实战(从配置、管理与控制)

《SpringBoot多环境开发实战(从配置、管理与控制)》本文详解SpringBoot多环境配置,涵盖单文件YAML、多文件模式、MavenProfile分组及激活策略,通过优先级控制灵活切换环境... 目录一、多环境开发基础（单文件 YAML 版）（一）配置原理与优势（二）实操示例二、多环境开发多文件版
阅读更多...
使用docker搭建嵌入式Linux开发环境

使用docker搭建嵌入式Linux开发环境

《使用docker搭建嵌入式Linux开发环境》本文主要介绍了使用docker搭建嵌入式Linux开发环境,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面... 目录1、前言2、安装docker3、编写容器管理脚本4、创建容器1、前言在日常开发全志、rk等不同
阅读更多...
Three.js构建一个 3D 商品展示空间完整实战项目

Three.js构建一个 3D 商品展示空间完整实战项目

《Three.js构建一个3D商品展示空间完整实战项目》Three.js是一个强大的JavaScript库,专用于在Web浏览器中创建3D图形,：本文主要介绍Three.js构建一个3D商品展... 目录引言项目核心技术1. 项目架构与资源组织2. 多模型切换、交互热点绑定3. 移动端适配与帧率优化4. 可
阅读更多...
sky-take-out项目中Redis的使用示例详解

sky-take-out项目中Redis的使用示例详解

《sky-take-out项目中Redis的使用示例详解》SpringCache是Spring的缓存抽象层,通过注解简化缓存管理,支持Redis等提供者,适用于方法结果缓存、更新和删除操作,但无法实现... 目录Spring Cache主要特性核心注解1.@Cacheable2.@CachePut3.@Ca
阅读更多...
sysmain服务可以禁用吗? 电脑sysmain服务关闭后的影响与操作指南

sysmain服务可以禁用吗? 电脑sysmain服务关闭后的影响与操作指南

《sysmain服务可以禁用吗?电脑sysmain服务关闭后的影响与操作指南》在Windows系统中，SysMain服务（原名Superfetch）作为一个旨在提升系统性能的关键组件，一直备受用户关... 在使用 Windows 系统时，有时候真有点像在「开盲盒」。全新安装系统后的「默认设置」，往往并不尽编
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2