Jax-RS API POST和GET方法（RESTful服务）

Question

我有一个关于JAX-RS的项目（作业）。我正在使用NetBeans，Jersey和Tomcat。在post方法中例如： '{"user":{"username":"accavdar", "gender":"M", "birthDate":"06.11.1982"}}' 当这样的请求到来时，我必须解析此输入并将新用户添加到我的系统。样本回复必须是：

{
    "meta": {
        "code": 200
    },
    "data": {
        "message": "You successfully created a user."
    }
}

可预见的错误可能是这样的：

{
    "meta": {
        "code": 101,
        "type": "FieldError",
        "errors": [
            {
                "fieldName": "fullname",
                "rejectedValue": null
            }
        ]
    }
}

另一个问题是：使用Get方法，develepor可能希望列出系统中的所有用户。答案必须是这样的：

{
  "meta": {
    "code": 200
  },
  "data": [
    {
      "id": 1,
      "username": "sample",
      "fullname": "sample",
      "gender": "M",
      "birthDate": "12.02.1990"
    },
    {
      "id": 2,
      "username": "sample",
      "fullname": "sample",
      "gender": "M",
      "birthDate": "21.09.1940"
    }
  ]
}

我想让用户保留在一个文本文件中，对于保留用户的方式没有限制。（你可以保留在数据库或内存中）但我不知道如何处理请求输入并生成响应之类的那。我不想让你做我的作业，但是有人可以给我一些关于我的问题的提示吗？

注意：我们只能使用JSON "Content-Type: application/json" "Accept: application/json"

EDİT：#Bogdan，非常感谢您的回答。我搜索了你给的网站。我想知道输出是如何产生的？：

{
    "meta": {
        "code": 200
    },
    "data": {
        "message": "You successfully created a user."
    }
}

或

{
  "meta": {
    "code": 200
  },
  "data": {
    "id": 1,
    "username": "jack",
    "fullname": "jack",
    "gender": "M",
    "birthDate": "12.12.2012"
  }
}

我有“meta”和“user”类。

@XmlRootElement(name="data")
public class User {

    @XmlElement
    public int id ;
    @XmlElement
    public String username;
    @XmlElement
    public String fullname;
    @XmlElement
    public String gender;
    @XmlElement
    public String birthDate;

    public User(){

    }

@XmlRootElement(name="meta")
public class Meta {

    @XmlElement
    int code=200;

    public Meta(){

    }

我也有这个jaxbcontextresolver类

@Provider
public class JAXBContextResolver implements ContextResolver<JAXBContext>{

    private JAXBContext context;
    private Class[] types = {User.class, Meta.class};


    public JAXBContextResolver() throws Exception {

        this.context = 
        new JSONJAXBContext(  JSONConfiguration.mapped().nonStrings("id").nonStrings("code").build(), types); 
    }

    @Override
    public JAXBContext getContext(Class<?> objectType) {
         for (Class type : types) {
             if (type == objectType) {
                 return context;
             }
         }

        return null;

    }

}

但是如何创建这个响应结构，可以帮助我吗？

Answer 1

您的应用程序适用于用户。这是您的应用程序处理的资源，您的客户端与之交互以创建，更新，删除和获取（基本上CRUD）。

但是用户是一个抽象资源，因此您的服务器和客户端使用representations of this resource相互交互。表示可以是JSON格式（如您的示例中所示），XML等。您的客户端指定它想要的表示类型，服务器通过Content-Type指定它返回的表示类型。请求/响应的主体与内容类型匹配。

这是一个Java应用程序，因此在您的应用程序代码中，用户被表示为Java对象。您需要将请求/响应主体转换为具有getter和setter的对象。 You can use JAXB to do the XML transformation, and with a library like Jackson you can transform JSON。您可以手动执行此操作并将字符串解析为对象并从对象输出字符串，但这样会更有效。

客户端提交JSON，转换后您将拥有可以处理的Java对象。您可以将它们保存在应用程序范围映射内的内存中，或者将它们写入文件或数据库中，然后再次更改它们的表示形式。

您的应用程序会将URL绑定到将请求表示转换为对象的特定操作，对对象执行操作，然后将它们返回以再次转换为客户端期望的表示形式。

以上只是基本解释。如果您按照JAX-RS tutorials进行操作，可以回答所有问题（例如快速搜索返回REST with Java (JAX-RS) using Jersey - Tutorial或REST: CRUD with JAX-RS (Jersey)。我相信还有很多其他问题。你的问题太开放了，所以当你遇到路障时，只需深入挖掘并返回有关stackoverflow的具体问题。

编辑：似乎您正在努力解决这个问题，所以我会添加一项基本服务来帮助您入门，让我们说一下用户列表。

到目前为止，您没有提及您的服务类。这是重要的一点，如：

package com.test;

import java.util.ArrayList;
import java.util.List;

import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;

@Path("/api")
public class Test {

