gpt4 book ai didi

java - 使用 JAX-RS 将两个查询参数合并到一个对象中

转载 作者:搜寻专家 更新时间:2023-10-31 20:01:04 37 4
gpt4 key购买 nike

我有一些资源处理方法,其中包含许多带有 @Default@QueryParam 参数,按大致主题(分页/排序、过滤、身份验证)分组。这真的很麻烦,我想简化一下。好处是这些参数按主题(分页、排序、过滤等)分组,因此我可以将整个参数集减少到 4 个方法。

我怎样才能做到这一点?

通常,我想来自于:

@GET
public Response findAll(
@QueryParam("sort") @DefaultValue("name") List<String> sort,
@QueryParam("from") UUID fromId
) {
// Validate sort
// Validate fromId
}

对此:

@GET
public Response findAll(@Context Pagination pagination) { // Inject pagination
// Yeah, small code! Yeah, modularity!
}

// Create the pagination somewhere else.

public Pagination createPagination(@Context UriInfo uriInfo) {
Optional<UUID> fromId = extractFromId(uriInfo); // retrieve "from" from uriInfo
List<String> sort = extractSort(uriInfo); // retrieve "sort" from uriInfo
Pagination pagination = new Pagination();
pagination.setFromId(fromId);
pagination.setSort(sort);
// Validate pagination
return pagination;
}

注意:正如我在示例中所展示的,我不介意自己编写更多代码,但我就是无法忍受在我的方法中使用太多参数并阅读那堵@QueryParam + @DefaultValue

最佳答案

如果您使用的是 JAX-RS 2.0,则可以使用 @BeanParam ,它允许您将任意 @XxxParam 注释属性和 @Context 对象注入(inject)任意 bean 类。例如

public class Bean {
@QueryParam("blah")
String blah;
}

@GET
public Response get(@BeanParam Bean bean) {}

如果你想要不变性,你甚至可以注入(inject)到构造函数中。例如

public static class Pagination {

private final List<String> sort;
private final Optional<String> from;

public Pagination(@QueryParam("sort") List<String> sort,
@QueryParam("from") Optional<String> from) {
this.sort = sort;
this.from = from;
}

public List<String> getSort() { return sort; }
public Optional<String> getFrom() { return from; }
}

如果您注意到正在注入(inject) Optional。通常这是不可能的,但我为它创建了一个 ParamConverter。您可以在 this answer 中阅读更多相关信息.它基本上允许我们注入(inject)任意对象,从参数的字符串值创建。

@Provider
public static class OptionalParamProvider implements ParamConverterProvider {

@Override
public <T> ParamConverter<T> getConverter(Class<T> rawType,
Type genericType,
Annotation[] annotations) {
if (Optional.class != rawType) {
return null;
}

return (ParamConverter<T>)new ParamConverter<Optional>() {

@Override
public Optional fromString(String value) {
return Optional.ofNullable(value);
}

@Override
public String toString(Optional value) {
return value.toString();
}
};
}
}

OptionalParamProvider 的好处是,它允许您在需要注入(inject) @FormParam 的任何地方使用 Optional@ QueryParam@PathParm 和所有其他 @XxxParam(multitpart 除外)。

我不知道您使用的是什么 JAX-RS 实现,但以上内容应该适用于所有实现。下面是 Jersey 测试用例,使用 Jersey Test Framework .您可以像运行任何其他 JUnit 测试一样运行该类。

import java.lang.annotation.Annotation;
import java.lang.reflect.Type;
import java.util.List;
import java.util.Optional;
import javax.ws.rs.BeanParam;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.Response;
import javax.ws.rs.ext.ParamConverter;
import javax.ws.rs.ext.ParamConverterProvider;
import javax.ws.rs.ext.Provider;
import org.glassfish.jersey.server.ResourceConfig;
import org.glassfish.jersey.test.JerseyTest;
import static org.hamcrest.CoreMatchers.containsString;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertThat;
import org.junit.Test;

public class BeanParamTest extends JerseyTest {

@Provider
public static class OptionalParamProvider implements ParamConverterProvider {

@Override
public <T> ParamConverter<T> getConverter(Class<T> rawType,
Type genericType,
Annotation[] annotations) {
if (Optional.class != rawType) {
return null;
}

return (ParamConverter<T>)new ParamConverter<Optional>() {

@Override
public Optional fromString(String value) {
return Optional.ofNullable(value);
}

@Override
public String toString(Optional value) {
return value.toString();
}
};
}
}

public static class Pagination {

private final List<String> sort;
private final Optional<String> from;

public Pagination(@QueryParam("sort") List<String> sort,
@QueryParam("from") Optional<String> from) {
this.sort = sort;
this.from = from;
}

public List<String> getSort() { return sort; }
public Optional<String> getFrom() { return from; }
}

@Path("bean")
public static class PaginationResource {

@GET
public String get(@BeanParam Pagination pagination) {
StringBuilder sb = new StringBuilder();
sb.append(pagination.getSort().toString());
if (pagination.getFrom().isPresent()) {
sb.append(pagination.getFrom().get());
}
return sb.toString();
}
}

@Override
public ResourceConfig configure() {
return new ResourceConfig(PaginationResource.class)
.register(OptionalParamProvider.class);
}

@Test
public void should_return_all_sort_and_from() {
Response response = target("bean")
.queryParam("sort", "foo")
.queryParam("sort", "bar")
.queryParam("from", "baz")
.request().get();
assertEquals(200, response.getStatus());
String message = response.readEntity(String.class);
assertThat(message, containsString("foo"));
assertThat(message, containsString("bar"));
assertThat(message, containsString("baz"));
System.out.println(message);
response.close();
}
}

这是运行测试所需的唯一 Maven 依赖项

<dependency>
<groupId>org.glassfish.jersey.test-framework.providers</groupId>
<artifactId>jersey-test-framework-provider-grizzly2</artifactId>
<version>2.19</version>
<scope>test</scope>
</dependency>

关于java - 使用 JAX-RS 将两个查询参数合并到一个对象中,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/33503374/

37 4 0
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com