Java эквивалентен компоненту encodeURIComponent JavaScript, который производит идентичный вывод?
я экспериментировал с различными битами кода Java, пытаясь придумать что-то, что будет кодировать строку, содержащую кавычки, пробелы и "экзотические" символы Юникода, и производить вывод, идентичный JavaScript encodeURIComponent
12 ответов:
глядя на различия в реализации, я вижу, что:
- литеральные символы (представление регулярных выражений):
[-a-zA-Z0-9._*~'()!]
документация Java 1.5.0 на
URLEncoder
:
- литеральные символы (представление регулярных выражений):
[-a-zA-Z0-9._*]
- пробел
" "
преобразовывается в знак плюс"+"
.так что в основном, чтобы получить желаемый результат, используйте
URLEncoder.encode(s, "UTF-8")
и затем сделать некоторые пост-обработки:
- заменить все вхождения
"+"
С"%20"
- заменить все вхождения
"%xx"
представляющие какой-либо из[~'()!]
вернуться к их буквальному контр-частей
это класс, который я придумал в конце:
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(); } }
использование движка 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
дело в другом, но это ближе к тому, что вы хотите.
я использую
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
.
Я придумал свою собственную версию 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 }; } } }
Я придумал другую реализацию, задокументированную на,http://blog.sangupta.com/2010/05/encodeuricomponent-and.html. реализация также может обрабатывать байты Юникода.
Я нашел класс PercentEscaper из библиотеки google-http-java-client, который можно использовать для реализации encodeURIComponent довольно легко.
PercentEscaper от google-http-java-client javadoc google-http-java-client home
Я успешно использовал класс 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; }
это простой пример решения Рави Валлау:
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
он также отвечает на висячий вопрос в комментариях Лорен Shqipognja о том, как передать строковую переменную в
encodeURIComponent()
. МетодscriptEngine.eval()
возвращаетObject
, поэтому он может быть преобразован в строку черезString.valueOf()
среди других методов.
для меня это работает:
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"
библиотека гуавы имеет PercentEscaper:
Escaper percentEscaper = new PercentEscaper("-_.*", false);
" -_.* "являются безопасными символами
false говорит PercentEscaper для выхода из пространства с "%20", а не"+"
вот что я использую:
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.
это oposite преобразование:
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(); }