Rest API示例

Question

我有一个简单的REST服务器实现，用Java编写。每个API调用都以XML格式返回数据，如果我想要JSON格式，我该怎么办？我需要外部库吗？这是我的代码：

User.java:

package com.leo;

import java.io.Serializable;

import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;

@XmlRootElement(name = "user")
public class User implements Serializable
{

private static final long serialVersionUID = 1L;
private int id;
private String name;
private String profession;

public User()
{
}

public User(int id, String name, String profession)
{
    this.id = id;
    this.name = name;
    this.profession = profession;
}

public int getId()
{
    return id;
}

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

public String getName()
{
    return name;
}

@XmlElement
public void setName(String name)
{
    this.name = name;
}

public String getProfession()
{
    return profession;
}

@XmlElement
public void setProfession(String profession)
{
    this.profession = profession;
}
}

UserDao.java

    package com.leo;

import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.util.ArrayList;
import java.util.List;

public class UserDao
{
    public List<User> getAllUsers()
    {
        List<User> userList = null;
        try
        {
            File file = new File("Users.dat");
            if (!file.exists())
            {
                User user = new User(1, "Mahesh", "Teacher");
                userList = new ArrayList<User>();
                userList.add(user);
                saveUserList(userList);
            }
            else
            {
                FileInputStream fis = new FileInputStream(file);
                ObjectInputStream ois = new ObjectInputStream(fis);
                userList = (List<User>) ois.readObject();
                ois.close();
            }
        }
        catch (IOException e)
        {
            e.printStackTrace();
        }
        catch (ClassNotFoundException e)
        {
            e.printStackTrace();
        }
        return userList;
    }

    public User getUser(int id){
          List<User> users = getAllUsers();

          for(User user: users){
             if(user.getId() == id){
                return user;
             }
          }
          return null;
       }

    public int addUser(User pUser)
    {
        List<User> userList = getAllUsers();
        boolean userExists = false;
        for (User user : userList)
        {
            if (user.getId() == pUser.getId())
            {
                userExists = true;
                break;
            }
        }
        if (!userExists)
        {
            userList.add(pUser);
            saveUserList(userList);
            return 1;
        }
        return 0;
    }

    public int updateUser(User pUser)
    {
        List<User> userList = getAllUsers();

        for (User user : userList)
        {
            if (user.getId() == pUser.getId())
            {
                int index = userList.indexOf(user);
                userList.set(index, pUser);
                saveUserList(userList);
                return 1;
            }
        }
        return 0;
    }

    public int deleteUser(int id)
    {
        List<User> userList = getAllUsers();

        for (User user : userList)
        {
            if (user.getId() == id)
            {
                int index = userList.indexOf(user);
                userList.remove(index);
                saveUserList(userList);
                return 1;
            }
        }
        return 0;
    }

    private void saveUserList(List<User> userList)
    {
        try
        {
            File file = new File("Users.dat");
            FileOutputStream fos;

            fos = new FileOutputStream(file);

            ObjectOutputStream oos = new ObjectOutputStream(fos);
            oos.writeObject(userList);
            oos.close();
        }
        catch (FileNotFoundException e)
        {
            e.printStackTrace();
        }
        catch (IOException e)
        {
            e.printStackTrace();
        }
    }
}

UserService.java

    package com.leo;

import java.io.IOException;
import java.util.List;

import javax.servlet.http.HttpServletResponse;
import javax.ws.rs.Consumes;
import javax.ws.rs.DELETE;
import javax.ws.rs.FormParam;
import javax.ws.rs.GET;
import javax.ws.rs.OPTIONS;
import javax.ws.rs.POST;
import javax.ws.rs.PUT;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.MediaType;

@Path("/UserService")
public class UserService {

   UserDao userDao = new UserDao();
   private static final String SUCCESS_RESULT="<result>success</result>";
   private static final String FAILURE_RESULT="<result>failure</result>";

   @GET
   @Path("/users")
   @Produces(MediaType.APPLICATION_XML)
   public List<User> getUsers(){
      return userDao.getAllUsers();
   }    

   @GET
   @Path("/users/{userid}")
   @Produces(MediaType.APPLICATION_XML)
   public User getUser(@PathParam("userid") int userid){
      return userDao.getUser(userid);
   }

