ObjectiveCのNSDictionaryオブジェクトからのURLクエリパラメーターの作成

90

すべてのURL処理オブジェクトが標準のCocoaライブラリ（NSURL、NSMutableURL、NSMutableURLRequestなど）に存在しているため、GETリクエストをプログラムで作成する簡単な方法を見過ごさなければならないことはわかっています。

現在、手動で「？」を追加しています 「＆」で結合された名前と値のペアが続きますが、名前と値のペアはすべて手動でエンコードする必要があるため、URLに接続しようとしたときにNSMutableURLRequestが完全に失敗しません。

これは、プリベークされたAPIを使用できるように思えます...クエリパラメータのNSDictionaryをNSURLに追加するための追加設定はありますか？これに取り組む必要がある別の方法はありますか？

objective-c  nsurl 
— ゼフ・アイゼンバーグ
ソース
たくさんの答え！非常に多くの質問と回答に投票してください！それでも、回答済みとマークされていません。うわー！
— BangOperator 2017年

回答:

132

iOS8とOS X 10.10で導入されたはNSURLQueryItem、クエリの構築に使用できます。NSURLQueryItemのドキュメントから：

NSURLQueryItemオブジェクトは、URLのクエリ部分にあるアイテムの単一の名前と値のペアを表します。NSURLComponentsオブジェクトのqueryItemsプロパティでクエリアイテムを使用します。

1つを作成するには、指定された初期化子queryItemWithName:value:を使用し、次にそれらを追加してNSURLComponentsを生成しNSURLます。例えば：

NSURLComponents *components = [NSURLComponents componentsWithString:@"http://stackoverflow.com"];
NSURLQueryItem *search = [NSURLQueryItem queryItemWithName:@"q" value:@"ios"];
NSURLQueryItem *count = [NSURLQueryItem queryItemWithName:@"count" value:@"10"];
components.queryItems = @[ search, count ];
NSURL *url = components.URL; // http://stackoverflow.com?q=ios&count=10

疑問符とアンパサンドは自動的に処理されることに注意してください。NSURLパラメータのディクショナリからを作成するのは、次のように簡単です。

NSDictionary *queryDictionary = @{ @"q": @"ios", @"count": @"10" };
NSMutableArray *queryItems = [NSMutableArray array];
for (NSString *key in queryDictionary) {
    [queryItems addObject:[NSURLQueryItem queryItemWithName:key value:queryDictionary[key]]];
}
components.queryItems = queryItems;

また、およびを使用してURLを作成する方法に関するブログ投稿も作成しました。NSURLComponentsNSURLQueryItems

— ジョー・マシロッティ
ソース
2
辞書がネストされている場合はどうなりますか？
— hariszaman
1
@hariszaman URLを介してネストされた辞書を送信する場合は、代わりにPOST本文を介して送信することを検討する必要があります。
— Joe Masilotti 2016
2
ただ注意してください、値はNSString型のみです
— igrrik
ここでポイントを強調したいだけです：NSURLQueryItemの値は文字列のみです。そうでない場合は、クラッシュする可能性があります！
— Pulkit Sharma
47

NSDictionaryこれを行うためのカテゴリを作成できます。Cocoaライブラリには、私が見つけることのできる標準的な方法はありません。私が使用するコードは次のようになります：

// file "NSDictionary+UrlEncoding.h"
#import <cocoa/cocoa.h>

@interface NSDictionary (UrlEncoding)

-(NSString*) urlEncodedString;

@end

この実装では：

// file "NSDictionary+UrlEncoding.m"
#import "NSDictionary+UrlEncoding.h"

// helper function: get the string form of any object
static NSString *toString(id object) {
  return [NSString stringWithFormat: @"%@", object];
}

// helper function: get the url encoded string form of any object
static NSString *urlEncode(id object) {
  NSString *string = toString(object);
  return [string stringByAddingPercentEscapesUsingEncoding: NSUTF8StringEncoding];
}

@implementation NSDictionary (UrlEncoding)

-(NSString*) urlEncodedString {
  NSMutableArray *parts = [NSMutableArray array];
  for (id key in self) {
    id value = [self objectForKey: key];
    NSString *part = [NSString stringWithFormat: @"%@=%@", urlEncode(key), urlEncode(value)];
    [parts addObject: part];
  }
  return [parts componentsJoinedByString: @"&"];
}

@end

