利用GAE构建第一个REST风格的java webservice
- 配置好你的Eclipse GAE开发环境
- 测试一下你的GAE环境的配置是否正确。写个HeloWord发布一下试试。记得翻墙。不翻墙你是发布不了的。
- 让我们开始
- 利用GAE建一个gaeRest项目.记得把use google web toolkit勾去
项目如下
注意,droidinvokeRest是客户端调用的例子,现在先不管。
下载RestEasy 框架http://sourceforge.net/projects/resteasy/files/Resteasy%20JAX-RS/注意,2.2.2.GA该版本在使用过程时会出现java.lang.IllegalAccessException: Reflection is not allowed on protected final java.lang.Class 错误。我使用了2.0.0.GA,虽然版本比较老,但是无论是本地发布还是正式发布都没有问题。为此问题,我也纠结了许久。最终在google app engine 官方开发论坛上找到答案。
下载后,将里边的所有jar包拷贝到当前项目的war\web-inf\lib文件中(记得不这样做,会运行会报错。。),然后创建userlibray,链接到该lib路径,添加这些包的引用。
创建数据实体,Book类,同时使用jaxb 注解,以用于对象序列化为 xml。关于jaxb你可以在网上找到相关资料。
代码如下
package henu.cjt.webservice;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
@XmlRootElement(name = "book")
public class Book {
private String name;
private String content;
public Book() {
}
public Book(String name, String content) {
this.name = name;
this.content = content;
}
@XmlElement
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
@XmlElement
public String getContent() {
return content;
}
public void setContent(String content) {
this.content = content;
}
}
创建服务类Library,里边用来处理客户端的请求。
使用@Path标注来标识资源路径。请求该路径时就会执行该方法。
代码如下
package henu.cjt.webservice;
import javax.ws.rs.*;
import java.util.*;
import javax.ws.rs.core.*;
@Path("/library")
public class Library {
/**
* 利用books来模拟数据存储区
* 在构造函数中添加数据
*/
public static List<Book> books = new ArrayList<Book>();
static {
books.add(new Book("huhu", "huhu"));
books.add(new Book("haha", "haha"));
}
/**
* 获得所有的book列表
* @return
*/
@GET
@Produces({MediaType.APPLICATION_ATOM_XML, MediaType.APPLICATION_JSON })//设定返回的数据类型 xml 格式和json格式
@Path("/books") //资源的相对路径
public List<Book> listBooks() {
return books;
}
/**
* 获得指定id的书籍信息
* @param id
* @return
*/
@GET
@Produces({MediaType.APPLICATION_XML,MediaType.APPLICATION_JSON })
@Path("/book/{id}")
public Book getBook(@PathParam("id") String id) { //将传入的id赋值给di
if ("1".equals(id))
return new Book("huhu", "huhu");
else
return new Book("haha", "haha");
}
/**
* 利用put提交方式进行数据更新
* @param book
*/
@PUT
@Path("/book/{name}")
public void updateBook(@PathParam("name") PathSegment book) {
Iterator<Book> it = books.iterator();
String name = String.valueOf(book.getMatrixParameters().get("name"));
String content = String.valueOf(book.getMatrixParameters().get(
"content"));
while (it.hasNext()) {
Book booktmp = it.next();
if (name.equals(booktmp.getName())) {
booktmp.setContent(content);
break;
}
}
}
/**
* 利用post方式进行数据增加
* @param name
* @param content
*/
@POST
@Consumes("application/x-www-form-urlencoded")
@Path("/book/{name}")
public void addBook(@PathParam("name") String name,
@FormParam("content") String content) {
books.add(new Book(name, content));
}
@DELETE
@Path("/book/{name}")
public void deleteBookByName(@PathParam("name") String name){
Iterator<Book> iterator=books.iterator();
while(iterator.hasNext()){
Book book=iterator.next();
if(name.equals(name)){
iterator.remove();
}
}
}
}
创建Application,类名 EasyRestApplication告知有哪些应用。继承与javax.ws.rs.core.Application
代码如下
package henu.cjt.webservice;
import java.util.*;
import javax.ws.rs.core.Application;
import org.jboss.resteasy.plugins.server.servlet.ResteasyBootstrap;
public class EasyRestApplication extends Application {
HashSet<Object> singletons = new HashSet<Object>();
HashSet<Class<?>> set = new HashSet<Class<?>>();
public EasyRestApplication() {
singletons.add(new Library());//单件模式,客户端公用一个线程,一个服务实例
// set.add(Library.class);//每个请求出于独立的线程中,有独立的实例存在。
}
@Override
public Set<Class<?>> getClasses() {
return set;
}
@Override
public Set<Object> getSingletons() {
return singletons;
}
}
接下来还要配置war文件夹中的web.xml
添加配置如下
<?xml version="1.0" encoding="utf-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
version="2.5">
<display-name>gaerest</display-name>
<context-param>
<param-name>javax.ws.rs.Application</param-name>
<param-value>henu.cjt.webservice.EasyRestApplication</param-value>
</context-param>
<context-param>
<param-name>resteasy.servlet.mapping.prefix</param-name>
<param-value>/gaerest</param-value>
</context-param>
<listener>
<listener-class>org.jboss.resteasy.plugins.server.servlet.ResteasyBootstrap</listener-class>
</listener>
<servlet>
<servlet-name>GaeRest</servlet-name>
<servlet-class>org.jboss.resteasy.plugins.server.servlet.HttpServletDispatcher</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>GaeRest</servlet-name>
<url-pattern>/gaerest/*</url-pattern>
</servlet-mapping>
<welcome-file-list>
<welcome-file>index.html</welcome-file>
</welcome-file-list>
</web-app>
上述工作完成后,就可以点击运行了。然后在浏览器中输入地址(如果你使用代理上网,你可能接受不到数据。。把代理去掉。)
http://localhost:8888/gaerest/library/books
你可以接受到如下内容
<?xml version="1.0" encoding="UTF-8" standalone="yes"?><collection><book><content>huhu</content><name>huhu</name></book><book><content>haha</content><name>haha</name></book></collection>
本地发布成功。
- 正式发布
在https://appengine.google.com/登录后,创建相应的应用后。 然后点击Eclipse中的GAE发布按钮
如果没有登录google 账户,会提示你登陆接下来填写project名字时候,记得填写名字需要是你在google上创建的应用的名字而且,改名字你需要配置在 appengine-web-xml中, <application>cjtmobiles</application>
虽然,这一点已经超出了本文章的讲述范围,但是我还是愿意你能够顺利的发布。
最后提醒,发布需要翻墙。感谢伟大的墙。
发布成功后,你可以访问http://cjtmobiles.appspot.com/gaerest/library/books ,
当然,cjtmobiles是我创建的应用的名字,记得改成你的。
查看结果如果出现500内部server错误,你可以通过点击查看相应的日志
如果出现如下错误
Caused by: java.lang.IllegalAccessException: Reflection is not allowed on protected final java.lang.Class java.lang.ClassLoader.findLoadedClass(java.lang.String)
那么就是上边我说的RestEasy版本的问题,其实是其中jaxb的版本问题。
我用jaxb 2.1.12也就是resteasy2.0.0 解决了这个问题。
访问http://cjtmobiles.appspot.com/gaerest/library/books 成功返回相应数据后,恭喜你,你的服务端模型算是完成了
你也可使用cURL简单测试restful web service来使用各种提交方式,进行测试。
接下来,我们可以写一个简单的android客户端,模拟调用。