SpringBoot统一功能处理实现的全过程

目录
  • 前言
  • 1.用户登录权限效验
    • 1.1 Spring AOP 实现用户统一登录验证
    • 1.2 Spring 拦截器
      • 1.2.1 自定义拦截器
      • 1.2.2 将自定义拦截器加入到系统配置
    • 1.3 拦截器实现原理
  • 2.统一异常处理
  • 3.统一数据返回格式
    • 3.1 统一数据返回格式的优点
    • 3.2 统一数据返回格式的实现
  • 4.总结

前言

这篇文章主要介绍Spring Boot的统一功能处理模块,也是AOP的实战环节。

1.用户登录权限效验

在学习Spring AOP之前,用户登录权限的验证是由每个方法中自己验证。

1.1 Spring AOP 实现用户统一登录验证

而学习了Spring AOP之后,可以通过Spring AOP的前置通知环绕通知来实现,具体实现代码如下:

但如果在以上Spring AOP的切面中实现用户权限效验的功能,有以下两个问题:

1.没办法获取到HttpSession对象。

2.我们要对一部分方法进行拦截,而另一部分方法不拦截,如注册方法和登录方法是不拦截的,这样的话排除方法的规则很难定义,甚至没办法定义。

要解决上述问题,就需要使用下边的Spring拦截器:

1.2 Spring 拦截器

对于以上问题Spring中提供了具体的实现拦截器:HandlerInterceptor,拦截器的实现分为以下两个步骤:

1、创建自定义拦截器,实现 HandlerInterceptor 接口的perHandle(执行具体方法之前的预处理)方法。

2、将自定义拦截器加入 WebMvcConfigeraddInterceptors方法中。

具体实现如下:

1.2.1 自定义拦截器

自定义拦截器是一个普通类,具体实现代码如下:

1.2.2 将自定义拦截器加入到系统配置

将上一步中的自定义拦截器加入到系统配置信息中,具体实现代码如下:

其中:

  • addPathPatterns:表示需要拦截的URL,**表示拦截任意方法(也就是所有方法)
  • excludePathPatterns:表示需要排除的URL。

说明:以上拦截规则可以拦截此项目中使用的URL,包括静态文件(图片文件、JS和CSS等文件)。

1.3 拦截器实现原理

在用户调用Controller的方法之前,拦截器进行预处理,符合条件才会进一步调用Controller层的方法。

2.统一异常处理

在我们的程序出错时,前端可能根本不知道是由于什么原因,而导致程序不能正常运行,所以我们就需要通过统一异常的处理方式,使得前端获取到程序异常的具体原因,进而使得程序员更好的解决问题。

统一异常处理使用的是@ControllerAdvice+@ExceptionHandler来实现的,@ControllerAdvice表示控制器通知类,@ExceptionHandler是异常处理器,两个结合表示当出现异常的时候执行某个通知,也就是执行某个方法事件,具体实现代码如下:

方法名和返回值可以自定义,其中最重要的是@ExceptionHandler(Exception.class)注解。

以上方法表示,如果出现了异常,就可以返回给前端一个HashMap对象,我们也可以针对不同的异常返回不同的结果具体执行的异常通知符合当前异常向上依次匹配的规则

在浏览器中输入127.0.0.1:8080/user/reg,查看统一异常处理后的执行效果,可以发现,之前返回的是执行了 reg 方法,但现在如果程序再因为异常原因不能正常运行,前端就会获取到异常的原因了。

3.统一数据返回格式

3.1 统一数据返回格式的优点

  • 方便前端程序员更好的接受和解析后端数据接口返回的数据。
  • 降低前端程序员和后端程序员的沟通成本,按照某个格式实现就可以了,因为所有接口都是这样返回的。
  • 有利于项目统一数据的维护和修改。
  • 有利于后端技术部门的统一规范的标准制定,不会出现稀奇古怪的返回内容。

3.2 统一数据返回格式的实现

统一的数据返回格式可以使用@ControllerAdvice+ResponseBodyAdvice的方式实现,具体实现代码如下:

在浏览器输入127.0.0.1:8080/user/login,在统一数据格式之前,前端页面接收到的参数为布尔类型true/false,而现在返回的就是统一格式的数据了。

4.总结

  • 统一用户登录权限的效验使用WebMvcConfigurer+HandlerInterceptor来实现
  • 统一异常处理使用@ControllerAdvice+@ExceptionHandler来实现
  • 统一返回值处理使用@ControllerAdvice+ResponseBodyAdvice来处理

到此这篇关于SpringBoot统一功能处理实现的文章就介绍到这了,更多相关SpringBoot统一功能处理内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们!

(0)

