JavaEE【Spring】：SpringBoot 统一功能处理

news2024/12/24 0:04:56

文章目录

  • 前言
  • 一、用户登录权限效验
    • 1、最初用户登录验证
    • 2、Spring AOP 用户统⼀登录验证的问题
    • 3、Spring 拦截器
      • ① 自定义拦截器
      • ② 将自定义拦截器加入到系统配置
    • 4、拦截器实现原理
      • ① 实现原理源码分析
      • ② 拦截器小结
    • 5、扩展：统⼀访问前缀添加
  • 二、统⼀异常处理
    • 1、使用方法
    • 2、异常分类
  • 三、统⼀数据返回格式
    • 1、为什么需要统⼀数据返回格式？
    • 2、统⼀数据返回格式的实现
    • 3、@ControllerAdvice 源码分析（了解）

前言

之前我们学习了 Spring AOP，我们就可以通过 AOP 在 Spring Boot 中进行统⼀功能处理模块：

  1. 统⼀⽤户登录权限验证；
  2. 统⼀数据格式返回；
  3. 统⼀异常处理。

一、用户登录权限效验

1、最初用户登录验证

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpSession;

@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 方法来进行统一验证。

2、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 的切⾯中实现⽤户登录权限效验的功能，有以下两个问题：

  1. 没办法获取到 HttpSession 对象。
  2. 我们要对⼀部分⽅法进⾏拦截，⽽另⼀部分⽅法不拦截，如注册⽅法和登录⽅法是不拦截的，这样的话排除⽅法的规则很难定义，甚⾄没办法定义。

3、Spring 拦截器

对于上述问题，Spring 官方就提供了一个拦截器来解决这个问题。

① 自定义拦截器

实现 HandlerInterceptor 类，重写其 preHandle 方法：

package com.example.springbootaop.config;

import org.springframework.web.servlet.HandlerInterceptor;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;

/**
 * 登录拦截器
 */
public class LoginInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 登录的判断业务
        HttpSession session = request.getSession(false);
        if (session != null && session.getAttribute("userinfo") != null) {
            return true;
        }
        response.setStatus(401);
        return false;
    }
}

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

实现 WebMvcConfigurer ，重写其 addInterceptors 方法：

package com.example.springbootaop.config;

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration // 一定不要忘记
public class MyConfig implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LoginInterceptor())
                .addPathPatterns("/**") // 拦截所有请求
                .excludePathPatterns("/user/login")
                .excludePathPatterns("/user/reg"); // 排除不拦截的 url
    }
}

其中：

  • addPathPatterns：表示需要拦截的 URL，“**”表示拦截任意⽅法（也就是所有方法）。
  • excludePathPatterns：表示需要排除的 URL。

排除所有的静态资源

package com.example.springbootaop.config;

import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration // 一定不要忘记
public class MyConfig implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LoginInterceptor())
                .addPathPatterns("/**") // 拦截所有请求
                .excludePathPatterns("/**/*.js")
				.excludePathPatterns("/**/*.css")
				.excludePathPatterns("/**/*.jpg")
				.excludePathPatterns("/login.html")
				.excludePathPatterns("/**/login"); // 排除不拦截的 url
    }
}

4、拦截器实现原理

有无拦截器业务执行的流程对比：
在这里插入图片描述

① 实现原理源码分析

所有的 Controller 执⾏都会通过⼀个调度器 DispatcherServlet 来实现：
在这里插入图片描述
而 DispatcherServlet 这个调度器里边有一个叫 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;
                    }
                    // 执⾏ Controller 中的业务
                    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 di spatch 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);
            }
        }
    }

从上述源码可以看出在开始执⾏ Controller 之前，会先调⽤ 预处理⽅法 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 并执⾏拦截器中的 preHandle ⽅法，与我们之前自定义拦截器时相同：
在这里插入图片描述

② 拦截器小结

通过上⾯的源码分析，我们可以看出，Spring 中的拦截器也是通过动态代理和环绕通知的思想实现的：
在这里插入图片描述

5、扩展：统⼀访问前缀添加

@Configuration
public class AppConfig implements WebMvcConfigurer {
	// 所有的接⼝添加 api 前缀
	@Override
	public void configurePathMatch(PathMatchConfigurer configurer) {
		configurer.addPathPrefix("api", c -> true);
	}
}

