使用Swift进行带参数的GET请求

Question

我对Swift非常陌生，所以我的代码可能有很多错误，但我想要实现的是向本地服务器发送带参数的GET请求。更重要的是，我正在尝试实现它，因为我的函数需要两个参数baseURL:string,params:NSDictionary。 我不确定如何将这两个参数组合成实际的URLRequest？以下是我目前尝试过的内容：

    func sendRequest(url:String,params:NSDictionary){
       let urls: NSURL! = NSURL(string:url)
       var request = NSMutableURLRequest(URL:urls)
       request.HTTPMethod = "GET"
       var data:NSData! =  NSKeyedArchiver.archivedDataWithRootObject(params)
       request.HTTPBody = data
       println(request)
       var session = NSURLSession.sharedSession()
       var task = session.dataTaskWithRequest(request, completionHandler:loadedData)
       task.resume()

    }

}

func loadedData(data:NSData!,response:NSURLResponse!,err:NSError!){
    if(err != nil){
        println(err?.description)
    }else{
        var jsonResult: NSDictionary = NSJSONSerialization.JSONObjectWithData(data, options: NSJSONReadingOptions.MutableContainers, error: nil) as NSDictionary
        println(jsonResult)

    }

}

- MrSSS16

Answer 1

构建“GET”请求时，请求中没有正文体，所有内容都在URL上。要构建URL（并正确地进行百分比转义），您还可以使用“URLComponents”。

var url = URLComponents(string: "https://www.google.com/search/")!

url.queryItems = [
    URLQueryItem(name: "q", value: "War & Peace")
]

唯一的诀窍在于，大多数网络服务需要对+字符进行百分号转义（因为它们将按照application/x-www-form-urlencoded规范所规定的那样将其解释为空格字符）。但是URLComponents不会进行百分号转义。苹果认为+是查询中的有效字符，因此不应该被转义。从技术上讲，他们是正确的，因为它在URI的查询中允许使用，但它在application/x-www-form-urlencoded请求中具有特殊含义，因此不应该未经转义就传递。

苹果承认我们必须对+字符进行百分号转义，并建议我们手动完成：

var url = URLComponents(string: "https://www.wolframalpha.com/input/")!

url.queryItems = [
    URLQueryItem(name: "i", value: "1+2")
]

url.percentEncodedQuery = url.percentEncodedQuery?.replacingOccurrences(of: "+", with: "%2B")

这是一个不太优雅的解决方案，但它有效，并且如果您的查询可能包含+字符并且您有一个将它们解释为空格的服务器，则这是苹果建议的方法。

因此，将其与您的sendRequest例程结合使用，最终会得到类似以下的内容：

func sendRequest(_ url: String, parameters: [String: String], completion: @escaping ([String: Any]?, Error?) -> Void) {
    var components = URLComponents(string: url)!
    components.queryItems = parameters.map { (key, value) in 
        URLQueryItem(name: key, value: value) 
    }
    components.percentEncodedQuery = components.percentEncodedQuery?.replacingOccurrences(of: "+", with: "%2B")
    let request = URLRequest(url: components.url!)
    
    let task = URLSession.shared.dataTask(with: request) { data, response, error in
        guard
            let data = data,                              // is there data
            let response = response as? HTTPURLResponse,  // is there HTTP response
            200 ..< 300 ~= response.statusCode,           // is statusCode 2XX
            error == nil                                  // was there no error
        else {
            completion(nil, error)
            return
        }
        
        let responseObject = (try? JSONSerialization.jsonObject(with: data)) as? [String: Any]
        completion(responseObject, nil)
    }
    task.resume()
}

你可以像这样调用:

sendRequest("someurl", parameters: ["foo": "bar"]) { responseObject, error in
    guard let responseObject = responseObject, error == nil else {
        print(error ?? "Unknown error")
        return
    }

    // use `responseObject` here
}

个人而言，我现在会使用JSONDecoder并返回一个自定义的struct而不是一个字典，但这在此并不重要。希望这说明了如何将参数百分比编码到GET请求的URL中的基本思路。

---

请参见此答案的先前版本，适用于Swift 2和手动百分号转义方式。

- Rob

---

这看起来很简单，使用 https://github.com/xyyc/SwiftSocket/ 这样的东西有什么优势呢？对不起，我对这一切都很陌生。 - jigzat

这是一个很棒的解决方案。谢谢@Rob。顺便问一下，像这样提供参数有什么区别吗？NSJSONSerialization.dataWithJSONObject(parameters, options: nil, error: nil)？其中parameters是一个字典数组[String: String]。 - Isuru

对我来说，使用JSON进行“GET”请求没有太多意义。如果您要向服务器发送信息，那就是“POST”，而不是“GET”。您需要指定不同的“Content-Type”标头。而且您不需要任何百分比编码的东西。总之，很多执行细节都是不同的。 - Rob

Rob，你有没有可能将扩展方法更新为Swift 2？ - Roi Mulia

只是提醒一下，如果字典包含非字符串值（例如Int数据类型），则字典类别会中断。 - RonLugge

Answer 2

使用NSURLComponents来构建你的NSURL，像这样

var urlComponents = NSURLComponents(string: "https://www.google.de/maps/")!

urlComponents.queryItems = [
  NSURLQueryItem(name: "q", value: String(51.500833)+","+String(-0.141944)),
  NSURLQueryItem(name: "z", value: String(6))
]
urlComponents.URL // returns https://www.google.de/maps/?q=51.500833,-0.141944&z=6