コードは非常に単純だと思いますが、http：//blog.ablepear.com/2008/12/urlencoding-category-for-nsdictionary.htmlでさらに詳しく説明しています。

— ドン・マッコーイ
ソース
16
私はこれがうまくいくとは思いません。具体的には、アンパサンドをエスケープしないstringByAddingPercentEscapesUsingEncodingと、RFC 3986で指定されているクエリパラメータでエスケープする必要がある他の文字を使用しています。代わりに、Mac用のGoogle Toolboxエスケープコードを検討することを検討してください。
— デイブ・ペック
適切なエスケープのためのこの作品：stackoverflow.com/questions/9187316/...
— JoeCortopassi
30

クリスの答えを使いたかったのですが、自動参照カウント（ARC）用に書かれていなかったので更新しました。他の誰かがこれと同じ問題を抱えている場合に備えて、私は自分のソリューションを貼り付けると思いました。 注：self必要に応じて、インスタンス名またはクラス名に置き換えてください。

+(NSString*)urlEscapeString:(NSString *)unencodedString 
{
    CFStringRef originalStringRef = (__bridge_retained CFStringRef)unencodedString;
    NSString *s = (__bridge_transfer NSString *)CFURLCreateStringByAddingPercentEscapes(NULL,originalStringRef, NULL, (CFStringRef)@"!*'\"();:@&=+$,/?%#[]% ", kCFStringEncodingUTF8);
    CFRelease(originalStringRef);
    return s;
}


+(NSString*)addQueryStringToUrlString:(NSString *)urlString withDictionary:(NSDictionary *)dictionary
{
    NSMutableString *urlWithQuerystring = [[NSMutableString alloc] initWithString:urlString];

    for (id key in dictionary) {
        NSString *keyString = [key description];
        NSString *valueString = [[dictionary objectForKey:key] description];

        if ([urlWithQuerystring rangeOfString:@"?"].location == NSNotFound) {
            [urlWithQuerystring appendFormat:@"?%@=%@", [self urlEscapeString:keyString], [self urlEscapeString:valueString]];
        } else {
            [urlWithQuerystring appendFormat:@"&%@=%@", [self urlEscapeString:keyString], [self urlEscapeString:valueString]];
        }
    }
    return urlWithQuerystring;
}
— 匿名の開発
ソース
私はこのコードが好きです。追加するのは、すべてのキー/値に対してエンコードがURLセーフになることだけです。
— 2016年
22

値が文字列の場合、他の回答はうまく機能しますが、値が辞書または配列の場合、このコードはそれを処理します。

クエリ文字列を介して配列/辞書を渡す標準的な方法はありませんが、PHPはこの出力を適切に処理することに注意することが重要です

-(NSString *)serializeParams:(NSDictionary *)params {
    /*

     Convert an NSDictionary to a query string

     */

    NSMutableArray* pairs = [NSMutableArray array];
    for (NSString* key in [params keyEnumerator]) {
        id value = [params objectForKey:key];
        if ([value isKindOfClass:[NSDictionary class]]) {
            for (NSString *subKey in value) {
                NSString* escaped_value = (NSString *)CFURLCreateStringByAddingPercentEscapes(NULL,
                                                                                              (CFStringRef)[value objectForKey:subKey],
                                                                                              NULL,
                                                                                              (CFStringRef)@"!*'();:@&=+$,/?%#[]",
                                                                                              kCFStringEncodingUTF8);
                [pairs addObject:[NSString stringWithFormat:@"%@[%@]=%@", key, subKey, escaped_value]];
            }
        } else if ([value isKindOfClass:[NSArray class]]) {
            for (NSString *subValue in value) {
                NSString* escaped_value = (NSString *)CFURLCreateStringByAddingPercentEscapes(NULL,
                                                                                              (CFStringRef)subValue,
                                                                                              NULL,
                                                                                              (CFStringRef)@"!*'();:@&=+$,/?%#[]",
                                                                                              kCFStringEncodingUTF8);
                [pairs addObject:[NSString stringWithFormat:@"%@[]=%@", key, escaped_value]];
            }
        } else {
            NSString* escaped_value = (NSString *)CFURLCreateStringByAddingPercentEscapes(NULL,
                                                                                          (CFStringRef)[params objectForKey:key],
                                                                                          NULL,
                                                                                          (CFStringRef)@"!*'();:@&=+$,/?%#[]",
                                                                                          kCFStringEncodingUTF8);
            [pairs addObject:[NSString stringWithFormat:@"%@=%@", key, escaped_value]];
            [escaped_value release];
        }
    }
    return [pairs componentsJoinedByString:@"&"];
}

