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中的getopt模块用法小结

《Python中的getopt模块用法小结》getopt.getopt()函数是Python中用于解析命令行参数的标准库函数,该函数可以从命令行中提取选项和参数,并对它们进行处理,本文详细介绍了Pyt... 目录getopt模块介绍getopt.getopt函数的介绍getopt模块的常用用法getopt模

mysql中的group by高级用法

《mysql中的groupby高级用法》MySQL中的GROUPBY是数据聚合分析的核心功能,主要用于将结果集按指定列分组,并结合聚合函数进行统计计算,下面给大家介绍mysql中的groupby用法... 目录一、基本语法与核心功能二、基础用法示例1. 单列分组统计2. 多列组合分组3. 与WHERE结合使

Java中Scanner的用法示例小结

《Java中Scanner的用法示例小结》有时候我们在编写代码的时候可能会使用输入和输出,那Java也有自己的输入和输出,今天我们来探究一下,对JavaScanner用法相关知识感兴趣的朋友一起看看吧... 目录前言一 输出二 输入Scanner的使用多组输入三 综合练习:猜数字游戏猜数字前言有时候我们在

java解析jwt中的payload的用法

《java解析jwt中的payload的用法》:本文主要介绍java解析jwt中的payload的用法,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录Java解析jwt中的payload1. 使用 jjwt 库步骤 1:添加依赖步骤 2:解析 JWT2. 使用 N

Linux命令之firewalld的用法

《Linux命令之firewalld的用法》:本文主要介绍Linux命令之firewalld的用法,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录linux命令之firewalld1、程序包2、启动firewalld3、配置文件4、firewalld规则定义的九大

SQL BETWEEN 的常见用法小结

《SQLBETWEEN的常见用法小结》BETWEEN操作符是SQL中非常有用的工具,它允许你快速选取某个范围内的值,本文给大家介绍SQLBETWEEN的常见用法,感兴趣的朋友一起看看吧... 在SQL中,BETWEEN是一个操作符,用于选取介于两个值之间的数据。它包含这两个边界值。BETWEEN操作符常用

MySql match against工具详细用法

《MySqlmatchagainst工具详细用法》在MySQL中,MATCH……AGAINST是全文索引(Full-Textindex)的查询语法,它允许你对文本进行高效的全文搜素,支持自然语言搜... 目录一、全文索引的基本概念二、创建全文索引三、自然语言搜索四、布尔搜索五、相关性排序六、全文索引的限制七

C#中async await异步关键字用法和异步的底层原理全解析

《C#中asyncawait异步关键字用法和异步的底层原理全解析》:本文主要介绍C#中asyncawait异步关键字用法和异步的底层原理全解析,本文给大家介绍的非常详细,对大家的学习或工作具有一... 目录C#异步编程一、异步编程基础二、异步方法的工作原理三、代码示例四、编译后的底层实现五、总结C#异步编程

python3 gunicorn配置文件的用法解读

《python3gunicorn配置文件的用法解读》:本文主要介绍python3gunicorn配置文件的使用,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录python3 gunicorn配置文件配置文件服务启动、重启、关闭启动重启关闭总结python3 gun

MySQL 中的 LIMIT 语句及基本用法

《MySQL中的LIMIT语句及基本用法》LIMIT语句用于限制查询返回的行数,常用于分页查询或取部分数据,提高查询效率,:本文主要介绍MySQL中的LIMIT语句,需要的朋友可以参考下... 目录mysql 中的 LIMIT 语句1. LIMIT 语法2. LIMIT 基本用法(1) 获取前 N 行数据(