同一の出力を生成するJavaScriptのencodeURIComponentと同等のJava？

92

引用符、スペース、「エキゾチック」なUnicode文字を含む文字列をエンコードし、JavaScriptのencodeURIComponent関数と同じ出力を生成するものを考え出すために、Javaコードのさまざまなビットを試してきました。

私の拷問テスト文字列は「A」B±「

Firebugに次のJavaScriptステートメントを入力すると：

encodeURIComponent('"A" B ± "');

-それから私は得る：

"%22A%22%20B%20%C2%B1%20%22"

これが私の小さなテストJavaプログラムです：

import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;

public class EncodingTest
{
  public static void main(String[] args) throws UnsupportedEncodingException
  {
    String s = "\"A\" B ± \"";
    System.out.println("URLEncoder.encode returns "
      + URLEncoder.encode(s, "UTF-8"));

    System.out.println("getBytes returns "
      + new String(s.getBytes("UTF-8"), "ISO-8859-1"));
  }
}

-このプログラムは以下を出力します。

URLEncoder.encodeは％22A％22 + B +％C2％B1 +％22を返します
getBytesは "A" B± "を返します

閉じますが、葉巻はありません！JavaScriptと同じ出力を生成するようにJavaを使用してUTF-8文字列をエンコードする最良の方法は何encodeURIComponentですか？

編集：私はJava1.4を使用して間もなくJava5に移行します。

java  javascript  unicode  utf-8 
— ジョン・トプリー
ソース

回答:

63

実装の違いを見ると、次のことがわかります。