例

[foo] => bar
[translations] => 
        {
            [one] => uno
            [two] => dos
            [three] => tres
        }

foo = bar＆translations [one] = uno＆translations [two] = dos＆translations [three] = tres

[foo] => bar
[translations] => 
        {
            uno
            dos
            tres
        }

foo = bar＆translations [] = uno＆translations [] = dos＆translations [] = tres

— アルビーブ
ソース
1
最後の「else」の場合、descriptionへの呼び出しを追加して、lengthへの呼び出しで切り詰めるのではなく、NSNumbersに文字列を提供します： '（CFStringRef）[[params objectForKey：key] description ]'ありがとう！
— JohnQ 2013
素晴らしい答え。ただし、CFURLCreateStringByAddingPercentEscapes通話をstringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]
— S1LENT WARRIOR 2017
8

AlBeebeでリファクタリングし、ARCの回答に変換しました

- (NSString *)serializeParams:(NSDictionary *)params {
    NSMutableArray *pairs = NSMutableArray.array;
    for (NSString *key in params.keyEnumerator) {
        id value = params[key];
        if ([value isKindOfClass:[NSDictionary class]])
            for (NSString *subKey in value)
                [pairs addObject:[NSString stringWithFormat:@"%@[%@]=%@", key, subKey, [self escapeValueForURLParameter:[value objectForKey:subKey]]]];

        else if ([value isKindOfClass:[NSArray class]])
            for (NSString *subValue in value)
            [pairs addObject:[NSString stringWithFormat:@"%@[]=%@", key, [self escapeValueForURLParameter:subValue]]];

        else
            [pairs addObject:[NSString stringWithFormat:@"%@=%@", key, [self escapeValueForURLParameter:value]]];

}
return [pairs componentsJoinedByString:@"&"];

}

- (NSString *)escapeValueForURLParameter:(NSString *)valueToEscape {
     return (__bridge_transfer NSString *) CFURLCreateStringByAddingPercentEscapes(NULL, (__bridge CFStringRef) valueToEscape,
             NULL, (CFStringRef) @"!*'();:@&=+$,/?%#[]", kCFStringEncodingUTF8);
}
— レネティック
ソース
2
これは私にとってはうまくいきましたが、？を含めるために最後の行を変更しました。最初のパラメータの前：[NSString stringWithFormat:@"?%@",[pairs componentsJoinedByString:@"&"]];
— BFar 2014
1
CFURLCreateStringByAddingPercentEscapesコールを置き換える必要があると思いますstringByAddingPercentEncodingWithAllowedCharacters:[NSCharac‌​terSet URLQueryAllowedCharacterSet]
— S1LENT WARRIOR 2017
5

すでにAFNetworkingを使用している場合（私と同じように）、AFHTTPRequestSerializerそのクラスを使用して必要なを作成できますNSURLRequest。

[[AFHTTPRequestSerializer serializer] requestWithMethod:@"GET" URLString:@"YOUR_URL" parameters:@{PARAMS} error:nil];

作業にURLのみが必要な場合は、を使用してくださいNSURLRequest.URL。

— アユッシュゴエル
ソース
3

Swift（iOS8 +）の簡単な例を次に示します。

private let kSNStockInfoFetchRequestPath: String = "http://dev.markitondemand.com/Api/v2/Quote/json"

private func SNStockInfoFetchRequestURL(symbol:String) -> NSURL? {
  if let components = NSURLComponents(string:kSNStockInfoFetchRequestPath) {
    components.queryItems = [NSURLQueryItem(name:"symbol", value:symbol)]
    return components.URL
  }
  return nil
}
— ゾライア
ソース
1
かなりすっきりしていqueryItemsますが、iOS8.0から利用できます。
— Adil Soomro、2015
ありがとう、これを明確にするためにコメントを追加しました。
— Zorayr、2015
3

Joelの推奨する使用方法URLQueryItemsを採用し、Swift Extension（Swift 3）に変換しました

