【JavaEE】Spring全家桶实现AOP-统一处理

已于 2023-08-28 15:00:48 修改
阅读量1.7k 收藏 20
点赞数 22
分类专栏： JavaEE 文章标签： java-ee spring java 统一处理 后端
于 2023-08-24 20:17:11 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Carefree_State/article/details/132481494
版权

【JavaEE】AOP（2）

在这里插入图片描述

文章目录

【JavaEE】AOP（2）

在前面的Spring AOP的学习之中，Spring AOP去实现AOP，虽然比较灵活，可以实现很多想法，但是也有一些现实的问题：

  1. 没办法获取到HttpRequest，一些功能难以实现
    • 进而无法获取HttpSession对象，这样登录校验功能就无法实现
  2. 我们要对⼀部分方法进行拦截，而另⼀部分方法不拦截，如注册方法和登录方法是不拦截的，这样的话排除方法的规则很难定义，甚至没办法定义

我们手动去实现，太难了！

所以本文讲解的重点就是，Spring全家桶实现AOP的几种固定的机制，虽然较不灵活，但是实现的功能有针对性，且代码简单！

  • 只要我们按照框架的要求去写，就可以实现对应的功能
  • 这些功能都是很常见、很必要的功能！
    • 所以不要纠结于这个框架不够全面，不能实现一些极端特殊的要求，因为它只是 把一切常见的功能，打包成现成的模块 ，方便开发；如果有其他特殊要求，用Spring AOP等等偏底层地去实现就好了！
    • 框架就是这样的，方便一些常见开发的操作，我们不需要过多了解底层实现，“坐享其成”即可😀
    • Spring全家桶实现AOP更偏向于具体的统一处理功能，而Spring AOP实现AOP更偏底层

网路资料：

Spring AOP是Spring框架中的一个模块，用于实现面向切面编程。它通过动态代理或者字节码生成的方式，在运行时将横切逻辑织入到目标对象的方法中，从而在目标对象执行前、执行后或者执行异常时执行额外的操作。Spring AOP主要基于代理模式来实现。

Spring Boot框架是基于Spring框架的扩展，用于简化和加速Spring应用程序的开发。

Spring Boot并没有重新实现AOP概念，而是直接继承了Spring框架中的AOP模块，因此在Spring Boot中，使用AOP的方式和Spring框架中的方式是一样的。Spring Boot提供了更方便的自动配置和默认约定，使得使用AOP更加简单。

因此，Spring AOP和Spring Boot框架实现的AOP的本质是相同的，都是通过代理方式实现的面向切面编程。区别主要在于Spring全家桶提供了[更简化的配置]和[默认约定]，使得使用AOP更加方便。

  • 因为代码的运行就是通过 Spring Boot框架来运行的，以此来控制一些逻辑也很合理！

本文讲解的几个统一处理：

  1. 统一登录校验处理
    • Spring 拦截器
  2. 统一异常处理
  3. 统一数据格式返回处理

没学到不代表不重要，需要用到什么统一处理的功能，再专门去学！

1. 统一登录校验处理

框架的学习说到底就是学习一个约定，按照约定才能实现方便功能~

Spring全家桶提供了具体的现成拦截器：HandlerInterceptor ，应用拦截器分为两步：

  1. 创建自定义拦截器，实现 HandlerInterceptor接口，重写 preHandle方法

    • preHandle() => 目标方法执行之前要执行的预处理方法

    • 其返回值为true/false

      1. true=>目标方法可执行，放行

      2. false=>目标方法不可执行，拦截

        //伪代码
HandlerInterceptor o = new LoginInterceptor(); 
if(!o.preHandle(...)) {
    return;
}
targetMethod();

  2. 重写 WebMvcConfigurer 的addInterceptors(InterceptorRegistry registry)方法

    • 添加拦截器到registry中（登记）
      • 可以添加多个拦截器，按顺序进行拦截（如果逻辑冲突，按照顺序，以第一个结果为准）
    • 添加拦截的路由/排除拦截的路由

1.1 自定义拦截器