二、统⼀异常处理

1、使用方法

统⼀异常处理使⽤的是 @ControllerAdvice + @ExceptionHandler 来实现的：

package com.example.springbootaop.config;

import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

import java.util.HashMap;

/**
 * 统一处理异常
 */
@ControllerAdvice
public class ErrorAdive {
    @ExceptionHandler(Exception.class)
    @ResponseBody
    public HashMap<String,Object> exAdvie(Exception e){
        HashMap<String,Object> result = new HashMap<>();
        result.put("code","-1");
        result.put("msg",e.getMessage());
        return result;
    }
}

在 UserController 中设置⼀个空指针异常：
在这里插入图片描述
访问结果为：
在这里插入图片描述

2、异常分类

我们可以针对不同的异常，返回不同的结果：

package com.example.springbootaop.config;

import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

import java.util.HashMap;

/**
 * 统一处理异常
 */
@ControllerAdvice
public class ErrorAdive {
    @ExceptionHandler(Exception.class)
    @ResponseBody
    public HashMap<String,Object> ExceptionAdvie(Exception e){
        HashMap<String,Object> result = new HashMap<>();
        result.put("code","-1");
        result.put("msg",e.getMessage());
        return result;
    }

    @ExceptionHandler(ArithmeticException.class)
    @ResponseBody
    public HashMap<String,Object> ArithmeticExceptionAdvie(ArithmeticException e){
        HashMap<String,Object> result = new HashMap<>();
        result.put("code","-2");
        result.put("msg",e.getMessage());
        return result;
    }
}

在 UserController 中设置⼀个空指针异常：
在这里插入图片描述
访问结果为：
在这里插入图片描述

当有多个异常通知时，匹配顺序为当前类及其⼦类向上依次匹配

三、统⼀数据返回格式

1、为什么需要统⼀数据返回格式？

统⼀数据返回格式的优点有很多，主要就是为了统一格式，降低沟通成本。

2、统⼀数据返回格式的实现

统⼀的数据返回格式可以使⽤ @ControllerAdvice + ResponseBodyAdvice 的⽅式实现

package com.example.springbootaop.config;

import org.springframework.core.MethodParameter;
import org.springframework.http.MediaType;
import org.springframework.http.server.ServerHttpRequest;
import org.springframework.http.server.ServerHttpResponse;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;

import java.util.HashMap;

@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> result = new HashMap<>();
        result.put("code", 200);
        result.put("msg", "");
        result.put("data", body);
        return result;
    }
}

postman 测试：
在这里插入图片描述

3、@ControllerAdvice 源码分析（了解）

在这里插入图片描述
从上述源码可以看出 @ControllerAdvice 派⽣于 @Component 组件，⽽所有组件初始化都会调⽤ InitializingBean 接⼝：
在这里插入图片描述
这个⽅法中有⼀个 initControllerAdviceCache ⽅法：
在这里插入图片描述
这个⽅法在执⾏是会查找使⽤所有的 @ControllerAdvice 类，这些类会被注册在容器中，但发⽣某个事件时，调⽤相应的 Advice ⽅法。

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

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

相关文章

系分 - （软件）需求工程

系分 - （软件）需求工程

个人总结&#xff0c;仅供参考&#xff0c;欢迎加好友一起讨论 文章目录系分 - (软件)需求工程考点摘要需求工程需求开发&#xff08;主线&#xff0c;目标&#xff09;需求分类领域工程PIECES框架需求获取需求记录技术需求分析结构化分析方法 - SASA - 数据字典SA - 数据流图D…
阅读更多...
浅谈Web缓存

浅谈Web缓存

Web缓存分为两类 http缓存浏览器缓存 1、缓存位置 Service WorkerMemory CacheDisk CachePush Cache 2、浏览器缓存分为三类 cookielocalStroragesessionStorage cookie的最大容量为4kb, localStorage, sessionStorage容量为5M localStorage可永久存储, 除非调用API删除或…
阅读更多...
【Linux编译器-gcc/g++使用】

【Linux编译器-gcc/g++使用】

