文字列をURLエンコードする方法


回答:


291

残念ながら、stringByAddingPercentEscapesUsingEncoding常に100%機能するとは限りません。URL以外の文字をエンコードしますが、予約文字(スラッシュ/やアンパサンドなど&)はそのままにします。どうやらこれはAppleが認識しているバグですが、まだ修正されていないため、このカテゴリを使用して文字列をURLエンコードしています。

@implementation NSString (NSString_Extended)

- (NSString *)urlencode {
    NSMutableString *output = [NSMutableString string];
    const unsigned char *source = (const unsigned char *)[self UTF8String];
    int sourceLen = strlen((const char *)source);
    for (int i = 0; i < sourceLen; ++i) {
        const unsigned char thisChar = source[i];
        if (thisChar == ' '){
            [output appendString:@"+"];
        } else if (thisChar == '.' || thisChar == '-' || thisChar == '_' || thisChar == '~' || 
                   (thisChar >= 'a' && thisChar <= 'z') ||
                   (thisChar >= 'A' && thisChar <= 'Z') ||
                   (thisChar >= '0' && thisChar <= '9')) {
            [output appendFormat:@"%c", thisChar];
        } else {
            [output appendFormat:@"%%%02X", thisChar];
        }
    }
    return output;
}

このように使用されます:

NSString *urlEncodedString = [@"SOME_URL_GOES_HERE" urlencode];

// Or, with an already existing string:
NSString *someUrlString = @"someURL";
NSString *encodedUrlStr = [someUrlString urlencode];

これも機能します:

NSString *encodedString = (NSString *)CFURLCreateStringByAddingPercentEscapes(
                            NULL,
                            (CFStringRef)unencodedString,
                            NULL,
                            (CFStringRef)@"!*'();:@&=+$,/?%#[]",
                            kCFStringEncodingUTF8 );

主題についてのいくつかの良い読書:

Objective-c iPhoneパーセントは文字列をエンコードしますか?
Objective-CおよびSwift URLエンコーディング

http://cybersam.com/programming/proper-url-percent-encoding-in-ios
https://devforums.apple.com/message/15674#15674 http://simonwoodside.com/weblog/2009/4/ 22 / how_to_really_url_encode /


12
一体どうしてCFURLCreateStringByAddingPercentEscapes()にドロップダウンするのではなく、このような複雑なカテゴリを使用するのでしょうか。ここでは、常にエスケープする文字を明示的に指定できます。
リリーバラード

8
@KevinBallardは、CF関数が包含モデル(「これらの文字をエスケープする」)で機能し、通常、排他モデル(「これらの文字を除くすべてエスケープする」)で作業するため
Dave DeLong


31
@DaveDeLongそれは私がそれを得た場所かもしれません。それは1年ほどの間、私のすべてのプロジェクトで標準的なカテゴリだったので、あなたが元のソースだったのではないかと思います。私は文言を編集したので、私がそれを書いたことを信用しようとしているようには見えません)。
chown

4
どうして?if(thisChar == ''){[output appendString:@ "+"]; }期待どおりに%20でスペースをエンコードする場合、これを使用しないでください
Chris Stephens

127

これは役に立ちます

NSString *sampleUrl = @"http://www.google.com/search.jsp?params=Java Developer";
NSString* encodedUrl = [sampleUrl stringByAddingPercentEscapesUsingEncoding:
 NSUTF8StringEncoding];

iOS 7以降の場合、推奨される方法は次のとおりです。

NSString* encodedUrl = [sampleUrl stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];

URLコンポーネントの要件に従って、許可される文字セットを選択できます。


7
また、「&」、「?」などのパラメータ区切り文字を正しくエンコードしません コンテンツをAPIに渡す場合。
Ben Lachman

'&'は、URLクエリ文字列パラメーターの有効な文字ではありません。「&amp;」を使用してみてください 代わりに。
Nishant 2014

