JAX-RS资源方法签名

Question

我正在使用Jersey 2.19来实现REST API。

我想知道如何从Jersey用户指南或其他规范中找出我应该如何知道我的JAX-RS资源的签名。

例如，为处理POST请求的资源，我使用发现的示例尝试了以下不同的签名。

public Response myResource()
public Response myResource(String param)

两者都是有效的，因为它们可以编译并运行，并且该方法在正确的条件下被调用。

谁能告诉我签名应该在什么地方以及参数的含义？ 这似乎是一个简单的问题，但我找不到答案。

Answer 1

正如您所说的POST请求一样，它应该从Request中接收一些数据。 因此，您应该期望Parameter中有一些东西。 public Response myResource(String param)但是参数的type实际上应该取决于@Consumes注释，例如：

@Consumes(MediaType.APPLICATION_JSON) ：这需要JSON输入，或者@Consumes(MediaType.APPLICATION_XML) ：这需要XML输入；或者@Consumes(MediaType.TEXT_PLAIN) ：这需要String纯文本输入

Answer 2

您可以按照官方文档中的说明对方法进行注释。 另外，不要忘了用@Path注释服务类。

@Path("MyService")
public class MyService
{
    @GET
    @Produces(MediaType.APPLICATION_JSON)
    @Path("/User")
    public List<User> getUser()
    {
        //Return all users
    }

    //Inserts new User in JSON Format
    @Get
    @Path("/User/UserId/{userid}")
    public User getUserById(@PathParam("userid") String userid)
    {
        //Find User with ID in Database and return it
    }

    @POST
    @Consumes(MediaType.APPLICATION_JSON)
    public User getUserById(User user)
    {
        //add user to your Database or something
    }
}

如果现在要以json格式获取所有用户，则必须调用： http://ip-address/MyService/user

Answer 3

您的问题有确切答案，但会束缚您的腰部。 因为如果Jersey的文档过于模糊，那么它们的方向就截然相反：由某人用抽象代数炫耀其博士学位的作品所组成。

一切的答案都在JAX-RS规范中，Jersey是其实现 。 您可以在此处将其下载为PDF （在您注销灵魂之后）

对于如何选择其中一种方法而不是另一种方法的具体答案，对于我来说太详细了，无法在此处粘贴，但在“ 3.7.2请求匹配 ”部分中

我什至不会尝试粘贴用于设置与请求匹配的潜在方法列表的数学规则，然后从中进行选择。 没有机会用SO可读地格式化它们。

对于您的更一般性问题，“ 3.3资源方法 ”部分将更易于访问。 以下是一些选择摘录：

3.3资源方法

... JAX-RS为常见的HTTP方法定义了一组请求方法标识符：@ GET，@ POST，@ PUT，@ DELETE，@ HEAD和@OPTIONS。 ...

3.3.1可见性：只有公共方法才可以公开为资源方法。 ...

3.3.2参数：资源方法必须最多具有一个实体参数...

3.3.3返回类型：资源方法可以返回void，Response，GenericEntity或其他Java类型...

等等等