【SpringBoot】Spring 一站式解决方案:融合统一返回结果、异常处理与适配器模式

前言

🌟🌟本期讲解关于统一功能处理的详细介绍~~~

🌈感兴趣的小伙伴看一看小编主页:GGBondlctrl-CSDN博客

🔥 你的点赞就是小编不断更新的最大动力                                       

🎆那么废话不多说直接开整吧~~

目录

📚️1.适配器模式 

🚀1.1适配器模式定义

​编辑

🚀1.2适配器模式角色

🚀1.3适配器模式实现

📚️2.统一数据返回格式

🚀2.1快速入门

🚀2.2存在问题

1.作用路径

2.异常情况

🚀2.3统一返回格式优点

📚️3.统一异常处理

🚀3.1快速入门

🚀3.2多种异常

🚀3.3统一异常处理优点

📚️4.总结

 

📚️1.适配器模式 

🚀1.1适配器模式定义

适配器模式, 也叫包装器模式. 将⼀个类的接⼝,转换成客⼾期望的另⼀个接⼝, 适配器让原本接⼝不兼容的类可以合作⽆间.

简单来说就是⽬标类不能直接使⽤, 通过⼀个新类进⾏包装⼀下, 适配调⽤⽅使⽤. 把两个不兼容的接⼝通过⼀定的⽅式使之兼容.

⽐如下⾯两个接⼝, 本⾝是不兼容的(参数类型不⼀样, 参数个数不⼀样等等)

 

但是此时我们可以通过适配器进行两者的兼容,具体的图示如下所示:

🚀1.2适配器模式角色

• Target: ⽬标接⼝ (可以是抽象类或接⼝), 客⼾希望直接⽤的接⼝

• Adaptee: 适配者, 但是与Target不兼容

• Adapter: 适配器类, 此模式的核⼼. 通过继承或者引⽤适配者的对象, 把适配者转为⽬标接⼝

• client: 需要使⽤适配器的对象

大致就是:两个不相容的接口,通过适配器进行了连接,使得使用适配器的对象能够操作目标接口;

🚀1.3适配器模式实现

slf4j 就使⽤了适配器模式,slf4j底层调用了这里的log4j,我们作为调用者,只需要调用slf4j的api就可以了

具体的代码如下所示:

第一步:创建slf4j的api接口

interface Slf4jApi{
 void log(String message);
}

第二步:创建一个log4j,实现打印的功能

class Log4j{
 void log4jLog(String message){
 System.out.println("Log4j打印:"+message);
 }
}

 此时可以看到,这两个类并没有关联,那么此时我们就要进行两个接口的连接了

第三步:创建适配器,进行两个接口的连接

class Slf4jLog4JAdapter implements Slf4jApi{
   private Log4j log4j;
   public Slf4jLog4JAdapter(Log4j log4j) {
      this.log4j = log4j;
   }
   @Override
   public void log(String message) {
      log4j.log4jLog(message);
   }
}

此时就是进行方法的重写,这里重写的方法调用我们目标打印的类里的方法,此时就将两个不相关的接口进行连接;

第四步:调用api实现打印

public class Slf4jDemo {
   public static void main(String[] args) {
      Slf4jApi slf4jApi = new Slf4jLog4JAdapter(new Log4j());
         slf4jApi.log("使⽤slf4j打印⽇志");
      }
}

所以可以发现,作为调用者,真正使用的就是适配器帮我们进行操作,不需要改变log4j的api,只需要通过适配器转换下, 就可以更换⽇志框架, 保障系统的平稳运⾏

适配器使用场景:

⼀般来说,适配器模式可以看作⼀种"补偿模式",⽤来补救设计上的缺陷. 应⽤这种模式算是"⽆奈之举", 如果在设计初期,我们就能协调规避接⼝不兼容的问题, 就不需要使⽤适配器模式了

📚️2.统一数据返回格式

🚀2.1快速入门

统⼀的数据返回格式使⽤ @ControllerAdvice 和 ResponseBodyAdvice 的⽅式实现
@ControllerAdvice 表⽰控制器通知类
添加类 ResponseAdvice , 实现 ResponseBodyAdvice 接⼝, 并在类上添加
@ControllerAdvice 注解

代码如下所示:

@ControllerAdvice
public class ResponseAdvice implements ResponseBodyAdvice {   
    @Override
    public boolean supports(MethodParameter returnType, Class converterType) {
        return true;
    }

    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
        
         return null
    }
}

解释:

