日本語のURLエンコードの方法について

Question

前提・実現したいこと

Objective-cにて、URLをエンコードしたいのですが、CFURLCreateStringByAddingPercentEscapesがiOS9から非推奨になったことにより置き換えを考えております。いろいろネットを探してみたのですが、うまく変換できません。

'CFURLCreateStringByAddingPercentEscapes' is deprecated: first deprecated in iOS 9.0 - Use [NSString stringByAddingPercentEncodingWithAllowedCharacters:] instead, which always uses the recommended UTF-8 encoding, and which encodes for a specific URL component or subcomponent (since each URL component or subcomponent has different rules for what characters are valid).

今までは、以下のように記載していました。

NSString *str = CFBridgingRelease(CFURLCreateStringByAddingPercentEscapes(NULL, (CFStringRef)@"https://ドメイン日本語.com/vi/あいう/test?name=かきく&test=漢字", NULL, NULL, kCFStringEncodingUTF8));

結果

https://%E3%83%89%E3%83%A1%E3%82%A4%E3%83%B3%E6%97%A5%E6%9C%AC%E8%AA%9E.com/vi/%E3%81%82%E3%81%84%E3%81%86/test?name=%E3%81%8B%E3%81%8D%E3%81%8F&test=%E6%BC%A2%E5%AD%97

試したこと

以下のサイトのまま文字列を変換したところ、schemeの後の「://」やpathの「/」まで変換されてしまい、うまくいかず。。。
https://qiita.com/totomo/items/370d9aa8b14c4c075a4a

※クエリストリングに対するパーセントエンコーディングと書いてあることは承知の上で試しました。

https%3A%2F%2F%E3%83%89%E3%83%A1%E3%82%A4%E3%83%B3%E6%97%A5%E6%9C%AC%E8%AA%9E.com%2Fvi%2F%E3%81%82%E3%81%84%E3%81%86%2Ftest%3Fname%3D%E3%81%8B%E3%81%8D%E3%81%8F%26test%3D%E6%BC%A2%E5%AD%97

Answer 1

ご提示のQiitaの先で紹介されているメソッドでやること自体はあっているのですが、URLHostAllowedCharacterSet や URLPathAllowedCharacterSet など、URLの各部品ごとに利用可能文字が違ってきますので、丁寧に実装する場合は各部品に対してそれぞれエンコードをかける必要があります。

たとえばこんな感じ...

// NSURL+IDN.h

@interface NSURL (IDN)

+ (NSURL * __nullable) URLWithIDNURLString:(NSString * __nonnull)str;

@end

// NSURL+IDN.m

@implementation NSURL (IDN)

+ (NSURL * __nullable) URLWithIDNURLString:(NSString * __nonnull)str {
    // <scheme>://<user>:<password>@<host>:<port>/<path>?<query>#<fragment>

    // 与えられた文字列を :// でsplitする。[0]が <scheme>
    NSMutableArray<NSString*> *components = [str componentsSeparatedByString:@"://"].mutableCopy;
    if(components.count <= 1) return nil;
    NSMutableString *encodedStr = [components[0] stringByAppendingString:@"://"].mutableCopy;

    // components[1] 以降をNSStringに戻して、今度は / でsplitする。[0]を host として保持する
    [components removeObjectAtIndex:0];
    components = [[components componentsJoinedByString:@"://"] componentsSeparatedByString:@"/"].mutableCopy;
    NSString *host = components[0];

    // <user>:<password> を持っているかチェックする
    NSArray<NSString*> *hostComponents = [host componentsSeparatedByString:@"@"];
    NSArray<NSString*> *userComponents = [hostComponents[0] componentsSeparatedByString:@":"];
    if(hostComponents.count > 1 && userComponents.count > 1) {
        [encodedStr appendFormat:
         @"%@:%@@",
         [userComponents[0] stringByAddingPercentEncodingWithAllowedCharacters:NSCharacterSet.URLUserAllowedCharacterSet],
         [userComponents[1] stringByAddingPercentEncodingWithAllowedCharacters:NSCharacterSet.URLPasswordAllowedCharacterSet]
        ];
        host = [host substringFromIndex:hostComponents[0].length + 1];
    }

    // <port> を持っているかチェックする。ある場合は portComponentsの最後の要素が <port> で、その手前はすべて <host> になる
    NSMutableArray<NSString*> *portComponents = [host componentsSeparatedByString:@":"].mutableCopy;
    if(portComponents.count == 1) {
        // <port> がない場合
        [encodedStr appendString:[host stringByAddingPercentEncodingWithAllowedCharacters:NSCharacterSet.URLHostAllowedCharacterSet]];
    } else {
        // <port> がある場合
        NSString *port = portComponents[portComponents.count - 1];
        [portComponents removeObjectAtIndex:portComponents.count - 1];
        [encodedStr appendFormat:@"%@:%@", [[portComponents componentsJoinedByString:@":"] stringByAddingPercentEncodingWithAllowedCharacters:NSCharacterSet.URLHostAllowedCharacterSet], port];
    }

    // components[1] 以降をNSStringに戻して、今度は ? でsplitする。[0]が <path>
    [components removeObjectAtIndex:0];
    components = [[components componentsJoinedByString:@"/"] componentsSeparatedByString:@"?"].mutableCopy;
    [encodedStr appendFormat:@"/%@", [components[0] stringByAddingPercentEncodingWithAllowedCharacters:NSCharacterSet.URLPathAllowedCharacterSet]];

    // components[1] 以降をNSStringに戻して、今度は # でsplitする。[0]が <query>, [1]以降が <fragment>
    [components removeObjectAtIndex:0];
    components = [[components componentsJoinedByString:@"?"] componentsSeparatedByString:@"#"].mutableCopy;
    if(components[0].length) {
        [encodedStr appendFormat:@"?%@", [components[0] stringByAddingPercentEncodingWithAllowedCharacters:NSCharacterSet.URLQueryAllowedCharacterSet]];
    }
    if(components.count > 1) {
        [components removeObjectAtIndex:0];
        [encodedStr appendFormat:@"#%@", [[components componentsJoinedByString:@"#"] stringByAddingPercentEncodingWithAllowedCharacters:NSCharacterSet.URLFragmentAllowedCharacterSet]];
    }

    return [NSURL URLWithString:encodedStr];
}

