Как заставить URIBuilder.path() кодировать такие параметры, как %AD? Этот метод не всегда корректно кодирует параметры в процентах

Урибилдер

Это возможно с помощью UriComponent из Джерси или URLEncoder непосредственно из Java:

UriBuilder.fromUri("https://dummy.com")
        .queryParam("param",
                UriComponent.encode("%AD",
                    UriComponent.Type.QUERY_PARAM_SPACE_ENCODED))
        .build();

Что приводит к:

https://dummy.com/?param=%25AD

Or:

UriBuilder.fromUri("https://dummy.com")
        .queryParam("param", URLEncoder.encode("%AD", "UTF-8"))
        .build()

Приведет к:

https://dummy.com/?param=%25AD

Для более сложных примеров (например, кодирование JSON в параметре запроса) этот подход также возможен. Предположим, у вас есть JSON, например {"Entity":{"foo":"foo","bar":"bar"}}. При кодировании с использованием UriComponent результат для параметра запроса будет выглядеть так:

https://dummy.com/?param=%7B%22Entity%22:%7B%22foo%22:%22foo%22,%22bar%22:%22bar%22%7D%7D

Подобный JSON можно даже внедрить через @QueryParam в поле ресурса/параметр метода (см. rs-parameter-annotations/">JSON в параметрах запроса или как внедрять пользовательские типы Java с помощью аннотаций параметров JAX-RS).

Какую версию джерси вы используете? В тегах вы упоминаете Джерси 2, но в разделе RuntimeDelegate вы используете материалы из Джерси 1.

Посмотрите, помогут ли следующие примеры. В приведенной ниже ветке подробно обсуждаются доступные функции и их различные результаты.

Следующее:

1. UriBuilder.fromUri("http://localhost:8080").queryParam("name", "{value}").build("%20");
2. UriBuilder.fromUri("http://localhost:8080").queryParam("name", "{value}").buildFromEncoded("%20");
3. UriBuilder.fromUri("http://localhost:8080").replaceQuery("name={value}).build("%20");
4. UriBuilder.fromUri("http://localhost:8080").replaceQuery("name={value}).buildFromEncoded("%20");

Выведет:

1. http://localhost:8080?name=%2520
2. http://localhost:8080?name=%20
3. http://localhost:8080?name=%2520
4. http://localhost:8080?name=%20

через http://comments.gmane.org/gmane.comp.java.jsr311.user/71

Кроме того, на основе документации Class UriBuilder, в следующем примере показано, как получить то, что вам нужно.

Шаблоны URI разрешены в большинстве компонентов URI, но их значение ограничено конкретным компонентом. Например.

UriBuilder.fromPath("{arg1}").build("foo#bar");

приведет к кодированию '#' таким образом, что результирующий URI будет "foo%23bar". Чтобы создать URI "foo#bar", используйте

UriBuilder.fromPath("{arg1}").fragment("{arg2}").build("foo", "bar")

вместо. Имена и разделители шаблонов URI никогда не кодируются, но их значения кодируются при построении URI. Регулярные выражения параметров шаблона игнорируются при построении URI, т. е. проверка не выполняется.

Можно перезаписать поведение по умолчанию в майке вручную при запуске, например. со статическим помощником, который вызывает RuntimeDelegate.setInstance(yourRuntimeDelegateImpl).

Итак, если вы хотите иметь UriBuilder, который кодирует проценты, даже если они выглядят так, как будто они являются частью уже закодированной последовательности, это будет выглядеть так:

[...]
import javax.ws.rs.core.UriBuilder;
import javax.ws.rs.ext.RuntimeDelegate;

import com.sun.jersey.api.uri.UriBuilderImpl;
import com.sun.ws.rs.ext.RuntimeDelegateImpl;
// or for jersey2:
// import org.glassfish.jersey.uri.internal.JerseyUriBuilder;
// import org.glassfish.jersey.internal.RuntimeDelegateImpl;

public class SomeBaseClass {

    [...]

    // this is the lengthier custom implementation of UriBuilder
    // replace this with your own according to your needs
    public static class AlwaysPercentEncodingUriBuilder extends UriBuilderImpl {

        @Override
        public UriBuilder queryParam(String name, Object... values) {
            Object[] encValues = new Object[values.length];
            for (int i=0; i<values.length; i++) {
                String value = values[i].toString(); // TODO: better null check here, like in base class
                encValues[i] = percentEncode(value);
            }
            return super.queryParam(name, encValues);
        }

        private String percentEncode(String value) {
            StringBuilder sb = null;
            for (int i=0;  i < value.length(); i++) {
                char c = value.charAt(i);
                // if this condition is is true, the base class will not encode the percent
                if (c == '%' 
                    && i + 2 < value.length()
                    && isHexCharacter(value.charAt(i + 1)) 
                    && isHexCharacter(value.charAt(i + 2))) {
                    if (sb == null) {
                        sb = new StringBuilder(value.substring(0, i));
                    }
                    sb.append("%25");
                } else {
                    if (sb != null) sb.append(c);
                }
            }
            return (sb != null) ? sb.toString() : value;
        }

        // in jersey2 one can call public UriComponent.isHexCharacter
        // but in jersey1 we need to provide this on our own
        private static boolean isHexCharacter(char c) {
            return ('0' <= c && c <= '9')
                || ('A' <=c && c <= 'F')
                || ('a' <=c && c <= 'f');
        }
    }

    // here starts the code to hook up the implementation
    public static class AlwaysPercentEncodingRuntimeDelegateImpl extends RuntimeDelegateImpl {
        @Override
        public UriBuilder createUriBuilder() {
            return new AlwaysPercentEncodingUriBuilder();
        }
    }

    static {
        RuntimeDelegate myDelegate = new AlwaysPercentEncodingRuntimeDelegateImpl();
        RuntimeDelegate.setInstance(myDelegate);
    }

}

Предостережение: Конечно, таким образом это не очень настраивается, и если вы сделаете это в каком-то коде библиотеки, который может быть повторно использован другими, это может вызвать некоторое раздражение.

Например, у меня была та же проблема, что и у OP, при написании остаточного клиента в плагине Confluence, и вместо этого я получил решение «ручное кодирование каждого параметра», поскольку плагины загружаются через OSGi и, таким образом, просто не могут коснуться RuntimeDelegateImpl (вместо этого получая java.lang.ClassNotFoundException: com.sun.ws.rs.ext.RuntimeDelegateImpl во время выполнения).

(И просто для справки, в jersey2 это выглядит очень похоже, особенно код для перехвата пользовательского RuntimeDelegateImpl такой же.)