SpringBoot统一功能处理(统一处理用户登陆权限验证、统一异常处理以及统一数据返回格式)

news2024/11/19 17:40:57

目录

1. SpringBoot统一功能处理简介

2. 统一处理用户登陆验证

2.1 原生SpringAOP实现统一登陆验证的问题

2.2 Spring拦截器实现用户统一登陆验证

2.3 扩展: 统一访问前缀添加

3. 统一异常处理 

4. 统一数据返回格式

4.1 统一数据返回格式的必要性

4.2 实现统一数据返回格式的功能

5. 总结


1.SpringBoot统一功能处理简介

我们在上篇博客中学习了AOP思想以及SpringAOP实现,但是在实际的业务开发中,使用原生的SpringAOP开发是很难满足我们真正的的业务需求的。我们在这里总结的SpringBoot统一功能处理就是对原生的SpringAOP操作的一种增强集合,为什么这么说呢,一起来向下看吧!

2.统一处理用户登陆验证

2.1 原生SpringAOP实现统一登陆验证的问题

在学习了SpringAOP的原生操作后,我就立即着手想着去写一个统一处理用户登陆权限验证的功能。可能大多数小伙伴的想法和我一致,直接使用SpringAOP的前置通知方法或者环绕通知方法来实现不就行了吗?但是在真正使用原生SpringAOP对该功能进行实现时,我遇到了以下几个问题:

  1. 首先是要验证用户的登陆状态,就要先获取到内存中的session对象,但是通过前置或者环绕通知的方式时很难拿到请求对象的,也就很难拿到session对象进行判断。
  2. 其次是与我们用户相关的控制器中并非所有方法都要进行拦截判断(像登录、注册方法),那这样就大大增加了通过原生SpringAOP的切点表达式配置拦截规则的难度

那该怎么解决上述的问题呢?——更好的解决办法就是使用Spring拦截器~

2.2 Spring拦截器实现用户统一登陆验证

使用Spring拦截器实现用户统一验证登录的步骤整体上分为以下几步:

  1. 创建一个自定义类实现HandlerInterceptor接口,并重写preHandler方法,在该方法中编写进行统一用户登陆验证的逻辑代码。
  2. 将1中创建的拦截器加入到系统配置中,并配置拦截器的拦截规则。本步骤其实就是通过创建一个自定义类实现WebMvcConfigurable接口,并标注@Configuration注解将该类交由Spring进行管理,同时重写接口的addInterceptors方法,在该方法中将创建的HandlerInterceptor接口子类传入,并配置拦截规则。

接下来我们在程序中实际定义一个用户登陆权限校验的拦截器来学习以下上边拦截器的具体实现过程及定义的相关注意事项:

0.准备工作。

1.首先创建自定义类LoginInterceptor拦截器类实现HandlerInterceptor接口,并重写preHandler方法,在其中编写我们进行用户统一登录的验证逻辑。


 2.创建自定义系统配置类实现WebMvcConfigurable接口,并重写addInterceptors方法,加上@Configuration将我们创建的拦截器类的实例对象加入到系统配置中并指定该拦截器的拦截规则。


3.到这里,我们自定义的拦截器就完成配置啦!接下来,我们启动程序来进行测试。

2.3 扩展: 统一访问前缀添加

在实际的业务场景中,一台服务器上时可能会有多个服务的。而这些服务通常也是通过同一端口来与外界进行通信的。那么,它们是怎么实现同一端口通信的呢?这个时候就需要用到统一前缀添加了。给同一台服务器上的不同服务加上不同的统一前缀,这样就能够让网关系统识别并匹配到对应的服务。那该怎么实现统一前缀添加呢?实现方式有以下两种:

  1. 在系统配置中配置
    在实现了WebMcvConfigurer的类中覆写接口中的configurePathMatch方法并指定统一前缀。

  2. 在SpringBoot的application配置文件中配置
# 在配置文件中配置,在所有的路由最前统一加上前缀/bai
server:
  servlet:
    context-path: /bai

通过了以上配置,我们再来请求原来的路由对应的接口,会发现页面信息不存在。这个时候就需要加上程序中添加的统一前缀了。之后服务器的网关才能够通过识别这个统一前缀将你的请求转发到指定的服务进行处理返回。

3. 统一异常处理 

为什么要进行统一异常处理呢?


这是因为如果我们不进行统一的异常处理,那么当后端程序抛出异常后程序不再往下运行,前端会在控制台报错,而用户发送请求后由于后端程序没有响应也就导致页面无响应,大大降低了客户的体验感。我们来模拟一下后端程序抛出异常时的场景:

接下来我们就来实现一下程序的统一异常处理功能,对比下统一异常处理后我们的后端程序的有哪些优点。


