用Jersey構建RESTful服務-JAVA物件轉成XML/Json輸出
阿新 • • 發佈:2019-01-02
1、XML資料型別輸出:
一、 總體說明
XML和JSON 是最為常用的資料交換格式。本例子演示如何將java物件,轉成XML輸出。
二、流程
1.在上文的例子中,建立一個包“com.waylau.rest.bean”
2.在該包下建立一個JAVA類"User"
[java] view plain copy print?- package com.waylau.rest.bean;
- import javax.xml.bind.annotation.XmlRootElement;
- /*
- * 使用者 bean
- * @author waylau.com
- * 2014-3-17
- */
- @XmlRootElement
- publicclass User {
- private String userId;
- private String userName;
- private String age;
- public User() {};
- public User(String userId, String userName, String age) {
- this.userId = userId;
- this.userName = userName;
- this.age = age;
- }
- public String getUserId() {
- return userId;
- }
- publicvoid setUserId(String userId) {
- this.userId = userId;
- }
- public String getUserName() {
- return userName;
- }
- publicvoid setUserName(String userName) {
- this.userName = userName;
- }
- public String getAge() {
- return age;
- }
- publicvoid setAge(String age) {
- this.age = age;
- }
- }
package com.waylau.rest.bean;
import javax.xml.bind.annotation.XmlRootElement;
/*
* 使用者 bean
* @author waylau.com
* 2014-3-17
*/
@XmlRootElement
public class User {
private String userId;
private String userName;
private String age;
public User() {};
public User(String userId, String userName, String age) {
this.userId = userId;
this.userName = userName;
this.age = age;
}
public String getUserId() {
return userId;
}
public void setUserId(String userId) {
this.userId = userId;
}
public String getUserName() {
return userName;
}
public void setUserName(String userName) {
this.userName = userName;
}
public String getAge() {
return age;
}
public void setAge(String age) {
this.age = age;
}
}
注意:該類上面增加了一個註解“@XmlRootElement”,在將該類轉化成XML時,說明這個是XML的根節點。
3.在“com.waylau.rest.resources”中,增加資源“UserResource“,程式碼如下:
[java] view plain copy print?- package com.waylau.rest.resources;
- import java.util.ArrayList;
- import java.util.HashMap;
- import java.util.List;
- import java.util.Map;
- import javax.ws.rs.Path;
- import javax.ws.rs.Produces;
- import javax.ws.rs.PathParam;
- import javax.ws.rs.core.MediaType;
- import javax.ws.rs.DELETE;
- import javax.ws.rs.GET;
- import javax.ws.rs.POST;
- import javax.ws.rs.PUT;
- import com.waylau.rest.bean.User;
- @Path("/users")
- publicclass UserResource {
- privatestatic Map<String,User> userMap = new HashMap<String,User>();//儲存使用者
- /**
- * 查詢所有
- * @return
- */
- @GET
- @Produces(MediaType.APPLICATION_XML)
- public List<User> getAllUsers(){
- List<User> users = new ArrayList<User>();
- User u1 = new User("001","WayLau","26");
- User u2 = new User("002","King","23");
- User u3 = new User("003","Susan","21");
- userMap.put(u1.getUserId(), u1);
- userMap.put(u2.getUserId(), u2);
- userMap.put(u3.getUserId(), u3);
- users.addAll( userMap.values() );
- return users;
- }
- @GET
- @Path("/getUserXml")
- @Produces(MediaType.APPLICATION_XML)
- public User getUserXml() {
- User user = new User();
- user.setAge("21");
- user.setUserId("004");
- user.setUserName("Amand");
- return user;
- }
- }
其中MediaType.APPLICATION_XML說明了是以XML形式輸出
在瀏覽器輸入http://localhost:8089/RestDemo/rest/users/getUserXml,輸出單個物件
在瀏覽器輸入 http://localhost:8089/RestDemo/rest/users 輸出物件的集合
2、資料輸出為JSON型別:
一、 總體說明
XML和JSON 是最為常用的資料交換格式。本例子演示如何將java物件,轉成JSON輸出。
二、流程
1.在上文專案中,
在“com.waylau.rest.resources.UserResource“中增加程式碼,程式碼如下:
- @GET
- @Path("/getUserJson")
- @Produces(MediaType.APPLICATION_JSON)
- public User getUserJson() {
- User user = new User();
- user.setAge("27");
- user.setUserId("005");
- user.setUserName("Fmand");
- return user;
- }
@GET
@Path("/getUserJson")
@Produces(MediaType.APPLICATION_JSON)
public User getUserJson() {
User user = new User();
user.setAge("27");
user.setUserId("005");
user.setUserName("Fmand");
return user;
}
MediaType.APPLICATION_JSON 說明輸出的是JSON格式
期望獲取到json的資料,此時,專案報錯
[html] view plain copy print?- org.glassfish.jersey.message.internal.MessageBodyProviderNotFoundException: MessageBodyWriter not found for media type=application/json, type=class com.waylau.rest.bean.User, genericType=class com.waylau.rest.bean.User.
- at org.glassfish.jersey.message.internal.WriterInterceptorExecutor$TerminalWriterInterceptor.aroundWriteTo(WriterInterceptorExecutor.java:247)
- at org.glassfish.jersey.message.internal.WriterInterceptorExecutor.proceed(WriterInterceptorExecutor.java:162)
- at org.glassfish.jersey.filter.LoggingFilter.aroundWriteTo(LoggingFilter.java:293)
- at org.glassfish.jersey.message.internal.WriterInterceptorExecutor.proceed(WriterInterceptorExecutor.java:162)
- at org.glassfish.jersey.server.internal.JsonWithPaddingInterceptor.aroundWriteTo(JsonWithPaddingInterceptor.java:103)
- at org.glassfish.jersey.message.internal.WriterInterceptorExecutor.proceed(WriterInterceptorExecutor.java:162)
- at org.glassfish.jersey.server.internal.MappableExceptionWrapperInterceptor.aroundWriteTo(MappableExceptionWrapperInterceptor.java:88)
- at org.glassfish.jersey.message.internal.WriterInterceptorExecutor.proceed(WriterInterceptorExecutor.java:162)
- at org.glassfish.jersey.message.internal.MessageBodyFactory.writeTo(MessageBodyFactory.java:1154)
- at org.glassfish.jersey.server.ServerRuntime$Responder.writeResponse(ServerRuntime.java:571)
- at org.glassfish.jersey.server.ServerRuntime$Responder.processResponse(ServerRuntime.java:378)
- at org.glassfish.jersey.server.ServerRuntime$Responder.process(ServerRuntime.java:368)
- at org.glassfish.jersey.server.ServerRuntime$1.run(ServerRuntime.java:262)
org.glassfish.jersey.message.internal.MessageBodyProviderNotFoundException: MessageBodyWriter not found for media type=application/json, type=class com.waylau.rest.bean.User, genericType=class com.waylau.rest.bean.User.
at org.glassfish.jersey.message.internal.WriterInterceptorExecutor$TerminalWriterInterceptor.aroundWriteTo(WriterInterceptorExecutor.java:247)
at org.glassfish.jersey.message.internal.WriterInterceptorExecutor.proceed(WriterInterceptorExecutor.java:162)
at org.glassfish.jersey.filter.LoggingFilter.aroundWriteTo(LoggingFilter.java:293)
at org.glassfish.jersey.message.internal.WriterInterceptorExecutor.proceed(WriterInterceptorExecutor.java:162)
at org.glassfish.jersey.server.internal.JsonWithPaddingInterceptor.aroundWriteTo(JsonWithPaddingInterceptor.java:103)
at org.glassfish.jersey.message.internal.WriterInterceptorExecutor.proceed(WriterInterceptorExecutor.java:162)
at org.glassfish.jersey.server.internal.MappableExceptionWrapperInterceptor.aroundWriteTo(MappableExceptionWrapperInterceptor.java:88)
at org.glassfish.jersey.message.internal.WriterInterceptorExecutor.proceed(WriterInterceptorExecutor.java:162)
at org.glassfish.jersey.message.internal.MessageBodyFactory.writeTo(MessageBodyFactory.java:1154)
at org.glassfish.jersey.server.ServerRuntime$Responder.writeResponse(ServerRuntime.java:571)
at org.glassfish.jersey.server.ServerRuntime$Responder.processResponse(ServerRuntime.java:378)
at org.glassfish.jersey.server.ServerRuntime$Responder.process(ServerRuntime.java:368)
at org.glassfish.jersey.server.ServerRuntime$1.run(ServerRuntime.java:262)
此時,需要獲取json轉換包的支援 。
可以由多種方式實現:MOXy、JSON-P、Jackson、Jettison等,本例為Jackson。
4. 專案中引入jackson-all-1.9.11.jar
5.在“com.waylau.rest”目錄下建立RestApplication.java
[java] view plain copy print?- package com.waylau.rest;
- import org.codehaus.jackson.jaxrs.JacksonJsonProvider;
- import org.glassfish.jersey.filter.LoggingFilter;
- import org.glassfish.jersey.server.ResourceConfig;
- /**
- * 應用
- * @author waylau.com
- * 2014-3-18
- */
- publicclass RestApplication extends ResourceConfig {
- public RestApplication() {
- //服務類所在的包路徑
- packages("com.waylau.rest.resources");
- //註冊JSON轉換器
- register(JacksonJsonProvider.class);
- }
- }
package com.waylau.rest;
import org.codehaus.jackson.jaxrs.JacksonJsonProvider;
import org.glassfish.jersey.filter.LoggingFilter;
import org.glassfish.jersey.server.ResourceConfig;
/**
* 應用
* @author waylau.com
* 2014-3-18
*/
public class RestApplication extends ResourceConfig {
public RestApplication() {
//服務類所在的包路徑
packages("com.waylau.rest.resources");
//註冊JSON轉換器
register(JacksonJsonProvider.class);
}
}
6.修改web.xml,初始化從RestApplicaton進入應用,如下:
- <servlet>
- <servlet-name>Way REST Service</servlet-name>
- <servlet-class>org.glassfish.jersey.servlet.ServletContainer</servlet-class>
- <init-param>
- <param-name>javax.ws.rs.Application</param-name>
- <param-value>com.waylau.rest.RestApplication</param-value>
- </init-param>
- <load-on-startup>1</load-on-startup>
- </servlet>
- <servlet-mapping>
- <servlet-name>Way REST Service</servlet-name>
- <url-pattern>/rest/*</url-pattern>
- </servlet-mapping>
<servlet>
<servlet-name>Way REST Service</servlet-name>
<servlet-class>org.glassfish.jersey.servlet.ServletContainer</servlet-class>
<init-param>
<param-name>javax.ws.rs.Application</param-name>
<param-value>com.waylau.rest.RestApplication</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>Way REST Service</servlet-name>
<url-pattern>/rest/*</url-pattern>
</servlet-mapping>