1
stringByAddingPercentEscapesUsingEncodingは非-stringByAddingPercentEncodingWithAllowedCharacters:推奨「代わりに使用します。これは常に推奨されるUTF-8エンコーディングを使用し、特定のURLコンポーネントまたはサブコンポーネントをエンコードします。これは、各URLコンポーネントまたはサブコンポーネントが有効な文字について異なるルールを持っているためです。」
Mihir Oza

89

回答が選択されてから、新しいAPIが追加されました。これでNSURLUtilitiesを使用できます。URLの異なる部分では異なる文字を使用できるため、適切な文字セットを使用してください。次の例は、クエリ文字列に含めるためにエンコードします。

encodedString = [myString stringByAddingPercentEncodingWithAllowedCharacters:NSCharacterSet.URLQueryAllowedCharacterSet];

「&」を具体的に変換するには、「&」がURLクエリで許可されているため、URLクエリセットから削除するか、別のセットを使用する必要があります。

NSMutableCharacterSet *chars = NSCharacterSet.URLQueryAllowedCharacterSet.mutableCopy;
[chars removeCharactersInRange:NSMakeRange('&', 1)]; // %26
encodedString = [myString stringByAddingPercentEncodingWithAllowedCharacters:chars];

1
「use NSURLUtilities」が何を意味するのかを理解するのに少し時間がかかりましたが、これがAppleがiOS 7およびOS X 10.9でこの新しいメソッドを定義したNSStringのカテゴリの名前であることがわかりました。
Richard Venable 2014年

1
このようなより複雑な答えがあります:stackoverflow.com/a/20271177/456366
Richard Venable

うん。また、リリースされた新しいAPIのリストにNSURLUtilitiesとしてリストされていました。
Peter DeWeese 14年

'&'はもちろんクエリ文字列で許可されているので、Richardのリンクを使用して回答を編集します。
Peter DeWeese 14

3
NSMakeRange('&', 1)Swiftは、ハックなしではcharからintへの変換を許可しないため、Swiftでは機能しません。このソリューションをSwiftコードで使用するremoveCharactersInString("&")には、代わりに.removeCharactersInRange(...)
cbh2000

16

Swift 2.0の例(iOS 9互換)

extension String {

  func stringByURLEncoding() -> String? {

    let characters = NSCharacterSet.URLQueryAllowedCharacterSet().mutableCopy() as! NSMutableCharacterSet

    characters.removeCharactersInString("&")

    guard let encodedString = self.stringByAddingPercentEncodingWithAllowedCharacters(characters) else {
      return nil
    }

    return encodedString

  }

}

2
@AlecThomasここにたどり着くには、いくつかのフープをジャンプする必要があるようです。そのため、エクステンションでそれを隠した方が良いのです
Oliver Atkinson

@OliverAtkinson-私にとっては、Int(String(Character( "&")))はnilを返します。代わりに、characters.removeCharactersInString( "&")を使用します。
アンビエントライト2015年

14

iOS 7アップデート

NSString *encode = [string stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLQueryAllowedCharacterSet]];

NSString *decode = [encode stringByReplacingPercentEscapesUsingEncoding:NSUTF8StringEncoding];

これは不正確です。URLの異なる部分を異なる方法でエスケープする必要があります。stackoverflow.com/questions/3423545/…–
Steve Moser、

実際に使用できる文字はサーバーに依存します。ここでは、サーバーで使用した英数字の文字セットのみを使用している例を示します。これを特定の文字に変更して、ニーズに応えることができます。
アンダードッグ

1
「&」文字のエンコードについて質問します。
Steve Moser

8

私はCFURLCreateStringByAddingPercentEscapes受け入れられた回答で与えられたコールを使用することを選択しましたが、XCodeの最新バージョン(およびIOS)ではエラーが発生したため、代わりに以下を使用しました。