extension URL
{
    /// Creates an NSURL with url-encoded parameters.
    init?(string : String, parameters : [String : String])
    {
        guard var components = URLComponents(string: string) else { return nil }

        components.queryItems = parameters.map { return URLQueryItem(name: $0, value: $1) }

        guard let url = components.url else { return nil }

        // Kinda redundant, but we need to call init.
        self.init(string: url.absoluteString)
    }
}

（self.initメソッドはちょっと安っぽいですがNSURL、コンポーネントの初期化はありませんでした）

として使用できます

URL(string: "http://www.google.com/", parameters: ["q" : "search me"])
— できる
ソース
2

私は別の解決策を持っています：

http://splinter.com.au/build-a-url-query-string-in-obj-c-from-a-dict

+(NSString*)urlEscape:(NSString *)unencodedString {
    NSString *s = (NSString *)CFURLCreateStringByAddingPercentEscapes(NULL,
        (CFStringRef)unencodedString,
        NULL,
        (CFStringRef)@"!*'\"();:@&=+$,/?%#[]% ",
        kCFStringEncodingUTF8);
    return [s autorelease]; // Due to the 'create rule' we own the above and must autorelease it
}

// Put a query string onto the end of a url
+(NSString*)addQueryStringToUrl:(NSString *)url params:(NSDictionary *)params {
    NSMutableString *urlWithQuerystring = [[[NSMutableString alloc] initWithString:url] autorelease];
    // Convert the params into a query string
    if (params) {
        for(id key in params) {
            NSString *sKey = [key description];
            NSString *sVal = [[params objectForKey:key] description];
            // Do we need to add ?k=v or &k=v ?
            if ([urlWithQuerystring rangeOfString:@"?"].location==NSNotFound) {
                [urlWithQuerystring appendFormat:@"?%@=%@", [Http urlEscape:sKey], [Http urlEscape:sVal]];
            } else {
                [urlWithQuerystring appendFormat:@"&%@=%@", [Http urlEscape:sKey], [Http urlEscape:sVal]];
            }
        }
    }
    return urlWithQuerystring;
}

その後、次のように使用できます。

NSDictionary *params = @{@"username":@"jim", @"password":@"abc123"};

NSString *urlWithQuerystring = [self addQueryStringToUrl:@"https://myapp.com/login" params:params];
— クリス
ソース
4
回答に関連するコードを投稿してください。そのリンクが永久に存在するわけではありません。
— Madbreaks、
2 
-(NSString*)encodeDictionary:(NSDictionary*)dictionary{
    NSMutableString *bodyData = [[NSMutableString alloc]init];
    int i = 0;
    for (NSString *key in dictionary.allKeys) {
        i++;
        [bodyData appendFormat:@"%@=",key];
        NSString *value = [dictionary valueForKey:key];
        NSString *newString = [value stringByReplacingOccurrencesOfString:@" " withString:@"+"];
        [bodyData appendString:newString];
        if (i < dictionary.allKeys.count) {
            [bodyData appendString:@"&"];
        }
    }
    return bodyData;
}
— フィリッポオジノカリガリス
ソース
これは、名前または値（スペース以外）の特殊文字を適切にエンコードしません。
— jcaron
スペースは+ではなく％20で置き換える必要があるとは思いません。これが変更された唯一の文字です。
— PrzemysławWrzesiński15年
1

さらに別の解決策として、RestKitを使用する場合、RKURLEncodedSerialization呼び出された関数があり、RKURLEncodedStringFromDictionaryWithEncodingそれがまさに望みどおりのことを行います。

— シセロカマルゴ
ソース
1

Objective-cでNSDictionaryをURLクエリ文字列に変換する簡単な方法

例：first_name = Steve＆middle_name = Gates＆last_name = Jobs＆address = Palo Alto、California

    NSDictionary *sampleDictionary = @{@"first_name"         : @"Steve",
                                     @"middle_name"          : @"Gates",
                                     @"last_name"            : @"Jobs",
                                     @"address"              : @"Palo Alto, California"};

    NSMutableString *resultString = [NSMutableString string];
            for (NSString* key in [sampleDictionary allKeys]){
                if ([resultString length]>0)
                    [resultString appendString:@"&"];
                [resultString appendFormat:@"%@=%@", key, [sampleDictionary objectForKey:key]];
            }
NSLog(@"QueryString: %@", resultString);

願っています:)

— ヴィダルベンジョー
ソース
「＆」などの文字が辞書の値に含まれている場合はエスケープしないため、これは正しくありません。
— Thomas Tempelmann
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.