java - JaxRs 客户端不执行 MessageBodyReader

问题描述

我在设置MessageBodyReader时遇到问题- 我尝试根据许多教程设置它，但是它的函数从未被调用。我正在使用泽西 2.27

这是我的 MessageBodyReader 实现：

@Provider
public class MyMsgBodyReader implements MessageBodyReader<Object> {

    @Override
    public boolean isReadable(Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType) {
        return true;
    }

    @Override
    public Object readFrom(Class<Object> type, Type genericType, Annotation[] annotations, MediaType mediaType, MultivaluedMap<String, String> httpHeaders, InputStream entityStream) throws IOException, WebApplicationException {
        HashMap<String, String> hash = new HashMap<>();
        hash.put("replaced", "true");
        return hash;
    }

}

我试着这样称呼它：

@Path("api")
@ApplicationScoped
public class TestClazz {

    @GET
    @Path("test")
    public Response test() {
        Client client = ClientBuilder.newBuilder().register(MyMsgBodyReader.class).build();
        WebTarget target = client.target("http://localhost:3000").path("/api/test");
        Response resp = target.request().get();
        Object receivedEntity = resp.getEntity();
        return Response.ok(receivedEntity).build();
    }
}

虽然 receivedEntity 应该是带有一个条目的哈希图，但它仍然是我从测试 api 收到的原始实体。我什至尝试在 MyMsgBodyReader 方法中设置断点，并确认它们甚至没有被调用一次。

我还尝试以多种方式扫描它：

@ApplicationPath("v1")
public class App extends Application {

    @Override
    public Set<Class<?>> getClasses() {
        Set<Class<?>> classes = new HashSet<>();
        classes.add(MyMsgBodyReader.class);
        classes.add(
        return classes;
    }

    @Override
    public Set<Object> getSingletons() {
        Set<Object> singletons = new HashSet<>();
        singletons.add(new MsgBodiReader());
        return singletons;
    }
}

我不知道还能尝试什么。

标签： javajakarta-eejerseyjersey-2.0java-ee-7

解决方案

您需要决定的第一件事是阅读器将处理哪种类型的数据。您可以使用@Consumes注释来执行此操作。你把它放在阅读器类的顶部。根据Content-Type响应，Jersey 将选择与@Consumes. 如果有多个匹配的阅读器，那么下一步就是测试该isReadable()方法。如果不止一个通过此检查，则 Jersey 将检查优先级。您可以@Priority(int)在阅读器上添加注释。或者您可以将优先级作为第二个参数传递给该register()方法。较高的优先级将具有最高的优先级。如果您正在使用@Consumes已经有标准阅读器的媒体类型，那么您可能会想要使用您的媒体类型@Priority。

如果仍然没有调用 reader，您应该检查Content-Type响应并确保它是您所期望的。您还可以设置Accept标头（可以通过将媒体类型传递给request()方法来隐式设置。

这是您的读者将被调用的示例。

@Provider
@Conumes("application/custom")
public class MyReader implements MessageBodyReader<String> {
}

Response res = client.target("test")
        .register(MyReader.class)
        .request("application/custom")
        .get();

假设服务器确实返回了 type 的数据，application/custom应该调用这个 reader。如果服务器无法返回数据格式，并且您请求该类型，那么您应该收到406 Not Acceptable错误。

此外，您不应该使用Response#getEntity(). 您应该使用readEntity(Class)，传入您希望将数据转换为的 Java 类型（MessageBodyReader在后台使用）。对于泛型，您应该使用GenericType

Map<String, String> data = res.readEntity(new GenericType<Map<String, String>>(){});

这是使用Jersey Test Framework进行的完整测试。

import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.lang.annotation.Annotation;
import java.lang.reflect.Type;
import java.nio.charset.StandardCharsets;

import javax.ws.rs.Consumes;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.WebApplicationException;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.MultivaluedMap;
import javax.ws.rs.core.Response;
import javax.ws.rs.ext.MessageBodyReader;

import org.glassfish.jersey.server.ResourceConfig;
import org.glassfish.jersey.test.JerseyTest;
import org.junit.Test;

import static org.assertj.core.api.Assertions.assertThat;

public class CustomReaderTest extends JerseyTest {

    private static final String DATA = "UselessStaticData";
    private static final String CUSTOM_MEDIA_TYPE = "application/useless";

    @Consumes(CUSTOM_MEDIA_TYPE)
    public static class UselessReader implements MessageBodyReader<String> {

        @Override
        public boolean isReadable(Class<?> aClass, Type type,
                                  Annotation[] annotations, MediaType mediaType) {
            return true;
        }

        @Override
        public String readFrom(Class<String> aClass, Type type, Annotation[] annotations,
                               MediaType mediaType, MultivaluedMap<String,String> multivaluedMap,
                               InputStream inputStream) throws IOException, WebApplicationException {
            return DATA;
        }
    }


    @Path("test")
    public static class TestResource {

        @GET
        @Produces(CUSTOM_MEDIA_TYPE)
        public InputStream post(String data) {
            return new ByteArrayInputStream("Test".getBytes(StandardCharsets.UTF_8));
        }
    }

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

    @Test
    public void testIt() {
        Response res = target("test")
                .register(UselessReader.class)
                .request(CUSTOM_MEDIA_TYPE)
                .get();

        assertThat(res.readEntity(String.class)).isEqualTo(DATA);
    }
}

java - JaxRs 客户端不执行 MessageBodyReader

问题描述

解决方案

推荐阅读