NSString *apiKeyRaw = @"79b|7Qd.jW=])(fv|M&W0O|3CENnrbNh4}2E|-)J*BCjCMrWy%dSfGs#A6N38Fo~";

NSString *apiKey = (NSString *)CFBridgingRelease(CFURLCreateStringByAddingPercentEscapes(NULL, (CFStringRef)apiKeyRaw, NULL, (CFStringRef)@"!*'();:@&=+$,/?%#[]", kCFStringEncodingUTF8));

エンコーディングスペースではありません。例@ "string string"および@ "string&string"は適切にエンコードされています。同じことについて、私に知らせてください。
Yogesh Lolusare 2014

2
私にとって最もこれを解決費やした時間の私は、フレームワークはいじりなしでこれを行い「でurlencode」に似た名前の何か..含まdoes notの信じることを拒否した拒否期間だった
dancl

6

stringByAddingPercentEncodingWithAllowedCharactersメソッドを使用してみてください[NSCharacterSet URLUserAllowedCharacterSet]すべてのケースをカバー

目的C

NSString *value = @"Test / Test";
value = [value stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLUserAllowedCharacterSet]];

迅速

var value = "Test / Test"
value.stringByAddingPercentEncodingWithAllowedCharacters(NSCharacterSet.URLUserAllowedCharacterSet())

出力

Test%20%2F%20Test


6

このトピックのすべての回答と(間違った)承認さ、投稿を追加したいと思います。

IFターゲットはiOS7 +で、そして2017年に、それは、Xcodeは速く、iOS8、最良の方法は、スレッドセーフで下の互換性を提供するために本当にハードになります必要があるため、AMDフルUTF-8のサポートは、これはやってます。

(目的Cコード)

@implementation NSString (NSString_urlencoding)

- (NSString *)urlencode {
    static NSMutableCharacterSet *chars = nil;
    static dispatch_once_t pred;

    if (chars)
        return [self stringByAddingPercentEncodingWithAllowedCharacters:chars];

    // to be thread safe
    dispatch_once(&pred, ^{
        chars = NSCharacterSet.URLQueryAllowedCharacterSet.mutableCopy;
        [chars removeCharactersInString:@"!*'();:@&=+$,/?%#[]"];
    });
    return [self stringByAddingPercentEncodingWithAllowedCharacters:chars];
}
@end

これはNSStringを拡張し、RFC禁止文字を除外し、UTF-8文字をサポートし、次のようなものを使用できるようにします。

NSString *myusername = "I'm[evil]&want(to)break!!!$->àéìòù";
NSLog(@"Source: %@ -> Dest: %@", myusername, [myusername urlencode]);

デバッグコンソールに出力されます。

ソース:I'm [evil]&want(to)break !!! $->àéìòù-> Dest:I%27m%5Bevil%5D%26want%28to%29break%21%21%21%24-%3E%C3 %A0%C3%A9%C3%AC%C3%B2%C3%B9

...マルチスレッド環境での複数の初期化を回避するためのdispatch_onceの使用にも注意してください。


5

Swift 5.xでの本番環境に対応した柔軟なアプローチを次に示します。

public extension CharacterSet {

    static let urlQueryParameterAllowed = CharacterSet.urlQueryAllowed.subtracting(CharacterSet(charactersIn: "&?"))

    static let urlQueryDenied           = CharacterSet.urlQueryAllowed.inverted()
    static let urlQueryKeyValueDenied   = CharacterSet.urlQueryParameterAllowed.inverted()
    static let urlPathDenied            = CharacterSet.urlPathAllowed.inverted()
    static let urlFragmentDenied        = CharacterSet.urlFragmentAllowed.inverted()
    static let urlHostDenied            = CharacterSet.urlHostAllowed.inverted()

    static let urlDenied                = CharacterSet.urlQueryDenied
        .union(.urlQueryKeyValueDenied)
        .union(.urlPathDenied)
        .union(.urlFragmentDenied)
        .union(.urlHostDenied)


