SpringBoot 统一功能的处理

SpringBoot 统一功能的处理

文章目录

  • SpringBoot 统一功能的处理
    • 1. 用户登录权限校验
      • 1.1 最初用户登录验证
      • 1.2 Spring AOP 统一用户登录验证的问题
      • 1.3 SpringAOP 拦截器
        • 1.3.1 实现自定义拦截器
        • 1.3.2 将自定义拦截器加入到系统配置
      • 1.4 拦截器实现原理
        • 1.4.1 实现流程图
        • 1.4.2 实现源码剖析
      • 1.5 统一访问前缀添加
    • 2. 统一异常处理
      • 2.1 创建一个异常处理类
      • 2.2 创建异常检测的类和异常处理方法
    • 3. 统一数据返回
      • 3.1为什么需要统一数据返回?
      • 3.2 统一数据返回格式的实现
      • 3.3 统一异常处理在遇到 String 返回类型时报错的问题
      • 3.4 ControllerAdvice 源码剖析

1. 用户登录权限校验

1.1 最初用户登录验证

@RestController
@RequestMapping("/user")
public class UserController {
/**
* 某⽅法 1
*/
@RequestMapping("/m1")
public Object method(HttpServletRequest request) {
  // 有 session 就获取，没有不会创建
  HttpSession session = request.getSession(false);
  if (session != null && session.getAttribute("userinfo") != null) {
  // 说明已经登录，业务处理
  return true;
  } else {
  // 未登录
  return false;
	}
}
/**
* 某⽅法 2
*/
@RequestMapping("/m2")
public Object method2(HttpServletRequest request) {
  // 有 session 就获取，没有不会创建
  HttpSession session = request.getSession(false);
  if (session != null && session.getAttribute("userinfo") != null) {
  // 说明已经登录，业务处理
  return true;
  } else {
  // 未登录
  return false;
	}
}
// 其他⽅法...
}

从上述代码中可以看出每个方法都相同的登录权限校验 , 这样做的缺点是:

  • 每个方法中都要单独写用户登录验证的方法 , 即使封装成公共方法 , 也一样要在方法中传参判断.
  • 添加控制器越多, 调用用户登录的方法也越多 , 这样后期会增大维护成本.
  • 用户登录方法与接下来的业务实现没有任何关联 , 但还是要每个方法中写一遍.

因此, 使用 AOP 思想, 进行统一用户登录验证迫在眉睫.

1.2 Spring AOP 统一用户登录验证的问题

一说到用户登录验证 , 第一个想到的方法就是 , Spring AOP 前置或环绕通知来实现 , 具体实现代码如下:

import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
import org.springframework.stereotype.Component;
@Aspect
@Component
public class UserAspect {
  // 定义切点⽅法 controller 包下、⼦孙包下所有类的所有⽅法
  @Pointcut("execution(* com.example.demo.controller..*.*(..))")
  public void pointcut(){ }
  // 前置⽅法
  @Before("pointcut()")
  public void doBefore(){
  }
  // 环绕⽅法
  @Around("pointcut()")
  public Object doAround(ProceedingJoinPoint joinPoint){
    Object obj = null;
    System.out.println("Around ⽅法开始执⾏");
    try {
    // 执⾏拦截⽅法
    obj = joinPoint.proceed();
    } catch (Throwable throwable) {
    throwable.printStackTrace();
    }
    System.out.println("Around ⽅法结束执⾏");
    return obj;
  }
}

但是在 Spring AOP 的切面中实现用户登录校验有以下两个缺点:

  • 没法获取到 HttpSession 对象
  • 由于需要拦截一部分方法 , 另一部分是不拦截的 , 如注册和登录方法不拦截 , 这样的话排除规则将无法定义.

1.3 SpringAOP 拦截器

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

  • 创建自定义拦截器 , 实现 HandlerInterceptor 接口的 preHandle(执行具体方法之前的预处理) 方法.
  • 将自定义拦截器加入 WebMvcConfigurer 的 addInterceptors 方法中.

