SpringBoot—统一功能处理

news2024/11/15 21:30:13

SpringBoot—统一功能处理

  • 🔎小插曲(通过一级路由调用多种方法)
  • 🔎使用拦截器实现用户登录权限的统一校验
    • 自定义拦截器
    • 将自定义拦截器添加至配置文件中
    • 拦截器的实现原理
    • 统⼀访问前缀添加
  • 🔎统一异常的处理
  • 🔎统一数据格式的返回
    • 统一数据格式返回的优点
    • 统一数据格式返回的实现
  • 🔎总结

利用 AOP 的思想对一些特定的功能进行统一的处理, 包括

  • 使用拦截器实现用户登录权限的统一校验
  • 统一异常的处理
  • 统一数据格式的返回

🔎小插曲(通过一级路由调用多种方法)


通过一级路由调用多种方法, 需要保证这些方法的请求类型各不相同(GET, POST, PUT…)

在这里插入图片描述

在这里插入图片描述

在这里插入图片描述

🔎使用拦截器实现用户登录权限的统一校验


使用 Spring AOP 可以实现统一拦截, 但 Spring AOP 的使用较为复杂, 包括

  1. 定义拦截的规则(切点表达式)较为复杂
  2. 在切面类中拿到 HttpSession 较为复杂

于是 Pivotal 公司针对上述情况开发出 Spring 拦截器

Spring 拦截器的使用🍂

  1. 自定义拦截器
    • 实现 HandlerInterceptor 接口
    • 重写 preHandler 方法, 在方法中编写业务代码
  2. 将自定义拦截器添加至配置文件中, 并设置拦截的规则

自定义拦截器


在这里插入图片描述