supports⽅法: 判断是否要执⾏beforeBodyWrite⽅法. true为执⾏, false不执⾏. 通过该⽅法可以
选择哪些类或哪些⽅法的response要进⾏处理, 其他的不进⾏处理

下面的方法就是表示同意返回的格式是什么,默认重写的就是null;

🚀2.2存在问题

1.作用路径

假如我们需要作用指定的类上,那么代码如下所示:

@Override
public boolean supports(MethodParameter returnType, Class converterType) {
    // 假设你想针对某个具体业务的返回值类型进行处理,这里以 com.example.demo.entity.User 为例
    return returnType.getParameterType().getName().equals("com.example.demo.entity.User");
}

解释:

过获取MethodParameter中的返回值类型的全限定名,并与指定的类全限定名(这里是com.example.demo.entity.User)进行比较,如果相等,就表明当前处理的方法返回值类型正是我们期望操作的那个类,supports方法就返回true

2.异常情况

这里在对于返回类型为string类型的数据会发生,数据不匹配的原因,这里涉及到原码的问题了,出现问题如下所示:

@Controller
@RequestMapping("/test")
public class TestController {
    @RequestMapping("t1")
    public String t1(){
        return "t1";
    }
}

首先我们先创建一个string类,通过运行代码,然后进行同意结果的访问,那么出现的结果如下所示:

主要还是应为原码的问题:

所以此时,我们规定的返回格式不符合这里的string类型,所以发生类型不匹配的问题,那么此时我们就需要进行操作修改;

代码如下:

@Autowired
    private ObjectMapper mapper;

    @Override
    public boolean supports(MethodParameter returnType, Class converterType) {
        return true;
    }

    @SneakyThrows
    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
         //如果返回的值本来就是result类型,那么就不必再次进行包装了
         if(body instanceof String){
              return mapper.writeValueAsString(Result.success(body));
         }
      
         return Result.success(body);
    }

 解释:

这里就是判断类型是否是一个string类型,如果是string类型,在包装后我们要进行转化为string类,那么这里的objectmapping的使用是什么呢?

ObjectMapper是 Jackson 库(一个常用的 Java 处理 JSON 数据的库)中的一个核心类,主要用于在 Java 对象和 JSON 格式数据之间进行相互转换,在这里主要用于将对象转换为json格式的字符串

🚀2.3统一返回格式优点

1. ⽅便前端程序员更好的接收和解析后端数据接⼝返回的数据
2. 降低前端程序员和后端程序员的沟通成本, 按照某个格式实现就可以了, 因为所有接⼝都是这样返回的.
3. 有利于项⽬统⼀数据的维护和修改.
4. 有利于后端技术部⻔的统⼀规范的标准制定, 不会出现稀奇古怪的返回内容

📚️3.统一异常处理

🚀3.1快速入门

统⼀异常处理使⽤的是 @ControllerAdvice + @ExceptionHandler 来实现的,@ControllerAdvice 表⽰控制器通知类, @ExceptionHandler 是异常处理器,两个结合表⽰当出现异常的时候执⾏某个通知,也就是执⾏某个⽅法事件

代码如下所示:

@Slf4j
@ResponseBody
@ControllerAdvice
public class ExceptionAdvice {
    @ExceptionHandler
    public Result handlerException(Exception e){
        log.error("发生不知名异常, e: {}", e);
        return Result.fail("内部错误");
    }

注意:小编这里使用统一返回类型来进行演示的,这里添加了@slf4j来进行错误日志的打印;此时我们自己手动构造一个错误;

@Controller
@RequestMapping("/test")
public class TestController {
    @RequestMapping("t1")
    public String t1(){
        int a=10/0;
        return "t1";
    }
}

很明显这是一种算数异常的出现,那么此时我们进行运行后,在postman中可以看到此时的情况是如何的;

可以看到这里就是出现了内部错误;

🚀3.2多种异常

代码如下:

 @ExceptionHandler
    public Result handlerException(Exception e){
        log.error("发生不知名异常, e: {}", e);
        return Result.fail("内部错误");
    }
    @ExceptionHandler
    public Result handlerException(NullPointerException e){
        log.error("发生空指针异常, e: {}", e);
        return Result.fail("发生空指针异常");
    }
    @ExceptionHandler
    public Result handlerException(ArithmeticException e){
        log.error("发生算数异常, e: {}", e);
        return Result.fail("发生算数异常");
    }

那么此时可以看到,我们列举了不止一种异常,一个父类异常,两个子类异常,那么此时我们再次进行运行,并试一下controller中的算数异常;

可以看到此时得到的就是算数异常;

总结:

在出现一个父类异常时,和出现一个对应的子类异常时,优先就是使用子类异常处理,若没有对应的子类异常,那么就是使用父类的异常处理;这里涉及到原码小编就不再过多赘述了;

🚀3.3统一异常处理优点

1.保障代码质量:确保异常处理方式统一规范,避免因开发人员差异导致的不一致,使代码遵循相同规则,增强可读性与可维护性。
2.强化系统性能:全面捕获各类异常,采取诸如重试、降级等应对策略,有效防止系统因异常而崩溃,维持稳定运行,提升健壮性。
3.助力问题排查:详细记录异常信息,包括类型、发生位置及堆栈详情,方便开发人员依据日志迅速追溯根源,实现高效调试。
4.优化用户感受:向客户端反馈简洁友好的错误消息,屏蔽复杂技术细节,使用户能直观了解问题,提升交互体验。

📚️4.总结

本期接着上回,讲解了关于适配器模式,以及Spring统一功能处理的统一返回格式,以及统一异常处理,当然这里涉及原码,大家可以去看看,翻一翻;

🌅🌅🌅~~~~最后希望与诸君共勉,共同进步!!!


💪💪💪以上就是本期内容了, 感兴趣的话,就关注小编吧。