具体实现如下:

1.3.1 实现自定义拦截器

//定义拦截器
@Component
public class LoginInterceptor implements HandlerInterceptor {
//    调用目标方法之前执行的方法
//    此方法返回 boolean 类型的值 , 如果返回值为 true, 继续执行剩余流程, 否则表示拦截器验证未通过, 剩余的不在执行

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        HttpSession session = request.getSession(false);
        if (session != null || session.getAttribute("session_userinfo") != null){
            return true;
        }
      //如果执行失败不能直接给前端返回一个状态码, 后端必须明确告诉前端异常信息, 但状态码必须是200, 
      //原理类似于确认应答, 如果是异常状态码前端无法接收到信息.
      	response.setContentType("application/json;charset=utf8");
        response.getWriter().println("{\"code\":-1, \"msg\":\"登录失败\", \"data\":\"\"}");
        return false;
    }
}

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

@Configuration
public class MyConfig implements WebMvcConfigurer {
    @Autowired
    private LoginInterceptor loginInterceptor;
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(loginInterceptor)
                .addPathPatterns("/**")
                .excludePathPatterns("/user/login")//排除登录
                .excludePathPatterns("/user/reg");//排除注册
    }
}

其中:

  • addPathPatterns() 表示需要拦截的 URL
  • excludePathPatterns() 表示需要排除的 URL

1.4 拦截器实现原理

1.4.1 实现流程图

Spring 项目中 , 正常的程序调用如下:

然而有了拦截器之后 , 就会在 Controller 之间进行预处理操作:

1.4.2 实现源码剖析

通过观察 Spring Boot 控制台的打印信息可知 , 所有的 Controller 执行都会通过一个调度器 DispatcherServlet 来实现.

image-20230713212836088

所有方法都会执行 DispatcherServlet 中的 doDispatch 调度方法 , doDispatch 源码如下:

image-20230713213143501

通过源码可以看出 , 执行 Controller 之前, 会先调用预处理方法 applyPreHandle() , applyPreHandle() 源码如下:

boolean applyPreHandle(HttpServletRequest request, HttpServletResponse response) throws Exception {
        for(int i = 0; i < this.interceptorList.size(); this.interceptorIndex = i++) {
          //获取所有拦截器, 并调用preHandle()方法
            HandlerInterceptor interceptor = (HandlerInterceptor)this.interceptorList.get(i);
            if (!interceptor.preHandle(request, response, this.handler)) {
                this.triggerAfterCompletion(request, response, (Exception)null);
                return false;
            }
        }

        return true;
    }

通过源码可以看出 , applyPreGHandle() 会获取所有拦截器 HandlerInterceptor 并执行其中的 preHandle()方法 , 由此就与上文中的拦截器定义相对应.

image-20230713213742581

通过上述源码分析 , 拦截器也是通过动态代理和环绕通知是思想实现的 , 大体流程如下:

image-20230713214218243

1.5 统一访问前缀添加

在企业开发中 , 如果我们的项目工程较大且多个项目部署到同一台服务器上 , 如果不给具体的项目添加前缀 , 那么就会极大的增加维护成本.

eg. 给当前项目所有请求地址添加 api 前缀:

@Configuaration
public class AppConfig implement WebMvcConfigurer(){
  @Override
  public void configurePathMatch(PathMatchConfigure configure){
    configure.addPathPrefix("api",c -> true)
  }
}

第二个参数为表达式 , 设置 true 表示启动前缀.

那么后续访问时 , URL 都需要加上 api 前缀.

image-20230713215315206

2. 统一异常处理

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

无论后端执行结果如何 , 都会给前端返回一个明确的信息.

2.1 创建一个异常处理类

import java.util.HashMap;