将自定义拦截器添加至配置文件中


  • addPathPatterns, 表示需要拦截的 URL
    (/*表示一级路由, /**表示所有的请求)
  • excludePathPatterns, 表示不需要拦截的 URL
    在这里插入图片描述

拦截器的实现原理


调用方法时, 发现 DispatcherServlet

Dispatcher → 调度器

在这里插入图片描述

所有方法都会执行 DispatcherServlet 中的 doDispatch—调度方法

拦截器(doDispatch)的实现源码🌰

protected void doDispatch(HttpServletRequest request, HttpServletResponse response) throws Exception {
     HttpServletRequest processedRequest = request;
     HandlerExecutionChain mappedHandler = null;
     boolean multipartRequestParsed = false;
     WebAsyncManager asyncManager = WebAsyncUtils.getAsyncManager(request);

     try {
         try {
             ModelAndView mv = null;
             Object dispatchException = null;

             try {
                 processedRequest = this.checkMultipart(request);
                 multipartRequestParsed = processedRequest != request;
                 mappedHandler = this.getHandler(processedRequest);
                 if (mappedHandler == null) {
                     this.noHandlerFound(processedRequest, response);
                     return;
                 }

                 HandlerAdapter ha = this.getHandlerAdapter(mappedHandler.getHandler());
                 String method = request.getMethod();
                 boolean isGet = HttpMethod.GET.matches(method);
                 if (isGet || HttpMethod.HEAD.matches(method)) {
                     long lastModified = ha.getLastModified(request, mappedHandler.getHandler());
                     if ((new ServletWebRequest(request, response)).checkNotModified(lastModified) && isGet) {
                         return;
                     }
                 }

                 if (!mappedHandler.applyPreHandle(processedRequest, response)) {
                     return;
                 }

                 mv = ha.handle(processedRequest, response, mappedHandler.getHandler());
                 if (asyncManager.isConcurrentHandlingStarted()) {
                     return;
                 }

                 this.applyDefaultViewName(processedRequest, mv);
                 mappedHandler.applyPostHandle(processedRequest, response, mv);
             } catch (Exception var20) {
                 dispatchException = var20;
             } catch (Throwable var21) {
                 dispatchException = new NestedServletException("Handler dispatch failed", var21);
             }

             this.processDispatchResult(processedRequest, response, mappedHandler, mv, (Exception)dispatchException);
         } catch (Exception var22) {
             this.triggerAfterCompletion(processedRequest, response, mappedHandler, var22);
         } catch (Throwable var23) {
             this.triggerAfterCompletion(processedRequest, response, mappedHandler, new NestedServletException("Handler processing failed", var23));
         }

     } finally {
         if (asyncManager.isConcurrentHandlingStarted()) {
             if (mappedHandler != null) {
                 mappedHandler.applyAfterConcurrentHandlingStarted(processedRequest, response);
             }
         } else if (multipartRequestParsed) {
             this.cleanupMultipart(processedRequest);
         }

     }
}

在这里插入图片描述

当返回结果为 false 时, 拦截器将不会进行后续操作

在这里插入图片描述

applyPreHandle 的源码🌰

boolean applyPreHandle(HttpServletRequest request, HttpServletResponse response) throws Exception {
    for(int i = 0; i < this.interceptorList.size(); this.interceptorIndex = i++) {
        HandlerInterceptor interceptor = (HandlerInterceptor)this.interceptorList.get(i);
        if (!interceptor.preHandle(request, response, this.handler)) {
            this.triggerAfterCompletion(request, response, (Exception)null);
            return false;
        }
    }

    return true;
}

分析源码🍂

在 applyPreHandle 中会获取所有的拦截器 HandlerInterceptor, 并执行 HandlerInterceptor 中的 preHandle 方法

即自定义拦截器中重写的 preHandle 方法

在这里插入图片描述

统⼀访问前缀添加


统⼀访问前缀的添加有 2 种方式

  1. 重写 configurePathMatch( )
  2. 在配置文件中添加

重写 configurePathMatch( ) 🍂

@Override
public void configurePathMatch(PathMatchConfigurer configurer) {
    configurer.addPathPrefix("/bibubibu", c -> true);
}
  • /bibubibu, 要添加的统一前缀
  • c -> true, 所有请求均添加统一前缀

在这里插入图片描述

在配置文件中添加🍂

server:
  servlet:
    context-path: /bibubibu

在这里插入图片描述

🔎统一异常的处理


统一异常的处理, 利用 2 个注解

  1. @ControllerAdvice → 感知异常
  2. @ExceptionHandler → 处理异常

未设置异常处理🍂

在这里插入图片描述

NullPointerException

在这里插入图片描述

ArithmeticException

在这里插入图片描述

设置异常处理🍂

@ControllerAdvice
@ResponseBody
public class MyExceptionHandler {

    /**
    * 拦截所有空指针异常, 进行统一数据格式的返回
    * @author bibubibu
    * @date 2023/7/9
    */
    @ExceptionHandler(NullPointerException.class)
    public HashMap<String, Object> nullPointerException(NullPointerException e) {
        HashMap<String, Object> map = new HashMap<>();
        map.put("status", -1);
        map.put("data", null);
        map.put("msg", "NullPointerException" + e.getMessage()); // 错误码的描述信息
        return map;
    }

    /**
    * 拦截所有算数异常, 进行统一数据格式的返回
    * @author bibubibu
    * @date 2023/7/9
    */
    @ExceptionHandler(ArithmeticException.class)
    public HashMap<String, Object> arithmeticException(ArithmeticException e) {
        HashMap<String, Object> map = new HashMap<>();
        map.put("status", -1);
        map.put("data", null);
        map.put("msg", "ArithmeticException" + e.getMessage()); // 错误码的描述信息
        return map;
    }

    /**
    * 拦截所有异常, 进行统一数据格式的返回
    * @author bibubibu
    * @date 2023/7/9
    */
    @ExceptionHandler(Exception.class)
    public HashMap<String, Object> exception(Exception e) {
        HashMap<String, Object> map = new HashMap<>();
        map.put("status", -1);
        map.put("data", null);
        map.put("msg", "Exception" + e.getMessage());
        return map;
    }
}

在这里插入图片描述

NullPointerException

在这里插入图片描述

ArithmeticException

在这里插入图片描述

🔎统一数据格式的返回


统一数据格式返回的优点


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

统一数据格式返回的实现


统一数据格式的返回, 利用注解 @ControllerAdvice + ResponseBodyAdvice(接口) 实现

