Java equivalente ao codeuricomponent de JavaScript que produz saída idêntica?
-
03-07-2019 - |
Pergunta
Eu tenho experimentado vários bits de código Java tentando criar algo que codificará uma string contendo citações, espaços e caracteres unicode "exóticos" e produzirá saída idêntica ao JavaScript's Encodeuricomponent função.
Minha sequência de teste de tortura é: "A" B ± "
Se eu inserir a seguinte instrução JavaScript no Firebug:
encodeURIComponent('"A" B ± "');
- Então eu recebo:
"%22A%22%20B%20%C2%B1%20%22"
Aqui está o meu pequeno programa de Java TEST:
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"));
}
}
—Este saída do programa:
URLEncoder.encode returns %22A%22+B+%C2%B1+%22 getBytes returns "A" B ± "
Fechar, mas sem charuto! Qual é a melhor maneira de codificar uma string UTF-8 usando Java para que ela produz a mesma saída que o JavaScript's encodeURIComponent
?
EDITAR: Estou usando o Java 1.4 Movendo -se para o Java 5 em breve.
Solução
Olhando para as diferenças de implementação, vejo isso:
- caracteres literais (representação regex):
[-a-zA-Z0-9._*~'()!]
Java 1.5.0 Documentação sobre URLEncoder
:
- caracteres literais (representação regex):
[-a-zA-Z0-9._*]
- o personagem espacial
" "
é convertido em um sinal positivo"+"
.
Então, basicamente, para obter o resultado desejado, use URLEncoder.encode(s, "UTF-8")
E então faça algum pós-processamento:
- substitua todas as ocorrências de
"+"
com"%20"
- substitua todas as ocorrências de
"%xx"
representando qualquer um de[~'()!]
Voltar para suas contrapartes literais
Outras dicas
Esta é a aula que eu criei no final:
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();
}
}
Usando o mecanismo JavaScript que é enviado com 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 ± \"'))");
}
}
Produção:%22a%22%20b%20%c2%b1%20%22
O caso é diferente, mas está mais próximo do que você deseja.
eu uso java.net.URI#getRawPath()
, por exemplo
String s = "a+b c.html";
String fixed = new URI(null, null, s, null).getRawPath();
O valor de fixed
vai ser a+b%20c.html
, que é o que você quer.
Pós-processando a saída de URLEncoder.encode()
vai obliterar quaisquer vantagens que sejam suposto estar no URI. Por exemplo
URLEncoder.encode("a+b c.html").replaceAll("\\+", "%20");
Darei à você a%20b%20c.html
, que será interpretado como a b c.html
.
Eu criei minha própria versão do Encodeuricomponent, porque a solução publicada tem um problema, se houve um A + presente na string, que deve ser codificado, ela será convertida em um espaço.
Então aqui está minha aula:
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 };
}
}
}
Eu criei outra implementação documentada em, http://blog.sangupta.com/2010/05/encodeuricomponent-and.html. A implementação também pode lidar com o Unicode Bytes.
Este é um exemplo direto da solução de 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();
}
}
Resultado:
https://www.website.com/document/Tom%20%26%20Jerry%20Manuscript.pdf
Ele também responde a pergunta pendurada nos comentários de Loren Shqipognja sobre como passar uma variável de string para encodeURIComponent()
. O método scriptEngine.eval()
retorna um Object
, para que possa ser convertido em string via String.valueOf()
entre outros métodos.
É isso que estou usando:
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();
}
Vai além de JavaScript, codificando porcentagem de todos os personagens que não são um personagem não reservado de acordo com RFC 3986.
Esta é a conversão oposta:
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();
}
Encontrei a classe percentSrescaper da biblioteca Google-Http-Java-Client, que pode ser usada para implementar o Encodeuricomponent com bastante facilidade.
Percentescaper do google-http-java-client javadoc Home do Google-Http-Java-Client
Eu usei com sucesso a classe java.net.uri como assim:
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;
}
Para mim, isso funcionou:
import org.apache.http.client.utils.URIBuilder;
String encodedString = new URIBuilder()
.setParameter("i", stringToEncode)
.build()
.getRawQuery() // output: i=encodedString
.substring(2);
ou com um uribuilder diferente
import javax.ws.rs.core.UriBuilder;
String encodedString = UriBuilder.fromPath("")
.queryParam("i", stringToEncode)
.toString() // output: ?i=encodedString
.substring(3);
Na minha opinião, usar uma biblioteca padrão é uma idéia melhor, em vez de pós -processamento manualmente. Além disso, a resposta @chris parecia boa, mas não funciona para os URLs, como "http: // a+b c.html "
A biblioteca de goiaba tem centrescaper:
Escaper percentEscaper = new PercentEscaper("-_.*", false);
"-_.*" São personagens seguros
false diz centrescaper para escapar do espaço com '%20', não '+'