
原文:How to percent encode a URL String
作者:@kharrison
譯者:CocoaChina--飄
和 Web 服務打交道時,我們時常需要對 URL 中的特定字元以及傳輸的表單資料做百分號編碼。舉例來說,& 編碼後會變成 %26。問題是:URL 的哪一部分、哪些字元該被編碼?這件事並不容易搞對。目前最可靠的依據大概是 RFC 3986 與 W3C HTML5。出於興趣與教學目的,我寫了 Swift 版的 String 擴充套件,並附上作為對照的 Objective-C 分類。
RFC 3986 第 2.3 節列出了不需要百分號編碼的字元,因為它們在 URL 中沒有特殊含義:
ALPHA / DIGIT / “-” / “.” / “_” / “~”
第 3.4 節進一步說明:由於查詢字串本身常常內含另一個 URL,最好不要把斜線(“/”)和問號(“?”)編碼掉。廣受歡迎的 iOS 網路庫 Alamofire 採用的正是這個策略,這也給了我不少信心。
所以,要產出符合 RFC 3986 的相容查詢,我們只需把上述清單以外的字元全部編碼。做法很簡單:先構造一個「允許字元集合」,再用 stringByAddingPercentEncodingWithAllowedCharacters 編碼剩下的。
注意:蘋果已在 iOS 9 中棄用了 stringByAddingPercentEscapesUsingEncoding 與 CFURLCreateStringByAddingPercentEscapes 這兩個舊方法。
先給 String 加個擴充套件:
extension String {
func stringByAddingPercentEncodingForRFC3986() -> String? {
let unreserved = "-._~/?"
let allowed = NSMutableCharacterSet.alphanumericCharacterSet()
allowed.addCharactersInString(unreserved)
return stringByAddingPercentEncodingWithAllowedCharacters(allowed)
}
}用 NSString 的分類可以做到同樣的事:
@implementation NSString (URLEncoding)
- (nullable NSString *)stringByAddingPercentEncodingForRFC3986 {
NSString *unreserved = @"-._~/?";
NSMutableCharacterSet *allowed = [NSMutableCharacterSet alphanumericCharacterSet];
[allowed addCharactersInString:unreserved];
return [self stringByAddingPercentEncodingWithAllowedCharacters:allowed];
}
@end// Swift let query = "one&two =three" let encoded = query.stringByAddingPercentEncodingForRFC3986() // "one%26two%20%3Dthree" // Objective-C NSString *query = @"one&two =three"; NSString *encoded = [query stringByAddingPercentEncodingForRFC3986]; // "one%26two%20%3Dthree"
W3C HTML5 對表單資料的編碼建議與 RFC 3986 相似,但有幾處關鍵差異。第 4.10.22.5 節指出下列字元不應被百分號編碼:
ALPHA / DIGIT / “*” / “-” / “.” / “_”
同時,空格(“ ”)應該用 “+”(0x2B)代替。差異在於:波浪號(“~”)被編碼了,而星號(“*”)沒有。Stack Overflow 上有一則回答總結得很好——這種表單編碼在許多方面都是反常的,多年實踐中的問題與妥協堆疊出了一長串為了互通而不得不做的操作,但絕對不能算好的設計實踐。
替 String 擴充套件再補一個方法:
public func stringByAddingPercentEncodingForFormData(plusForSpace: Bool = false) -> String? {
let unreserved = "*-._"
let allowed = NSMutableCharacterSet.alphanumericCharacterSet()
allowed.addCharactersInString(unreserved)
if plusForSpace {
allowed.addCharactersInString(" ")
}
var encoded = stringByAddingPercentEncodingWithAllowedCharacters(allowed)
if plusForSpace {
encoded = encoded?.stringByReplacingOccurrencesOfString(" ", withString: "+")
}
return encoded
}之所以把「空格用 + 還是百分號編碼」做成可選項,是因為實務上很多 Web 服務對此並不計較。
Objective-C 沒有預設參數,所以要多傳一個旗標:
- (nullable NSString *)stringByAddingPercentEncodingForFormData:(BOOL)plusForSpace {
NSString *unreserved = @"*-._";
NSMutableCharacterSet *allowed = [NSMutableCharacterSet alphanumericCharacterSet];
[allowed addCharactersInString:unreserved];
if (plusForSpace) {
[allowed addCharactersInString:@" "];
}
NSString *encoded = [self stringByAddingPercentEncodingWithAllowedCharacters:allowed];
if (plusForSpace) {
encoded = [encoded stringByReplacingOccurrencesOfString:@" " withString:@"+"];
}
return encoded;
}// Swift let query = "one two" let space = query.stringByAddingPercentEncodingForFormData() // "one%20two" let plus = query.stringByAddingPercentEncodingForFormData(true) // "one+two" // Objective-C NSString *query = @"one two"; NSString *encodedQuery = [query stringByAddingPercentEncodingForFormData:YES]; // "one+two"
Swift 程式碼與部分測試用例可以在我的 GitHub 範例庫 Encode 專案中找到;Objective-C 的分類與測試用例則在 TwitterSearch 專案裡。歡迎回饋與改進。
百分號編碼(維基百科)
RFC 3986 統一資源標識符(URI):通用語法
W3C HTML5 第 4.10.22.6 節:URL 表單資料的編碼