使用Alamofire編碼請求參數(shù)

向大家介紹Alamofire中的parameter encoding。為什么需要parameter encoding呢挪捕?來看個例子。

我們發(fā)送一個最簡單的帶參數(shù)的GET請求:


let requestUrl = "https://apidemo.boxue.io/alamofire?XDEBUG_SESSION_START=PHPSTORM"
let parameters = [ "foo": 1 ]

Alamofire.request(.GET, requestUrl, parameters: parameters)
    .responseJSON(completionHandler: { response in
        switch response.result {
        case .Success(let json):
            print("JSON: ================")
            print("\(json)")
        case .Failure(let error):
            print("\(error)")
        }
    })

按Command + R編譯執(zhí)行:

image

在PhpStorm中争便,我們可以看到级零,在服務端收到的數(shù)據(jù)中,foo的值滞乙,是字符串"1"奏纪,而不是整數(shù)值1,如何讓服務端直接接收到一個整數(shù)值呢酷宵?使用Alamofire parameter encoding就可以幫我們完成這個功能亥贸。

打開Alamofire的官網(wǎng)躬窜,我們可以看到浇垦,Alamofire提供了5種不同的參數(shù)encoding方式,我們介紹前三種的常見用法荣挨。


Parameter encoding in URL

對于一個GET / HEAD / DELETE請求來說男韧,我們可以直接在URL后面帶上要發(fā)送到服務器端的參數(shù),例如我們之前已經(jīng)用過的這個最簡單的形式:


https://apidemo.boxue.io/alamofire?XDEBUG_SESSION_START=PHPSTORM

它直接給服務器傳遞了一個叫做XDEBUG_SESSION_START的變量默垄,值是一個字符串"PHPSTROM"此虑。除了這種最簡單的key = value的形式之外,我們還可能會向服務器發(fā)送一個數(shù)組口锭,例如:


https://apidemo.boxue.io/alamofire?XDEBUG_SESSION_START=PHPSTORM&foo[]=1&foo[]=2

或者朦前,發(fā)送一個字典:


https://apidemo.boxue.io/alamofire?XDEBUG_SESSION_START=PHPSTORM&bar[x]=a&bar[y]=2

如果我們要同時使用它們介杆,就會變成這樣:


https://apidemo.boxue.io/alamofire?XDEBUG_SESSION_START=PHPSTORM&foo[]=1&foo[]=2&bar[x]=a&bar[y]=2

當我們使用這種URL的時候,我們要先使用下面的方法韭寸,對URL進行編碼:


let requestParameters = "&foo[]=1&foo[]=2&bar[x]=a&bar[y]=2"
requestUrl = requestUrl + requestParameters

requestUrl.stringByAddingPercentEncodingWithAllowedCharacters(
    NSCharacterSet.URLQueryAllowedCharacterSet()
)

let encodedUrl = 
    requestUrl.stringByAddingPercentEncodingWithAllowedCharacters(
        NSCharacterSet.URLQueryAllowedCharacterSet()
    )!

然后春哨,按Command + R編譯執(zhí)行,就可以看到我們發(fā)送到服務端的結果了:

image

這種通過拼接字符串發(fā)送請求的方式恩伺,是非常不易于維護的赴背,因此Alamofire允許我們在request方法里添加一個參數(shù),傳遞我們要發(fā)送的數(shù)據(jù)晶渠。Alamofire會自動對參數(shù)進行編碼凰荚,然后發(fā)送到服務器。


Parameter encoding in URL

首先褒脯,我們可以按照自己要發(fā)送的數(shù)據(jù)內容便瑟,構建一個數(shù)據(jù)結構:


let parameters = [
    "foo": [1, 2],
    "bar": [
        "x": "a",
        "y": "2"
    ]
]

然后,我們可以這樣使用Alamofire.request:


let requestUrl = "https://apidemo.boxue.io/alamofire?XDEBUG_SESSION_START=PHPSTORM"
let parameters = [
    "foo": [1, 2],
    "bar": [
        "x": "a",
        "y": "2"
    ]
]

Alamofire.request(.GET, requestUrl, parameters: parameters, encoding: .URL)

顯然憨颠,這樣的方式看上去要好的多胳徽。按Command + R,重新編譯執(zhí)行爽彤,我們可以在PhpStorm里养盗,看到同樣的結果。如果我們注意一下發(fā)送到服務器的requestUrl适篙,就可以看到Alamofire自動把我們的參數(shù)編碼之后往核,添加在了URL后面。

image

那么Alamofire中指定的.URL和.URLEncodedInURL有什么區(qū)別呢嚷节?

對于.URL的編碼方式聂儒,Alamofire會在GET / HEAD / DELETE請求時,把參數(shù)直接追加在request url后面硫痰。

而對于POST / PUT請求衩婚,Alamofire則會把參數(shù)放在HTTP BODY里,而此時的request url效斑,就會是這樣:

image

