立即前往

活动

天翼云最新优惠活动,涵盖免费试用,产品折扣等,助您降本增效!
查看全部活动
热门活动
  • 智算采购季 热销S6云服务器2核4G限时88元/年起,部分主机可加赠对象存储组合包!
  • 免费体验DeepSeek,上天翼云息壤 NEW 新老用户均可免费体验2500万Tokens,限时两周
  • 云上钜惠 HOT 爆款云主机全场特惠,更有万元锦鲤券等你来领!
  • 算力套餐 HOT 让算力触手可及
  • 天翼云脑AOne NEW 连接、保护、办公,All-in-One!
  • 一键部署Llama3大模型学习机 0代码一键部署,预装最新主流大模型Llama3与StableDiffusion
  • 中小企业应用上云专场 产品组合下单即享折上9折起,助力企业快速上云
  • 息壤高校钜惠活动 NEW 天翼云息壤杯高校AI大赛,数款产品享受线上订购超值特惠
  • 天翼云电脑专场 HOT 移动办公新选择,爆款4核8G畅享1年3.5折起,快来抢购!
  • 天翼云奖励推广计划 加入成为云推官,推荐新用户注册下单得现金奖励
免费活动
  • 免费试用中心 HOT 多款云产品免费试用,快来开启云上之旅
  • 天翼云用户体验官 NEW 您的洞察,重塑科技边界

智算服务

打造统一的产品能力,实现算网调度、训练推理、技术架构、资源管理一体化智算服务
智算云(DeepSeek专区)
科研助手
  • 算力商城
  • 应用商城
  • 开发机
  • 并行计算
算力互联调度平台
  • 应用市场
  • 算力市场
  • 算力调度推荐
一站式智算服务平台
  • 模型广场
  • 体验中心
  • 服务接入
智算一体机
  • 智算一体机
大模型
  • DeepSeek-R1-昇腾版(671B)
  • DeepSeek-R1-英伟达版(671B)
  • DeepSeek-V3-昇腾版(671B)
  • DeepSeek-R1-Distill-Llama-70B
  • DeepSeek-R1-Distill-Qwen-32B
  • Qwen2-72B-Instruct
  • StableDiffusion-V2.1
  • TeleChat-12B

应用商城

天翼云精选行业优秀合作伙伴及千余款商品,提供一站式云上应用服务
进入甄选商城进入云市场创新解决方案
办公协同
  • WPS云文档
  • 安全邮箱
  • EMM手机管家
  • 智能商业平台
财务管理
  • 工资条
  • 税务风控云
企业应用
  • 翼信息化运维服务
  • 翼视频云归档解决方案
工业能源
  • 智慧工厂_生产流程管理解决方案
  • 智慧工地
建站工具
  • SSL证书
  • 新域名服务
网络工具
  • 翼云加速
灾备迁移
  • 云管家2.0
  • 翼备份
资源管理
  • 全栈混合云敏捷版(软件)
  • 全栈混合云敏捷版(一体机)
行业应用
  • 翼电子教室
  • 翼智慧显示一体化解决方案

合作伙伴

天翼云携手合作伙伴,共创云上生态,合作共赢
天翼云生态合作中心
  • 天翼云生态合作中心
天翼云渠道合作伙伴
  • 天翼云代理渠道合作伙伴
天翼云服务合作伙伴
  • 天翼云集成商交付能力认证
天翼云应用合作伙伴
  • 天翼云云市场合作伙伴
  • 天翼云甄选商城合作伙伴
天翼云技术合作伙伴
  • 天翼云OpenAPI中心
  • 天翼云EasyCoding平台
天翼云培训认证
  • 天翼云学堂
  • 天翼云市场商学院
天翼云合作计划
  • 云汇计划
天翼云东升计划
  • 适配中心
  • 东升计划
  • 适配互认证

开发者

开发者相关功能入口汇聚
技术社区
  • 专栏文章
  • 互动问答
  • 技术视频
资源与工具
  • OpenAPI中心
开放能力
  • EasyCoding敏捷开发平台
培训与认证
  • 天翼云学堂
  • 天翼云认证
魔乐社区
  • 魔乐社区

支持与服务

为您提供全方位支持与服务,全流程技术保障,助您轻松上云,安全无忧
文档与工具
  • 文档中心
  • 新手上云
  • 自助服务
  • OpenAPI中心
定价
  • 价格计算器
  • 定价策略
基础服务
  • 售前咨询
  • 在线支持
  • 在线支持
  • 工单服务
  • 建议与反馈
  • 用户体验官
  • 服务保障
  • 客户公告
  • 会员中心
增值服务
  • 红心服务
  • 客户支持计划
  • 专家技术服务
  • 备案管家

了解天翼云

