G核心網(wǎng)SBA架構(gòu)協(xié)議簡介

1/66RESTful

API介紹目錄：OpenAPI

3.0JSON及其語法介紹HTTP/2概述2/66RESTful

API介紹3/66議題

REST是什么REST式服務(wù)特點(diǎn)REST式服務(wù)優(yōu)點(diǎn)云學(xué)堂RESTfulAPI4/66REST是什么REST(RepresentationalStateTransfer):表示性狀態(tài)轉(zhuǎn)移，分布式超媒體軟件一個架構(gòu)格調(diào) --源自RoyThomasFielding博士論文。一套簡單設(shè)計標(biāo)準(zhǔn)、一個架構(gòu)格調(diào)(或模式)，不是一個詳細(xì)標(biāo)準(zhǔn)或架構(gòu)?；谑褂肏TTP、URI等現(xiàn)有廣泛流行協(xié)議和標(biāo)準(zhǔn)對Web本質(zhì)回歸，一個真實(shí)描述Web方式REST目標(biāo)：尋找Web特征，然后使用這些特征來指導(dǎo)Web設(shè)計5/66議題

REST是什么

REST式服務(wù)特點(diǎn)REST式服務(wù)優(yōu)點(diǎn)云學(xué)堂RESTfulAPI6/66REST式服務(wù)特點(diǎn)網(wǎng)絡(luò)上全部事物都被抽象為資源,每個資源對應(yīng)一個唯一資源標(biāo)識URI經(jīng)過HTTP協(xié)議方法作連接器對資源進(jìn)行操作對資源任何操作不改變資源標(biāo)識URI全部服務(wù)器操作都是無狀態(tài)7/66議題

REST是什么REST式服務(wù)特點(diǎn)

REST式服務(wù)優(yōu)點(diǎn)云學(xué)堂RESTfulAPI8/66REST式服務(wù)優(yōu)點(diǎn)能夠利用緩存Cache來提升響應(yīng)速度通訊本身無狀態(tài)性能夠讓不一樣服務(wù)器處理一系列請求中不一樣請求，提升服務(wù)器擴(kuò)展性瀏覽器即可作為客戶端，簡化軟件需求相對于其它疊加在HTTP協(xié)議之上機(jī)制，REST軟件依賴性更小不需要額外資源發(fā)覺機(jī)制在軟件技術(shù)演進(jìn)中長久兼容性更加好9/66議題

REST是什么REST式服務(wù)特點(diǎn)REST式服務(wù)優(yōu)點(diǎn)

云學(xué)堂RESTfulAPI10/66云學(xué)堂RESTfulAPI架構(gòu)設(shè)計/attachments/277/BackEnd%20Design.png11/66云學(xué)堂RESTfulAPI協(xié)議HTTPS更佳,條件限制時采取HTTP域名專用域名版本

/v1/URI集合資源/v1/orgs(英文單詞復(fù)數(shù))單個資源/v1/orgs/1625fdcb-2f44-4949-9e5d-8247e0f77a8c(唯一標(biāo)識這個資源id,不限于uuid)隸屬關(guān)系/v1/orgs//v1/orgs/1625fdcb-2f44-4949-9e5d-8247e0f77a8c/v1/orgs/1625fdcb-2f44-4949-9e5d-8247e0f77a8c/users/v1/orgs/1625fdcb-2f44-4949-9e5d-8247e0f77a8c/users/18ef1d08-803c-4f2c-a79e-a6edc839e5db12/66云學(xué)堂RESTfulAPIHTTP方法GET：獲?。⊿ELECT）POST：新建（CREATE）PUT：更新（UPDATE）DELETE：刪除（DELETE）HTTP方法+URIAPIPOST+集合資源URI：在服務(wù)器新建一個資源。GET+集合資源URI：從服務(wù)器取出資源列表。GET+單個資源URI：在服務(wù)器取出特定資源。PUT+單個資源URI：在服務(wù)器更新特定資源。DELETE+單個資源URI：從服務(wù)器刪除資源。13/66云學(xué)堂RESTfulAPI請求頭Source標(biāo)識調(diào)用方類別(101,102,103,201,202...)Token標(biāo)識當(dāng)前操作者身份Content-Type標(biāo)識請求體內(nèi)容格式(application/json)

