Прочитать другой параметр в ParamConverter Джерси
Я сделал ParamConverter который обеспечивает Instant (Дата), когда задана строка, отформатированная как собственный ISO-8601 Instant или целое число миллисекунд с начала эпохи. Это работает нормально, но я также должен иметь возможность поддерживать другие форматы даты (клиенты суетливы).
Чтобы избежать классики dd/mm/yyyy против mm/dd/yyyy двусмысленность, я хотел бы, чтобы клиент указал свой предпочтительный формат как часть запроса *. например:
GET http://api.example.com/filter?since=01/02/2000&dateformat=dd/mm/yyyy
передается метод, который выглядит следующим образом:
@GET
String getFilteredList( final @QueryParam( "since" ) Instant since ) {
...
}
(части времени и часового пояса опущены для ясности)
Так что я хотел бы мой ParamConverter<Instant> чтобы иметь возможность читать dateformat параметр.
Я был в состоянии использовать комбинацию фильтра, который устанавливает ContainerRequestContext собственность и AbstractValueFactoryProvider чтобы сделать что-то подобное, но для этого параметра необходимо применить пользовательскую аннотацию и не позволить ему работать с QueryParam/FormParam/ и т. д., что делает его гораздо менее полезным.
Есть ли способ получить другие параметры или сам объект запроса из ParamConverter?
[*] В реальном мире это было бы из набора предварительно утвержденных форматов, но сейчас просто предположим, что они предоставляют информацию дляDateTimeFormatter
Для ясности вот код, который у меня есть:
public class InstantParameterProvider implements ParamConverterProvider {
private static final ParamConverter<Instant> INSTANT_CONVERTER =
new ParamConverter<Instant>( ) {
@Override public final T fromString( final String value ) {
// This is where I would like to get the other parameter's value
// Is it possible?
}
@Override public final String toString( final T value ) {
return value.toString( );
}
};
@SuppressWarnings( "unchecked" )
@Override public <T> ParamConverter<T> getConverter(
final Class<T> rawType,
final Type genericType,
final Annotation[] annotations
) {
if( rawType == Instant.class ) {
return (ParamConverter<T>) INSTANT_CONVERTER;
}
return null;
}
}
1 ответ
Как уже упоминалось, ключом к этому является добавление некоторого объекта контекста javax.inject.Provider, что позволяет нам лениво извлекать объект. Так как ParamConverterProvider это компонент, управляемый Джерси, мы должны иметь возможность внедрять другие компоненты.
Проблема в том, что необходимый нам компонент будет находиться в области запроса. Чтобы обойти это, мы вводим javax.inject.Provider<UriInfo> в провайдера. Когда мы на самом деле звоним get() в Provider чтобы получить фактический экземпляр UriInfo, это будет в запросе. То же самое касается любого другого компонента, который требует области запроса.
Например
public class InstantParamProvider implements ParamConverterProvider {
@Inject
private javax.inject.Provider<UriInfo> uriInfoProvider;
@Override
public <T> ParamConverter<T> getConverter(Class<T> rawType,
Type genericType,
Annotation[] annotations) {
if (rawType != Instant.class) return null;
return new ParamConverter<T>() {
@Override
public T fromString(String value) {
UriInfo uriInfo = uriInfoProvider.get();
String format = uriInfo.getQueryParameters().getFirst("date-format");
if (format == null) {
throw new WebApplicationException(Response.status(400)
.entity("data-format query parameter required").build());
} else {
try {
// parse and return here
} catch (Exception ex) {
throw new WebApplicationException(
Response.status(400).entity("Bad format " + format).build());
}
}
}
@Override
public String toString(T value) {
return value.toString();
}
};
}
}
ОБНОВИТЬ
Вот полный пример использования Тестовой платформы Джерси
import java.lang.annotation.Annotation;
import java.lang.reflect.Type;
import java.time.LocalDate;
import java.time.format.DateTimeFormatter;
import java.util.logging.Logger;
import javax.inject.Inject;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.QueryParam;
import javax.ws.rs.WebApplicationException;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.UriInfo;
import javax.ws.rs.ext.ParamConverter;
import javax.ws.rs.ext.ParamConverterProvider;
import org.glassfish.jersey.filter.LoggingFilter;
import org.glassfish.jersey.server.ResourceConfig;
import org.glassfish.jersey.test.JerseyTest;
import org.junit.Test;
import static org.junit.Assert.*;
import static org.junit.matchers.JUnitMatchers.*;
public class LocalDateTest extends JerseyTest {
public static class LocalDateParamProvider implements ParamConverterProvider {
@Inject
private javax.inject.Provider<UriInfo> uriInfoProvider;
@Override
public <T> ParamConverter<T> getConverter(Class<T> rawType,
Type genericType,
Annotation[] annotations) {
if (rawType != LocalDate.class) {
return null;
}
return new ParamConverter<T>() {
@Override
public T fromString(String value) {
UriInfo uriInfo = uriInfoProvider.get();
String format = uriInfo.getQueryParameters().getFirst("date-format");
if (format == null) {
throw new WebApplicationException(Response.status(400)
.entity("date-format query parameter required").build());
} else {
try {
return (T) LocalDate.parse(value, DateTimeFormatter.ofPattern(format));
// parse and return here
} catch (Exception ex) {
throw new WebApplicationException(
Response.status(400).entity("Bad format " + format).build());
}
}
}
@Override
public String toString(T value) {
return value.toString();
}
};
}
}
@Path("localdate")
public static class LocalDateResource {
@GET
public String get(@QueryParam("since") LocalDate since) {
return since.format(DateTimeFormatter.ofPattern("MM/dd/yyyy"));
}
}
@Override
public ResourceConfig configure() {
return new ResourceConfig(LocalDateResource.class)
.register(LocalDateParamProvider.class)
.register(new LoggingFilter(Logger.getAnonymousLogger(), true));
}
@Test
public void should_return_bad_request_with_bad_format() {
Response response = target("localdate")
.queryParam("since", "09/20/2015")
.queryParam("date-format", "yyyy/MM/dd")
.request().get();
assertEquals(400, response.getStatus());
assertThat(response.readEntity(String.class), containsString("format yyyy/MM/dd"));
response.close();
}
@Test
public void should_return_bad_request_with_no_date_format() {
Response response = target("localdate")
.queryParam("since", "09/20/2015")
.request().get();
assertEquals(400, response.getStatus());
assertThat(response.readEntity(String.class), containsString("query parameter required"));
response.close();
}
@Test
public void should_succeed_with_correct_format() {
Response response = target("localdate")
.queryParam("since", "09/20/2015")
.queryParam("date-format", "MM/dd/yyyy")
.request().get();
assertEquals(200, response.getStatus());
assertThat(response.readEntity(String.class), containsString("09/20/2015"));
response.close();
}
}
Вот тестовая зависимость
<dependency>
<groupId>org.glassfish.jersey.test-framework.providers</groupId>
<artifactId>jersey-test-framework-provider-grizzly2</artifactId>
<version>${jersey2.version}</version>
<scope>test</scope>
</dependency>