@ControllerAdvice//针对 Controller 的增强方法, 会检测控制器的异常
public class MyExceptionAdvice{
  
}

2.2 创建异常检测的类和异常处理方法

import java.util.HashMap;

@ControllerAdvice//针对 Controller 的增强方法, 会检测控制器的异常
@ResponseBody //返回非静态页面 (数据)
public class MyExceptionAdvice{
  @ExceptionHandler(NullPointerException.class)
  public HashMap<String, Object> doNullPointerException(NullPointerException e){
    HashMap<String, 0bject> result = new HashMap<>();
    result.put("code", -1);
    result.put("msg", "空指针: " + e.getMessage());
    result.put("data", null);
    return result;
  }
  //默认异常处理, 当具体异常匹配不到时, 执行此方法
  @ExceptionHandler(Exception.class)
  public HashMap<String, Object> doException(Exception e){
    HashMap<String, 0bject> result = new HashMap<>();
    result.put("code", -300);
    result.put("msg", "Exception: " + e.getMessage());
    result.put("data", null);
    return result;
  }
}

3. 统一数据返回

3.1为什么需要统一数据返回?

  1. 方便前端程序员更好的接收和解析数据接口返回的数据
  2. 降低前后端沟通成本
  3. 有利于统一的数据维护和修改
  4. 有利于后端技术部门统一标准的规定

保底策略 , 强制性统一数据返回 , 返回数据之前进行数据重写

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

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

@ControllerAdvice
public class ResponseAdvice implements ResponseBodyAdvice {
    //只有 true 时, 才会执行 beforeBodyWriter()
    @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) {
        //首先判断是否已经是标准格式了
        if (body instanceof HashMap){
            return body;
        }
        // 重写返回结果, 让其返回一个统一的数据格式
        HashMap<String, Object> result = new HashMap<>();
        result.put("code", 200);
        result.put("msg", null);
        result.put("data", body);
        return result;
    }
}

Tips: 实际开发中 , 通常不建议将 HashMap 作为返回类型 , 因为使用 HashMap 作为返回类型，无法提供类型信息，容易导致数据解析错误或类型转换异常 , 可读性差 , 维护困难.

3.3 统一异常处理在遇到 String 返回类型时报错的问题

当返回类型是 String 时

@RequestMapping("/login")
    public String login(){
        return "login";
    }

控制台抛出异常:

image-20230714215848923

如果剖析一下返回执行流程:

  1. 方法返回的是 String
  2. 统一数据返回之前处理 ----> String 转换为 HashMap
  3. 将 HashMap 转换为 application/json 字符串给前端

通过抓包可以看出 , 返回给前端的是 json 格式的数据 , 因此异常出现在第三步.

image-20230714221049837

第三步转换时 , 首先查看原 Body 的数据类型:

  1. 是 String --> 调用 StringHttpMessageConverter 进行类型转换
  2. 非 String --> 调用 HttpMessageConverter 进行类型转换

总而言之 , 原本是 HashMap 类型的数据 , 却被判断成 String 类型的数据 , 并调用 StringHttpMessageConverter 进行类型转换 , 于是就出现了 HashMap cannot be cast to java.lang.String

解决方案:

  1. 通过修改配置文件将 StringHttpMessageConverter 这个转换器从项目中去除.
  2. 在统一数据重写时 , 单独处理 String 类型 , 让其返回一个 String 字符串 , 而非 HashMap

解决方案一:

@Configuration
public class MyConfig implements WebMvcConfigurer {
    /**
     * 移除 StringHttpMessageConverter()
     * @param converters
     */
    @Override
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        converters.removeIf(converter -> converters instanceof StringHttpMessageConverter);
    }
}

解决方案二:

