ControllerAdvice用法

2024-04-13 22:52
文章标签 用法 controlleradvice

本文主要是介绍ControllerAdvice用法,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

ControllerAdvice用法

@ControllerAdvice是一个组件注解,它允许你在一个地方处理整个应用程序控制器的异常、绑定数据和预处理请求。这意味着你不需要在每个控制器中重复相同的异常处理代码,从而使得代码更加简洁、易于管理。

主要特性

  • 全局异常处理:通过@ExceptionHandler注解捕获全局异常,减少重复的错误处理代码。
  • 数据绑定:使用@InitBinder注解自定义请求参数的格式化和转换。
  • 全局数据预处理:通过@ModelAttribute注解添加全局模型属性,这些属性对所有的@RequestMapping方法都是可见的。

全局异常处理

在开发过程中,统一异常处理是非常重要的一环。使用@ControllerAdvice,你可以定义一个或多个方法来处理整个应用中的异常。这样,当应用抛出异常时,Spring会自动寻找带有@ExceptionHandler的方法来处理它。

返回 ResponseEntity

使用@ControllerAdvice进行全局异常处理的示例代码:

@ControllerAdvice
public class GlobalExceptionHandler {@ExceptionHandler(Exception.class)public ResponseEntity<String> handleException(Exception ex) {// 可以记录日志return new ResponseEntity<>("发生异常: " + ex.getMessage(), HttpStatus.INTERNAL_SERVER_ERROR);}
}

在这个例子中,我们定义了一个GlobalExceptionHandler类,并使用@ControllerAdvice注解标记。其中,@ExceptionHandler(Exception.class)注解表示这个方法可以处理所有类型的异常。当应用中发生异常时,这个方法会被调用,并返回一个包含错误信息的ResponseEntity对象。

直接使用HttpServletResponse返回json

@ControllerAdvice使用中,除了返回ResponseEntity对象外,还可以通过HttpServletResponse直接写入响应来返回JSON格式的错误信息。这种方式在需要更灵活控制响应内容和格式时非常有用,特别是在构建RESTful API时。

以下是一个示例,展示了如何在拦截到异常后通过HttpServletResponse返回JSON格式的错误信息:

@ControllerAdvice
public class GlobalExceptionHandlerWithResponse {@ExceptionHandler(Exception.class)public void handleException(Exception ex, HttpServletResponse response) throws IOException {response.setStatus(HttpStatus.INTERNAL_SERVER_ERROR.value());response.setContentType("application/json");// 使用Jackson或其他JSON处理库将错误信息转换为JSON格式String jsonResponse = "{\"error\": \"" + ex.getMessage() + "\"}";response.getWriter().write(jsonResponse);}
}

在这个例子中,handleException方法除了接收异常对象Exception作为参数外,还接收了HttpServletResponse对象。这允许我们直接向响应输出流写入内容。首先,我们通过setStatus方法设置了HTTP状态码,然后通过setContentType方法指定了响应的内容类型为application/json。最后,我们构造了一个包含错误信息的JSON字符串,并通过response.getWriter().write(jsonResponse)将其写入响应体中。

返回自定义通用返回类

handleException方法可以直接返回一个自定义的通用返回对象,Spring框架会自动将该对象序列化为JSON格式返回给客户端。这是通过Spring MVC的消息转换器(如MappingJackson2HttpMessageConverter)自动完成的,前提是你已经在项目中加入了JSON处理库(如Jackson)。

以下是一个示例,展示如何返回一个自定义的通用返回对象,并让Spring自动将其序列化为JSON格式:

@ControllerAdvice
public class GlobalExceptionHandler {@ExceptionHandler(Exception.class)@ResponseBody // 确保返回的对象被序列化为JSONpublic ErrorResponse handleException(Exception ex) {return new ErrorResponse(HttpStatus.INTERNAL_SERVER_ERROR.value(), ex.getMessage());}// 自定义的通用返回对象类public static class ErrorResponse {private int status;private String message;public ErrorResponse(int status, String message) {this.status = status;this.message = message;}// getter和setter省略}
}

在这个例子中,handleException方法返回了一个ErrorResponse对象,该对象包含了错误状态码和错误消息。我们通过@ResponseBody注解告知Spring,这个方法的返回值应该被视为响应体,并且需要被转换为JSON格式。

Spring MVC在内部使用配置的HTTP消息转换器来将返回对象序列化为JSON。如果你的项目依赖于Jackson库,Spring会使用MappingJackson2HttpMessageConverter自动将ErrorResponse对象转换为JSON格式,然后发送给客户端。

这种方式简化了异常处理的代码,同时也提供了返回结构化错误信息的灵活性,非常适合构建RESTful API和微服务架构。

自定义参数绑定

当你需要对进入控制器的请求参数进行自定义处理时,比如日期格式的转换,@ControllerAdvice配合@InitBinder可以全局定义转换规则,避免在每个控制器中重复定义。

使用@InitBinder自定义日期格式绑定的示例:

@ControllerAdvice
public class GlobalBindingInitializer {@InitBinderpublic void initBinder(WebDataBinder binder) {SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd");binder.registerCustomEditor(Date.class, new CustomDateEditor(dateFormat, true));}
}

在这个例子中,我们通过@InitBinder注解标记的方法initBinder中,注册了一个自定义的编辑器CustomDateEditor,用于将字符串转换为Date类型。这意味着,当Spring MVC接收到日期格式的字符串参数时,会自动使用这个编辑器进行转换。

添加全局数据模型

有时候,你可能希望某些数据对所有的控制器都是可用的,比如用户登录信息、全局配置信息等。@ControllerAdvice允许你通过@ModelAttribute注解轻松实现这一点。

使用@ModelAttribute添加全局数据模型的例子:

@ControllerAdvice
public class GlobalModelAttributes {@ModelAttribute("globalMessage")public String globalMessage() {return "这是一个全局消息";}
}

在这个例子中,我们使用@ModelAttribute注解定义了一个方法globalMessage,该方法返回一个字符串。这个字符串会被添加到所有控制器方法的模型中,可以在视图中使用${globalMessage}来访问它。

参考链接