    func inverted() -> CharacterSet {
        var copy = self
        copy.invert()
        return copy
    }
}



public extension String {
    func urlEncoded(denying deniedCharacters: CharacterSet = .urlDenied) -> String? {
        return addingPercentEncoding(withAllowedCharacters: deniedCharacters.inverted())
    }
}

使用例:

print("Hello, World!".urlEncoded()!)
print("You&Me?".urlEncoded()!)
print("#Blessed 100%".urlEncoded()!)
print("Pride and Prejudice".urlEncoded(denying: .uppercaseLetters)!)

出力:

Hello,%20World!
You%26Me%3F
%23Blessed%20100%25
%50ride and %50rejudice

私は将来的に、より良い答えを書く方法を知っているので🙂ごdownvotesの理由を説明するコメントを含めてください
ベンLeggiero

4

NSURLComponentsを使用して、HTTP GETパラメータをエンコードします。

    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

http://www.ralfebert.de/snippets/ios/encoding-nsurl-get-parameters/


1
アンパサンド、スラッシュ、セミコロンはエンコードしません。
ファビオ・オリベイラ

4

このコードは、特殊文字をエンコードするのに役立ちました

NSString* encPassword = [password stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet alphanumericCharacterSet]];

3

このスレッドでのchownのobjc回答に基づく迅速なコード。

extension String {
    func urlEncode() -> String {
        return CFURLCreateStringByAddingPercentEscapes(
            nil,
            self,
            nil,
            "!*'();:@&=+$,/?%#[]",
            CFStringBuiltInEncodings.UTF8.rawValue
        )
    }
}