@Autowired
    private ObjectMapper objectMapper;
    @SneakyThrows
    @Override
    public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {
        //首先判断是否已经是标准格式了
        if (body instanceof HashMap){
            return body;
        }
        // 重写返回结果, 让其返回一个统一的数据格式
        HashMap<String, Object> result = new HashMap<>();
        result.put("code", 200);
        result.put("msg", null);
        result.put("data", body);
        if (body instanceof HashMap){
//            返回一个 String 字符串
            objectMapper.writeValueAsString(result);
        }
        return result;
    }

3.4 ControllerAdvice 源码剖析

点击 @ControllerAdvice 实现源码如下:

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface ControllerAdvice {
    @AliasFor("basePackages")
    String[] value() default {};

    @AliasFor("value")
    String[] basePackages() default {};

    Class<?>[] basePackageClasses() default {};

    Class<?>[] assignableTypes() default {};

    Class<? extends Annotation>[] annotations() default {};
}

从上述源码中可以看出 @ControllerAdvice 派生于 @Component 组件 , 而所有的组件初始化都会调用 InitializingBean 接口.

通过查询 InitializingBean , 可以发现其中 Spring MVC 实现子类是 RequestMappingHandlerAdapter , 里面有一个 afterPropertiesSet() 方法 , 表示所有参数设置完成之后执行的方法.

package org.springframework.beans.factory;

public interface InitializingBean {
    void afterPropertiesSet() throws Exception;
}

在 afterPropertiesSet() 中有一个 initControllerAdviceCache 方法, 此方法的源码如下:

image-20230715095324959

分析可知 , 该方法会查找所有的 @ControllerAdvice 类 , 这些类未被存入容器中 , 但发生某个时间时 , 会调用相应的 Advice 方法 , 比如返回数据前调用统一数据封装.
gHandlerAdapter , 里面有一个 afterPropertiesSet() 方法 , 表示所有参数设置完成之后执行的方法.

package org.springframework.beans.factory;

public interface InitializingBean {
    void afterPropertiesSet() throws Exception;
}

在 afterPropertiesSet() 中有一个 initControllerAdviceCache 方法, 此方法的源码如下:

[外链图片转存中…(img-mo8rbC9p-1689386373868)]

分析可知 , 该方法会查找所有的 @ControllerAdvice 类 , 这些类未被存入容器中 , 但发生某个时间时 , 会调用相应的 Advice 方法 , 比如返回数据前调用统一数据封装.

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

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

相关文章

快速批量改名文件！随机字母命名，让文件名更有创意！

快速批量改名文件！随机字母命名，让文件名更有创意！

想要让文件名更加有创意和个性化吗&#xff1f;不妨尝试使用随机字母来批量改名文件&#xff01;无论是照片、文档还是其他文件&#xff0c;只需要简单的几个步骤&#xff0c;您就可以为它们赋予一个独特的随机字母命名。这不仅可以帮助您整理文件&#xff0c;还能增加一些乐趣…
阅读更多...
查看mac是macOS x64还是macOS ARM64系统

查看mac是macOS x64还是macOS ARM64系统

打开终端输入&#xff1a; uname -a
阅读更多...
微信原生实现一个简易的图片上传功能

微信原生实现一个简易的图片上传功能

一、实现原理 wx.showActionSheet()&#xff1a;显示操作菜单&#xff0c;选择是从相册选择还是相机拍摄照片wx.chooseImage()&#xff1a;从本地相册选择图片或使用相机拍照。wx.uploadFile()&#xff1a;将本地资源上传到服务器。客户端发起一个 HTTPS POST 请求&#xff0c…
阅读更多...
【微信小程序-uniapp】CustomDialog 居中弹窗组件

【微信小程序-uniapp】CustomDialog 居中弹窗组件

1. 效果图 2. 组件完整代码 <template><uni-popup :ref="ref" type="center" @change
阅读更多...
编程小白的自学笔记十（python爬虫入门二+实例代码详解）

编程小白的自学笔记十（python爬虫入门二+实例代码详解）

