比思論壇

標題: Memcache協議中文版 [打印本頁]

作者: admin 時間: 2011-1-26 11:14
標題: Memcache協議中文版
協議
memcached 的客戶端使用TCP鏈接與服務器通訊。（UDP接口也同樣有效，參考後文的 “UDP協議” ）一個運行中的memcached服務器監視一些（可設置）端口。客戶端連接這些端口，發送命令到服務器，讀取回應，最後關閉連接。
結束會話不需要發送任何命令。當不再需memcached服務時，要客戶端可以在任何時候關閉連接。需要註意的是，鼓勵客戶端緩存這些連接，而不是每次需要存取數據時都重新打開連接。這是因為memcached 被特意設計成及時開啟很多連接也能夠高效的工作（數百個，上千個如果需要的話）。緩存這些連接，可以消除建立連接所帶來的開銷（/*/相對而言，在服務器端建立一個新連接的準備工作所帶來的開銷，可以忽略不計。）。

在memcache協議中發送的數據分兩種：文本行和自由數據。文本行被用於來自客戶端的命令和服務器的回應。自由數據用於客戶端從服務器端存取數據時。同樣服務器會以字節流的方式傳回自由數據。/*/服務器不用關心自由數據的字節順序。自由數據的特征沒有任何限制；但是通過前文提到的文本行，這項數據的接受者（服務器或客戶端），便能夠精確地獲知所發送的數據庫的長度。
文本行固定以“\r\n”(回車符緊跟一個換行符)結束。自由數據也是同樣會以“\r\n”結束，但是 \r(回車符)、\n(換行符)，以及任何其他8位字符，均可出現在數據中。因此，當客戶端從服務器取回數據時，必須使用數據區塊的長度來確定數據區塊的結束位置，而不要依據數據區塊末尾的“\r\n”，即使它們固定存在於此。
鍵值
存儲在memcached中的數據通過鍵值來標識。鍵值是一個文本字符串，對於需要存取這項數據的客戶端而言，它必須是唯一的。鍵值當前的長度限制設定為250字符（當然，客戶端通常不會用到這麽長的鍵）；鍵值中不能使用制表符和其他空白字符（例如空格，換行等）。
命令
所有命令分為3種類型：
存儲命令（有3項：’set’、’add’、’repalce’）指示服務器儲存一些由鍵值標識的數據。客戶端發送一行命令，後面跟著數據區塊；然後，客戶端等待接收服務器回傳的命令行，指示成功與否。
取回命令（只有一項：’get’）指示服務器返回與所給鍵值相符合的數據（一個請求中右一個或多個鍵值）。客戶端發送一行命令，包括所有請求的鍵值；服務器每找到一項內容，都會發送回客戶端一行關於這項內容的信息，緊跟著是對應的數據區塊；直到服務器以一行“END”回應命令結束。
/*?*/其他的命令都不能攜帶自由數據。在這些命令中，客戶端發送一行命令，然後等待（由命令所決定）一行回應，或最終以一行“END”結束的多行命令。
一行命令固定以命令名稱開始，接著是以空格隔開的參數（如果有參數的話）。命令名稱大小寫敏感，並且必須小寫。一些客戶端發送給服務器的命令會包含一些時限（針對內容或客戶端請求的操作）。這時，時限的具體內容既可以是Unix時間戳（從1970年1月1日開始的秒鐘數），或當前時間開始的秒鐘數。對後者而言，不能超過 60*60*24*30（30天）；如果超出，服務器將會理解為Unix時間戳，而不是從當前時間起的秒偏移。
錯誤字串
每一個由客戶端發送的命令，都可能收到來自服務器的錯誤字串回複。這些錯誤字串會以三種形式出現：
- “ERROR\r\n”
意味著客戶端發送了不存在的命令名稱。
- “CLIENT_ERROR <error>\r\n”
意味著輸入的命令行里存在一些客戶端錯誤，例如輸入未遵循協議。<error>部分是人類易於理解的錯誤解說……
- “SERVER_ERROR <error>\r\n”
意味著一些服務器錯誤，導致命令無法執行。<error>部分是人類易於理解的錯誤解說。在一些嚴重的情形下（通常應該不會遇到），服務器將在發送這行錯誤後關閉連接。這是服務器主動關閉連接的唯一情況。
在後面每項命令的描述中，這些錯誤行不會再特別提到，但是客戶端必須考慮到這些它們存在的可能性。
存儲命令
首先，客戶端會發送一行像這樣的命令：
<command name> <key> <flags> <exptime> <bytes>\r\n
- <command name> 是 set, add, 或者 repalce

