当前位置: 首页 > news >正文

SpringBoot 统⼀功能处理

统⼀功能处理

  • 1. 拦截器
  • 2. 统⼀异常处理
  • 3. 统⼀数据返回格式

1. 拦截器

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

  1. 创建⾃定义拦截器,实现 HandlerInterceptor 接⼝的 preHandle(执⾏具体⽅法之前的预处理)⽅法.
  2. 将⾃定义拦截器加⼊ WebMvcConfigurer 的 addInterceptors ⽅法中.

接下来使⽤代码来实现⼀个⽤户登录的权限效验,⾃定义拦截器是⼀个普通类,分为两步:

  1. 实现 HandlerInterceptor 接口
  2. 重写 preHandle 方法
public class LoginInterceptor implements HandlerInterceptor {@Overridepublic 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.sendRedirect("/login.html");return false;}
}

然后就是将自定义的拦截器配置到系统当中:
总共分为三步:

  1. 添加 @Configuration 注解
  2. 实现 WebMvcConfigurer 接口
  3. 重写 addInterceptors 方法
@Configuration
public class AppConfig implements WebMvcConfigurer {@Overridepublic void addInterceptors(InterceptorRegistry registry) {registry.addInterceptor(new LoginInterceptor()).addPathPatterns("/**")// 拦截所有请求.excludePathPatterns("/**/*.html")// 放开不需要拦截的部分.excludePathPatterns("/user/login").excludePathPatterns("/user/reg");}
}

统⼀访问前缀添加
所有请求地址添加 api 前缀, 有两种方式:

  1. 通过方法添加
@Configuration
public class AppConfig implements WebMvcConfigurer {// 所有的接⼝添加 api 前缀@Overridepublic void configurePathMatch(PathMatchConfigurer configurer) {configurer.addPathPrefix("/api", c -> true);}
}
  1. 通过配置文件添加
server.servlet.context-path=/api

2. 统⼀异常处理

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

@ControllerAdvice
@ResponseBody
public class ErrorAdive {@ExceptionHandler(Exception.class)public Object error(Exception e) {Map<String, Object> map = new HashMap<>();map.put("code", -1);map.put("data", null);map.put("msg", e.getMessage());return map;}}

以上⽅法表示,如果出现了异常就返回给前端⼀个 HashMap 的对象,其中包含的字段如代码中定义的那样. 我们可以针对不同的异常,返回不同的结果, 例如:

    @ExceptionHandler(NullPointerException.class)public Object nullPointerexceptionAdvice(NullPointerException e) {HashMap<String, Object> result = new HashMap<>();result.put("success", -1);result.put("message", "空指针异常:" + e.getMessage());result.put("data", null);return result;}

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

3. 统⼀数据返回格式

统⼀数据返回格式的优点有很多,⽐如以下⼏个:

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

统⼀的数据返回格式可以使⽤ @ControllerAdvice + 实现 ResponseBodyAdvice 的⽅式实现,具体实现代码如下:

@ControllerAdvice
public class ResponseAdvice implements ResponseBodyAdvice {/***  内容是否需要重写(通过此⽅法可以选择性部分控制器和⽅法进⾏重写)*  返回 true 表示重写* @param returnType* @param converterType* @return*/@Overridepublic boolean supports(MethodParameter returnType, Class converterType) {return true;}@Overridepublic Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType, Class selectedConverterType, ServerHttpRequest request, ServerHttpResponse response) {ObjectMapper objectMapper = new ObjectMapper();HashMap<String, Object> result = new HashMap<>();result.put("success", -1);result.put("message", "");result.put("data", body);// 当 body 值是 String 类型的值时直接返回会报错if (body instanceof String) {try {return objectMapper.writeValueAsString(result);} catch (JsonProcessingException e) {e.printStackTrace();}}return result;}
}
http://www.lryc.cn/news/138163.html

相关文章:

  • hadoop 报错 java.io.IOException: Inconsistent checkpoint fields
  • workbench连接MySQL8.0错误 bad conversion 外部组件 异常
  • Qt Scroll Area控件设置,解决无法显示全部内容,且无法滚动显示问题。
  • 【Java架构-包管理工具】-Maven私服搭建-Nexus(三)
  • 守护进程(精灵进程)
  • csdn冷知识:如何在csdn里输入公式或矩阵
  • 【前端】CSS技巧与样式优化
  • Linux下的系统编程——makefile入门
  • redis常用五种数据类型详解
  • Python代理池健壮性测试 - 压力测试和异常处理
  • 回文子串-中心拓展
  • 2023.8各大浏览器11家对比:Edge/Chrome/Opera/Firefox/Tor/Vivaldi/Brave,安全性,速度,体积,内存占用
  • python中的matplotlib画散点图(数据分析与可视化)
  • 2023前端面试笔记 —— HTML5
  • 【LeetCode】面试题总结 消失的数字 最小k个数
  • 导入功能importExcel (现成直接用)
  • cvc-complex-type.2.4.a: 发现了以元素 ‘base-extension‘ 开头的无效内容。应以 ‘{layoutlib}‘ 之一开头
  • cortex-A7核IIC实验
  • task.run()和 await task.run() 区别 await 运行机制
  • LeetCode面试经典150题(day 2)
  • 阿里云机器学习PAI全新推出特征平台 (Feature Store),助力AI建模场景特征数据高效利用
  • 网络安全工具和资源推荐: 介绍网络安全领域中常用的工具、框架、资源和学习资料
  • 『C语言入门』探索C语言函数
  • Django基础3——视图函数
  • python 基础篇 day 4 选择结构—— if 结构
  • 科技赋能,教育革新——大步迈向体育强国梦
  • 【秋招基础】后端开发——笔面试常见题目
  • 自定义loadbalance实现feignclient的自定义路由
  • 论文笔记:从不平衡数据流中学习的综述: 分类、挑战、实证研究和可重复的实验框架
  • C#设计模式六大原则之--迪米特法则