系列文章目录 编程小白的自学笔记九&#xff08;python爬虫入门代码详解&#xff09; 编程小白的自学笔记八&#xff08;python中的多线程&#xff09; 编程小白的自学笔记七&#xff08;python中类的继承&#xff09; 编程小白的自学笔记六&#xff08;python中类的静态方法…
阅读更多...
一、音频基础-音频分析的重要工具（语谱图）

一、音频基础-音频分析的重要工具（语谱图）

文章目录 1. 傅里叶转换2. 语谱图3. 应用1. 傅里叶转换 通过前面的描述可以知道，声音的本质就是各种声波，那么任意某一个时刻，都不可能是只有一个频率的波，而且声波也不可能是我们理解的标准的正弦波： 而一般我们对声音进行处理时，需要分析出频率当中的有哪些频率，然…
阅读更多...
VScode 右键菜单加入使用用VSCode打开文件和文件夹【Windows】

VScode 右键菜单加入使用用VSCode打开文件和文件夹【Windows】

VScode 右键菜单加入使用用VSCode打开文件和文件夹【Windows】 介绍修改注册表添加右键打开文件属性修改注册表添加右键打开文件夹属性修改注册表添加右键空白区域属性 介绍 鼠标右击文件或者文件夹&#xff0c;可直接用VSCode打开&#xff0c;非常方便。但如果我们在安装VSCo…
阅读更多...
TypeScript 学习笔记(七)：条件类型

TypeScript 学习笔记(七)：条件类型

条件类型 TS中的条件类型就是在类型中添加条件分支&#xff0c;以支持更加灵活的泛型&#xff0c;满足更多的使用场景。内置条件类型是TS内部封装好的一些类型处理&#xff0c;使用起来更加便利。 一、基本用法 当T类型可以赋值给U类型时&#xff0c;则返回X类型&#xff0c…
阅读更多...
Vue 和 React 前端框架的比较

Vue 和 React 前端框架的比较

Vue 和 React 前端框架的比较 本文研究了流行的前端框架 Vue 和 React 之间的区别。通过对它们的学习曲线、视图层处理方式、组件化开发、响应式数据处理方式和生态系统及社区支持进行比较分析&#xff0c;得出了它们在不同方面的优劣和特点。该研究对于开发者在选择合适的前端…
阅读更多...
Ceph简介及部署

Ceph简介及部署

Ceph Ceph一、存储基础1、单机存储设备2、Ceph 简介3、Ceph 优势5、Ceph 架构6、Ceph 核心组件7、OSD 存储后端8、Ceph 数据的存储过程9、Ceph 版本发行生命周期10、Ceph 集群部署 二、部署ceph-deploy Ceph 集群前环境配置1、关闭 selinux 与防火墙2、根据规划设置主机名3、配…
阅读更多...
Cisco学习笔记（CCNA）——Introduction to TCP/IP

Cisco学习笔记（CCNA）——Introduction to TCP/IP

Introduction to TCP/IP 常见协议 应用层协议 协议 端口号 描述 HTTP 80 超文本传输协议&#xff0c;提供浏览网页服务 Telnet 23 远程登录协议&#xff0c;提供远程管理服务 FTP 20、21 文件传输协议&#xff0c;提供互联网文件资源共享服务 SMTP 25 简单邮件传…
阅读更多...
【Go语言开发】简单了解一下搜索引擎并用go写一个demo

【Go语言开发】简单了解一下搜索引擎并用go写一个demo

写在前面 这篇文章我们一起来了解一下搜索引擎的原理&#xff0c;以及用go写一个小demo来体验一下搜索引擎。 简介 搜索引擎一般简化为三个步骤 爬虫&#xff1a;爬取数据源&#xff0c;用做搜索数据支持。索引&#xff1a;根据爬虫爬取到的数据进行索引的建立。排序&#xf…
阅读更多...
LayUI之增删改查

LayUI之增删改查