set 意思是 “儲存此數據”
add 意思是 “儲存此數據，只在服務器*未*保留此鍵值的數據時”
replace意思是 “儲存此數據，只在服務器*曾*保留此鍵值的數據時”

- <key> 是接下來的客戶端所要求儲存的數據的鍵值
- <flags> 是在取回內容時，與數據和發送塊一同保存服務器上的任意16位無符號整形（用十進制來書寫）。客戶端可以用它作為“位域”來存儲一些特定的信息；它對服務器是不透明的。
- <exptime> 是終止時間。如果為0，該項永不過期(雖然它可能被刪除，以便為其他緩存項目騰出位置)。如果非0（Unix時間戳或當前時刻的秒偏移），到達終止時間後，客戶端無法再獲得這項內容。
- <bytes> 是隨後的數據區塊的字節長度，不包括用於分野的“\r\n”。它可以是0（這時後面跟隨一個空的數據區塊）。
在這一行以後，客戶端發送數據區塊。
<data block>\r\n
- <data block> 是大段的8位數據，其長度由前面的命令行中的<bytes>指定。
發送命令行和數據區塊以後，客戶端等待回複，可能的回複如下：
- “STORED\r\n”
表明成功.
- “NOT_STORED\r\n”
表明數據沒有被存儲，但不是因為發生錯誤。這通常意味著add 或 replace命令的條件不成立，或者，項目已經位列刪除隊列（參考後文的“delete”命令）。
取回命令
一行取回命令如下：
get <key>*\r\n
- <key>* 表示一個或多個鍵值，由空格隔開的字串
這行命令以後，客戶端的等待0個或多個項目，每項都會收到一行文本，然後跟著數據區塊。所有項目傳送完畢後，服務器發送以下字串：
“END\r\n”
來指示回應完畢。
服務器用以下形式發送每項內容：
VALUE <key> <flags> <bytes>\r\n
<data block>\r\n
- <key> 是所發送的鍵名
- <flags> 是存儲命令所設置的記號
- <bytes> 是隨後數據塊的長度，*不包括* 它的界定符“\r\n”
- <data block> 是發送的數據
如果在取回請求中發送了一些鍵名，而服務器沒有送回項目列表，這意味著服務器沒這些鍵名（可能因為它們從未被存儲，或者為給其他內容騰出空間而被刪除，或者到期，或者被已客戶端刪除）。
刪除
命令“delete”允許從外部刪除內容：
delete <key> <time>\r\n
- <key> 是客戶端希望服務器刪除的內容的鍵名
- <time> 是一個單位為秒的時間（或代表直到某一刻的Unix時間），在該時間內服務器會拒絕對於此鍵名的“add”和“replace”命令。此時內容被放入delete隊列，無法再通過“get”得到該內容，也無法是用“add”和“replace”命令（但是“set”命令可用）。直到指定時間，這些內容被最終從服務器的內存中徹底清除。
<time>參數是可選的，缺省為0（表示內容會立刻清除，並且隨後的存儲命令均可用）。
此命令有一行回應：
- “DELETED\r\n”
表示執行成功
- “NOT_FOUND\r\n”
表示沒有找到這項內容
參考隨後的“flush_all”命令使所有內容無效
增加/減少
命令 “incr” 和 “decr”被用來修改數據，當一些內容需要替換、增加或減少時。這些數據必須是十進制的32位無符號整新。如果不是，則當作0來處理。修改的內容必須存在，當使用“incr”/“decr”命令修改不存在的內容時，不會被當作0處理，而是操作失敗。
客戶端發送命令行：
incr <key> <value>\r\n
或
decr <key> <value>\r\n
- <key> 是客戶端希望修改的內容的建名
- <value> 是客戶端要增加/減少的總數。
回複為以下集中情形：
- “NOT_FOUND\r\n”
指示該項內容的值，不存在。
- <value>\r\n ，<value>是增加/減少。
註意”decr”命令發生下溢：如果客戶端嘗試減少的結果小於0時，結果會是0。”incr” 命令不會發生溢出。
狀態
命令”stats” 被用於查詢服務器的運行狀態和其他內部數據。有兩種格式。不帶參數的：
stats\r\n
這會在隨後輸出各項狀態、設定值和文檔。另一種格式帶有一些參數：
stats <args>\r\n
通過<args>，服務器傳回各種內部數據。因為隨時可能發生變動，本文不提供參數的種類及其傳回數據。
各種狀態
受到無參數的”stats”命令後，服務器發送多行內容，如下：
STAT <name> <value>\r\n
服務器用以下一行來終止這個清單：
END\r\n
在每行狀態中，<name> 是狀態的名字，<value> 使狀態的數據。以下清單，是所有的狀態名稱，數據類型，和數據代表的含義。
在“類型”一列中，”32u”表示32位無符號整型，”64u”表示64位無符號整型，”32u:32u”表示用冒號隔開的兩個32位無符號整型。