1. 背景知识1. 预处理&#xff08;)2. 编译&#xff08;)3. 汇编&#xff08;&#xff09;4. 连接&#xff08;)有关具体详解可以参照这篇博客&#xff1a;程序环境与预处理2. gcc如何完成格式 gcc [选项] 要编译的文件 [选项] [目标文件]2.1预处理&#x1f4d9;功能&#x1f4…
阅读更多...
11_1、Java集合概述

11_1、Java集合概述

一、Java集合框架概述 一方面&#xff0c; 面向对象语言对事物的体现都是以对象的形式&#xff0c;为了方便对多个对象 的操作&#xff0c;就要对对象进行存储。另一方面&#xff0c;使用Array存储对象方面具有一些弊 端&#xff0c;而Java 集合就像一种容器&#xff0c;可以动…
阅读更多...
【自学Java】Java语言数组赋值

【自学Java】Java语言数组赋值

Java语言数组赋值 Java数组赋值教程 在 Java 语言 中&#xff0c;给 数组 赋值&#xff0c;就相当于给每个位置上的对应的位置填充数据。 Java语言数组赋值详解 Java 中的数据赋值分为动态化赋值和静态化赋值两种赋值方式。动态化赋值指的是先定义数组&#xff0c;然后指定…
阅读更多...
Unity github发布 和 gitignore文件的详细设置

Unity github发布 和 gitignore文件的详细设置

你做了一个unity项目 想给他提到github上去 如果你是windows 他会不停提示你 warning: LF will be replaced by CRLF in ***** The file will have its original line endings in your working directory 提示这个是因为 windows和其他平台的换行符不一样导致的 git想给你改换行…
阅读更多...
PDF转换成Word转换器，这个软件实在太好用了！

PDF转换成Word转换器，这个软件实在太好用了！

在办公中我们会发现&#xff0c;我们每天需要处理的文件实在是太多了。大部分时间里我们都在跟各种各样的文件打交道&#xff0c;有部分文件内容很接近&#xff0c;甚至只是转换了输出格式而已&#xff0c;其具体内容并没有发生改动。那当我们想要直接使用它的另一种格式的时候…
阅读更多...
ArcGIS三维制作步骤发布时间：

ArcGIS三维制作步骤发布时间：

ArcGIS三维制作步骤发布时间&#xff1a;2018-01-17 版权&#xff1a;同步视频教程&#xff08;一)&#xff1a;http://www.bigemap.com/video/play2018022687.html&#xff08;二&#xff09;&#xff1a;http://www.bigemap.com/video/play2018022686.html&#xff08;三&…
阅读更多...
电脑死机怎么办？超级简单的方法

电脑死机怎么办？超级简单的方法

当我们的电脑运行多个软件的时候&#xff0c;就会很容易发生死机。如果是台式电脑&#xff0c;我们可以通过按重启按钮&#xff0c;或者是通过直接拔电源来解决死机的问题。 如果是笔记本电脑&#xff0c;我们怎么按鼠标或者电脑的键盘&#xff0c;它都没有反应。电脑死机怎么…
阅读更多...
Ubuntu 20.04源码编译安装OpenCV 4.7.0

Ubuntu 20.04源码编译安装OpenCV 4.7.0

目录 前言 1--下载OpenCV 4.7.0 2--编译安装OpenCV 4.7.0 3--测试 3-1--查看安装的版本 3-2--基于VSCode和CMake测试项目 4--报错解决&#xff08;重点&#xff01;&#xff09; 4-1--OpenCV与FFmpeg不兼容 4-2--LIBTIFF报错 4-3--系统与Anaconda的库lib冲突 4-4--测…
阅读更多...
MATLAB-罗盘图绘制

MATLAB-罗盘图绘制

compass 函数用于绘制罗盘图&#xff0c;利用直角坐标系&#xff0c;在圆形栅格上绘制图形&#xff0c;整个形状类似一个“罗盘”&#xff0c;具体使用格式如下。1 ) compass( x , y):函数绘制一个由原点出发、由(x ,y)组成的向量箭头图形。2 ) compass( z):等价于compass( rea…
阅读更多...
6步速通：修复损坏的word文件

6步速通：修复损坏的word文件