   @PUT
   @Path("/users")
   @Produces(MediaType.APPLICATION_XML)
   @Consumes(MediaType.APPLICATION_FORM_URLENCODED)
   public String createUser(@FormParam("id") int id,
      @FormParam("name") String name,
      @FormParam("profession") String profession,
      @Context HttpServletResponse servletResponse) throws IOException{
      User user = new User(id, name, profession);
      int result = userDao.addUser(user);
      if(result == 1){
         return SUCCESS_RESULT;
      }
      return FAILURE_RESULT;
   }

   @POST
   @Path("/users")
   @Produces(MediaType.APPLICATION_XML)
   @Consumes(MediaType.APPLICATION_FORM_URLENCODED)
   public String updateUser(@FormParam("id") int id,
      @FormParam("name") String name,
      @FormParam("profession") String profession,
      @Context HttpServletResponse servletResponse) throws IOException{
      User user = new User(id, name, profession);
      int result = userDao.updateUser(user);
      if(result == 1){
         return SUCCESS_RESULT;
      }
      return FAILURE_RESULT;
   }

   @DELETE
   @Path("/users/{userid}")
   @Produces(MediaType.APPLICATION_XML)
   public String deleteUser(@PathParam("userid") int userid){
      int result = userDao.deleteUser(userid);
      if(result == 1){
         return SUCCESS_RESULT;
      }
      return FAILURE_RESULT;
   }

   @OPTIONS
   @Path("/users")
   @Produces(MediaType.APPLICATION_XML)
   public String getSupportedOperations(){
      return "<operations>GET, PUT, POST, DELETE</operations>";
   }
}

编辑：我在项目中包含了Jackson的jar包，具体来说是 jackson-core-2.7.0.jar，jackson-databind-2.7.0.jar，jackson-annotations-2.2.1.jar，但现在我从Tomcat得到了以下异常：

javax.servlet.ServletException: org.glassfish.jersey.server.ContainerException: java.lang.NoClassDefFoundError: Could not initialize class com.fasterxml.jackson.databind.ObjectMapper
    org.glassfish.jersey.servlet.WebComponent.serviceImpl(WebComponent.java:489)
    org.glassfish.jersey.servlet.WebComponent.service(WebComponent.java:427)
    org.glassfish.jersey.servlet.ServletContainer.service(ServletContainer.java:388)
    org.glassfish.jersey.servlet.ServletContainer.service(ServletContainer.java:341)
    org.glassfish.jersey.servlet.ServletContainer.service(ServletContainer.java:228)
    org.apache.tomcat.websocket.server.WsFilter.doFilter(WsFilter.java:53)

- leqo

---

我编辑了我的问题，现在我又遇到另一个问题。 - leqo

很可能你的应用WAR没有部署依赖的JAR包。虽然如何解决这个问题在技术上是一个新问题，因为它取决于你如何构建你的WAR。 - paisanco

Answer 1

我理解您的问题是关于REST服务（UserService.java）的，如果不是，请评论。

您首先必须确保方法中的调用实际上会返回JSON结果。这将需要对User.java和UserDao.java进行适当的更改，以返回JSON而不是XML。

您所提供的User类示例使用了Java JAXB库，基于@XMLRootElement、@XMLElement等注释。

您需要使用支持创建JSON对象的Java库重写此类。

Jackson库是一个不错的选择。这是Jackson wiki的主页，文档相当完备。

至于REST服务本身，在您的UserService.java中，您需要更改服务生成的媒体类型。

将所有想要生成JSON的方法注释实例更改为：

@Produces(MediaType.APPLICATION_XML)

到

@Produces(MediaType.APPLICATION_JSON)

- paisanco

---

是的，那就是我的意思。但是我应该在User.java和UserDao.java中做出什么改变呢？例如，我如何替换那些"@XMLRootElement"、"@XMLElement"注释？ - leqo

只要JSON中的键名与bean中的名称相同，您就不需要对bean进行任何更改。否则，在名称不匹配的地方使用@JsonProperty。请参考http://www.journaldev.com/2324/jackson-json-java-parser-api-example-tutorial。 - tyagi

有支持XML和JSON格式的JAXB库，例如Eclipselink MOXy。 - George