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

最新推荐文章于 2023-08-05 20:02:15 发布

小s的s

最新推荐文章于 2023-08-05 20:02:15 发布

阅读量1.7k

点赞数 1

分类专栏： JavaEE 文章标签： spring java 后端 SpringBoot SpringMVC

本文链接：https://blog.csdn.net/weixin_64450588/article/details/130891240

版权

JavaEE 专栏收录该内容

27 篇文章 0 订阅

订阅专栏

1. SpringBoot统一功能处理简介

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

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

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

1.SpringBoot统一功能处理简介

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

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

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

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

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

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

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

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

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

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

0.准备工作。

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

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

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

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

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

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

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

3. 统一异常处理

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

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

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

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

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

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

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

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

4. 统一数据返回格式

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

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

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

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

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

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

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

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

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

5.总结

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