名稱	類型	含義
pid	32u	服務器進程ID
uptime	32u	服務器運行時間，單位秒
time	32u	服務器當前的UNIX時間
version	string	服務器的版本號
rusage_user	32u:32u	該進程累計的用戶時間 (秒:微妙)
rusage_system	32u:32u	該進程累計的系統時間 (秒:微妙)
curr_items	32u	服務器當前存儲的內容數量
total_items	32u	服務器啟動以來存儲過的內容總數
bytes	64u	服務器當前存儲內容所占用的字節數
curr_connections	32u	連接數量
total_connections	32u	服務器運行以來接受的連接總數
connection_structures	32u	服務器分配的連接結構的數量
cmd_get	32u	取回請求總數
cmd_set	32u	存儲請求總數
get_hits	32u	請求成功的總次數
get_misses	32u	請求失敗的總次數
bytes_read	64u	服務器從網絡讀取到的總字節數
bytes_written	64u	服務器向網絡發送的總字節數
limit_maxbytes	32u	服務器在存儲時被允許使用的字節總數

其它命令
“flush_all”命令有一個可選的數字參數。它總是執行成功，服務器會發送“OK\r\n”回應。它的效果是使已經存在的項目立即失效（缺省），或在指定的時間後。此後執行取回命令，將不會有任何內容返回（除非重新存儲同樣的鍵名）。flush_all 實際上沒有立即釋放項目所占用的內存，而是在隨後陸續有新的項目被儲存時執行。flush_all 效果具體如下：它導致所有更新時間早於flush_all所設定時間的項目，在被執行取回命令時命令被忽略。
“version”命令沒有參數：
version\r\n
在回應中，服務器發送：
“VERSION <version>\r\n”
<version> 是服務器的版本字串。
“quit”命令沒有參數：
quit\r\n
接收此命令後，服務器關閉連接。不過，客戶端可以在不再需要時，簡單地關閉連接就行，並不一定需要發送這個命令。
UDP 協議
當來自客戶端的連接數遠大於TCP連接的上限時，可以使用基於UDP的接口。UDP接口不能保證傳輸到位，所以只有在不要求成功的操作中使用；比如被用於一個“get”請求時，會因不當的緩存處理而發生錯誤或回應有遺失。
每個UDP數據包都包含一個簡單的幀頭，數據之後的內容與TCP協議的描述類似。在執行所產生的數據流中，請求必須被包含在單獨的一個UDP數據包中，但是回應可能跨越多個數據包。（只有“get”和“set”請求例外，跨越了多個數據包）
幀頭有8字節長，如下（均由16位整數組成，網絡字節順序，高位在前）：

0-1 請求ID
2-3 序號
4-5 該信息的數據包總數
6-7 保留位，必須為0

請求ID有客戶端提供。一般它會是一個從隨機基數開始的遞增值，不過客戶端想用什麽樣的請求ID都可以。服務器的回應會包含一個和請求中的同樣的ID。客戶端使用請求ID來區分每一個回應。任何一個沒有請求ID的數據包，可能是之前的請求遭到延遲而造成的，應該被丟棄。序號的返回是從0到n-1，n是該條信息的數據包數量。

作者: 滴血qq 時間: 2011-12-2 22:42
哦中文的我写学

作者: leeyee2009 時間: 2011-12-3 10:44
顶，表示看不懂...

作者: 545115917 時間: 2011-12-3 11:45
完全不懂- -！

作者: cxy1987211 時間: 2011-12-3 13:12
完全看不懂啊···

作者: PureLove 時間: 2011-12-3 15:36
记下，很有用！

作者: xxl1 時間: 2012-2-18 16:34
学习中！谢谢！

作者: huoyan1963 時間: 2012-2-19 19:21
非常有用的东东

歡迎光臨比思論壇 (http://asicrs.com/)