天翼云秉承央企使命,致力于成为数字经济主力军,投身科技强国伟大事业,为用户提供安全、普惠云服务
品牌介绍
  • 关于天翼云
  • 智算云
  • 天翼云4.0
  • 新闻资讯
  • 天翼云APP
基础设施
  • 全球基础设施
  • 产品能力
  • 信任中心
最佳实践
  • 精选案例
  • 超级探访
  • 云杂志
  • 分析师和白皮书
  • 天翼云·创新直播间
市场活动
  • 2025智能云生态大会
  • 2024智算云生态大会
  • 2023云生态大会
  • 2022云生态大会
  • 天翼云中国行
天翼云
  • 活动
  • 智算服务
  • 产品
  • 解决方案
  • 应用商城
  • 合作伙伴
  • 开发者
  • 支持与服务
  • 了解天翼云
    • 关系数据库SQL Server版
    • 企业主机安全
    • 云防火墙
    • CDN加速
    • 物理机
    • GPU云主机
    • 天翼云电脑(政企版)
    • 天翼云电脑(公众版)
    • 云主机备份
    • 弹性云主机
      搜索发现
      关系数据库SQL Server版企业主机安全云防火墙CDN加速物理机GPU云主机天翼云电脑(政企版)天翼云电脑(公众版)云主机备份弹性云主机
    • 文档
    • 控制中心
    • 备案
    • 管理中心
    • 登录
    • 免费注册

    ControllerAdvice用法

    首页 知识中心 软件开发 文章详情页

    ControllerAdvice用法

    2024-05-17 06:56:39 阅读次数:44

    springboot,开发语言

    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 // 确保返回的对象被序列化为JSON
        public 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 {
    
        @InitBinder
        public 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}来访问它。

    版权声明:本文内容来自第三方投稿或授权转载,原文地址:https://blog.csdn.net/kaka_buka/article/details/137670964,作者:黑风风,版权归原作者所有。本网站转在其作品的目的在于传递更多信息,不拥有版权,亦不承担相应法律责任。如因作品内容、版权等问题需要同本网站联系,请发邮件至ctyunbbs@chinatelecom.cn沟通。

    上一篇:给定字符串 S and T,找出 S 中最短的(连续)子串 W ,使得 T 是 W 的 子序列 。 如果 S 中没有窗口可以包含 T 中的所有字符,返回空字符串 ““。

    下一篇:自定义使用S缓存方法

    相关文章

    2025-04-23 08:18:27

    nginx结合前后端分离项目springboot+vue的配置

    项目采用的是前后端分离springboot+vue,通过nginx监听,转发到对应的前端页面或者后台接口调用

    2025-04-23 08:18:27
    nginx , springboot , vue , 分离 , 配置
    2025-04-23 08:18:21

    springboot整合LDAP的另外一种方式并实现增删改查功能

    springboot整合LDAP的另外一种方式并实现增删改查功能

    2025-04-23 08:18:21
    springboot , yml , 配置
    2025-04-23 08:18:21

    springboot 整合 LDAP

    springboot 整合 LDAP

    2025-04-23 08:18:21
    LDAP , springboot , 配置
    2025-04-07 10:28:48

    Python高维统计建模变量选择:SCAD平滑剪切绝对偏差惩罚、Lasso惩罚函数比较

    变量选择是高维统计建模的重要组成部分。许多流行的变量选择方法,例如 LASSO,都存在偏差。

    2025-04-07 10:28:48
    python , r语言 , 后端 , 开发语言
    2025-04-07 10:20:39

    ​Python是如何表示时间的?2个模块、3种方式,1文看懂~

    ​Python是如何表示时间的?2个模块、3种方式,1文看懂~

    2025-04-07 10:20:39
    python , 开发语言 , 时间戳 , 结构化
    2025-04-01 10:28:37

    找到非负数组中拥有“最大或的结果“的最短子数组,返回最短长度。

    找到非负数组中拥有"最大或的结果"的最短子数组,返回最短长度。

    2025-04-01 10:28:37
    java代码 , rust , 后端 , 开发语言 , 数组
    2025-04-01 09:21:49

    【C语言】探索数据的存储(上篇)

    【C语言】探索数据的存储(上篇)

    2025-04-01 09:21:49
    c语言 , 后端 , 开发语言
    2025-03-31 08:49:25

    MFC编程 -- 判断是否按下ctrl和shift键

    MFC编程 -- 判断是否按下ctrl和shift键

    2025-03-31 08:49:25
    c++ , mfc , 开发语言
    2025-03-24 08:53:06

    【编译原理实验】 -- 词法分析程序设计原理与实现(C语言实现)

    【编译原理实验】 -- 词法分析程序设计原理与实现(C语言实现)

    2025-03-24 08:53:06
    c语言 , 开发语言
    2025-03-04 09:13:56

    springboot整合mybatis-plus超快速

    springboot整合mybatis-plus超快速

    2025-03-04 09:13:56
    Mapper , mybatis , springboot
    查看更多
    推荐标签

    作者介绍

    天翼云小翼
    天翼云用户

    文章

    32777

    阅读量

    4819955

    查看更多

    最新文章

    Python高维统计建模变量选择:SCAD平滑剪切绝对偏差惩罚、Lasso惩罚函数比较

    2025-04-07 10:28:48

    ​Python是如何表示时间的?2个模块、3种方式,1文看懂~

    2025-04-07 10:20:39

    找到非负数组中拥有“最大或的结果“的最短子数组,返回最短长度。

    2025-04-01 10:28:37

    【C语言】探索数据的存储(上篇)

    2025-04-01 09:21:49

    MFC编程 -- 判断是否按下ctrl和shift键

    2025-03-31 08:49:25

    【编译原理实验】 -- 词法分析程序设计原理与实现(C语言实现)

    2025-03-24 08:53:06

    查看更多

    热门文章

    SpringBoot配置文件分类

    2023-07-27 06:49:01

    springboot接受post/get参数值的几种形式,Java

    2023-04-11 10:14:19

    java学习第三天笔记-运算符10-短路逻辑运算符56

    2023-04-07 06:41:50

    ESLint:可组装的JavaScript和JSX检查工具

    2023-02-23 07:57:25

    Filter&Listener笔记

    2023-02-22 08:37:42

    java学习第二天笔记-java基础概念08-数据类型-30

    2023-04-10 08:53:07

    查看更多

    热门标签

    java Java python 编程开发 开发语言 代码 算法 线程 html Python 数组 C++ javascript c++ 元素
    查看更多

    相关产品

    弹性云主机

    随时自助获取、弹性伸缩的云服务器资源

    天翼云电脑(公众版)

    便捷、安全、高效的云电脑服务

    对象存储

    高品质、低成本的云上存储服务

    云硬盘

    为云上计算资源提供持久性块存储

    查看更多

    随机文章

    输入:去重数组arr,里面的数只包含0~9。limit,一个数字。 返回:要求比limit小的情况下,能够用arr拼出来的最大数字。

    Spring 中经典的 9 种设计模式

    Qt实现桌面右下角放置窗体

    Java Stream 流对象(实用技巧)

    小团生日收到妈妈送的两个一模一样的数列作为礼物! 他很开心的把玩,不过不小心没拿稳将数列摔坏了! 现在他手上的两个数列分别为A和B,长度分别为n和m。

    C++:数据类型-int(6)

    • 7*24小时售后
    • 无忧退款
    • 免费备案
    • 专家服务
    售前咨询热线
    400-810-9889转1
    关注天翼云
    • 权益商城
    • 天翼云APP
    • 天翼云微信公众号
    服务与支持
    • 备案中心
    • 售前咨询
    • 智能客服
    • 自助服务
    • 工单管理
    • 客户公告
    • 涉诈举报
    账户管理
    • 管理中心
    • 订单管理
    • 余额管理
    • 发票管理
    • 充值汇款
    • 续费管理
    快速入口
    • 权益商城
    • 文档中心
    • 最新活动
    • 免费试用
    • 信任中心
    • 天翼云学堂
    云网生态
    • 甄选商城
    • 渠道合作
    • 云市场合作
    了解天翼云
    • 关于天翼云
    • 天翼云APP
    • 服务案例
    • 新闻资讯
    • 联系我们
    热门产品
    • 云电脑
    • 弹性云主机
    • 云电脑政企版
    • 天翼云手机
    • 云数据库
    • 对象存储
    • 云硬盘
    • Web应用防火墙
    • 服务器安全卫士
    • CDN加速
    热门推荐
    • 云服务备份
    • 边缘安全加速平台
    • 全站加速
    • 安全加速
    • 云服务器
    • 云主机
    • 智能边缘云
    • 应用编排服务
    • 微服务引擎
    • 共享流量包
    更多推荐
    • web应用防火墙
    • 密钥管理
    • 等保咨询
    • 安全专区
    • 应用运维管理
    • 云日志服务
    • 文档数据库服务
    • 云搜索服务
    • 数据湖探索
    • 数据仓库服务
    友情链接
    • 中国电信集团
    • 189邮箱
    • 天翼企业云盘
    • 天翼云盘
    ©2025 天翼云科技有限公司版权所有 增值电信业务经营许可证A2.B1.B2-20090001
    公司地址:北京市东城区青龙胡同甲1号、3号2幢2层205-32室
    • 用户协议
    • 隐私政策
    • 个人信息保护
    • 法律声明
    备案 京公网安备11010802043424号 京ICP备 2021034386号