【Spring】源码浅析 - ResponseEntity.ok

前言

  • 为什么这篇又不是Spring Boot初体验,因为在初体验过程中,我使用的方法返回值类型并不是基本数据类型,也不是String,而是用了ResponseEntity,为了避免有些人看不懂,在这篇做个ResponseEntity的源码浅析。
  • 主要浅析ResponseEntity.ok方法的源码
  • 本文是基于Spring5源码进行浅析
  • 本文及以后文章中的 API 指的是API文档描述

ResponseEntity.class

让我们打开ResponseEntity.class


ResponseEntity.class(部分)

嗯。可以说是非常的清爽了;一个注释文档都没看到┑( ̄Д  ̄)┍
无奈;只好上官网找API:ResponseEntity API

ResponseEntity概念

Extension of HttpEntity that adds a HttpStatus status code. Used in RestTemplate as well @Controller methods.

以上引用自ResponseEntity API

直译
可以添加HttpStatus状态码的HttpEntity的扩展类。被用于RestTemplate和Controller层方法
简单粗暴理解
ResponseEntity继承了HttpEntity,是HttpEntity的子类且可以添加HttpStatus状态码(推测HttpEntity不能添加HttpStatus状态码)。被用于RestTemplate和Controller层方法

ResponseEntity.ok API

在ResponseEntity中有两个ok方法;一个无参,一个有参

  • public static ResponseEntity.BodyBuilder ok()

Create a builder with the status set to OK.

以上引用自ResponseEntity API

直译
创建一个设置了OK状态的builder
简单粗暴理解
这个方法若被调用的话,返回OK状态

  • public static <T> ResponseEntity<T> ok(T body)

A shortcut for creating a ResponseEntity with the given body and the status set to OK.

以上引用自ResponseEntity API

直译
一种捷径去创建ResponseEntity,通过被给予的body和设置了OK的状态
简单粗暴理解
这个方法若被调用的话,返回body内容和OK状态

至于OK状态是什么,后面再解释

ResponseEntity.ok源码

//无参ok
public static ResponseEntity.BodyBuilder ok() {
        return status(HttpStatus.OK);
    }

//有参ok
public static <T> ResponseEntity<T> ok(T body) {
        ResponseEntity.BodyBuilder builder = ok();
        return builder.body(body);
    }

通过源码,我们不难发现

  • 与API中的描述一致,无参ok方法返回OK状态,有参ok方法返回body内容和OK状态
  • body类型 是 泛型T,也就是我们不确定body是什么类型,可以向ok方法传递任意类型的值
  • 有参ok方法其实有调用无参ok方法

那么源码中的BodyBuilder又是什么鬼呢,后面再解释

解释一下

OK状态是什么鬼

现在我们都知道ResponseEntity概念是可以添加HttpStatus状态码的HttpEntity的扩展类;那么不难推测出这个OK状态其实就是HttpStatus状态码(其实在上面的源码中也能看到了)

//无参ok
public static ResponseEntity.BodyBuilder ok() {
        return status(HttpStatus.OK);
    }

那么有计算机网络基础的看官都知道,在HttpStatus状态码中代表OK的是200;不信??看源码(应该没人不信吧┑( ̄Д  ̄)┍)

HttpStatus状态码(部分)

BodyBuilder又是什么鬼

ResponseEntity结构

ResponseEntity结构

通过ResponseEntity的结构,我们知道BodyBuilder是ResponseEntity中的接口

BodyBuilder API

Defines a builder that adds a body to the response entity.

以上引用自BodyBuilder API

直译
定义一个可以添加body到response entity的builder
简单粗暴理解
ResponseEntity可以通过这个builder返回任意类型的body内容

BodyBuilder源码

    public interface BodyBuilder extends ResponseEntity.HeadersBuilder<ResponseEntity.BodyBuilder> {
        ResponseEntity.BodyBuilder contentLength(long var1);

        ResponseEntity.BodyBuilder contentType(MediaType var1);

        <T> ResponseEntity<T> body(@Nullable T var1);
    }

通过BodyBuilder源码,不难发现

  • BodyBuilder接口中的body方法的参数可以为空值(有@Nullable标签名字推测其允许空值)

后记

  • 感觉写技术文章好艰难,要写好久,而且还要捋顺思路,这难度堪比编程,可能是我写的少的缘故吧(脑阔疼)
  • 这两天被ThreadLocal给吸引住了,在研究ThreadLocal的源码,怎么说,感觉ThreadLocal源码的思维逻辑对现在的我来说,好难理解,过几天(也许是十几天)也会出个ThreadLocal的源码浅析,当然是在写完Spring Boot初体验之后
  • 关于读源码,这是每个程序员的必经之路,而我现在正在经过;嗯。。虽然源码读得有点艰难,但还算有趣吧(真素脑阔疼)

参考文章

ResponseEntity API
BodyBuilder API

下篇预告

Spring Boot初体验

补充 于2018年08月25日

我才发现原来class文件是不会有注释文档的;
在idea中打开class文件,发现idea代码编辑区的右上角有个Download Sources,很明显就是下载源码的意思,我点了,然后源码就下载下来了,根本不用去官网查API的。。

ResponseEntity.java(部分)

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,637评论 18 139
  • Spring Web MVC Spring Web MVC 是包含在 Spring 框架中的 Web 框架,建立于...
    Hsinwong阅读 22,366评论 1 92
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,846评论 25 707
  • 下雨了。 听见雨声的时候有些惊讶,巴巴的跑下床去,窗户没有关,凄风冷雨,雨声让人听了安静,零星路灯的光把夜照得淡淡...
    青苔之城阅读 312评论 0 2
  • 35岁 你因为身体越来越差 加班越来越少 晋升的速度也越来越缓慢 那天下班,媳妇告诉你 孩子要上幼儿园了 双语的一...
    奈何岛上阅读 267评论 0 0