文档章节

spring boot / cloud (二) 规范响应格式以及统一异常处理

wangkang80
 wangkang80
发布于 2017/05/25 14:54
字数 635
阅读 1414
收藏 6
点赞 0
评论 3

spring boot / cloud (二) 规范响应格式以及统一异常处理

##前言

###为什么规范响应格式?

我认为,采用预先约定好的数据格式,将返回数据(无论是正常的还是异常的)规范起来,有助于提高团队间接口对接的效率(前端和后端,后端和后端等).

##思路

  • 自定义统一的ResposeBody类 : 用于统一响应格式

  • 自定义统一的Error类 : 用于统一异常格式

  • 自定义异常 : 区分不同场景的异常

  • 实现ExceptionHandler : 用于拦截处理异常

##实现

###1.创建ErrorResult类

public class ErrorResult implements Serializable {

	........省略

	//异常发生时间
	private Date exceptionDate;
	
	//异常类名
	private String exceptionType;
	
	//异常描述
	private String exceptionMessage;
	
	//异常堆栈
	private String exceptionStackTrace;
	
	........省略

}

###2.创建RestResponse类

使用泛型,来适应不同类型的结果集

响应代码和响应描述,可自定义枚举来规范

注意,一定有留有无参的构造函数,否则json转换会报错

public class RestResponse<T> implements Serializable {

	........省略

	//响应ID
	private String id = UUID.randomUUID().toString();
	
	//响应代码
	private String code = "SUCCESS";
	
	//响应描述
	private String message = "操作成功";
	
	//响应体
	private T result = null;
	
	//错误体
	private ErrorResult error = null;
	
	//构造函数
	public RestResponse() {
	   super();
	}
  	
  	//构造函数
   public RestResponse(ErrorCode errorCode, ErrorResult error) {
      super();
      this.code = errorCode.name();
      this.message = errorCode.value();
      this.error = error;
   }
	
	........省略

}

###3.自定义异常

检查型异常

public class SystemException extends Exception {
	........省略
}

运行时异常

public class SystemRuntimeException extends RuntimeException {
	........省略
}

其他类型异常,如:认证异常,权限异常,参数校验异常,等等,按需定义

public class AuthException extends RuntimeException {
	........省略
}

###4.创建ExceptionMapping类

@ControllerAdvice
public class ExceptionMapping {
	........省略
}

定义私有的方法构造ErrorResult

private ErrorResult buildError(Exception exception) {
  ErrorResult error = new ErrorResult();
  error.setType(exception.getClass().getName());
  error.setMessage(ExceptionUtils.getMessage(exception));
  error.setStackTrace(ExceptionUtils.getStackTrace(exception));
  error.setDate(new Date());
  LOGGER.error(exception.getClass().getName(), exception);
  return error;
}

按照异常类型,拦截处理异常,拦截的优先级遵循类的集成关系,优先拦截子类异常

@ExceptionHandler(value = 要拦截的异常.class)
@ResponseStatus(响应状态)
@ResponseBody
public RestResponse<String> exception(要拦截的异常 exception) {
  return new RestResponse<>(ErrorCode.ERROR, buildError(exception));
}

这里提醒注意点,如果想要拦截404错误的话,需要在spring boot中做如下设置

spring.mvc.throw-exception-if-no-handler-found=true
spring.resources.add-mappings=false

##结束

然后相关思路和原则,大家可自行搜索契约优先,由于本身不想在文章中引入太多教条性的东西,主要都是以解决问题的思路为主,所以不深入讨论.


想获得最快更新,请关注公众号

想获得最快更新,请关注公众号

© 著作权归作者所有

共有 人打赏支持
wangkang80
粉丝 345
博文 22
码字总数 34117
作品 3
浦东
高级程序员
加载中

评论(3)

wangkang80
wangkang80

引用来自“jackerx”的评论

统一处理错误和异常 用spring boot的ErrorController 更简单
可以看我的这两篇博客
https://my.oschina.net/wangkang80/blog/1519189
https://my.oschina.net/wangkang80/blog/1523308
jackerx
jackerx
统一处理错误和异常 用spring boot的ErrorController 更简单
小蚂蚁飞呀飞
66666666
UDF 集成样例--udf-sample

UDF 基于spring boot / spring cloud 的基础项目,脚手架,主要用于学习和实践 按照spring boot的思想,将各个不同的功能按照starter的形式拆分开来,做到灵活组合 物理架构示意 CI & CD 示意 代...

wangkang80
2017/08/27
344
0
springboot + shiro 权限注解、请求乱码解决、统一异常处理

springboot + shiro 权限注解、请求乱码解决、统一异常处理 前篇 后台权限管理系统 相关: spring boot + mybatis + layui + shiro后台权限管理系统 springboot + shiro之登录人数限制、登录...

wyait
06/06
0
0
利用 Spring Boot 设计风格良好的Restful API及错误响应

一、前言 网上经常会看到一些文章,旨在介绍如何使用Spring MVC或Spring Boot实现Restful接口,譬如: 对于如上实现方式,本人着实不敢恭维。试问,这算哪门子的Restful?自认为其与Restful...

宅楠军
07/05
0
0
Spring Cloud Spring Boot mybatis分布式微服务云架构 返回JSON格式