相关推荐

  • Spring Boot实现功能的统一详解

    目录 1. 统一用户登录权限验证 1.1 自定义拦截器 1.2 将自定义拦截器加入到系统配置 1.3 运行结果 1.4 总结 2. 统一异常处理 2.1 代码实现 2.2 运行结果 3. 统一数据返回格式 3.1 代码实现 3.2 运行结果 1. 统一用户登录权限验证 拦截器的实现分为两步: 创建自定义拦截器, 实现 HandlerInterceptor 接口并重写 preHandle 方法 配置拦截器和拦截规则, (将自定义拦截器加入 WebMvcConfigurer 的 addInterce

  • SpringBoot统一功能处理的方式详解

    目录 SpringMVC统一处理的三种方式 1.基于SpringMVC的配置类扩展 2.统一的响应数据格式封装 3.统一异常处理 基于SpringAOP已经实现统一功能增强,但如果希望对Controller增强,就无法获取其中的http请求数据.因此,实现以下这些统一增强的业务,就不能使用SpringAOP: 响应数据统一封装 统一异常处理(返回错误信息的http响应) http请求日志记录 SpringMVC统一处理的三种方式 SpringMVC在SpringBoot项目中,是默认进行了配置,

  • SpringBoot统一功能处理实现的全过程

    目录 前言 1.用户登录权限效验 1.1 Spring AOP 实现用户统一登录验证 1.2 Spring 拦截器 1.2.1 自定义拦截器 1.2.2 将自定义拦截器加入到系统配置 1.3 拦截器实现原理 2.统一异常处理 3.统一数据返回格式 3.1 统一数据返回格式的优点 3.2 统一数据返回格式的实现 4.总结 前言 这篇文章主要介绍Spring Boot的统一功能处理模块,也是AOP的实战环节. 1.用户登录权限效验 在学习Spring AOP之前,用户登录权限的验证是由每个方法中自己

  • Spring AOP统一功能处理示例代码

    目录 1. 什么是Spring AOP? 2. 为什要用 AOP? 3. Spring AOP 应该怎么学习呢? 3.1AOP组成 3.1.1 切面(Aspect) 3.1.2 连接点(Join Point) 3.1.3 切点(Pointcut) 3.1.4 通知(Advice) 3.2 Spring AOP实现 3.2.1 添加 AOP 框架支持 3.2.2 定义切面和切点. 3.2.3 定义相关通知 3.3 Spring AOP 实现原理 3.3.1 动态代理 3.3.2 JDK和CGLIB

  • SpringBoot统一处理功能实现的全过程

    目录 登录校验 异常处理 原理 返回数据结构 在处理网络请求时,有一部分功能是需要抽出来统一处理的,与业务隔开. 登录校验 可以利用spring mvc的拦截器Interceptor,实现HandlerInterceptor接口即可.实现该接口后,会在把请求发给Controller之前进行拦截处理. 拦截器的实现分为以下两个步骤: 创建⾃定义拦截器,实现 HandlerInterceptor 接⼝的 preHandle(执⾏具体⽅法之前的预处理)⽅法. 将⾃定义拦截器加⼊ WebMvcConfi

  • SpringBoot统一api返回风格的实现

    学过上一章的人也许发现问题了,接口返回的格式基本都是固定的,例如 { "code": 200, "msg": "", "data": "Object ....", } 而我们的登陆却返回 密码必须传!等等返回值 显然我们的返回格式不符合常规开发,因为前台并不知道这是错误信息还是正确返回信息! 所以我们简单封装一个返回类,代码如下 添加base包,新建BaseResult类 import lombok.Dat

  • 详解SpringBoot 统一后端返回格式的方法

    目录 为什么要对SpringBoot返回统一的标准格式 定义返回标准格式 定义返回对象 定义状态码 统一返回格式 高级实现方式 接口异常问题 SpringBoot为什么需要全局异常处理器 如何实现全局异常处理器 体验效果 全局异常接入返回的标准格式 首先我们来看看为什么要返回统一的标准格式? 为什么要对SpringBoot返回统一的标准格式 在默认情况下,SpringBoot的返回格式常见的有三种: 第一种:返回 String @GetMapping("/hello") public

  • SpringBoot统一返回格式的方法详解

    目录 前言 1. 直接返回结果 2. 约定返回格式 3. 返回统一格式结果 4. 切片封装统一格式 编写注解 编写ControllerAdvice 见证奇迹的时刻到了 5. 自定义返回格式 场景1:返回成功时code为200 场景2:自定义返回格式 前言 目前很多项目都是前后端分离,前后端会事先约定好返回格式.那么后端如何做,才能优雅的返回统一格式呢,接下来,请大家跟着我,一步步来实现. 1. 直接返回结果 先看一下最基本的例子,直接将结果原封不动返回: @Data @AllArgsConstr

  • SpringBoot 统一异常处理详解

    代码结构 配置pom文件 <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/

  • SpringBoot 统一请求返回的实现

    目前我们的返回是直接把实体类扔给请求方,这样很不友好,一方面没有统一的格式,二来请求方不知道请求成功与否,没有一个可以判断的东西,也没有说明性的返回. 本篇就来为所有接口提供一个统一的友好返回. 确定返回结构 首先,我们先确定好我们接口返回的格式是什么样的,然后再一步一步实现下面的. { "code": 200, "msg": "ok", "data": "" } code 字段表示状态码,调用方根据该码来

  • springboot统一接口返回数据的实现

    一,没有异常的情况,正常返回数据 希望接口统一返回的数据格式如下: { "status": 0, "msg": "成功", "data": null } 和接口数据对应的bean /** * 统一返回结果的实体 * @param <T> */ public class Result<T> implements Serializable { private static final long serial

随机推荐