未设置统一数据格式的返回🍂

@RestController
@RequestMapping("/user")
public class UserController {

    @RequestMapping("get-num")
    public Integer getNumber() {
        return (int) (Math.random() * 10 + 1);
    }

}

在这里插入图片描述

设置统一数据格式的返回🍂

  1. 自定义类(ResponseAdvice), 添加 @ControllerAdvice 注解
  2. 实现 ResponseBodyAdvice 接口, 重写 supports() 与 beforeBodyWrite()

supports() 类似于一个开关
当返回值为 true 时, 开启 beforeBodyWrite() 中编写的相关功能
当返回值为 false 时, 关闭 beforeBodyWrite() 中编写的相关功能

@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) {
        HashMap<String, Object> map = new HashMap<>();
        map.put("status", 200);
        map.put("data", body); // 此处的 Body 是 String 类型会出错
        map.put("msg", "");
        return map;
    }
}

在这里插入图片描述

当方法的返回值类型为 String 时

@RestController
@RequestMapping("/user")
public class UserController {

    @RequestMapping("/get-user")
    public String getUser() {
        System.out.println("执行 getUser()");
        return "getUser~~";
    }

}

当调用方法的返回值类型为 String 时, 设置统一数据格式的返回🍂

在这里插入图片描述

类型转换异常

在这里插入图片描述

解决方法

当调用方法的返回值类型为 String 时, 利用 jackson 完成类型转换

@ControllerAdvice
public class ResponseAdvice implements ResponseBodyAdvice {
    // 利用 jackson 转换 String
    @Autowired
    private ObjectMapper objectMapper;

    @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) {
        HashMap<String, Object> map = new HashMap<>();
        map.put("status", 200);
        map.put("data", body); // 此处的 Body 是 String 类型会出错
        map.put("msg", "");
        // 判断 Body 是否为 String 类型
        if(body instanceof String) {
            // 是 String 类型, 将 map 转换为 Json 格式
            try {
                return objectMapper.writeValueAsString(map);
            } catch (JsonProcessingException e) {
                e.printStackTrace();
            }
        }
        return map;
    }
}

在这里插入图片描述

在这里插入图片描述

🔎总结


  1. 用户登录权限的统一校验 → 实现 HandlerInterceptor 接口 + 重写 preHandler 方法 + 将自定义拦截器添加至配置文件中(实现 WebMvcConfigurer 接口)
  2. 统一访问前缀的添加 → 重写 configurePathMatch( ) / 在配置文件中添加
  3. 统一异常的处理 → 利用注解 @ControllerAdvice + @ExceptionHandler
  4. 统一数据格式的返回 → 利用注解 @ControllerAdvice + 实现接口 ResponseBodyAdvice

🌸🌸🌸完结撒花🌸🌸🌸

在这里插入图片描述

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

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

相关文章

linux中grep命令的常见用法

linux中grep命令的常见用法

作为linux中最为常用的三大文本&#xff08;awk&#xff0c;sed&#xff0c;grep&#xff09;处理工具之一&#xff0c;掌握好其用法是很有必要的。 首先谈一下grep命令的常用格式为&#xff1a;grep [选项] ”模式“ [文件] grep家族总共有三个&#xff1a;grep&#xff…
阅读更多...
leetcode 686. 重复叠加字符串匹配(KMP算法-java)

leetcode 686. 重复叠加字符串匹配(KMP算法-java)

重复叠加字符串匹配 leetcode 686. 重复叠加字符串匹配题目描述KMP 算法代码演示 KMP 算法 leetcode 686. 重复叠加字符串匹配 来源&#xff1a;力扣&#xff08;LeetCode&#xff09; 链接&#xff1a;https://leetcode.cn/problems/repeated-string-match 题目描述 给定两个字…
阅读更多...
MySql存储引擎介绍——InnoDB、MyISAM、Memory

MySql存储引擎介绍——InnoDB、MyISAM、Memory