  • Spring官方文档:链接地址
  • @ControllerAdvice详细用法:链接地址

在这里插入图片描述

这篇关于ControllerAdvice用法的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/901442

相关文章

揭秘Python Socket网络编程的7种硬核用法

《揭秘PythonSocket网络编程的7种硬核用法》Socket不仅能做聊天室,还能干一大堆硬核操作,这篇文章就带大家看看Python网络编程的7种超实用玩法,感兴趣的小伙伴可以跟随小编一起... 目录1.端口扫描器:探测开放端口2.简易 HTTP 服务器:10 秒搭个网页3.局域网游戏:多人联机对战4.

MyBatis 动态 SQL 优化之标签的实战与技巧(常见用法)

《MyBatis动态SQL优化之标签的实战与技巧(常见用法)》本文通过详细的示例和实际应用场景,介绍了如何有效利用这些标签来优化MyBatis配置,提升开发效率,确保SQL的高效执行和安全性,感... 目录动态SQL详解一、动态SQL的核心概念1.1 什么是动态SQL?1.2 动态SQL的优点1.3 动态S

java之Objects.nonNull用法代码解读

《java之Objects.nonNull用法代码解读》:本文主要介绍java之Objects.nonNull用法代码,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐... 目录Java之Objects.nonwww.chinasem.cnNull用法代码Objects.nonN

JavaScript Array.from及其相关用法详解(示例演示)

《JavaScriptArray.from及其相关用法详解(示例演示)》Array.from方法是ES6引入的一个静态方法,用于从类数组对象或可迭代对象创建一个新的数组实例,本文将详细介绍Array... 目录一、Array.from 方法概述1. 方法介绍2. 示例演示二、结合实际场景的使用1. 初始化二

一文带你了解SpringBoot中启动参数的各种用法

《一文带你了解SpringBoot中启动参数的各种用法》在使用SpringBoot开发应用时,我们通常需要根据不同的环境或特定需求调整启动参数,那么,SpringBoot提供了哪些方式来配置这些启动参... 目录一、启动参数的常见传递方式二、通过命令行参数传递启动参数三、使用 application.pro

关于@RequestParam的主要用法详解

《关于@RequestParam的主要用法详解》:本文主要介绍关于@RequestParam的主要用法,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录1. 基本用法2. 默认值3. 可选参数4. 绑定到对象5. 绑定到集合或数组6. 绑定到 Map7. 处理复杂类

SQL中的CASE WHEN用法小结

《SQL中的CASEWHEN用法小结》文章详细介绍了SQL中的CASEWHEN函数及其用法,包括简单CASEWHEN和CASEWHEN条件表达式两种形式,并通过多个实际场景展示了如何使用CASEWH... 目录一、简单CASE WHEN函数:二、CASE WHEN条件表达式函数三、常用场景场景1:不同状态展

Linux find 命令完全指南及核心用法

《Linuxfind命令完全指南及核心用法》find是Linux系统最强大的文件搜索工具,支持嵌套遍历、条件筛选、执行动作,下面给大家介绍Linuxfind命令完全指南,感兴趣的朋友一起看看吧... 目录一、基础搜索模式1. 按文件名搜索(精确/模糊匹配)2. 排除指定目录/文件二、根据文件类型筛选三、时间

Java导入、导出excel用法步骤保姆级教程(附封装好的工具类)

《Java导入、导出excel用法步骤保姆级教程(附封装好的工具类)》:本文主要介绍Java导入、导出excel的相关资料,讲解了使用Java和ApachePOI库将数据导出为Excel文件,包括... 目录前言一、引入Apache POI依赖二、用法&步骤2.1 创建Excel的元素2.3 样式和字体2.

kotlin中的行为组件及高级用法

《kotlin中的行为组件及高级用法》Jetpack中的四大行为组件:WorkManager、DataBinding、Coroutines和Lifecycle,分别解决了后台任务调度、数据驱动UI、异... 目录WorkManager工作原理最佳实践Data Binding工作原理进阶技巧Coroutine