       😊😊  期待你的关注~~~

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

如若内容造成侵权/违法违规/事实不符,请联系我们进行投诉反馈qq邮箱809451989@qq.com,一经查实,立即删除!

相关文章

回归预测 | MATLAB实RVM相关向量机多输入单输出回归预测

回归预测 | MATLAB实RVM相关向量机多输入单输出回归预测 目录 回归预测 | MATLAB实RVM相关向量机多输入单输出回归预测预测效果基本介绍程序设计参考资料 预测效果 基本介绍 RVM-Adaboost相关向量机集成学习多输入单输出回归预测是一种先进的机器学习方法,用于处理…

【C语言】内存函数详解与模拟实现

文章目录 拓展:Ⅰ. memcpy -- 内存拷贝1、函数介绍与使用2、模拟实现 Ⅱ. memmove -- 内存拷贝1、函数介绍与使用(与memcpy函数的区别)2、模拟实现 Ⅲ. memcmp -- 内存比较1、函数介绍与使用2、模拟实现 Ⅳ. memset -- 内存设置1、函数介绍与…

解析OVN架构及其在OpenStack中的集成

引言 随着云计算技术的发展,虚拟化网络成为云平台不可或缺的一部分。为了更好地管理和控制虚拟网络,Open Virtual Network (OVN) 应运而生。作为Open vSwitch (OVS) 的扩展,OVN 提供了对虚拟网络抽象的支持,使得大规模部署和管理…

解密AIGC三大核心算法:GAN、Transformer、Diffusion Models原理与应用

在当今数字化时代,人工智能生成内容(AIGC)技术正以前所未有的速度改变着我们的生活和工作方式。从创意无限的文本生成,到栩栩如生的图像创作,再到动听的音乐旋律,AIGC的魔力无处不在。而这一切的背后&#…

艾体宝干货丨网络故障排除基本指南

一、确保网络可视性以有效排除故障 有效的网络故障排除要求对穿越网络的数据具有完全的可见性,以便迅速识别和解决潜在问题。本指南深入探讨了一种结构化的网络分析方法,旨在提高故障排除的效率。首先,提出正确的问题至关重要,它…

汽车免拆诊断案例 | 2007 款法拉利 599 GTB 车发动机故障灯异常点亮

故障现象  一辆2007款法拉利599 GTB车,搭载6.0 L V12自然吸气发动机(图1),累计行驶里程约为6万km。该车因发动机故障灯异常点亮进厂检修。 图1 发动机的布置 故障诊断 接车后试车,发动机怠速轻微抖动,…

浪潮海岳 UploadListFile文件上传致RCE漏洞

一、漏洞简介 浪潮云财务系统的/cwbase/EP/ListContent/UploadListFile.ashx接口存在任意文件上传漏洞,未经身份验证的攻击者可以通过该漏洞上传恶意脚本文件,从而控制目标服务器。 二、漏洞影响 三、网络测绘: fofa: body"/cwbase/w…

高等数学学习笔记 ☞ 不定积分的积分法

1. 第一换元积分法 1. 基础概念:形如的过程,称为第一换元积分法。 2. 核心思想:通过对被积函数的观察(把被积函数的形式与积分表的积分公式进行比较),把外部的部分项拿到的内部(求原函数), 然后进行拼凑,…

Spring Boot 整合 Shiro详解

文章目录 Spring Boot 整合 Shiro详解一、引言二、整合步骤1、创建项目并引入依赖2、配置Shiro2.1、自定义Realm2.2、配置SecurityManager和ShiroFilterFactoryBean 三、使用示例四、总结 Spring Boot 整合 Shiro详解 一、引言 在现代的Web应用开发中,用户认证和授…

win10 Outlook(new) 企业邮箱登录 登录失败。请在几分钟后重试。附移除办法

windows系统经常弹出使用Outlook(new),自动切过去。 但是登录企业的内网邮箱,折腾了好几次都使用不了。排查网络等问题,在社区找到了答案。 推出一年多不支持企业账户,所以之前的折腾都是浪费时间。 因为这个答案不太…

tomcat状态一直是Exited (1)

docker run -di -p 80:8080 --nametomcat001 你的仓库地址/tomcat:9执行此命令后tomcat一直是Exited(1)状态 解决办法: 用以下命令创建运行 docker run -it --name tomcat001 -p 80:8080 -d 你的仓库地址/tomcat:9 /bin/bash最终结果 tomcat成功启动

Golang Gin系列-1:Gin 框架总体概述

本文介绍了Gin框架,探索了它的关键特性,并建立了简单入门的应用程序。在这系列教程里,我们会探索Gin的主要特性,如路由、中间件、数据库集成等,最终能使用Gin框架构建健壮的web应用程序。 总体概述 Gin是Go编程语言的…

实现linux硬盘smart检测

一、下载交叉编译libatasmart库 下载链接:https://www.linuxfromscratch.org/blfs/view/svn/general/libatasmart.html libatasmart库编译依赖libudev库,交叉编译器前先准备依赖的libudev: 设置libudev的环境变量,并通过configure编译文件生…

【GIS操作】使用ArcGIS Pro进行海图的地理配准(附:墨卡托投影对比解析)

文章目录 一、应用场景二、墨卡托投影1、知识点2、Arcgis中的坐标系选择 三、操作步骤1、数据转换2、数据加载3、栅格投影4、地理配准 一、应用场景 地理配准是数字化之前必须进行的一项工作。扫描得到的地图数据通常不包含空间参考信息,需要通过具有较高位置精度的…

模型 多元化思维(系统科学)

系列文章分享模型,了解更多👉 模型_思维模型目录。融合多学科知识,全面解决问题。 1 多元化思维模型的应用 1.1 完美日记的私域流量运营 完美日记作为美妆行业的新兴品牌,通过多元化的思维模型在私域流量运营中取得了显著成功。…

剧本杀门店预约系统开发,门店如何走下去?

近几年来,剧本杀行业经历了大浪淘金,行业进入到创新发展时期,如何在市场中占领一席之地成为了商家探讨的问题。 剧本杀作为一种社交游戏方式,深受年轻人的关注,不仅可以体验游戏的乐趣,还可以满足各种社交…

openharmony标准系统方案之瑞芯微RK3568移植案例

标准系统方案之瑞芯微RK3568移植案例 ​本文章是基于瑞芯微RK3568芯片的DAYU200开发板,进行标准系统相关功能的移植,主要包括产品配置添加,内核启动、升级,音频ADM化,Camera,TP,LCD&#xff0c…

Linux的常用命令(三)

目录 六、网络通信命令 1.网络通信命令ping 2.网络通信命令ifconfig 七、系统命令 1. 系统命令shutdown 2. 系统命令reboot 八、vi编辑器 六、网络通信命令 1.网络通信命令ping 命令名称:ping 命令所在路径:/usr/sbin/ping 执行权限&#xff…

STM32+W5500+以太网应用开发+003_TCP服务器添加OLED(u8g2)显示状态

STM32W5500以太网应用开发003_TCP服务器添加OLED(u8g2)显示状态 实验效果3-TCP服务器OLED1 拷贝显示驱动代码1.1 拷贝源代码1.2 将源代码添加到工程1.3 修改代码优化等级1.4 添加头文件路径1.5 修改STM32CubeMX工程 2 修改源代码2.1 添加头文件2.2 main函…

Pytorch|YOLO

🍨 本文为🔗365天深度学习训练营中的学习记录博客🍖 原作者:K同学啊 一、 前期准备 1. 设置GPU 如果设备上支持GPU就使用GPU,否则使用CPU import torch import torch.nn as nn import torchvision.transforms as transforms im…