Java 等效于产生相同输出的 JavaScript 的 encodeURIComponent？

Question

我一直在试验各种 Java 代码，试图想出一些东西来编码包含引号、空格和“外来”Unicode 字符的字符串，并产生与 JavaScript 的 encodeURIComponent 函数相同的输出。

我的折磨测试字符串是："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 ± "

关闭，但没有雪茄！使用 Java 对 UTF-8 字符串进行编码以使其产生与 JavaScript 的 encodeURIComponent 相同的输出的最佳方法是什么？

编辑：我正在使用 Java 1.4，很快就会迁移到 Java 5。

Answer 1

这是我最后想出的课程：

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();
  }
}

Answer 2

查看实现差异，我看到：

MDC on encodeURIComponent():

• 文字字符（正则表达式表示）：[-a-zA-Z0-9._*~'()!]

Java 1.5.0 documentation on URLEncoder:

• 文字字符（正则表达式表示）：[-a-zA-Z0-9._*]
• 空格字符" " 转换为加号"+"。

所以基本上，为了得到想要的结果，使用URLEncoder.encode(s, "UTF-8") 然后做一些后期处理：

• 将所有出现的"+" 替换为"%20"
• 将所有出现的 "%xx" 代表任何 [~'()!] 替换回它们的字面对应部分

Answer 3

使用 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

情况不同，但更接近你想要的。

Answer 4

我使用java.net.URI#getRawPath()，例如

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

fixed 的值将是 a+b%20c.html，这是您想要的。

对URLEncoder.encode() 的输出进行后处理将消除假定在URI 中的所有优点。例如

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

会给你a%20b%20c.html，它会被解释为a b c.html。

Answer 5

我想出了我自己版本的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 };
        }
    }
}

Answer 6

我想出了另一个实现，记录在 http://blog.sangupta.com/2010/05/encodeuricomponent-and.html。该实现还可以处理 Unicode 字节。

Answer 7

对我来说这很有效：

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+b c.html”

Answer 8

我已经成功使用了 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;
}

Answer 9

这是一个简单的例子 Ravi Wallau 的解决方案：

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

它还回答了 Loren Shqipognja 在 cmets 中关于如何将字符串变量传递给 encodeURIComponent() 的悬而未决的问题。 scriptEngine.eval()方法返回一个Object，所以可以通过String.valueOf()等方法转换成String。

Answer 10

这是我正在使用的：

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();
}

Answer 11

我用过 String encodedUrl = new URI(null, url, null).toASCIIString(); 对网址进行编码。 要在url 中的现有参数之后添加参数，我使用UriComponentsBuilder

Answer 12

我从 google-http-java-client 库中找到了 PercentEscaper 类，它可以很容易地用于实现 encodeURIComponent。

PercentEscaper from google-http-java-client javadoc google-http-java-client home

Answer 13

Guava 库有 PercentEscaper：

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

“-_.*”是安全字符

false 表示 PercentEscaper 用 '%20' 转义空间，而不是 '+'