    @GET
    @Path("/users")
    @Produces({ MediaType.APPLICATION_JSON })
    public UsersResponseWrapper getUsers() {
        List<User> users = new ArrayList<User>();

        User u1 = new User();
        u1.setId(1);
        u1.setFullname("Joe Doe");
        u1.setGender("M");
        u1.setUsername("joe.doe");
        u1.setBirthDate("1919-12-12");

        User u2 = new User();
        u2.setId(1);
        u2.setFullname("John Smith");
        u2.setGender("M");
        u2.setUsername("john.smith");
        u2.setBirthDate("1990-01-01");

        users.add(u1);
        users.add(u2);

        UsersResponseWrapper resp = new UsersResponseWrapper();
        resp.setMeta(new Meta(200));
        resp.setData(users);

        return resp;
    }
}

然后是您的用户和元类：

package com.test;

public class Meta {
    private int code;

    public Meta(int code) {
        this.code = code;
    }

    public Meta() {
        this.code = 200;
    }

    public int getCode() {
        return code;
    }

    public void setCode(int code) {
        this.code = code;
    }
}

package com.test;

public class User {
    private int id;
    private String username;
    private String fullname;
    private String gender;
    private String birthDate;

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getFullname() {
        return fullname;
    }

    public void setFullname(String fullname) {
        this.fullname = fullname;
    }

    public String getGender() {
        return gender;
    }

    public void setGender(String gender) {
        this.gender = gender;
    }

    public String getBirthDate() {
        return birthDate;
    }

    public void setBirthDate(String birthDate) {
        this.birthDate = birthDate;
    }

}

JAXB提供商：

package com.test;

import java.util.ArrayList;

import javax.ws.rs.ext.ContextResolver;
import javax.ws.rs.ext.Provider;
import javax.xml.bind.JAXBContext;

@Provider
public class JAXBContextResolver implements ContextResolver<JAXBContext> {
    private JAXBContext context;
    private static Class<?>[] types = {UsersResponseWrapper.class, User.class, Meta.class, ArrayList.class};

    public JAXBContextResolver() throws Exception {
        this.context = JAXBContext.newInstance(types);
    }

    @Override
    public JAXBContext getContext(Class<?> objectType) {
         for (Class<?> type : types) {
             if (type == objectType) {
                 return context;
             }
         }
        return null;
    }
}

来自web.xml的东西：

<web-app xmlns="http://java.sun.com/xml/ns/javaee"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
      version="3.0">
 <servlet>
    <servlet-name>RestService</servlet-name>
    <servlet-class>com.sun.jersey.spi.container.servlet.ServletContainer</servlet-class>
    <init-param>
      <param-name>com.sun.jersey.config.property.packages</param-name>
      <param-value>com.test</param-value>
    </init-param>
  </servlet>
  <servlet-mapping>
    <servlet-name>RestService</servlet-name>
    <url-pattern>/*</url-pattern>
  </servlet-mapping>
</web-app>

结果的包装：

package com.test;

import java.util.List;

import javax.xml.bind.annotation.XmlRootElement;

@XmlRootElement
public class UsersResponseWrapper {
    private Meta meta;
    private List<User> data;

    public Meta getMeta() {
        return meta;
    }

    public void setMeta(Meta meta) {
        this.meta = meta;
    }

    public List<User> getData() {
        return data;
    }

    public void setData(List<User> data) {
        this.data = data;
    }
}

我认为最后一堂课让你陷入困境，因为你的结果是由元内容和数据内容组成的。请记住，您需要返回对象（Jersey distribution中的默认Jackson映射器将会处理它），并且您遇到了复杂的映射器。上面应该返回（不包括格式）：

{
    "data": [
        {
            "birthDate": "1919-12-12",
            "fullname": "Joe Doe",
            "gender": "M",
            "id": "1",
            "username": "joe.doe"
        },
        {
            "birthDate": "1990-01-01",
            "fullname": "John Smith",
            "gender": "M",
            "id": "1",
            "username": "john.smith"
        }
    ],
    "meta": {
        "code": "200"
    }
}

这就像我可以添加到细节一样多。 毕竟这是你的功课：）。你做得很好，继续前进。