使用PATCH和Jersey Client API进行单元测试

时间:2015-04-07 18:55:52

标签: java rest jax-rs jersey-2.0 http-patch

我正在使用Jersey开发REST API实现。对于PATCH(部分更新),我已经实现了自己的PATCH自定义实现,因为Jersey不支持它。

现在我想弄清楚如何围绕该实现编写功能测试。我正在为其他方法(PUTPOSTGETDELETE)使用泽西测试框架,该方法在该框架中具有该支持。

有没有办法在我可以扩展泽西测试框架实现来编写PATCH的功能测试? 如果没有,是否有任何其他测试框架可用于测试我的泽西PATCH实施?

如果有人可以提供任何示例,那就太棒了。

4 个答案:

答案 0 :(得分:4)

通过HTTP PATCH发送JAX RS Client API,无需任何额外配置:

 client.target("$baseUrl$restUsersUrl/$userId")
                .request("application/json")
                .build("PATCH", Entity.entity(json2Update, MediaType.APPLICATION_JSON))
                .invoke()

答案 1 :(得分:3)

假设您的实现包含这样的自定义注释

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import javax.ws.rs.HttpMethod;

@HttpMethod("PATCH")
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface PATCH {}

尝试使用Client

执行此类操作
 String response = target.request().method("PATCH", Entity.text("Hello"), String.class);
默认情况下不支持

,并且会出现例如

的异常
java.net.ProtocolException: Invalid HTTP method: PATCH

直接使用Client API不是问题,而是使用较低级别的Java API。似乎是一些安全限制。

使用Client API,我们可以通过设置属性

来覆盖它

JerseyTest中,配置Client的一种方法是覆盖configureClient,并使用ClientConfig设置属性。您可以轻松地在Client本身设置属性,但保持JerseyTest框架的精神(我们不需要明确访问Client,下面的示例只会覆盖方法

public class PatchTest extends JerseyTest {

    @Path("patch")
    public static class PatchResource {
        @PATCH
        @Produces(MediaType.TEXT_PLAIN)
        public String getPatch(String request) {
            return "Patched " + request;
        }
    }

    @Override
    protected void configureClient(final ClientConfig config) {
        config.property(HttpUrlConnectorProvider.SET_METHOD_WORKAROUND, true);
    }

    @Override
    public Application configure() {
        return new ResourceConfig(PatchResource.class);
    }

    @Test
    public void doPatchTest() {
        WebTarget target = target("patch");
        String response = target.request().method("PATCH", Entity.text("Hello"), String.class);
        Assert.assertEquals("Patched Hello", response);
        System.out.println(response);
    }
}

答案 2 :(得分:2)

JAX-RS 2.1现在提供了注释@PATCH。您可以在服务器端实现此HTTP方法,如:

@PATCH
public Response updateResource() { ... } 

至于客户端,您可以执行以下操作:

Response r = ClientBuilder.newClient()
    .target("http://localhost:8080/patch")
    .request()
    .build("PATCH", Entity.text("patch"))
    .property(HttpUrlConnectorProvider.SET_METHOD_WORKAROUND, true)
    .invoke();

使用SET_METHOD_WORKAROUND来避免协议异常,如@peeskillet所示:

java.net.ProtocolException: Invalid HTTP method: PATCH

答案 3 :(得分:-1)

使用简单的Strings对我有用。但是,当Patch方法不接受并返回简单的String时,有人知道该怎么做吗?请参阅下面的示例。 响应中的返回类型与传递的参数的类型不同。两者都不是简单的类型。 而不是200,我总是得到400和/或消息,它不能构造ObjectPatch实例。而且我了解到,因为它是仅包含apply方法的接口。但是无论如何,在运行时,它还是设法从它构造一个AttentionPatchResource对象。不幸的是,在使用JerseyTest框架时没有。

@PATCH
 @Path("/something")
 @Produces(MediaType.APPLICATION_JSON)
 @Consumes({ PatchMediaTypes.APPLICATION_MERGE_PATCH_JSON, PatchMediaTypes.APPLICATION_JSON_PATCH })
    public Response updateAttention( //
            @Parameter(schema = @Schema(implementation = AttentionPatchResource.class)) ObjectPatch patch) {

        Attention attention = attentionService.find();
        AttentionPatchResource patchResource = attentionAdapter.toPatchResource(attention);

        AttentionPatchResource patchedResource = patch.apply(patchResource);
        Attention patchedAttention = attentionAdapter.fromPatchResource(attention, patchedResource);

        AttentionResource resource = attentionAdapter.toResource(patchedAttention);

        return Response.status(Status.OK).entity(resource).build();
    }