在这里插入图片描述

Ctrl O重写方法：

在这里插入图片描述

在这里插入图片描述

默认返回true，放行

在这里插入图片描述

Java对于一些常量通常会放在一个类里面，以访问的形式去获取常量，而不是每次都手敲：

在这里插入图片描述

在这里插入图片描述

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

在这里插入图片描述

Ctrl O重写方法：

在这里插入图片描述

在这里插入图片描述

  • 加Configuration！否则项目启动不会加载这个类，自然不会进行系统配置
  • 实现MebMvcConfigurer，自然就是跟Spring Mvc（网络相关）有关的配置
  • 不仅仅只有配置文件才能配置，配置类也可以哦！

拦截器对象加入到Spring容器里

在这里插入图片描述

在这里插入图片描述

一般写成这样：

在这里插入图片描述

  • PathPatterns，路径的样式

  • 其实直接new一个咱们的拦截器对象甚至匿名内部类重写那个方法也行，因为这个参数只是定义预处理方法

  • 这个类只是游离在外的普通类，一个拦截器的定义罢了~

为什么可以怎么写：

在这里插入图片描述

  • 其实就是因为每个加或者减后返回的都是同一个对象~

1.3 测试

在这里插入图片描述

为了突出结果，做出以下改动：

  1. 拦截成功跳转百度：

在这里插入图片描述

  1. 提示执行了拦截器

在这里插入图片描述

  1. 排除路由/test/say_hello

在这里插入图片描述

效果：

在这里插入图片描述

在这里插入图片描述

在这里插入图片描述

1.4 对于静态资源的处理

比如图片/html/js/css等资源，如果是服务器的，都是向服务器请求来的

  • html等等很常规无非就是:.excludePathPatterns("/**/*.html")

  • 但是图片不一样，图片的格式很多很多，我们没办法一一列举，而我们可以这么做：

    • 将图片保存到一个目录image里，然后排除整个image目录
    • .excludePathPatterns("/image/**")

1.5 小练习：统一登录拦截处理

在这里插入图片描述

将我们之前做的博客前端资源拷贝到static里：

在这里插入图片描述

后端基本上代码不变，主要是对静态资源和一些路由的拦截排除：

有可能有缓存的问题，刚才的资源没有出现在target中，所以要删掉重新启动

在这里插入图片描述

效果：

在这里插入图片描述

在这里插入图片描述

在这里插入图片描述

重定向只是 对应的路径 相当于重定向后的路径，所以如果只是请求资源或者请求响应数据，不是访问 对应的路径 的网页，是不会触发跳转的~

  • 只会表现为访问不到资源/响应状态码为302

例如：

在这里插入图片描述

在这里插入图片描述

  • 背景消失~

补充，静态资源以static为起始，接受多级目录访问：

在这里插入图片描述

注意删除target重新启动！

在这里插入图片描述

1.6 拦截器原理

1.6.1 执行流程

之前：

在这里插入图片描述

现在：

  • 就在请求的传递路上"截胡"

在这里插入图片描述

1.6.2 源码分析

所有的Controller执行都会通过一个调度器DispatcherServlet来实现，可以通过控制台的日志观察到：（前提是拦截器工作了！）

在这里插入图片描述

双击shift查找DispatcherServlet：

在这里插入图片描述

在这里插入图片描述

在这里插入图片描述

  • 这个就是我们重写的方法！
  • 循环拦截器集合（多个拦截器的情况）

在这里插入图片描述

true就可以继续进行后面的程序（我们的目标方法就在后面）

false就直接return（响应通过输出型参数response返回）

  • 客户端发送请求后，在Spring MVC框架中会经过一系列的组件处理，其中就有可能被拦截器 “截胡”

1.7 扩展：统一访问前缀添加

所有请求地址添加api前缀：