来源：https://www.ralfebert.de/snippets/ios/encoding-nsurl-get-parameters/

- Ben-Hur Batista

---

尽管Rob的回答很出色，但你的答案更简单，而且有效。 - Jan ATAC

应该接受这个答案。建议使用NSURLComponents和查询项来构造URL，这样更安全，出错的可能性较小。 - John Rogers

Answer 3

我正在使用这个，可以在playground中试一下。将基本URL定义为常量中的结构体。

struct Constants {

    struct APIDetails {
        static let APIScheme = "https"
        static let APIHost = "restcountries.eu"
        static let APIPath = "/rest/v1/alpha/"
    }
}

private func createURLFromParameters(parameters: [String:Any], pathparam: String?) -> URL {

    var components = URLComponents()
    components.scheme = Constants.APIDetails.APIScheme
    components.host   = Constants.APIDetails.APIHost
    components.path   = Constants.APIDetails.APIPath
    if let paramPath = pathparam {
        components.path = Constants.APIDetails.APIPath + "\(paramPath)"
    }
    if !parameters.isEmpty {
        components.queryItems = [URLQueryItem]()
        for (key, value) in parameters {
            let queryItem = URLQueryItem(name: key, value: "\(value)")
            components.queryItems!.append(queryItem)
        }
    }

    return components.url!
}

let url = createURLFromParameters(parameters: ["fullText" : "true"], pathparam: "IN")

//Result url= https://restcountries.eu/rest/v1/alpha/IN?fullText=true

- anoop4real

Answer 4

Swift 3:

extension URL {
    func getQueryItemValueForKey(key: String) -> String? {
        guard let components = NSURLComponents(url: self, resolvingAgainstBaseURL: false) else {
              return nil
        }

        guard let queryItems = components.queryItems else { return nil }
     return queryItems.filter {
                 $0.name.lowercased() == key.lowercased()
                 }.first?.value
    }
}

我在func imagePickerController(_ picker: UIImagePickerController, didFinishPickingMediaWithInfo info: [String : Any])中使用它来获取UIImagePickerController的图像名称：

var originalFilename = ""
if let url = info[UIImagePickerControllerReferenceURL] as? URL, let imageIdentifier = url.getQueryItemValueForKey(key: "id") {
    originalFilename = imageIdentifier + ".png"
    print("file name : \(originalFilename)")
}

- Dani Pralea

---

您的回答没有回答楼主的问题。 - Ilias Karim

Answer 5

如果键和值都符合CustomStringConvertable，您可以扩展您的Dictionary以仅提供stringFromHttpParameter，如下所示：

extension Dictionary where Key : CustomStringConvertible, Value : CustomStringConvertible {
  func stringFromHttpParameters() -> String {
    var parametersString = ""
    for (key, value) in self {
      parametersString += key.description + "=" + value.description + "&"
    }
    return parametersString
  }
}

这样做更加清晰，可以防止在没有必要调用该方法的字典上意外调用 stringFromHttpParameters

- Reza Shirazian

Answer 6

这个扩展是@Rob建议的，适用于Swift 3.0.1

我无法使用他在帖子中包含的版本在Xcode 8.1 (8B62)上编译

extension Dictionary {

    /// Build string representation of HTTP parameter dictionary of keys and objects
    ///
    /// :returns: String representation in the form of key1=value1&key2=value2 where the keys and values are percent escaped

    func stringFromHttpParameters() -> String {

        var parametersString = ""
        for (key, value) in self {
            if let key = key as? String,
               let value = value as? String {
                parametersString = parametersString + key + "=" + value + "&"
            }
        }
        parametersString = parametersString.substring(to: parametersString.index(before: parametersString.endIndex))
        return parametersString.addingPercentEncoding(withAllowedCharacters: .urlHostAllowed)!
    }

}

- etayluz

Answer 7

func relationsApi(_ search: String) {
      let url = URL(string: getApiUrl)!
      
      let session = URLSession.shared
      let queryItems = [URLQueryItem(name: "search", value: search)]
      var urlComps = URLComponents(string: getApiUrl)!
      urlComps.queryItems = queryItems
      let result = urlComps.url!
      print(result)
      
      var request = URLRequest(url: result)
      
      request.setValue( "Bearer \(tokenName)", forHTTPHeaderField: "Authorization")
      let task = session.dataTask(with: request) { (data, response, error) in
          if let error = error{
              print (error)
          } else if let data = data {
              do {
                  let decoder = JSONDecoder()
                  let responseDatas = try decoder.decode(RelationsAPIModel.self, from: data)
                  //  print(responseDatas)
                  DispatchQueue.main.async {
                      
                      self.namesArr = responseDatas.data.relation
                      //     self.subname = responseDatas.data.relation[Re]
                      self.relationTableView.reloadData()
                  }
              } catch {
                  print(error)
              }
          } else {
              print("something went wrong")
          }
      }
      task.resume()
    }
}

- Nidhi Chaudhary

Answer 8

我使用：

let dictionary = ["method":"login_user",
                  "cel":mobile.text!
                  "password":password.text!] as  Dictionary<String,String>

for (key, value) in dictionary {
    data=data+"&"+key+"="+value
    }

request.HTTPBody = data.dataUsingEncoding(NSUTF8StringEncoding);

- Fabio Guerra