Origin用于設(shè)定js跨域訪問時允許域名User-agent標(biāo)識當(dāng)前請求所用操作系統(tǒng)和瀏覽器信息X-FORWARDED-FORIIS服務(wù)器端調(diào)用RESTfulAPI時需要傳遞客戶端ip14/66云學(xué)堂RESTfulAPI請求參數(shù)

主要用于獲取資源列表類型API

排序?order=email%20asc參數(shù)值為字段名+%20+asc或desc

分頁?offset=30&limit=10分別用于指定返回統(tǒng)計開始位置和每頁統(tǒng)計數(shù)請求體HTTP方法為POST/PUT時需要

詳細(xì)定義需看API文檔15/66云學(xué)堂RESTfulAPI響應(yīng)狀態(tài)碼200OK-[GET]：服務(wù)器成功返回用戶請求數(shù)據(jù)。201CREATED-[POST/PUT]：用戶新建或修改數(shù)據(jù)成功。204NOCONTENT-[DELETE]：用戶刪除數(shù)據(jù)成功。400INVALIDREQUEST-[POST/PUT]：用戶發(fā)出請求有錯誤。401Unauthorized-[*]：表示用戶沒有權(quán)限（令牌、用戶名、密碼錯誤）。403Forbidden-[*]表示用戶得到授權(quán)（與401錯誤相對），不過訪問是被禁止。404NOTFOUND-[*]：用戶發(fā)出請求針正確是不存在統(tǒng)計。500INTERNALSERVERERROR-[*]：服務(wù)器發(fā)生錯誤，用戶將無法判斷發(fā)出請求是否成功。響應(yīng)體HTTP方法為GET/POST時返回

有Error時返回

詳細(xì)定義需看API文檔16/66云學(xué)堂RESTfulAPI響應(yīng)頭LocationHTTP方法為POST時返回用來表示新創(chuàng)建資源URIAccess-Control-Allow-Origin跨域訪問時設(shè)置允許域名響應(yīng)體HTTP方法為GET/POST時返回

詳細(xì)定義需看API文檔17/66云學(xué)堂RESTfulAPI犯錯時響應(yīng)

狀態(tài)碼400~50X詳細(xì)參見API文檔中Error列表

響應(yīng)體格式{"error":{"key":"${errorKey}","message":"${errorMsg}"}}詳細(xì)參見API文檔中Error列表18/66OpenAPI

3.019/66

OpenAPI規(guī)范目標(biāo)：定義標(biāo)準(zhǔn)、獨(dú)立于語言指向RESTAPI接口，使得服務(wù)能力無需訪問源代碼、文檔，或是借助于網(wǎng)絡(luò)流量檢驗(yàn)，就可被人類和計算機(jī)發(fā)覺并了解。經(jīng)過對OpenAPI做適當(dāng)定義后，消費(fèi)者可使用最小數(shù)量實(shí)現(xiàn)邏輯了解遠(yuǎn)程服務(wù)，并與遠(yuǎn)程服務(wù)交互。定義：OpenAPI即開放API,也稱開放平臺。所謂開放API（OpenAPI）是服務(wù)型網(wǎng)站常見一個應(yīng)用，網(wǎng)站服務(wù)商將自己網(wǎng)站服務(wù)封裝成一系列API（ApplicationProgrammingInterface，應(yīng)用編程接口）開放出去，供第三方開發(fā)者使用，這種行為就叫做開放網(wǎng)站API，所開放API就被稱作OpenAPI（開放API）20/66新

OpenAPI規(guī)范3.0

帶來了以下重大改進(jìn)為實(shí)現(xiàn)更加好可重用性，對規(guī)范整體架構(gòu)進(jìn)行了重構(gòu)，重構(gòu)后架構(gòu)以下列圖所表示。支持oneOf、anyOf和not