实现统一异常处理的步骤如下:

  1. 创建一个统一异常处理类,标注上@ControllerAdvice注解表示这是一个统一异常处理类,@ControllerAdvice注解中包含@Component注解,所以该类也会加入到Spring中随着框架的加载而加载。
  2. 再类中定义异常处理方法,标注上@ExceptionHandler异常管理器注解订阅异常,并在方法中将异常处理后的结果返回给前端。

接下来我们一起来实现以下统一异常处理的功能,学习一下实现的细节和注意事项:


通过上述的实现过程,我们可以总结出统一异常处理功能实现时要注意:

  1. 当有多个异常处理的通知方法时,程序抛出的异常对象是按照由子类到父类的顺序进行匹配的。
  2.  实现统一异常处理使用到注解@ControllerAdvice、@ResponseBody(选用,看你返回的是页面还是数据)以及@ExceptionHandler。

4. 统一数据返回格式

4.1 统一数据返回格式的必要性

要知道,实际的开发场景中,一个项目不可能是由我们一人独自完成的。如果这时候每个后端开发程序员返回给前端的数据以及数据格式各式各样,那前端程序员大概率要懵逼:“这个接口返回的数据是什么来着?这个接口返回的数据格式是什么来着?...晕😵”!当统一了数据的返回格式后,优点是十分显著的,例如:

  1. 方便了前端程序员更好的接收和解析不同后端接口返回的数据。能够有效地降低沟通带来的时间损耗,同东我们项目组的进展。
  2. 统一的数据格式有利于数据维护和修改的调试。

4.2 实现统一数据返回格式的功能

实现步骤可以分为以下两步:

  1. 自定义统一数据返回处理类,标注上@ControllerAdvice注解同时实现ResponseBodyAdvice接口。
  2. 实现接口中的supports方法和beforeBodyWrite方法并在该方法中进行统一数据格式的处理。

我们来实现通统一数据返回格式的功能,学习下其中的细节和注意事项:


通过上述的实现过程,我们可以总结出同意数据返回功能实现时要注意:

  1. 当Controllerapi返回的时String格式时,会发生类转换异常。原因及解决办法在上述图片中已经详细总结出来了。

5.总结

  1. 统一用户登陆权限校验
    创建自定义拦截器实现HandlerInterceptor接口并重写preHandler方法;创建自定义系统配置类实现WebMvcConfigurer接口,并标注@Configuration注解交由Spring进行管理,接着重写addInterceptors方法将自定义拦截器加入到系统配置中并配置拦截规则。
  2. 统一异常处理
    自定义统一异常处理类,并标注@ControllerAdvice注解。编写异常捕获处理方法,标注上@ExceptionHandler注解并指明要捕获的异常类型,在方法中编写统一异常处理逻辑代码。
  3. 统一数据返回格式
    自定义统一格式处理类实现ResponseBodyAdvice接口,标注上@ControllerAdvice注解,并重写接口中的supportsbeforeBodyWrite方法(注意返回类型是String的情况)。

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

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

C++ vector类成员函数介绍

目录 🤔vector模板介绍: 🤔特点: 🤔vector的成员函数: 🔍vector构造函数: 🔍vector赋值函数 🔍vector容器的判断函数 resize函数的重点内容: …

chatgpt赋能python:Python中的并:优化代码执行效率的利器

Python中的并:优化代码执行效率的利器 Python作为一种优秀的编程语言,被广泛使用于各种各样的项目中。然而,随着程序的不断扩张,代码的复杂度日益增加,执行效率也愈加遇到了严峻的挑战。在这种情况下,Pyth…

Linux系统下imx6ull QT编程—— Ubuntu 下编写程序(一)