@Configuration//不是Configurable！
public class AppConfig implements WebMvcConfigurer {
    @Override
    public void configurePathMatch(PathMatchConfigurer configurer) {
        configurer.addPathPrefix("api", c -> true);
    }
}
  1. api，原有路由多一级
    • 但是不代表默认不被拦截！
    • 还是要去排除/api/…
    • 还会导致原有路由不能用
  2. c -> true，是一个表达式（不需要了解，感兴趣可以了解），表示启动前缀，false则无效果

2. 统一异常处理

2.1 为什么需要异常处理

如果后端报异常：

（监视器已关掉，此处重点观察异常）

在这里插入图片描述

在这里插入图片描述

信息太过杂，我们需要总结要点，但是不能边开发边写这些异常处理操作，而且几个开发者写的可能都不一样，后期也不方便维护，所以要统一处理~

所以我们希望异常返回的时候应该有明确统一的信息！

网路资料（了解）：

  1. 错误处理的一致性：通过统一处理异常，可以确保应用程序在遇到异常时采取一致的处理方式。这样可以提供更好的用户体验，避免不一致的错误展示或处理方式。

  2. 代码的可维护性：通过将异常处理逻辑集中到一个地方，可以提高代码的可维护性。如果每个控制器方法都有自己的异常处理逻辑，会导致代码重复和冗余，难以维护和更新。

  3. 封装敏感信息：统一处理异常可以帮助我们封装敏感信息，防止泄露给客户端。在异常处理过程中，我们可以选择性地披露或隐藏敏感信息，并返回友好的错误消息给客户端。

  4. 日志记录和监控：通过统一处理异常，我们可以方便地进行日志记录和监控。在异常处理过程中，我们可以记录异常的详细信息，包括异常类型、堆栈跟踪等，以便后续的故障排查和系统监控。

  5. 异常转换和包装：有时候，我们可能需要将底层的异常转换为更高级别的异常，或者将多个异常包装为一个更通用的异常。通过统一处理异常，可以方便地进行这些异常转换和包装操作，以便更好地传递和处理异常。

  6. 错误页面的统一管理：通过统一处理异常，可以将错误页面的管理集中到一个地方。这样可以更方便地自定义错误页面，并确保所有的异常都有对应的错误展示界面。

总之，通过统一处理异常，我们可以提高代码的可维护性和可读性，封装敏感信息，方便日志记录和监控，进行异常转换和包装，以及统一管理错误页面。这些都有助于提升应用程序的质量和用户体验。

大概了解一下就行了，实际项目遇到去使用体验会更好！

2.2 应用异常处理器

我们仍然有现成的异常处理器可以用，如何应用：

  1. @ControllerAdvice
    • 加在类上，代表其为控制器通知类此类会“监听”后端环境，随着项目启动的加载，如果抛出异常会被此类感知到
  2. @ExceptionHandler(Exception.class)
    • 顾名思义，这就是异常处理器，加在方法上，其返回值就是格式化后的数据，注解的括号内应该为对应异常的类对象，并且这个方法可以有一个参数e（名字自取），e会被注入刚才的异常对象
    • 会在获取到异常后调用这个方法，（AOP advice的位置）

补充：

返回的格式以json为最佳，所以返回的方式有两种：

  1. 自定义对象/自定义对象集合
  2. Map对象，自定义映射关系
    • 方便，以这个为例

返回值的类型可以是Object，包括其泛型或者其属性，系统会自动去获取每一个都是谁向上转型而来的

在这里插入图片描述

  • 无论什么异常都会被这个异常处理器捕捉到，因为Exception是所有异常的父类，而参数e则是被向上转型来的，所以其getMessage方法被重写了，仍然可以正常使用
  • 随便写的，只是示例！

但是对于潜在的个别异常，如NullPointerException，应该单独处理，并且被子类捕获就不会被父类捕获了~

  • 因为异常太多了，所以还是需要Exception这个"老父亲"来兜底

效果：

在这里插入图片描述

其他异常效果：

在这里插入图片描述

在这里插入图片描述

3. 统一数据格式返回处理

3.1 为什么要统一数据格式

其实每个公司都会对字段名严格必须符合规范，但是返回的格式则千奇百怪