此時非春,如果我們想強制讓request url帶上參數(shù),就可以使用.URLEncodedInURL編碼:


let requestUrl = "https://apidemo.boxue.io/alamofire?XDEBUG_SESSION_START=PHPSTORM"
let parameters = [
    "foo": [1, 2],
    "bar": [
        "x": "a",
        "y": "2"
    ]
]

Alamofire.request(.POST, requestUrl, parameters: parameters, encoding: .URLEncodedInURL)

此時缓屠,在服務端查看request url奇昙,就可以看到結果了:

image

向服務器發(fā)送一個JSON

從上面這些例子可以看到,無論是.URL還是.URLEncodeInURL敌完,在服務端接收到的储耐,都是字符串值。為了實現(xiàn)一開始我們提到過的滨溉,讓服務器直接接收到一個整數(shù)值什湘,我們可以對要發(fā)送的參數(shù)采用JSON編碼长赞。


let requestUrl = "https://apidemo.boxue.io/alamofire?XDEBUG_SESSION_START=PHPSTORM"
let parameters = [
    "foo": [1, 2],
    "bar": [
        "x": "a",
        "y": 2
    ]
]

Alamofire.request(.POST, requestUrl, parameters: parameters, encoding: .JSON)

按 Command + R 編譯執(zhí)行之后,我們就可以在Laravel服務端看到闽撤,foo直接被解碼成了一個整數(shù)數(shù)組涧卵,而bar,則根據(jù)值的類型腹尖,被轉換成了相應的字符串和整數(shù)柳恐。

image
?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市热幔,隨后出現(xiàn)的幾起案子乐设,更是在濱河造成了極大的恐慌,老刑警劉巖绎巨,帶你破解...
    沈念sama閱讀 219,110評論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件近尚,死亡現(xiàn)場離奇詭異,居然都是意外死亡场勤,警方通過查閱死者的電腦和手機戈锻,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,443評論 3 395
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來和媳,“玉大人格遭,你說我怎么就攤上這事×敉” “怎么了拒迅?”我有些...
    開封第一講書人閱讀 165,474評論 0 356
  • 文/不壞的土叔 我叫張陵,是天一觀的道長她倘。 經(jīng)常有香客問我璧微,道長,這世上最難降的妖魔是什么硬梁? 我笑而不...
    開封第一講書人閱讀 58,881評論 1 295
  • 正文 為了忘掉前任前硫,我火速辦了婚禮,結果婚禮上荧止,老公的妹妹穿的比我還像新娘屹电。我一直安慰自己,他們只是感情好罩息,可當我...
    茶點故事閱讀 67,902評論 6 392
  • 文/花漫 我一把揭開白布嗤详。 她就那樣靜靜地躺著个扰,像睡著了一般瓷炮。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上递宅,一...
    開封第一講書人閱讀 51,698評論 1 305
  • 那天娘香,我揣著相機與錄音苍狰,去河邊找鬼。 笑死烘绽,一個胖子當著我的面吹牛淋昭,可吹牛的內容都是我干的。 我是一名探鬼主播安接,決...
    沈念sama閱讀 40,418評論 3 419
  • 文/蒼蘭香墨 我猛地睜開眼翔忽,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了盏檐?” 一聲冷哼從身側響起歇式,我...
    開封第一講書人閱讀 39,332評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎胡野,沒想到半個月后材失,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,796評論 1 316
  • 正文 獨居荒郊野嶺守林人離奇死亡硫豆,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 37,968評論 3 337
  • 正文 我和宋清朗相戀三年龙巨,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片熊响。...
    茶點故事閱讀 40,110評論 1 351
  • 序言:一個原本活蹦亂跳的男人離奇死亡旨别,死狀恐怖,靈堂內的尸體忽然破棺而出汗茄,到底是詐尸還是另有隱情昼榛,我是刑警寧澤,帶...
    沈念sama閱讀 35,792評論 5 346
  • 正文 年R本政府宣布剔难,位于F島的核電站胆屿,受9級特大地震影響,放射性物質發(fā)生泄漏偶宫。R本人自食惡果不足惜非迹,卻給世界環(huán)境...
    茶點故事閱讀 41,455評論 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望纯趋。 院中可真熱鬧憎兽,春花似錦、人聲如沸吵冒。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,003評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽痹栖。三九已至亿汞,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間揪阿,已是汗流浹背疗我。 一陣腳步聲響...
    開封第一講書人閱讀 33,130評論 1 272
  • 我被黑心中介騙來泰國打工咆畏, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人吴裤。 一個月前我還...
    沈念sama閱讀 48,348評論 3 373
  • 正文 我出身青樓旧找,卻偏偏與公主長得像,于是被迫代替她去往敵國和親麦牺。 傳聞我的和親對象是個殘疾皇子钮蛛,可洞房花燭夜當晚...
    茶點故事閱讀 45,047評論 2 355

推薦閱讀更多精彩內容