JSON模式?？墒褂媚Ｊ絽?shù)。引入了Cookie參數(shù)，去除了dataForm參數(shù)。含有本身實(shí)體主體參數(shù)（BodyParameter）?？蓞f(xié)商內(nèi)容類型。多主機(jī)支持。簡化了安全定義，改進(jìn)WebHooks不再經(jīng)過回調(diào)機(jī)制描述。21/6622/66OpenAPI3.0基礎(chǔ)URL結(jié)構(gòu)23/66JSON及其語法介紹24/66JSON介紹JSON（JavaScriptObjectNatation）一個輕量級數(shù)據(jù)交換格式和XML一樣，基于純文本數(shù)據(jù)格式能夠表示String、Number、Boolean、數(shù)組、甚至對象等數(shù)據(jù)適合于服務(wù)器與JavaScript客戶端交互25/66JSON基本語法JSON實(shí)際上基于JavaScript語法一個子集。值表示字符串、數(shù)值、true、false、null、Object或數(shù)組等。字符串"abc"、"\r\n"、"\u00A9"數(shù)值123、-123.5布爾true、falsenull26/66JSON基本語法數(shù)組表示使用[]

包含全部元素，每個元素用逗號分隔，元素能夠是任意值。比如:["abc",123,true,null]訪問其中元素，使用索引號，從0開始。27/66JSON基本語法Object表示用{}

包含一系列無序Key-Value鍵值對表示,其中Key和Value之間用冒號分割，每個key-value之間用逗號分割。比如:{"bookname":"Ajax基礎(chǔ)","publisher":"電子工業(yè)出版社","price":56.0}訪問其中數(shù)據(jù)，經(jīng)過obj.key來獲取對應(yīng)value28/66JSON基本語法

復(fù)雜數(shù)據(jù)表示

Object或數(shù)組中值還能夠是另一個Object或者數(shù)組，以表示更復(fù)雜數(shù)據(jù)比如:Listlist=newArrayList();List.add(emp)[{"name":"張三","age":18,"loves":["看書","玩游戲"]},{"name":"王五","age":20,"loves":["旅游"]}]29/66HTTP/2概述30/66HTTP/2概述31/66CONTENTSPART1PART2HTTP基礎(chǔ)Http/2協(xié)議PART3Http/2支持情況PART4Http/2疑慮32/66HTTP基礎(chǔ)11.1縮略語

1.2版本演進(jìn)

1.3HTTP概述

1.5安全相關(guān)

1.4HTTP現(xiàn)實(shí)狀況與優(yōu)化

33/661.1、HTTP基礎(chǔ)——縮略語123HTTP：超文本傳輸協(xié)議（HyperTextTransferProtocol)IETF：互聯(lián)網(wǎng)工程任務(wù)組（InternetEngineeringTaskForce)RFC：RequestForComments，一系列以編號排定文件幾乎全部互聯(lián)網(wǎng)標(biāo)準(zhǔn)都收錄在RFC文件之中4HTTPS：HTTP安全版（HTTPoverSecureSocketLayer)5SSL：安全套接層（SecureSocketsLayer）

TLS：傳輸層安全協(xié)議（TransportLayerSecurityProtocol）34/661.2、HTTP基礎(chǔ)——版本演進(jìn)（HTTP）SPDYHTTP/1.0RFC19451996.5HTTP/0.919911997.1HTTP/1.1RFC2616HTTP/2RFC754035/661.2、HTTP基礎(chǔ)——版本演進(jìn)（SSL/TLS）TLS1.01999NetScape企業(yè)公布SSL2.0版，很快發(fā)覺有嚴(yán)重漏洞1995NetScape設(shè)計SSL1.0，但未公布19941996SSL3.0版問世，得到大規(guī)模應(yīng)用TLS1.1TLS1.2TLS1.2修訂版SSL3.1SSL3.2SSL3.336/661.3、HTTP基礎(chǔ)——HTTP概述HTTPHTTPSURIHTML去哪里找？顯示什么？怎么傳輸？確保安全？怎么顯示？Web三要素URI統(tǒng)一資源定位http://host[“:”port][/path][queryString][#anchor]URL協(xié)議schema域名domain/host端口port路徑path查詢字符串queryString錨點(diǎn)anchor（特殊URI）Http請求請求方法空格URL空格協(xié)議版本回車符換行符頭部字段名:值回車符換行符…頭部字段名:值回車符換行符回車符換行符請求數(shù)據(jù)請求行請求頭請求數(shù)據(jù)GET、POST、PUT、DELETE、TRACE、OPTIONS、HEADCache-ControlAcceptAccept-CharsetUser-AgentAuthorizationHost……空行Http響應(yīng)狀態(tài)行協(xié)議版本號狀態(tài)碼1xx:信息（請求已接受）2xx:成功3xx:重定向4xx:客戶端錯誤5xx:服務(wù)端錯誤狀態(tài)描述響應(yīng)頭空行響應(yīng)正文HTTP1CS架構(gòu)2無狀態(tài)5靈活3簡單4應(yīng)用層基于TCPHTTP概述37/661.4、HTTP基礎(chǔ)——HTTP現(xiàn)實(shí)狀況與優(yōu)化