统一数据格式的优点很多，比如以下几个：

  1. 方便前后端程序员对接数据
  2. 降低前后端沟通成本，所有接口都按一个格式返回
  3. 有利于项目统一数据的维护和修改
  4. 有利于后端技术部门的统一规范，不会出现稀奇古怪的返回内容

3.2 数据格式统一方法

一样可以按照刚才的两种方式：

  1. 自定义对象
    • 本次演示这种，因为有个小坑
  2. Map

在这里插入图片描述

现在我们分为两种情况：

  1. 成功是一个方法

在这里插入图片描述

  1. 失败是一个方法

在这里插入图片描述

3.3 应用数据格式返回统一处理器

我们仍然有现成的数据格式返回统一处理器可以用，如何应用：

  1. @ControllerAdvice
    • 加在类上，代表其为控制器通知类此类会“监听”后端环境，随着项目启动的加载，如果有返回值就会被捕获到！
  2. 实现接口ResponseBodyAdvice
    1. 重写supports方法，表示我们是否要重写beforeBodyWrite方法
      • 通过这个方法以及参数我们可以动态的选择性的对一些控制器和方法不重写/重写
      • return true代表可以重写，反之不能重写
    2. 重写beforeBodyWrite方法
      • 顾名思义就是“篡改”返回值，这个方法会在方法返回之前调用，替原方法返回值，（AOP advice的位置）
      • 默认返回像加了@ResponseBody

在这里插入图片描述

测试：

在这里插入图片描述

  • 返回值类型已经不重要了，因为都会被返回值统一处理掉
  • 当然写原来的类型会更好，因为这样有利于代码的正确性，并且此接口可能被处理器排除了~

效果：

在这里插入图片描述

3.4 String类型无法处理的问题

在这里插入图片描述

  • 因为异常处理，把异常处理的信息再次看成返回值了，实际上返回值处理器运行了两次🤣

因为框架在对返回数据格式处理的时候分为两类：

  1. body是非String类型向上转型而来
    • 跟原来一样，返回值Result类型可以直接返回，框架自动转换为json字符串
  2. body是String类型向上转型而来
    • 也跟原来一样，应该返回String类型并且视作html代码，Result类型的返回值尝试转换为String类型，但是Result类型无法直接转换为String类型！
    • 因为框架【并没有】将它看成非String对象返回，然后按非String对象的方式转换为json字符串！
    • 然后把Result对象看成String对象返回，显然直接报异常！
      • 证据就是，Result对象是完好的，只要调用toString方法返回，不会报异常，但是直接返回Result会报异常。说明返回值必须是字符串，并且最终会被渲染

所以我们应该对String类型单独处理：

在这里插入图片描述

效果：

在这里插入图片描述

在浏览器中，这段字符串被认为是html：

在这里插入图片描述
在这里插入图片描述
可见刚才的结论~

因为响应中Content-Type并非application/json

  • 因此前端收到这个响应，并不会直接将body视作json对象，而是字符串(html代码)，所以我们要用jquery的现成方法转化为json对象才行

3.5 @ControllerAdvice 源码分析

在这里插入图片描述

跟其他类注解一样派生于@Component，而所有的组件都会调用InitializingBean接口：

在这里插入图片描述

Spring MVC中的RequestMappingHandlerAdapter，实现了它：

在这里插入图片描述

实现了afterPropertiesSet方法：

在这里插入图片描述

在这里插入图片描述

异常处理器和返回值处理器的核心前提就是有这个注解，原因归功于它的监听机制

  • 我们发现，这些ControllerAdvice注解类Bean对象特殊地被查找和存储在容器之中，它们比较“忙”，当发生某个事件的时候，调用对应的Advice方法，比如统一异常处理，统一返回值格式处理…
    在这里插入图片描述

文章到此结束！谢谢观看
可以叫我 小马，我可能写的不好或者有错误，但是一起加油鸭🦆！

本文重点讲基本使用方法，具体功能实现要结合实际应变！

  • 例如拦截后咋样，异常处理格式咋样，统一数据格式返回咋样…都不是固定的，是根据实际情况的！