Linux QT编程 文章目录 Linux QT编程前言一、C简介二、C环境设置1.安装编译 C 语言和 C的环境。2.创建文件编写代码3.编译运行代码 总结 前言 绍在 Ubuntu 在终端窗口下使用 vi/vim 编辑一个 C源文件。通过编写最简单的示例“Hello,World QCX”。 一、C简介 C (c…

【分布式应用】ELK企业级日志分析系统

一、ELK 简介 ELK平台是一套完整的日志集中处理解决方案,将 ElasticSearch、Logstash 和 Kiabana 三个开源工具配合使用, 完成更强大的用户对日志的查询、排序、统计需求。 1.1 ELK各组件介绍 ElasticSearch: 是基于Lucene(一个…

Scala初识

1.scala简介 是一种多范式的编程语言,其设计的初衷是要集成面向对象编程和函数式编程的各种特性。Scala运行于Java平台(Java虚拟机)并兼容现有的Java程序。 scala特点 1.Scala是面向对象的 Scala是一种纯粹的面向对象语言,每一个…

Node.js 中的代码调试

目录 1、启用 Inspector 2、安全隐患 3、Inspector 客户端 4、启用远程调试的情形 5、以前的Debugger 1、启用 Inspector 当使用 --inspect 开关时,Node.js 进程开始侦听调试客户端,默认情况下侦听 127.0.0.1:9229 的域名和端口号;每个…

华为OD机试真题B卷 Java 实现【Linux 发行版的数量】,附详细解题思路

一、题目描述 Linux 操作系统有多个发行版,distrowatch.com 提供了各个发行版的资料。这些发行版互相存在关联,例如 Ubuntu 基于 Debian 只开发而 Mint 又基于 Ubuntu 开发,那么我们认为 Mint 同 Debian 也存在关联。 发行版集是一个或多个…

用Python求最大公约数和最小公倍数(51)

小朋友们好,大朋友们好! 我是猫妹,一名爱上Python编程的小学生。 和猫妹学Python,一起趣味学编程。 今日主题 什么是最大公约数? 如何用Python求最大公约数? 什么是最小公倍数? 如何用Pyt…

chatgpt赋能python:Python中的连接符:介绍与应用

Python中的连接符:介绍与应用 在Python编程中,连接符起着关键性的作用,它是连接不同代码部分的纽带。本篇文章将重点介绍几种常用的Python连接符。 一、加号连接符() 加号连接符最常见,用于连接不同的字…

一文读懂TSC时钟: (x86_64/arm64)实现介绍和编程使用

Linux(16)之Time Stamp Counter Author:Once Day Date:2023年5月30日 参考文档: 4. Environment Abstraction Layer — Data Plane Development Kit 23.03.0 documentation (dpdk.org)DPDK: lib/eal/include/generic/rte_cycles.h File Reference测量…

交换机安全功能介绍

今天海翎光电的小编来给大家聊聊以太网交换机安全功能。 交换机作为局域网中最常见的设备,在安全上面临着重大威胁,这些威胁有的是针对交换机管理上的漏洞,攻击者试图控制交换机。有的针对的是交换机的功能,攻击者试图扰乱交换机的…

新手快速学会使用DDL对数据库和表的操作

前言 SQL是一种操作关系型数据库的结构化查询语言。今天这篇文章将详细讲述数据定义语言DDL对数据库和表的相关操作。 文章目录 前言1. DDL-操作数据库1.1 查询1.2 创建数据库1.3 删除数据库1.4 使用数据库2.1 数据类型2.2 查询表2.3 创建表2.4 删除表2.5 修改表 3. 实战案例详…

统计学的假设检验/置信区间计算

假设检验的核心其实就是反证法。反证法是数学中的一个概念,就是你要证明一个结论是正确的,那么先假设这个结论是错误的,然后以这个结论是错误的为前提条件进行推理,推理出来的结果与假设条件矛盾,这个时候就说明这个假…

Navicat 15获取用户的密码

我使用Navicat连接好了mysql但是密码忘记了;可以通过如下操作找回密码 我使用的Navicat版本是 15.0.27 1、选择文件 --> 导出连接 2、选择你要知道密码的连接  勾选导出密码(默认位置是桌面) 3、 在Password 这栏找到加密后的密码 …

基于Android应用开发实现UWB(超宽带)通信

什么是超宽带UWB 超宽带通信是一种无线电技术,专注于设备之间的精确测距(测量位置的精度为 10 厘米)。这种无线电技术可以使用低能量密度进行短距离测量,并在大部分无线电频谱上执行高带宽信号传输。UWB 的带宽大于 500 MHz(或超过 20% 的小数带宽)。 从 Android 13 开…

[GXYCTF2019]Ping Ping Ping解题过程

1、来看看靶场 发现就只有这个提示,尝试一下在url输入框进行测试 页面返回ping的结果,然后我之前也做过另外一道类似的题 链接:[ACTF2020 新生赛]Exec1命令注入_[actf2020 新生赛]exec 1_旺仔Sec的博客-CSDN博客 尝试用管道符 果然是可以的…

chatgpt赋能python:Python中语句太长之续行符的使用

Python中语句太长之续行符的使用 如果你是一位有10年Python编程经验的工程师,那么你一定会遭遇语句太长的问题。这是导致程序出错的常见问题。在很多情况下,一条语句的长度会超过Python规定的最大长度,这时候我们就需要使用续行符进行换行了…

C语言——数据在内存中的存储(上)

数据在内存中的存储 1. 数据类型的介绍 之前已经介绍过C语言中的基本数据类型了,主要有: char //字符数据类型short //短整型int //整形long //长整型long long //更长的整形float //单精度浮点数double //双精度浮点数 注意:C语言中是是没…

JVM学习笔记(中)

1、垃圾回收算法 标记清除法 特点: 速度较快会产生内存碎片 注意:这里的清除并不是真正意义上的清除,即每个字节都清0,而是记录一下被清除的对象的起始和结束的地址,当下一次分配给一个新对象时,新对象…

一文看懂数字化转型丨三叠云

相信很多朋友在最近这几年对“数字化”、“数字化转型”等名词听得很多了吧,去网上搜搜“数字化转型”,这几年各式各样的信息如火如荼,充斥着互联网平台和大大小小的企业。 一、什么是数字化转型? 那么“数字化”和“数字化转型”…