前两天&#xff0c;老师找到我&#xff0c;想让我帮忙修复一个打不开的docx文档。症状大概是这样&#xff1a; 打开文件的时候花了较长时间&#xff0c;并且显示了乱码&#xff0c;并且老师使用WPS自带的文档修复功能也无法修复。 遇到这个情况&#xff0c;到底怎么办呢&#…
阅读更多...
【填坑向】我可能也就是踩了dockrfile部署jar包（需读取resource目录下的文件）全部的坑吧。。。

【填坑向】我可能也就是踩了dockrfile部署jar包（需读取resource目录下的文件）全部的坑吧。。。

FileNotFoundException。。没错、这篇还是从读取的文件找不到的问题开始&#xff0c;今天来个终极版(&#xffe3;∇&#xffe3;)/一开始我把要读取的文件放在了项目根路径&#xff0c;package就没把它打进去&#xff0c;显然是找不到的&#xff0c;于是我把这个JSON文件移到了…
阅读更多...
数据智能时代的营销新玩法RTA，你了解吗？｜极客星球

数据智能时代的营销新玩法RTA，你了解吗？｜极客星球

近日&#xff0c;由国内知名产品经理社区PMTalk和MobTech联合举办的“从0到1深入产品运营方法论”沙龙活动圆满落幕&#xff0c;MobTech袤博科技开发者平台副总裁陆俊超在会上分享了RTA产品如何全方位提升用户增长效能。 RTA应运而生 在流量红利日益消退的环境下&#xff0c;…
阅读更多...
中台KPI怎么设计？

中台KPI怎么设计？

在中台系统建设完毕之后&#xff0c;中台战略在一家企业中的落地工作就算完成了。 此时&#xff0c;我们必须有准确的指标来反映该战略的实际效果&#xff0c;因此就需要对中台战略在企业运作中的效益进行持续化的监测与评估。 行动点&#xff1a; &#xff08;1&#xff09…
阅读更多...
app嵌入新功能，一键接入（内含低代码平台）

app嵌入新功能，一键接入（内含低代码平台）

在app的开发运营中&#xff0c;有时会需要跟随着用户的使用习惯来进行业务上的更新迭代&#xff0c;比如说新增或删减部分功能&#xff0c;或是调整应用功能布局&#xff0c;优化组件分区&#xff0c;以达到更简洁的效果。那么对应的会有低代码平台提供一些通用组件&#xff0c…
阅读更多...
机器学习--决策树、线性模型、随机梯度下降

机器学习--决策树、线性模型、随机梯度下降

目录 一、决策树 二、线性模型 三、随机梯度下降 一、决策树 决策树&#xff08;decision tree&#xff09;&#xff1a;是一种基本的分类与回归方法&#xff0c;此处主要讨论分类的决策树。 在分类问题中&#xff0c;表示基于特征对实例进行分类的过程&#xff0c;可以认为…
阅读更多...
带你玩转指针——指针进阶（一）

带你玩转指针——指针进阶（一）

指针的概念&#xff1a;指针就是变量&#xff0c;用来存放地址指针的大小是固定的4/8个字节&#xff08;32位平台/64位平台&#xff09;指针也是有类型的&#xff0c;指针类型决定了-步长&#xff0c;指针解引用时的权限字符指针在前面的学习我们知道了字符指针的初阶应用假如是…
阅读更多...
xxljob 调度中心项目 调度一个方法到我们自己的项目，他是咋执行的

xxljob 调度中心项目 调度一个方法到我们自己的项目，他是咋执行的

目录 1 需求2 实现1 需求 xxljob 调度中心项目 调度一个方法到我们自己的项目，他是咋执行的 2 实现 我们的项目首先是netty 服务器接收到，然后转发到run方法里面 核心就是下面的这个map对象 // 任务启动之后，时间一到就 创建一个 JobThread ，就放到这个priva…
阅读更多...
【Linux kernel 文件系统入门及渐进 1 -- sysfs 介绍】

【Linux kernel 文件系统入门及渐进 1 -- sysfs 介绍】

文章目录1.1 Sysfs 介绍1.1.1 kobject 产生背景1.1.2 主要的数据结构1.1.3 数据结构实现1.2 attribute 的功能概述1.2.1 struct attribute 实现1.2.2 attribute 文件的创建1.2.3 attibute 文件的 read 和 write1.1 Sysfs 介绍 Sysfs 是一个基于 RAM 的文件系统&#xff0c;它和…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023