代码：spring_boot_aop_demo/src/main/java/com/example/demo · 游离态/马拉圈2023年8月 - 码云 - 开源中国 (gitee.com)

s:103
关注
  • 22
    点赞
  • 踩
  • 20
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 22
    评论
专栏目录
微服务架构下的异常处理
xiaoman的博客
06-11 1万+
微服务架构下的统一异常处理 本文简单串联Java异常的基础知识和结合项目实践分享相关知识。
Spring~Spring框架AOP的介绍, 实现统一异常处理、统一返回数据格式、统一会话管理(拦截器)
最新发布
2401_83915664的博客
03-31 883
很多程序员，整天沉浸在业务代码的 CRUD 中，业务中没有大量数据做并发，缺少实战经验，对并发仅仅停留在了解，做不到精通，所以总是与大厂擦肩而过。我把私藏的这套并发体系的笔记和思维脑图分享出来，理论知识与项目实战的结合，我觉得只要你肯花时间用心学完这些，一定可以快速掌握并发编程。《一线大厂Java面试题解析+核心总结学习笔记+最新讲解视频+实战项目源码》点击传送门即可获取！些内容对你有帮助，可以扫码获取！！（备注Java获取）**
spring-aop-review-tcf.zip
06-08
SpringAOP代理设计模式demo代码实现，从静态代理、动态代理两方面进行了编码实现
Java | 使用切面AOP拦截并修改Controller接口请求参数
Andya_net的博客
06-29 5284
在开发过程中，会有一些需求将controller层的一些方法入参进行全量转换，最容易想到的可能是在调用下层service方法时，调用公共的方法进行入参转换，这时带来的唯一问题就是代码不雅观，比较冗余。那还有什么方法可以更优雅的解决这个问题吗？答案是有的：切面。我们实现一个AOP切面程序，对入参中的需转换的参数进行专项转换，而无需在各个controller层的各个方法中进行转换处理。
微服务的统一异常处理
qq_38472465的博客
07-31 435
微服务的统一异常处理
【微服务】微服务开发中的统一异常处理
zhcf的博客
07-03 839
微服务开发中的统一异常处理
微服务统一异常处理机制
CSDNOFZHC的博客
08-07 7113
  公司项目用了比较完善的异常处理机制，在此做一个记录。   核心注解：@controllerAdvice+@ExpectionHandler,这个百度资料有很多。   为了让下游调用接口出现异常时，明确知道发生了什么错误，我们自己定义了一个统一的业务异常类BizExpection类，继承自RuntimeExpection.    @Data public class BizExcept...
