Java эквивалентен JavaScript encodeURIComponent, который производит идентичный вывод?

Question

Я экспериментировал с различными фрагментами Java-кода, пытаясь придумать что-то, что будет кодировать строку, содержащую кавычки, пробелы и «экзотические» символы Unicode, и производить вывод, идентичный функции JavaScript encodeURIComponent .

Моя строка теста на пытки: "A" B ± "

Если я введу следующий оператор JavaScript в Firebug:

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 returns %22A%22+B+%C2%B1+%22
getBytes returns "A" B ± "

Близко, но без сигары! Каков наилучший способ кодирования строки UTF-8 с использованием Java, чтобы он выдает тот же вывод, что и 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 /542548/java-ekvivalenten-javascript-encodeuricomponent-kotoryi-proizvodit-identichnyi-vyvod
 * @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 на encodeURIComponent():

• буквенные символы (представление регулярного выражения): [-a-zA-Z0-9._*~'()!]

Документация по Java 1.5.0 для URLEncoder:

• буквенные символы (представление регулярного выражения): [-a-zA-Z0-9._*]
• символ пробела " " преобразуется в знак плюс "+".

Таким образом, чтобы получить желаемый результат, используйте URLEncoder.encode(s, "UTF-8"), а затем выполните некоторую постобработку:

• заменить все вхождения "+" на "%20"
• заменяет все вхождения "%xx", представляющие любой из [~'()!], обратно на их буквальные составляющие

Answer 3

Использование движка javascript, поставляемого с Java 6:

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 * ​​1004 *

Дело в другом, но оно ближе к тому, что вы хотите.

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

Вот что я использую:

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

Это выходит за рамки Javascript за счет процентного кодирования каждого символа, который не является незарезервированным символом в соответствии с RFC 3986 .

---

Это обратное преобразование:

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 8

Это простой пример решения Рави Валлау:

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

Он также отвечает на висящий вопрос в комментариях Лорен Шкипогни о том, как передать строковую переменную в encodeURIComponent(). Метод scriptEngine.eval() возвращает Object, поэтому он может быть преобразован в строку через String.valueOf() среди других методов.

Answer 9

для меня это сработало:

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 ответ выглядел хорошо, но он не работает для URL, например, "http://a+b c.html"

Answer 10

В библиотеке гуавы есть PercentEscaper:

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

"-_. *" - безопасные символы

false говорит PercentEscaper, чтобы выходить из пробела с "% 20", а не "+"