在上述例子中,通过统一定义不同Exception映射到不同错误处理页面。而当我们要实现RESTful API时,返回的错误是JSON格式的数据,而不是HTML页面,这时候我们也能轻松支持。 本质上,只需在之...

itcloud
06/21
0
0
Spring cloud 微服务安全解决方案

Spring boot 微服务安全解决方案 作者:netkiller 本文节选自《Netkiller Architect 手札》 Restful 的通信安全有很多中解决方案,例如 1. HTTP Basic Auth 认证 2. Cooke / Session 认证 3. T...

netkiller-
2017/10/21
0
3
Spring Boot学习笔记-错误处理及自定义

正常的Web应用开发时,需要考虑到应用运行发生异常时或出现错误时如何来被处理,例如捕获必要的异常信息,记录日志方便日后排错,友好的用户响应输出等等。 当然应用发生错误,有可能是应用自...

chace0120
2015/12/31
3.6K
0
spring boot 之依赖

spring boot 虽然不强制使用特殊的依赖。但是其提供了一些非常高效的依赖。其中最有如下几个: spring-boot-starter-parent spring-boot-starter-data-jpa数据库连接的依赖。 spring-cloud-c...

乾坤刀
05/28
0
0
疯狂Spring Cloud连载(11)——Feign的编码器与解码器

本文节选自《疯狂Spring Cloud微服务架构实战》 京东购买地址:https://item.jd.com/12256011.html 当当网购买地址:http://product.dangdang.com/25201393.html Spring Cloud教学视频:htt...

杨大仙的程序空间
2017/10/23
0
4
spring-boot-starter-grpc 实现原理

RPC 流程 1、服务调用方(Client)将远程方法的信息(如类名、方法方法名、方法传入的参数)封装为统一的请求体; 2、序列化请求对象,转化为二进制串,方便传输; 3、通过 Client Stub 发送...

Anoyi
05/20
0
0
Spring Cloud Finchley 正式发布,兼容 Spring Boot 2.0.x

经过数个前期测试版本,Spring Cloud Finchley 终于迎来了正式版本: 下载地址 发行说明 显著变化: 与 Spring Boot 2.0.x 兼容 不支持 Spring Boot 1.5.x 最低要求 Java 8 新增 Spring Clo...

淡漠悠然
06/20
0
12

没有更多内容

加载失败,请刷新页面

加载更多

下一页

NNS域名系统之域名竞拍

0x00 前言 其实在官方文档中已经对域名竞拍的过程有详细的描述,感兴趣的可以移步http://doc.neons.name/zh_CN/latest/nns_protocol.html#id30 此处查阅。 我这里主要对轻钱包开发中会用到的...

暖冰
今天
0
0
32.filter表案例 nat表应用 (iptables)

10.15 iptables filter表案例 10.16/10.17/10.18 iptables nat表应用 10.15 iptables filter表案例: ~1. 写一个具体的iptables小案例,需求是把80端口、22端口、21 端口放行。但是,22端口我...

王鑫linux
今天
0
0
shell中的函数&shell中的数组&告警系统需求分析

20.16/20.17 shell中的函数 20.18 shell中的数组 20.19 告警系统需求分析

影夜Linux
今天
0
0
Linux网络基础、Linux防火墙

Linux网络基础 ip addr 命令 :查看网口信息 ifconfig命令:查看网口信息,要比ip addr更明了一些 centos 7默认没安装ifconfig命令,可以使用yum install -y net-tools命令来安装。 ifconfig...

李超小牛子
今天
1
0
[机器学习]回归--Decision Tree Regression

CART决策树又称分类回归树,当数据集的因变量为连续性数值时,该树算法就是一个回归树,可以用叶节点观察的均值作为预测值;当数据集的因变量为离散型数值时,该树算法就是一个分类树,可以很...

wangxuwei
昨天
1
0
Redis做分布式无锁CAS的问题

因为Redis本身是单线程的,具备原子性,所以可以用来做分布式无锁的操作,但会有一点小问题。 public interface OrderService { public String getOrderNo();} public class OrderRe...

算法之名
昨天
10
0
143. Reorder List - LeetCode

Question 143. Reorder List Solution 题目大意:给一个链表,将这个列表分成前后两部分,后半部分反转,再将这两分链表的节点交替连接成一个新的链表 思路 :先将链表分成前后两部分,将后部...

yysue
昨天
1
0
数据结构与算法1

第一个代码,描述一个被称为BankAccount的类,该类模拟了银行中的账户操作。程序建立了一个开户金额,显示金额,存款,取款并显示余额。 主要的知识点联系为类的含义,构造函数,公有和私有。...

沉迷于编程的小菜菜
昨天
1
0
从为什么别的队伍总比你的快说起

在机场候检排队的时候,大多数情况下,别的队伍都要比自己所在的队伍快,并常常懊悔当初怎么没去那个队。 其实,最快的队伍只能有一个,而排队之前并不知道那个队快。所以,如果有六个队伍你...

我是菜鸟我骄傲
昨天
1
0
分布式事务常见的解决方案

随着互联网的发展,越来越多的多服务相互之间的调用,这时候就产生了一个问题,在单项目情况下很容易实现的事务控制(通过数据库的acid控制),变得不那么容易。 这时候就产生了多种方案: ...

小海bug
昨天
3
0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

返回顶部
顶部