实战篇-设计类实战

# Java接口Result设计

方法签名
User getUserById(Long userId) throws BizException;

- 返回值User:方法的输出,方法的功能执行结果的准确表达,不应该有超出这个语义的东西存在。
- 异常BizException: 方法意外出现的错误,指超出这个方法之外的部分。

## 什么是意外-系统异常
意外指我们无法预知的,非正常情况,比如网络超时,DB异常,Bug等,调用方一般不太可能基于这些错误做不同的业务逻辑处理,调用不能通过调整参数继续处理。常用于日志和监控,方便定位排查。
结论:系统异常,通过异常返回

## 什么是失败-业务失败
失败指业务规则拦截导致的失败,比如密码错误,权限不足,余额不足。调用方可以根据不同的失败状态,完成不同的业务逻辑。
结论:业务失败,通过返回值返回

## 判断标准是什么
如果一个错误,调用方只能通过人工介入的方式才能恢复,比如修改代码,该配置,则必然属于异常;
如果调用方无法使用代码逻辑来处理错误而自动恢复,而是只能通过重试的方式,依赖下游的恢复才能恢复,则属于异常

## 接口返回设计建议
1. 对响应合理分类

普通读接口,建议直接用领域对象作为返回值,有特殊业务规则的除外
普通写接口,建议使用Result作为返回值,避免直接包装原生类型,避免所有的错误定义在一个类中

2. 对异常的处理
> 处理位置:
原始位置catch,记录日志,记录出入参,转化为本应用异常,上抛;
应用顶层catch,打印统一日志,打印堆栈,返回统一结果
中间层,不catch

> 处理方式:
系统异常直接抛出异常
参数错误,一般可以使用assert来保证正确。即我们的后续逻辑认为,当前的参数是不可能错误的,我么没必要为此写过多繁琐的防御性代码
系统异常并非一定是异常,我们可以转化成一个业务结果,比如网络异常无法获取结果,我们需要转化为未知状态,通过查询结果获取最终结果


The Complete Works of Tao Technology 2021

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 218,640评论 6 507
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 93,254评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 165,011评论 0 355
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,755评论 1 294
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,774评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,610评论 1 305
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,352评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,257评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,717评论 1 315
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,894评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,021评论 1 350
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,735评论 5 346
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,354评论 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,936评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,054评论 1 270
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,224评论 3 371
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,974评论 2 355

推荐阅读更多精彩内容