線頭阻塞網(wǎng)絡(luò)低延遲敏感HTTP現(xiàn)實(shí)狀況資源大小和數(shù)量不停增加過分設(shè)計IIIIIIIV雪碧圖圖片內(nèi)聯(lián)JS文件拼接多主機(jī)優(yōu)化38/661.5、HTTP基礎(chǔ)——安全相關(guān)SSL安全隱患TLS竊聽風(fēng)險篡改風(fēng)險冒充風(fēng)險加密傳輸校驗(yàn)機(jī)制CA證書應(yīng)對機(jī)制安全隱患及應(yīng)對機(jī)制Https握手機(jī)制客戶端（普通為瀏覽器）服務(wù)端（普通為Web應(yīng)用）②服務(wù)端響應(yīng)（支持協(xié)議版本不一致時直接關(guān)閉通信渠道）傳輸數(shù)據(jù)：確定協(xié)議版本和加密算法、證書（包含公鑰）、隨機(jī)數(shù)R2③客戶端握手結(jié)束（證書驗(yàn)證經(jīng)過或被信任之后）傳輸數(shù)據(jù)：使用公鑰加密后隨機(jī)數(shù)R3、編碼改變通知、客戶端握手結(jié)束通知（hash值）①客戶端加密請求傳輸數(shù)據(jù)：支持協(xié)議（如TLS1.0）、加密算法（如RSA）、隨機(jī)數(shù)R1④服務(wù)端握手結(jié)束傳輸數(shù)據(jù)：編碼改變通知、服務(wù)器握手結(jié)束通知（hash值）通訊雙方使用三個隨機(jī)數(shù)一起產(chǎn)生對稱加密密鑰，后續(xù)通訊全部加密傳輸包括4個相關(guān)概念①證書②非對稱加密③對稱加密④hash摘要算法HTTPS安全相關(guān)算法特征優(yōu)點(diǎn)缺點(diǎn)實(shí)現(xiàn)應(yīng)用對稱加密加解密密鑰相同簡單、效率高需協(xié)商共享密鑰，確保不外泄，兩兩之間需要一個密鑰DES3DESAESRC5加密普通數(shù)據(jù)非對稱加密加解密密鑰成對（公私鑰）安全、幾乎不能被破解耗時長RSAECC加密對稱算法中共享密鑰單向哈希算法相同數(shù)據(jù)結(jié)構(gòu)相同，不一樣數(shù)結(jié)果不一樣MD5SHA-1SHA-256驗(yàn)證數(shù)據(jù)完整性生成數(shù)字署名HTTPSSL/TLS數(shù)字證書HTTPSTCP非對稱加密數(shù)字署名數(shù)字摘要對稱加密39/66HTTP/2協(xié)議22.1概述

2.2連接

2.3幀

2.4多路復(fù)用2.6頭部壓縮

2.7中止

2.8服務(wù)端推送2.9流量控制2.5優(yōu)先級

2.10NPN/ALPN40/662.1、HTTP/2協(xié)議——概述HTTP/2https://http2.github.ioRFC7540-

HypertextTransferProtocolVersion2(HTTP/2)RFC7541-