MDCオンencodeURIComponent()：

  • リテラル文字（正規表現表現）： [-a-zA-Z0-9._*~'()!]

Java 1.5.0のドキュメントURLEncoder：

  • リテラル文字（正規表現表現）： [-a-zA-Z0-9._*]
  • スペース文字" "はプラス記号に変換され"+"ます。

したがって、基本的に、目的の結果を得るには、URLEncoder.encode(s, "UTF-8")次の処理を使用して実行します。

  • のすべての出現を"+"で置き換えます"%20"
  • "%xx"いずれかを表すすべてのオカレンスを[~'()!]文字通りのカウンターパートに置き換えます
— トマラク
ソース
「[〜 '（）！]のいずれかを表す「％xx」のすべての出現箇所を文字通りの対応部分に置き換える」を簡単な言語で記述しておけばよかったのにと思います。:(私の小さな頭が.......それを理解することはできません
— シャイレンドラ・シンRajawat
1
@Shailendra[~'()!]は"~"、"'"or"("または")"orまたはorを意味し"!"ます。:)ただし、正規表現の基本も学ぶことをお勧めします。（少なくとも他の2つの回答がそれぞれのJavaコードを示しているので、私もそれを拡張しませんでした。）
— Tomalak 2014年
3
のすべての出現箇所を"+"withに置き換えると、URIパスの正当な文字（クエリ文字列には含まれません）"%20"と同様"+"に、破壊的な可能性があります。たとえば、「a + bc」は"a+b%20c";としてエンコードする必要があります。このソリューションはそれをに変換し"a%20b%20c"ます。代わりに、を使用してくださいnew URI(null, null, value, null).getRawPath()。
— Chris Nitchie 2016
@ChrisNitchieそれは問題のポイントではありませんでした。質問は「Javaは同じ出力を生成するJavaScriptのencodeURIComponentと同等ですか？」でした。、「汎用Javaエンコード-URIコンポーネント関数？」ではありません。。
— Tomalak 2016
118

これは私が最終的に思いついたクラスです：

import java.io.UnsupportedEncodingException;
import java.net.URLDecoder;
import java.net.URLEncoder;

/**
 * Utility class for JavaScript compatible UTF-8 encoding and decoding.
 * 
 * @see http://stackoverflow.com/questions/607176/java-equivalent-to-javascripts-encodeuricomponent-that-produces-identical-output
 * @author John Topley 
 */
public class EncodingUtil
{
  /**
   * Decodes the passed UTF-8 String using an algorithm that's compatible with
   * JavaScript's <code>decodeURIComponent</code> function. Returns
   * <code>null</code> if the String is <code>null</code>.
   *
   * @param s The UTF-8 encoded String to be decoded
   * @return the decoded String
   */
  public static String decodeURIComponent(String s)
  {
    if (s == null)
    {
      return null;
    }

    String result = null;

    try
    {
      result = URLDecoder.decode(s, "UTF-8");
    }

    // This exception should never occur.
    catch (UnsupportedEncodingException e)
    {
      result = s;  
    }

    return result;
  }

  /**
   * Encodes the passed String as UTF-8 using an algorithm that's compatible
   * with JavaScript's <code>encodeURIComponent</code> function. Returns
   * <code>null</code> if the String is <code>null</code>.
   * 
   * @param s The String to be encoded
   * @return the encoded String
   */
  public static String encodeURIComponent(String s)
  {
    String result = null;

    try
    {
      result = URLEncoder.encode(s, "UTF-8")
                         .replaceAll("\\+", "%20")
                         .replaceAll("\\%21", "!")
                         .replaceAll("\\%27", "'")
                         .replaceAll("\\%28", "(")
                         .replaceAll("\\%29", ")")
                         .replaceAll("\\%7E", "~");
    }

    // This exception should never occur.
    catch (UnsupportedEncodingException e)
    {
      result = s;
    }

    return result;
  }  

  /**
   * Private constructor to prevent this class from being instantiated.
   */
  private EncodingUtil()
  {
    super();
  }
}
— ジョン・トプリー
ソース
5
ヒントを追加します。Android 4.4では%0A、Android入力のリターンキーを意味する置換も必要であることがわかりました。そうしないと、jsがクラッシュします。
— 2014年
あなたはここですべてをカバーでください：developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/...を
— kamaci
1
@Aloong置換とはどういう意味"%0A"ですか？どのキャラクターが代わりになりますか？空の文字列""ですか？
— HendraWD 2018年
15

Java 6に付属のjavascriptエンジンを使用する：


import javax.script.ScriptEngine;
import javax.script.ScriptEngineManager;

public class Wow
{
    public static void main(String[] args) throws Exception
    {
        ScriptEngineManager factory = new ScriptEngineManager();
        ScriptEngine engine = factory.getEngineByName("JavaScript");
        engine.eval("print(encodeURIComponent('\"A\" B ± \"'))");
    }
}

出力：％22A％22％20B％20％c2％b1％20％22

ケースは異なりますが、あなたが望むものに近いです。

— ラヴィ・ワラウ
ソース
ああ、ごめんなさい...私はJava1.4をJava5に移行していると質問で述べるべきでした！
— ジョントプリー
3
javascriptが唯一の解決策である場合は、Rhinoを試すことができますが、この小さな問題には多すぎます。
— Ravi Wallau
3
彼がJava6を使用していたとしても、このソリューションは非常に優れていると思います。彼がjavascriptメソッドを直接呼び出す方法を探しているのではなく、それをエミュレートする方法を探しているだけだと思います。
— アウトロープログラマー
1
多分。トリックを実行するものが見つからない場合は、独自のエスケープ関数を作成するのが最も簡単な解決策だと思います。StringEscapeUtilsクラス（Jakarta Commons Lang）からいくつかのメソッドをコピーし、必要に応じて再実装するだけです。
— Ravi Wallau
2
これは実際に機能しますが、パフォーマンスを気にしないのであれば...良いと思います。
— 2rs2ts 2014
8

私は使用しますjava.net.URI#getRawPath()、例えば

String s = "a+b c.html";
String fixed = new URI(null, null, s, null).getRawPath();

値はfixedなりますa+b%20c.htmlあなたが望むものです。

の出力を後処理すると、URIにあるはずのURLEncoder.encode()プラスがすべて消去されます。例えば

URLEncoder.encode("a+b c.html").replaceAll("\\+", "%20");

が与えられa%20b%20c.html、これはとして解釈されa b c.htmlます。

— クリス・ニッチー
ソース
これが最善の答えであると考えた後、いくつかのファイル名で実際に試しましたが、少なくとも2つで失敗し、1つはキリル文字で失敗しました。したがって、いいえ、これは明らかに十分にテストされていません。
— AsGoodAsItGets 2016年
次のような文字列では機能しません：http://a+b c.html、エラーがスローされます
— 2017年
5

投稿されたソリューションには1つの問題があるため、独自のバージョンのencodeURIComponentを思いつきました。エンコードする必要のある文字列に+が存在する場合、スペースに変換されます。

これが私のクラスです：

import java.io.UnsupportedEncodingException;
import java.util.BitSet;

public final class EscapeUtils
{
    /** used for the encodeURIComponent function */
    private static final BitSet dontNeedEncoding;

    static
    {
        dontNeedEncoding = new BitSet(256);

        // a-z
        for (int i = 97; i <= 122; ++i)
        {
            dontNeedEncoding.set(i);
        }
        // A-Z
        for (int i = 65; i <= 90; ++i)
        {
            dontNeedEncoding.set(i);
        }
        // 0-9
        for (int i = 48; i <= 57; ++i)
        {
            dontNeedEncoding.set(i);
        }

        // '()*
        for (int i = 39; i <= 42; ++i)
        {
            dontNeedEncoding.set(i);
        }
        dontNeedEncoding.set(33); // !
        dontNeedEncoding.set(45); // -
        dontNeedEncoding.set(46); // .
        dontNeedEncoding.set(95); // _
        dontNeedEncoding.set(126); // ~
    }

    /**
     * A Utility class should not be instantiated.
     */
    private EscapeUtils()
    {

    }

    /**
     * Escapes all characters except the following: alphabetic, decimal digits, - _ . ! ~ * ' ( )
     * 
     * @param input
     *            A component of a URI
     * @return the escaped URI component
     */
    public static String encodeURIComponent(String input)
    {
        if (input == null)
        {
            return input;
        }

        StringBuilder filtered = new StringBuilder(input.length());
        char c;
        for (int i = 0; i < input.length(); ++i)
        {
            c = input.charAt(i);
            if (dontNeedEncoding.get(c))
            {
                filtered.append(c);
            }
            else
            {
                final byte[] b = charToBytesUTF(c);

                for (int j = 0; j < b.length; ++j)
                {
                    filtered.append('%');
                    filtered.append("0123456789ABCDEF".charAt(b[j] >> 4 & 0xF));
                    filtered.append("0123456789ABCDEF".charAt(b[j] & 0xF));
                }
            }
        }
        return filtered.toString();
    }

    private static byte[] charToBytesUTF(char c)
    {
        try
        {
            return new String(new char[] { c }).getBytes("UTF-8");
        }
        catch (UnsupportedEncodingException e)
        {
            return new byte[] { (byte) c };
        }
    }
}
— ジョーミル
ソース
良い解決策をありがとう！他のものは完全に...非効率に見えます、IMO。おそらく、今日のハードウェアにBitSetがない方が良いでしょう。または、0 ... 127の2つのハードコードされたlong。
— Jonas N
URLEncoder.encode("+", "UTF-8");利回り"%2B"ソリューションがあるので、適切なURLエンコードされ、私の謝罪、全く不要。なぜ地球URLEncoder.encodeがスペースを変えないのか%20は私を超えています。
— 2rs2ts 2014
1

私は次のようにjava.net.URIクラスを正常に使用しました。

public static String uriEncode(String string) {
    String result = string;
    if (null != string) {
        try {
            String scheme = null;
            String ssp = string;
            int es = string.indexOf(':');
            if (es > 0) {
                scheme = string.substring(0, es);
                ssp = string.substring(es + 1);
            }
            result = (new URI(scheme, ssp, null)).toString();
        } catch (URISyntaxException usex) {
            // ignore and use string that has syntax error
        }
    }
    return result;
}
— マイクブライアント
ソース
いいえ、このアプローチは完全には成功していませんが、比較的問題ありません。あなたはまだ問題を抱えています。たとえば、基本文字＃javaは％23にエンコードしますjavascriptはそれをエンコードしません。参照：developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/…Javascript はespaceしません。AZ az 0-9; 、/？：@＆= + $ -_。！〜* '（）＃そして、これらのJavaのいくつかはespaceします。
— 99Sono
次の式を使用してUNITテストを実行することをお勧めします。'' '枢機卿は唯一の外れ値です。したがって、上記のアルゴリズムを修正してjavascriptと互換性を持たせるのは簡単です。
— 99Sono
1

これは、RaviWallauのソリューションの簡単な例です。

public String buildSafeURL(String partialURL, String documentName)
        throws ScriptException {
    ScriptEngineManager scriptEngineManager = new ScriptEngineManager();
    ScriptEngine scriptEngine = scriptEngineManager
            .getEngineByName("JavaScript");

    String urlSafeDocumentName = String.valueOf(scriptEngine
            .eval("encodeURIComponent('" + documentName + "')"));
    String safeURL = partialURL + urlSafeDocumentName;

    return safeURL;
}

public static void main(String[] args) {
    EncodeURIComponentDemo demo = new EncodeURIComponentDemo();
    String partialURL = "https://www.website.com/document/";
    String documentName = "Tom & Jerry Manuscript.pdf";

    try {
        System.out.println(demo.buildSafeURL(partialURL, documentName));
    } catch (ScriptException se) {
        se.printStackTrace();
    }
}

出力： https://www.website.com/document/Tom%20%26%20Jerry%20Manuscript.pdf

また、String変数をに渡す方法に関するLorenShqipognjaのコメントにあるぶら下がっている質問にも答えますencodeURIComponent()。このメソッドscriptEngine.eval()はを返すためObject、String.valueOf()他のメソッドの中でも特にStringに変換できます。

— 銀
ソース
1

私にとってこれはうまくいきました：

import org.apache.http.client.utils.URIBuilder;

String encodedString = new URIBuilder()
  .setParameter("i", stringToEncode)
  .build()
  .getRawQuery() // output: i=encodedString
  .substring(2);

または別のUriBuilderを使用

import javax.ws.rs.core.UriBuilder;

String encodedString = UriBuilder.fromPath("")
  .queryParam("i", stringToEncode)
  .toString()   // output: ?i=encodedString
  .substring(3);

私の意見では、手動で後処理するよりも、標準ライブラリを使用する方が良い考えです。また、@ Chrisの回答は良さそうに見えましたが、「http：// a + bc.html」のようなURLでは機能しません。

— バラズ
ソース
1
標準ライブラリを使用するのは良いことです......ミドルウェアであり、標準ライブラリの別のバージョンに依存している場合を除き、コードを使用する人は依存関係をいじる必要があり、何も壊れないことを望んでいます...
— Ajax
このソリューションが機能するのであれば素晴らしいと思いますが、リクエストと同じようには動作しませんencodeURIComponent。encodeURIComponent以下のためのリターン?& 結果%3F%26%20が、あなたの提案に戻ります%3F%26+。私はこれが他の質問と回答で何度も言及されていることを知っていますが、人々が盲目的にそれを信頼する前に、ここで言及されるべきです。
— フィリップ
1

これは私が使用しているものです：

private static final String HEX = "0123456789ABCDEF";

public static String encodeURIComponent(String str) {
    if (str == null) return null;

    byte[] bytes = str.getBytes(StandardCharsets.UTF_8);
    StringBuilder builder = new StringBuilder(bytes.length);

    for (byte c : bytes) {
        if (c >= 'a' ? c <= 'z' || c == '~' :
            c >= 'A' ? c <= 'Z' || c == '_' :
            c >= '0' ? c <= '9' :  c == '-' || c == '.')
            builder.append((char)c);
        else
            builder.append('%')
                   .append(HEX.charAt(c >> 4 & 0xf))
                   .append(HEX.charAt(c & 0xf));
    }

    return builder.toString();
}

これは、RFC 3986に従って、予約されていない文字ではないすべての文字をパーセントエンコードすることで、Javascriptを超えています。

これは反対の変換です：

public static String decodeURIComponent(String str) {
    if (str == null) return null;

    int length = str.length();
    byte[] bytes = new byte[length / 3];
    StringBuilder builder = new StringBuilder(length);

    for (int i = 0; i < length; ) {
        char c = str.charAt(i);
        if (c != '%') {
            builder.append(c);
            i += 1;
        } else {
            int j = 0;
            do {
                char h = str.charAt(i + 1);
                char l = str.charAt(i + 2);
                i += 3;

                h -= '0';
                if (h >= 10) {
                    h |= ' ';
                    h -= 'a' - '0';
                    if (h >= 6) throw new IllegalArgumentException();
                    h += 10;
                }

                l -= '0';
                if (l >= 10) {
                    l |= ' ';
                    l -= 'a' - '0';
                    if (l >= 6) throw new IllegalArgumentException();
                    l += 10;
                }

                bytes[j++] = (byte)(h << 4 | l);
                if (i >= length) break;
                c = str.charAt(i);
            } while (c == '%');
            builder.append(new String(bytes, 0, j, UTF_8));
        }
    }

    return builder.toString();
}
— ヌーノ・クルセス
ソース
0

GuavaライブラリにはPercentEscaperがあります。

Escaper percentEscaper = new PercentEscaper("-_.*", false);

「-_。*」は安全な文字です

falseは、PercentEscaperが「+」ではなく「％20」でスペースをエスケープすると言います

— Aliaksei Nikuliak
ソース
0

以前 String encodedUrl = new URI(null, url, null).toASCIIString(); はURLをエンコードしていました。url私が使用している既存のパラメータの後にパラメータを追加するにはUriComponentsBuilder

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