目录 一、前言 1.1 前言 1.2 前端代码(数据表格组件) 1.3 封装JS 二、LayUI增删改查的后台代码 2.1 编写Dao方法 2.1 增加 2.2 删除 2.3 修改 三、LayUI增删改查的前端代码 3.1 增加 一、前言 1.1 前言 上一篇文章我们一起做了LayUI的动态添加选项卡&#xff0c;这一篇…
阅读更多...
【天工Godwork精品教程】天工3.1.7安装教程（附Godwork完整版下载地址）

【天工Godwork精品教程】天工3.1.7安装教程（附Godwork完整版下载地址）

本文讲解天工3.1.7安装过程（附Godwork完整版网盘下载地址）。 文章目录 一、天工3.1.7安装教程1. 安装GodWork-AT 3.1.72. 安装GodWork-AT 3.1.7补丁3. 安装GodWork-EOS-Setup-2017B-12314. 安装GodWork-EOS补丁5. 运行godwokr软件6. 生成ZC码7. 输入ZC码8. eos插件调用二、天…
阅读更多...
【大数据之Hadoop】三十七、Hadoop HA高可用

【大数据之Hadoop】三十七、Hadoop HA高可用

1、HA概述 实现高可用最关键的策略是消除单点故障。HA分成各个组件的HA机制&#xff1a;HDFS的HA和YARN的HA。   Hadoop2.0之前&#xff0c;在HDFS集群中NameNode存在单点故障&#xff08;SPOF&#xff09;。 NameNode主要在以下两个方面影响HDFS集群&#xff1a; &#xff…
阅读更多...
07-尚硅谷大数据技术之Spark源码

07-尚硅谷大数据技术之Spark源码

1. 环境准备&#xff08;Yarn 集群&#xff09; 搭建Spark on Yarn集群 3.3 Yarn 模式 独立部署&#xff08;Standalone&#xff09;模式由 Spark 自身提供计算资源&#xff0c;无需其他框架提供资源。这种方式降低了和其他第三方资源框架的耦合性&#xff0c;独立性非常强。但…
阅读更多...
PyTorch训练RNN, GRU, LSTM：手写数字识别

PyTorch训练RNN, GRU, LSTM：手写数字识别

文章目录 pytorch 神经网络训练demoResult参考来源 pytorch 神经网络训练demo 数据集&#xff1a;MNIST 该数据集的内容是手写数字识别&#xff0c;其分为两部分&#xff0c;分别含有60000张训练图片和10000张测试图片 图片来源&#xff1a;https://tensornews.cn/mnist_intr…
阅读更多...
每日一题2023.7.19|ACM模式

每日一题2023.7.19|ACM模式

文章目录 C的输入方式介绍cin>>cin.get(字符变量名)cin.get(数组名,接收字符数目)cin.get()cin.getline() getline()gets()getchar() AB问题|AB问题||AB问题|||ABⅣAB问题ⅤAB问题Ⅵ C的输入方式介绍 参考博客 cin>> 最基本&#xff0c;最常用的字符或者数字的输…
阅读更多...
TMS FlexCel for VCL FMX Crack

TMS FlexCel for VCL FMX Crack

TMS FlexCel for VCL & FMX Crack 强大、广泛和灵活的组件套件&#xff0c;用于VCL和FireMonkey的本地Excel报告、文件生成和操作。 FlexCel for VCL/FireMonkey是一套允许操作Excel文件的Delphi组件。它包括一个广泛的API&#xff0c;允许本地读/写Excel文件。如果您需要在…
阅读更多...
c#调用cpp库，debug时不进入cpp函数

c#调用cpp库，debug时不进入cpp函数

选中c#的项目&#xff0c;右击属性&#xff0c;进入属性页&#xff0c;点击调试&#xff0c;点击打开调试启动配置文件UI&#xff0c;打开启用本机代码调试。
阅读更多...
最新文章

Copyright @ 2022~2023