文章目录 1.MySql体系结构2.存储引擎简介3.存储引擎的特点3.1 InnoDB存储引擎特点3.2 MyISAM存储引擎介绍3.3 Memory存储引擎介绍 4.三种存储引擎的特点5.存储引擎的选择6.小结 1.MySql体系结构 2.存储引擎简介 存储引擎就是存储数据、建立索引、更新/查询数据等技术的实现方式…
阅读更多...
python接口自动化（二十四）--unittest断言——中（详解）

python接口自动化（二十四）--unittest断言——中（详解）

简介 上一篇通过简单的案例给小伙伴们介绍了一下unittest断言&#xff0c;这篇我们将通过结合和围绕实际的工作来进行unittest的断言。这里以获取城市天气预报的接口为例&#xff0c;设计了 2 个用例&#xff0c;一个是查询北京的天气&#xff0c;一个是查询 南京为例&#xf…
阅读更多...
剑指offer55.二叉树的深度

剑指offer55.二叉树的深度

这道题只要想到一棵树的最大深度 max(左子树的最大深度&#xff0c; 右子树的最大深度) 1&#xff1b;就能做出来&#xff0c;利用这个规律递归就出来了。 class Solution {int max,k 1;public int maxDepth(TreeNode root) {if(root null) return 0;return dfs(root);}pr…
阅读更多...
【大数据趋势】7月9日 汇率，美澳，恒指期货的大数据趋势概率分析。

【大数据趋势】7月9日 汇率，美澳，恒指期货的大数据趋势概率分析。

1. 数据源头之一 : 美元汇率 美元国债利息持续上行&#xff0c;美元承压&#xff0c;阶段性弱势是明显的。行情这个位置震荡许久&#xff0c;比较大概率能力不佳&#xff0c;有破位可能。从中期趋势来看&#xff0c;正在一个阶段性一层一层往下走的形态下&#xff0c;处于一次…
阅读更多...
使用Gradio库创建交互式散点图

使用Gradio库创建交互式散点图

❤️觉得内容不错的话&#xff0c;欢迎点赞收藏加关注&#x1f60a;&#x1f60a;&#x1f60a;&#xff0c;后续会继续输入更多优质内容❤️ &#x1f449;有问题欢迎大家加关注私戳或者评论&#xff08;包括但不限于NLP算法相关&#xff0c;linux学习相关&#xff0c;读研读博…
阅读更多...
【二分查找】367. 有效的完全平方数

【二分查找】367. 有效的完全平方数

367. 有效的完全平方数 解题思路 使用二分查找查找区间是[1,num]针对mid * mid和num进行比较 然后更改查找区间 class Solution {public boolean isPerfectSquare(int num) {// 二分查找 // 区间就是[1,num.length]long left 1;long right num;long mid 0;while(left <…
阅读更多...
高薪Offer收割机之Redis的数据持久化

高薪Offer收割机之Redis的数据持久化

Redis的数据持久化有两种方式：RDB和AOF 先来看第一种方式RDB持久化： RDB全称Redis Database Backup file（Redis数据备份文件），也被叫做Redis数据快照，简单的说就是把内存中所有的数据都记录到磁盘中，当Redis服务器重启以后，从磁盘中读取文件恢复内存中的数据。 有两…
阅读更多...
Windows平台软件工程关键路径PDM图

Windows平台软件工程关键路径PDM图

我是荔园微风&#xff0c;作为一名在IT界整整25年的老兵&#xff0c;今天来聊聊Windows平台下软件工程实践中涉及关键路径问题时常用的PDM图。 PDM图 我们用工程实例来完整讲解PDM图的节点表示&#xff0c; ES(最早开始时间) 、 LS(最迟开始时间)、EF(最早完成时间)、LF(最迟…
阅读更多...
12 Java选择语句（switch)

12 Java选择语句（switch)

1 选择语句常规用法 switch语法如下&#xff1a; swicth(输入的变量){ case 1 : //如果变量等于1 System.out.println("星期一"); break; case 2 : //如果变量等于2 System.out.println("星期二"); break; default: // 如果变量不是1和2 System.out.pr…
阅读更多...
【Python】Python项目打包发布（五）（制作Windows安装包)

【Python】Python项目打包发布（五）（制作Windows安装包)