HPACK:HeaderCompressionforHTTP/2HTTP/1.1SPDY/2基礎(chǔ)恪守HTTP范式理念、標(biāo)準(zhǔn)提供HTTP/1.1代理降低、刪除可選項不使用小版本號

提升響應(yīng)速度目標(biāo)

HTTP/1.1HTTP/2消息頭HPACK（SPDY使用DELEFT算法）傳輸格式文本二進(jìn)制（語義兼容、底層重構(gòu)）多路復(fù)用Pipeline支持優(yōu)先級、流量控制服務(wù)端推送支持41/662.2、HTTP/2協(xié)議——連接（一）網(wǎng)絡(luò)層（IP）傳輸層（TCP）TLS（可選）二進(jìn)制幀（Frame）應(yīng)用層（HTTP/2）HTTP/1.1POST/uploadHTTP/1.1Host:Content-Type:application/jsonContent-Length:15{“msg”:”hello”}Headers幀Data幀HTTP/242/662.2、HTTP/2協(xié)議——連接（二）1、連接（Connection）同域名下全部通信都在單個連接上完成，能夠承接任意數(shù)量雙向數(shù)據(jù)流2、流（Stream）含有唯一整數(shù)ID，以消息形式發(fā)送流（Stream）……4、Data4、Headers3、請求消息（RequestMessage）DataData3、響應(yīng)消息（ResponseMessage）HeadersDataHeaders請求消息（RequestMessage）DataData響應(yīng)消息（ResponseMessage）Headers消息由一個或多個幀組成，幀之間能夠亂序發(fā)送，因?yàn)橐罁?jù)幀首部流標(biāo)識能夠重新組裝43/662.3、HTTP/2協(xié)議——幀幀數(shù)據(jù)部分長度，不包含頭部，頭部長度固定為9字節(jié)（24+8+8+1+31=72位）Length(24)區(qū)分幀數(shù)據(jù)存放是Header還是Body，HTTP/2新定義了一些其它Type，可參考RFC7540文檔Type(8)共8位，每位都起標(biāo)識作用。每種不一樣FrameType都有不一樣FrameFlagsFlags(8)保留位R(1)流ID，當(dāng)客戶端和服務(wù)端建立TCP連接時，就會先發(fā)送一個StreamID=0流，用來做些初始化工作，之后客戶端和服務(wù)端從1開始發(fā)送請求/響應(yīng)StreamIdentifier幀格式，摘自RFC7540-4.1（/html/rfc7540#section-4.1）+-----------------------------------------------+|Length(24)|+---------------+---------------+---------------+|Type(8)|Flags(8)|+-+-------------+---------------+-------------------------------+|R|StreamIdentifier(31)|+=+=============================================================+|FramePayload(0...)...+---------------------------------------------------------------+幀頭部44/662.4、HTTP/2協(xié)議——多路復(fù)用HTTP/1.1closeclientserveropenHTTP/1.1pipeliningcloseclientserveropenHTTP/1.1線頭阻塞closeclientserveropenHTTP/2多路復(fù)用closeclientserveropen45/662.5、HTTP/2協(xié)議——優(yōu)先級46/662.6、HTTP/2協(xié)議——頭部壓縮（一）原理：維護(hù)一份字典索引表，實(shí)際傳輸時只傳輸對應(yīng)索引如使用2表示:method=GET,5表示:path=/index.html等動態(tài)字典哈夫曼編碼HPACK靜態(tài)字典

常見Header名稱

