Java自学者论坛

 找回密码
 立即注册

手机号码,快捷登录

恭喜Java自学者论坛(https://www.javazxz.com)已经为数万Java学习者服务超过8年了!积累会员资料超过10000G+
成为本站VIP会员,下载本站10000G+会员资源,会员资料板块,购买链接:点击进入购买VIP会员

JAVA高级面试进阶训练营视频教程

Java架构师系统进阶VIP课程

分布式高可用全栈开发微服务教程Go语言视频零基础入门到精通Java架构师3期(课件+源码)
Java开发全终端实战租房项目视频教程SpringBoot2.X入门到高级使用教程大数据培训第六期全套视频教程深度学习(CNN RNN GAN)算法原理Java亿级流量电商系统视频教程
互联网架构师视频教程年薪50万Spark2.0从入门到精通年薪50万!人工智能学习路线教程年薪50万大数据入门到精通学习路线年薪50万机器学习入门到精通教程
仿小米商城类app和小程序视频教程深度学习数据分析基础到实战最新黑马javaEE2.1就业课程从 0到JVM实战高手教程MySQL入门到精通教程
查看: 371|回复: 0

Spring Boot HTTP over JSON 的错误码异常处理

[复制链接]
  • TA的每日心情
    奋斗
    2024-11-24 15:47
  • 签到天数: 804 天

    [LV.10]以坛为家III

    2053

    主题

    2111

    帖子

    72万

    积分

    管理员

    Rank: 9Rank: 9Rank: 9

    积分
    726782
    发表于 2021-6-18 19:04:10 | 显示全部楼层 |阅读模式

    摘要: 原创出处:www.bysocket.com 泥瓦匠BYSocket 希望转载,保留摘要,谢谢!

    “年轻人不要怕表现,要敢于出来表现,但还是那句话,要有正确的度,你的表现是分析问题和解决问题的能力。”

    – 《你凭什么做好互联网》

    本文提纲
    一、异常统一处理的使用场景
    二、运行 springboot-validation-over-json 工程
    三、springboot-validation-over-json 工程代码详解

    一、异常统一处理的使用场景

    在前后端分离开发中,经常用 HTTP over JSON 作为服务进行前后端联调对接。这里简单介绍下为啥前后端分离开发?我想到如下:

    1.低耦合,责权分离,模块化。前后端之间利用轻量级协议对接耦合。
    2.便于敏捷开发:后端给出 api 文档 -> 前端根据文档,mock出数据开发 ;同时,后端实现业务逻辑。
    3.微服务尤其适用

    这时候 HTTP over JSON 形式中很多涉及到返回码,错误码相关的处理。比如xxx参数不完整,权限不足,用户不存在等。

    怎么统一处理认为是异常的场景呢?
    利用的是 Spring 4.x 提供的 RestControllerAdvice。这里做下说明,也可以根据 ControllerAdvice 去实现。这里案例是 HTTP over JSON 模式,所以直接利用
    RestControllerAdvice ,控制层通知器,这里用于统一拦截异常,进行响应处理。工作模式,如图:

    二、运行 springboot-validation-over-json 工程

    运行环境:JDK 7 或 8,Maven 3.0+
    技术栈:SpringBoot 1.5+(内涵 Spring 4.x)

    1.git clone 下载工程 springboot-learning-example
    项目地址见 GitHub – https://github.com/JeffLi1993/springboot-learning-example:

    1
    git clone git@github.com:JeffLi1993 /springboot-learning-example .git

    然后,Maven 编译安装这个工程:

    1
    2
    cd springboot-learning-example
    mvn clean install

    2.运行 springboot-validation-over-json 工程
    右键运行 springboot-validation-over-json 工程 Application 应用启动类的 main 函数。默认端口 8080

    3.访问案例
    a. 参数不完整案例:
    访问浏览器打开下面链接,可得到以下 JSON 返回
    http://localhost:8080/api/city?cityName=

    1
    2
    3
    4
    5
    {
         "code" : "000001" ,
         "message" : "params no complete" ,
         "result" : null
    }

    b. 成功案例:
    访问浏览器打开下面链接,可得到以下 JSON 返回
    http://localhost:8080/api/city?cityName=%E6%B8%A9%E5%B2%AD%E5%B8%82

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    {
         "code" : "0" ,
         "message" : "success" ,
         "result" : {
             "id" : 1,
             "provinceId" : 2,
             "cityName" : "温岭" ,
             "description" : "是我的故乡"
         }
    }

    三、springboot-validation-over-json 工程代码详解

    代码详解提纲:
    a.控制层通知器
    b.响应码设计

    同样,代码共享在我的 GitHub 上:
    https://github.com/JeffLi1993/springboot-learning-example/tree/master/springboot-validation-over-json

    首先,工程代码目录如下:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    ├── pom.xml
    └── src
         └── main
             └── java
                 └── org
                     └── spring
                         └── springboot
                             ├── Application.java
                             ├── constant
                             │   └── CityErrorInfoEnum.java
                             ├── result
                             │   ├── ErrorInfoInterface.java
                             │   ├── GlobalErrorInfoEnum.java
                             │   ├── GlobalErrorInfoException.java
                             │   ├── GlobalErrorInfoHandler.java
                             │   └── ResultBody.java
                             └── web
                                 ├── City.java
                                 └── ErrorJsonController.java

    a.控制层通知器
    GlobalErrorInfoHandler.java 代码如下:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    @RestControllerAdvice
    public class GlobalErrorInfoHandler {
     
    @ExceptionHandler (value = GlobalErrorInfoException. class )
    public ResultBody errorHandlerOverJson(HttpServletRequest request,
    GlobalErrorInfoException exception) {
         ErrorInfoInterface errorInfo = exception.getErrorInfo();
         ResultBody result = new ResultBody(errorInfo);
         return result;
    }
    }

    @ExceptionHandler 注解,标记了使用 errorHandlerOverJson() 方法来处理 GlobalErrorInfoException 异常。
    @RestControllerAdvice 是 @ControllerAdvice 和 @ResponseBody 的语义结合。是控制器增强,直接返回对象。这里用于统一拦截异常,然后返回错误码对象体。
    @ResponseBody 作用: 该注解用于将 Controller 的方法返回的对象,通过适当的 HttpMessageConverter 转换为指定格式后,写入到 Response 对象的 body 数据区。

    b.响应码设计
    简单讲讲,这里定义了一个错误码接口,全局错误码枚举和各个业务错误码枚举去实现接口,并用枚举值枚举出错误码及错误码消息列表。如图:

    四、小结

    如果实战中,大家遇到什么,或者建议《Spring boot 那些事》还需要一起交流的。请点击留言。

    推荐书《腾讯传》,其中几章写的很不错。

    欢迎扫一扫我的公众号关注 — 及时得到博客订阅哦!
    — http://www.bysocket.com/ —
    — https://github.com/JeffLi1993 —

    哎...今天够累的,签到来了1...
    回复

    使用道具 举报

    您需要登录后才可以回帖 登录 | 立即注册

    本版积分规则

    QQ|手机版|小黑屋|Java自学者论坛 ( 声明:本站文章及资料整理自互联网,用于Java自学者交流学习使用,对资料版权不负任何法律责任,若有侵权请及时联系客服屏蔽删除 )

    GMT+8, 2025-2-2 01:46 , Processed in 0.065766 second(s), 29 queries .

    Powered by Discuz! X3.4

    Copyright © 2001-2021, Tencent Cloud.

    快速回复 返回顶部 返回列表