4
この関数はiOS 9で廃止されました:(
Oliver Atkinson

3

スウィフト3、以下試してみてください。

let stringURL = "YOUR URL TO BE ENCODE";
let encodedURLString = stringURL.addingPercentEncoding(withAllowedCharacters: .urlHostAllowed)
print(encodedURLString)

、以来stringByAddingPercentEscapesUsingEncoding(のような非URLの文字が、葉予約文字をエンコードする!*'();:@&=+$,/?%#[])、次のコードのようなURLをエンコードすることができます。

let stringURL = "YOUR URL TO BE ENCODE";
let characterSetTobeAllowed = (CharacterSet(charactersIn: "!*'();:@&=+$,/?%#[] ").inverted)
if let encodedURLString = stringURL.addingPercentEncoding(withAllowedCharacters: characterSetTobeAllowed) {
    print(encodedURLString)
}

2

迅速に:3

// exclude alpha and numeric == "full" encoding
stringUrl = stringUrl.addingPercentEncoding(withAllowedCharacters: .alphanumerics)!;

// exclude hostname and symbols &,/ and etc
stringUrl = stringUrl.addingPercentEncoding(withAllowedCharacters: .urlHostAllowed)!;

2

10.11リリースノートでのAppleのアドバイスは次のとおりです。

URL文字列全体をパーセントエンコードする必要がある場合は、次のコードを使用して、URL(urlStringToEncode内)となるNSStringをエンコードできます。

NSString *percentEncodedURLString =
  [[NSURL URLWithDataRepresentation:[urlStringToEncode dataUsingEncoding:NSUTF8StringEncoding] relativeToURL:nil] relativeString];

のように動作しないようで、&のような文字はまだ放置されています
kjyv 2018年

1

最後のコンポーネントがアラビア文字である私の場合、私は次のことを行いましたSwift 2.2

extension String {

 func encodeUTF8() -> String? {

    //If I can create an NSURL out of the string nothing is wrong with it
    if let _ = NSURL(string: self) {

        return self
    }

    //Get the last component from the string this will return subSequence
    let optionalLastComponent = self.characters.split { $0 == "/" }.last


    if let lastComponent = optionalLastComponent {

        //Get the string from the sub sequence by mapping the characters to [String] then reduce the array to String
        let lastComponentAsString = lastComponent.map { String($0) }.reduce("", combine: +)


        //Get the range of the last component
        if let rangeOfLastComponent = self.rangeOfString(lastComponentAsString) {
            //Get the string without its last component
            let stringWithoutLastComponent = self.substringToIndex(rangeOfLastComponent.startIndex)


            //Encode the last component
            if let lastComponentEncoded = lastComponentAsString.stringByAddingPercentEncodingWithAllowedCharacters(NSCharacterSet.alphanumericCharacterSet()) {


            //Finally append the original string (without its last component) to the encoded part (encoded last component)
            let encodedString = stringWithoutLastComponent + lastComponentEncoded

                //Return the string (original string/encoded string)
                return encodedString
            }
        }
    }

    return nil;
}
}

使用法:

let stringURL = "http://xxx.dev.com/endpoint/nonLatinCharacters"

if let encodedStringURL = stringURL.encodeUTF8() {

    if let url = NSURL(string: encodedStringURL) {

      ...
    }

} 

1
-(NSString *)encodeUrlString:(NSString *)string {
  return CFBridgingRelease(
                    CFURLCreateStringByAddingPercentEscapes(
                        kCFAllocatorDefault,
                        (__bridge CFStringRef)string,
                        NULL,
                        CFSTR("!*'();:@&=+$,/?%#[]"),
                        kCFStringEncodingUTF8)
                    );
}

次のブログによると


しかし、iOS 9では非推奨です。このための更新されたコードは何ですか?
Sujit Nachan

1

多くの回答がありましたが、うまくいきませんでしたので、次のことを試しました。

fun simpleServiceCall(for serviceUrl: String, appendToUrl: String) { 
    let urlString: String = serviceUrl + appendToUrl.addingPercentEncoding(withAllowedCharacters: .urlPathAllowed)!     

    let finalUrl = URL(string: urlString)!

    //continue to execute your service call... 
}

うまくいけば、それは誰かを助けるでしょう。ありがとう


0

個々のwwwフォームエンコードされたクエリパラメータについて、NSStringにカテゴリを作成しました。

- (NSString*)WWWFormEncoded{
     NSMutableCharacterSet *chars = NSCharacterSet.alphanumericCharacterSet.mutableCopy;
     [chars addCharactersInString:@" "];
     NSString* encodedString = [self stringByAddingPercentEncodingWithAllowedCharacters:chars];
     encodedString = [encodedString stringByReplacingOccurrencesOfString:@" " withString:@"+"];
     return encodedString;
}

0

//これはテストなしです

NSMutableCharacterSet* set = [[NSCharacterSet alphanumericCharacterSet] mutableCopy];
[set addCharactersInString:@"-_.~"];
NSString *encode = [test stringByAddingPercentEncodingWithAllowedCharacters:set];

0

複雑な文字列をPOSTパラメータとして渡すと、同様の問題に直面しました。文字列には、アジアの文字、スペース、引用符、およびあらゆる種類の特殊文字を含めることができます。私が最終的に見つけた解決策は、文字列を一致する一連のユニコードに変換することでした。たとえば、[NSString stringWithFormat:@ "Hu%04x"、[string characterAtIndex:i]]を使用して、それぞれからUnicodeを取得します。元の文字列の文字。Javaでも同じことができます。

この文字列はPOSTパラメータとして安全に渡すことができます。

サーバー側(PHP)では、すべての "H"を "\"に変更し、結果の文字列をjson_decodeに渡します。最後のステップは、文字列をMySQLに格納する前に単一引用符をエスケープすることです。

このようにして、サーバーに任意のUTF8文字列を保存できます。


0

これは私のために働いています。

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
}

私はこのリンクから上記の機能を見つけました:http : //useyourloaf.com/blog/how-to-percent-encode-a-url-string/

この関数は、swift拡張機能でも使用できます。問題がありましたらお知らせください。

弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.