JavaEE spring半自动实现AOP代理
10-16
JavaEE spring半自动实现AOP代理
JavaEE Spring AOP使用
04-16
压缩包中函数Spring AOP开发时使用注解和xml文件配置demo
JavaEE源代码 jaxen-1.1-beta-7
07-09
JavaEE源代码 jaxen-1.1-beta-7JavaEE源代码 jaxen-1.1-beta-7JavaEE源代码 jaxen-1.1-beta-7JavaEE源代码 jaxen-1.1-beta-7JavaEE源代码 jaxen-1.1-beta-7JavaEE源代码 jaxen-1.1-beta-7JavaEE源代码 jaxen-1.1-...
JavaEE示例-mybatis-spring-springMVC
12-16
本例子使用的是mybatis-spring-springMVC，占位符占位符占位符占位符占位符占位符占位符
微服务下全局异常处理方案
12-21
1、新建jhjcn-common-base基础工程 2、自定义全局异常类BaseException package com.jhjcn.common.base.exception; /** * @Deacription TODO * @Author jianhua.hong * @Date 2020/2/25 9:56 **/ public class BaseException extends RuntimeException { private String code; private String message; public BaseExceptio
Spring Cloud微服务统一处理异常
qq_38472451的博客
08-10 183
Spring Cloud微服务统一处理异常
微服务项目：尚融宝（10）（后端接口：统一异常处理）
一个菜鸡的博客
09-02 523
目标：使用一个或较少的异常类，可以捕获和显示所有的异常信息。方案：因此，我们可以创建一个自定义异常类（必须是运行时异常），在程序中抛出这个自定义异常对象，并在统一异常处理器中捕获自定义异常对象@Data//状态码//错误消息/**** @param message 错误消息*/}/**** @param message 错误消息* @param code 错误码*/}/**** @param message 错误消息* @param code 错误码。
微服务（spring）统一异常处理返回给前端
newbie_God的博客
02-10 1051
1、编写自定义异常类： 2、统一异常拦截 /** * @author * @version 1.0.0 * @ClassName ControllerHanderException.java * @Description 统一拦截自定义异常获取code和msg返回给前端 * @createTime 2022年02月09日 15:40:00 */ @ControllerAdvice public class ControllerHanderException { @Except
java版b2b2c社交电商spring cloud分布式微服务（十一）Web应用的统一异常处理
qq_42748864的博客
07-10 100
我们在做Web应用的时候，请求处理过程中发生错误是非常常见的情况。Spring Boot提供了一个默认的映射：/error，当处理中抛出异常之后，会转到该请求中处理，并且该请求有一个全局的错误页面用来展示异常内容。 选择一个之前实现过的Web应用为基础，启动该应用，访问一个不存在的URL，或是修改处理内容，直接抛出异常，如： @RequestMapping("/hello") public Str...
统一异常处理
csdn_ygy的博客
03-04 392
统一项目数据格式，统一异常管理便于更好的定位项目问题。 由于自我实现有项目业务原因，把主要的接口与思路分享，可自由实现自我适合的业务异常链路。 核心思路：类似于filter责任链处理方式。 chain ：管理handler执行链路 handler：处理特定异常的处理器（我使用自定义处理标记处理器）； abs...
【微服务网关---Gateway 的全局异常处理器】
热爱码农的平民博客
01-16 3378
Gateway网关统一全局异常处理操作 方便前端看到 这里要精细化翻译，默认返回用户是看不懂的 所以需要配置一个 Gateway 的全局异常处理器如果没有网关全局异常的 会如下截图以上就是今天要讲的内容，本文仅仅简单 所以需要配置一个 Gateway 的全局异常处理器。
javaee实验三spring aop
11-30
JavaEE实验三中的Spring AOP是指Spring框架中的面向切面编程。它可以在不修改原有代码的情况下，通过在程序运行时动态地将代码织入到类的指定方法中，实现对方法的增强。具体来说，Spring AOP主要包括两种代理方式：JDK动态代理和CGLIB动态代理。其中，JDK动态代理只能代理实现了接口的类，而CGLIB动态代理则可以代理任意类。在Spring AOP中，我们可以通过XML配置或注解来定义切面和通知，实现对目标方法的增强。 以下是JavaEE实验三中Spring AOP的基本步骤： 1. 定义切面类，即包含通知的类。 2. 定义通知，即增强的代码逻辑。 3. 配置切面和通知，可以通过XML配置或注解来实现。 4. 在需要增强的方法上添加切点，即指定需要增强的方法。 5. 运行程序，观察增强效果。 下面是一个使用XML配置的Spring AOP的例子： 1. 定义切面类和通知： ```java public class LogAspect { public void before() { System.out.println("方法执行前"); } public void after() { System.out.println("方法执行后"); } } ``` 2. 在XML配置文件中定义切面和通知： ```xml <bean id="logAspect" class="com.example.LogAspect"/> <aop:config> <aop:aspect ref="logAspect"> <aop:before method="before" pointcut="execution(* com.example.Service.*(..))"/> <aop:after method="after" pointcut="execution(* com.example.Service.*(..))"/> </aop:aspect> </aop:config> ``` 3. 在需要增强的方法上添加切点： ```java @Service public class UserServiceImpl implements UserService { @Override public void addUser(User user) { System.out.println("添加用户：" + user.getName()); } } ``` 4. 运行程序，观察增强效果。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 22
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

s:103

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值