@end

// 使い方
#import "NSURL+IDN.h"
- (void) nanikashiraNoMethod {
    [@[
        @"https://ドメイン日本語.com/vi/あいう/test?name=かきく&test=漢字",
        @"https://ユーザー:パスワード@ドメイン日本語.com/vi/あいう/test?name=かきく&test=漢字",
        @"https://ドメイン日本語.com:8000/vi/あいう/test?name=かきく&test=漢字#項1タイトル",
        @"https://ユーザー:パスワード@ドメイン日本語.com:8000/vi/あいう/test?name=かきく&test=漢字#項1タイトル",
    ] enumerateObjectsUsingBlock:^(NSString * _Nonnull str, NSUInteger idx, BOOL * _Nonnull stop) {
        NSString *encodedStr = [NSURL URLWithIDNURLString:str].absoluteString;
        NSLog(@"%@", encodedStr);
    }];
    /*
     https://%E3%83%89%E3%83%A1%E3%82%A4%E3%83%B3%E6%97%A5%E6%9C%AC%E8%AA%9E.com/vi/%E3%81%82%E3%81%84%E3%81%86/test?name=%E3%81%8B%E3%81%8D%E3%81%8F&test=%E6%BC%A2%E5%AD%97
     https://%E3%83%A6%E3%83%BC%E3%82%B6%E3%83%BC:%E3%83%91%E3%82%B9%E3%83%AF%E3%83%BC%E3%83%89@%E3%83%89%E3%83%A1%E3%82%A4%E3%83%B3%E6%97%A5%E6%9C%AC%E8%AA%9E.com/vi/%E3%81%82%E3%81%84%E3%81%86/test?name=%E3%81%8B%E3%81%8D%E3%81%8F&test=%E6%BC%A2%E5%AD%97
     https://%E3%83%89%E3%83%A1%E3%82%A4%E3%83%B3%E6%97%A5%E6%9C%AC%E8%AA%9E.com:8000/vi/%E3%81%82%E3%81%84%E3%81%86/test?name=%E3%81%8B%E3%81%8D%E3%81%8F&test=%E6%BC%A2%E5%AD%97#%E9%A0%851%E3%82%BF%E3%82%A4%E3%83%88%E3%83%AB
     https://%E3%83%A6%E3%83%BC%E3%82%B6%E3%83%BC:%E3%83%91%E3%82%B9%E3%83%AF%E3%83%BC%E3%83%89@%E3%83%89%E3%83%A1%E3%82%A4%E3%83%B3%E6%97%A5%E6%9C%AC%E8%AA%9E.com:8000/vi/%E3%81%82%E3%81%84%E3%81%86/test?name=%E3%81%8B%E3%81%8D%E3%81%8F&test=%E6%BC%A2%E5%AD%97#%E9%A0%851%E3%82%BF%E3%82%A4%E3%83%88%E3%83%AB
     */
}

※丁寧に実装しなくてもいい場合とは、決まったドメインのURLしか渡ってこないことが仕様上確定している場合などです。

Comments

[mitchi]

ありがとうございます！
私自身でも調べていたのですが、やはりそうやるしかなさそうですね。。。
後、ドメイン部分に関してはPunycodeという考え方(?)もあるそうなので、組み合わせて対応したいと思います。