常見Header及取值用于動態(tài)添加內(nèi)容和HTTP2連接關(guān)聯(lián)，每個連接維護(hù)一個動態(tài)字典47/662.6、HTTP/2協(xié)議——頭部壓縮（二）48/662.7、HTTP/2協(xié)議——中止HTTP/1.1有一個缺點(diǎn)是：當(dāng)一個含有確切值Content-LengthHTTP消息被送出之后，你就極難中止它了。當(dāng)然，通常你能夠斷開整個TCP鏈接（但也不總是能夠這么），但這么造成代價就是需要經(jīng)過三次握手來重新建立一個新TCP連接。一個更加好方案是只終止當(dāng)前傳輸消息并重新發(fā)送一個新。在HTTP/2里面，能夠經(jīng)過發(fā)送RST_STREAM幀來實(shí)現(xiàn)這種需求，從而防止浪費(fèi)帶寬和中止已經(jīng)有連接。49/662.8、HTTP/2協(xié)議——服務(wù)端推送這個功效通常被稱作“緩存推送”。主要思想：當(dāng)一個客戶端請求資源X，而服務(wù)器知道它很可能也需要資源Z情況下，服務(wù)器能夠在客戶端發(fā)送請求前，主動將資源Z推送給客戶端。功效控制：服務(wù)器推送需要客戶端顯式允許服務(wù)器提供該功效。中止：假如不需要話，客戶端能夠經(jīng)過發(fā)送一個RST_STREAM幀來中止。50/662.9、HTTP/2協(xié)議——流量控制每個http2流都擁有自己公告流量窗口，它能夠限制另一端發(fā)送數(shù)據(jù)。對于每個流來說，兩端都必須告訴對方自己還有足夠空間來處理新數(shù)據(jù)，而在該窗口被擴(kuò)大前，另一端只被允許發(fā)送這么多數(shù)據(jù)。只有數(shù)據(jù)幀會受到流量控制。51/662.10、HTTP/2協(xié)議——NPN/ALPNNextProtocolNegotiation(NPN)是一個用來在TLS服務(wù)器上協(xié)商SPDY協(xié)議。IETF將這個非正式標(biāo)準(zhǔn)進(jìn)行規(guī)范化，從而演變成了ALPN（ApplicationLayerProtocolNegotiation）。ALPN和NPN主要區(qū)分在于：誰來決定通信協(xié)議。在ALPN描述中，是讓客戶端先發(fā)送一個協(xié)議優(yōu)先級列表給服務(wù)器，由服務(wù)器最終選擇一個適當(dāng)。而NPN則恰好相反，客戶端有著最終決定權(quán)。NPN：客戶端決定ALPN：服務(wù)端決定52/66HTTP/2支持情況33.1總覽3.2Firefox 3.3Chrome 3.4Nginx3.5Java 53/663.1、HTTP/2支持情況——總覽（一）54/663.1、HTTP/2支持情況——總覽（二）說明：h2:支持HTTP/2正式版h2c:支持HTTP/2非加密通道h2-14:支持HTTP/2第14號草案版（共有00-17等18個草案版）h2c-14:支持HTTP/2第14號草案非加密通道版55/663.2、HTTP/2支持情況——Firefox從Firefox35之后默認(rèn)支持HTTP/2支持情況HTTP/2.0響應(yīng)頭僅支持TLSTLS插件HTTP/2andSPDYIndicator圖形化56/663.3、HTTP/2支持情況——Chrome從chrome40起默認(rèn)支持TLS-only圖形化試驗(yàn)QUIC移除SPDYHTTP/2andSPDYIndicator57/663.4、HTTP/2支持情況——Nginx（一）安裝：啟用http_v2_module和http_ssl_module./configure--with-http_v2_module--with-http_ssl_module從

Nginx1.9.5

開始提供http_v2_module配置：在listen中添加http2example:listen443sslhttp2fastopen=3reuseport;文檔：指令參考/en/docs/http/ngx_http_v2_module.html58/663.4、HTTP/2支持情況——Nginx（二）指令說明支持版本上下文默認(rèn)http2_chunk_size塊大小

http,server,location8khttp2_body_preread_size每次請求緩存區(qū)大小1.11.0http,server64khttp2_idle_timeout超時時間

http,server3mhttp2_max_concurrent_streams一個連接中流最大并發(fā)數(shù)

http,server128http2_max_field_size一個請求頭字段最大大小

http,server4khttp2_max_header_size整個請求頭最大大小

http,server16khttp2_max_requests最大請求數(shù)1.11.6http,server1000http2_recv_buffer_size接收緩存區(qū)大小

http256khttp2_recv_timeout接收超時時間

http,server30s59/66https://docs.spring.io/spring-boot/docs/2.0.0.BUILD-SNAPSHOT/reference/htmlsingle/#howto-configure-http23.5、HTTP/2支持