Dropwizard和协议缓冲区示例

Question

请注意：虽然这个问题特别提到了Dropwizard，但我相信任何有泽西/JAX-RS经验的人都应该能够回答这个问题，因为我可以想象Dropwizard只是在幕后遵循泽西/JAX-RS约定。

我有一个Dropwizard服务，它用JSON编写，工作非常出色。

现在我想将其切换为读/写二进制数据（以最小化网络带宽）。我看到了Dropwizard Protobuf库，但我对在Dropwizard中实现二进制序列化有一些担忧。

首先，以下是我当前的（以JSON为中心的）代码中的重要内容：

// Groovy pseudo-code

// Domain entity/POJO
@JsonIgnoreProperties(ignoreUnknown = true)
@JsonInclude(JsonInclude.Include.NON_NULL)
class Fizz {
    @JsonProperty
    String name

    @JsonProperty
    boolean isBuzz    
}

// The Dropwizard app entry point
class FizzService extends Application<FizzConfiguration> {
    @Override
    void run(FizzConfiguration fizzCfg, Environment env) throws Exception {
        // ... lots of stuff

        env.jersey().register(new FizzService())
    }
}

// JAX-RS resource with a sample GET endpoint
@Path(value = "/fizz")
@Produces(MediaType.APPLICATION_JSON)
class FizzResource {
    @GET
    @Path("/{id}")
    Fizz getFizzById(@PathParam("id") int id) {
        // Look up a 'Fizz' in a DB and return it.
        lookupFizzinDB(id)
    }
}

如您所见，GET/fizzendpoint需要一个JSON请求实体，该实体包含一个类型为int的名为id的元素。它返回一个与提供的id匹配的响应实体。

我想通过Google协议缓冲区将其从JSON切换到二进制。

根据Dropwizard-Schembuf文档，这就像将其添加到我的FizzService#run（...）方法一样简单：

environment.jersey().register(new ProtocolBufferMessageBodyProvider())

问题是目前我的整个应用程序都连接到序列化/反序列化到/从JSON。我的Fizz类上的@JsonProperty注释对Dropwizard有意义。@Produces（MediaType.APPLICATION_JSON）在FizzResources上的注释也起着关键作用。我担心让我的Dropwizard应用程序读取/写入原型生成的二进制文件并不像文档中发布的1-line那么容易。

我没有嫁给这个库。如果有人有在Dropwizard应用程序中设置RESTendpoint以接受/接收原型生成的二进制文件的经验，我所关心的只是一个有效的解决方案。想法？

Answer 1

你说得对，这可不像一行那么简单。您需要让protobuf生成代码才能工作。查看协议缓冲区文档。首先需要有一个proto文件，用protobuf编译器编译，它会为您生成代码。生成的代码是用于构建域/模型对象的代码。Dropwizard的protobuf提供程序使用此编译代码。无论您是否使用Dropwizard提供程序，您仍然需要使用生成的代码。请参阅上述链接中的“如何开始”部分。

生成代码后，在资源方法中，生成的类/类型是您需要返回的，以便提供程序能够序列化它。您还需要在资源方法或资源类上有@products（“application/x-protobuf”）或@products（ProtocolBufferMediaType.application\u protobuf），以便Jersey知道如何找到媒体类型的提供程序。

您可以同时支持应用程序/json和应用程序/x-protobuf，因为您可以在生产的介质中使用多种介质类型。只需使用语法products（{….，…}） 。

但这还不是全部。由于您需要返回两种不同的类型，即JSON的简单POJO，或原型buf的生成类型，因此您需要检查资源方法中的标头

@Produces({"application/json", "application/x-protobuf"})
public Response getFoo(@Context HttpHeaders headers) {
    List<MediaType> accepts = headers.getAcceptableMediaTypes();
    if (accepts.contains(MediaType.APPLICATION_JSON_TYPE) {
        return Response.ok(new Foo());
    } else if (accepts.contains(ProtocolBufferMediaType.APPLICATION_PROTOBUF_TYPE) {
        return Reponse.ok(new ProtoBufFoo());
    } else {
        // default
        return Response.ok(new Foo());
    }
}

或者您可以有两种不同的方法，每种类型一种

@Produces("application/json")
public Response getFooJson() {
    return Response.ok(new Foo());
}

@Produces("application/x-protobuf")
public Response getFooProto() {
    return Response.ok(new ProtoBufFoo());
}

无论客户机作为其接受头发送什么，都是将要发送的类型。例如，接受：应用程序/json或接受：应用程序/x-protobuf

另请参见：

• 将Google proto缓冲区与Jersey/JAX-RS相结合