Python项目打包发布汇总 【Python】Python项目打包发布&#xff08;一&#xff09;&#xff08;基于Pyinstaller打包多目录项目&#xff09; 【Python】Python项目打包发布&#xff08;二&#xff09;&#xff08;基于Pyinstaller打包PyWebIO项目&#xff09; 【Python】Pytho…
阅读更多...
学生成绩管理系统实现（CSS+JQuery+PHP+MySQL）

学生成绩管理系统实现（CSS+JQuery+PHP+MySQL）

学生成绩管理系统实现&#xff08;CSSJQueryPHPMySQL&#xff09; 一、项目背景 本项目基于学校教务系统的背景&#xff0c;根据大学生选课以及学校对学生成绩的管理&#xff0c;实现了一个学校的学生成绩管理网站。另外在学生功能模块实现了选课系统&#xff0c;可供学生选课…
阅读更多...
Ext4文件系统介绍 - 理论篇

Ext4文件系统介绍 - 理论篇

Overview ext4文件系统分割成多个block groups&#xff0c;为了解决碎片化问题&#xff0c;block allocator尽量将一个文件的block放在一个group中。block groups的size通过sb.s_blocks_per_group指定&#xff0c;同样也可以通过8*block_size_in_bytes计算得到。block默认大小…
阅读更多...
【Zookeeper】终端操作常用命令

【Zookeeper】终端操作常用命令

文章目录 服务端常用命令客户端常用命令 zookeeper版本3.7.1 Zookeeper是一个开源的分布式协调服务。 Zookeeper是Apache软件基金会的一个项目&#xff0c;它提供了分布式应用程序协调的通用服务&#xff0c;如分布式同步、命名服务、集群维护等&#xff0c;以简化分布式应用协…
阅读更多...
【计算机组成与体系结构Ⅰ】实验6 熟悉Vivado及MINISYS-1实验系统

【计算机组成与体系结构Ⅰ】实验6 熟悉Vivado及MINISYS-1实验系统

一、实验目的 1&#xff1a;熟悉Vivado的开发环境及开发流程&#xff0c;掌握Vivado中Verilog HDL文本输入设计方法&#xff0c;包括仿真、综合、实现与下载。熟悉Minisys开发板的功能和使用方法。 2&#xff1a;学会可配置IP核的设计与封装方法&#xff0c;深入理解与门逻辑…
阅读更多...
Linux驱动入门(五)——简单的字符设备驱动程序

Linux驱动入门(五)——简单的字符设备驱动程序

文章目录 前言字符设备驱动程序框架字符设备和块设备主设备号和次设备号申请和释放设备号 初识cdev结构cdev结构体file_operations结构体cdev和file_operation结构体的关系inode结构体 字符设备驱动的组成字符设备加载和卸载函数file_operations结构体和其他成员函数驱动程序与…
阅读更多...
Tomcat面试题

Tomcat面试题

江湖无名 安心练剑 关注微信公众号&#xff1a;程序三两行 获取最新版面试资料、java学习路线 1、Tomcat 的缺省端口是多少&#xff0c;怎么修改&#xff1f; 1&#xff09;找到 Tomcat 目录下的 conf 文件夹 2&#xff09;进入 conf 文件夹里面找到 server.xml 文件 3&…
阅读更多...
Elasticsearch】文档操作

Elasticsearch】文档操作

目录 3.文档操作 3.1.新增文档 3.2.查询文档 3.3.删除文档 3.4.修改文档 3.4.1.全量修改 3.4.2.增量修改 3.5.总结 3.文档操作 3.1.新增文档 语法&#xff1a; POST /索引库名/_doc/文档id {"字段1": "值1","字段2": "值2"…
阅读更多...
AUTOSAR CP标准的RTE和BSW各模块的设计及开发工作

AUTOSAR CP标准的RTE和BSW各模块的设计及开发工作

AUTOSAR&#xff08;Automotive Open System Architecture&#xff09;是一种开放的汽车电子系统架构标准&#xff0c;旨在提供一种统一的软件架构&#xff0c;以实现汽车电子系统的模块化和可重用性。 AUTOSAR标准中的两个重要模块是RTE&#xff08;Runtime Environment&…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023