Jersey框架搭建Rest服务.doc

例会制度 目录1.编写目的32.环境配置42.1.开发工具配置42.2.环境变量42.3.系统环境42.4.配置字符集42.5.配置JDK52.6.Tomcat配置63.框架搭建过程63.1.创建Java Web工程63.2.配置Java Web项目的Web.xml73.3.创建Spring配置文件applicationContext.xml83.4.Jersey的介绍和配置94.框架应用104.1.创建Java服务器端应用104.2.Ajax调用Rest服务User121. 编写目的本文档用于描Spring+Jersey框架的搭建Rest服务的过程及其注意事项。主要介绍环境配置、Spring框架配置、Jersey与Spring的集成配置，以及前端Ajax的调用Demo。2. 环境配置2.1. 开发工具配置下表所列开发工具都安装到D:DEVTOOLS下，其他工具自定安装位置。类别工具集成编程环境STS2.5（Eclipse+Spring Tools）JavaScriptSpket1.68(插件)SVN插件SubEclipse(插件)Flex开发环境FlashBuilder_4_PluginJDKJDK 6.0J2EE应用服务器Tomcat6 WebLogic10数据库Oracle10.2数据库工具PL/SQL Developer2.2. 环境变量JAVA_HOME= D: DEVTOOLSJDKCATALINA_HOME= D:DEVTOOLSTomcat2.3. 系统环境操作系统：Windows XP内存：2G以上硬盘：80G以上CPU：2.7GHz以上2.4. 配置字符集1） 右键点击工程，选择属性。2） 在属性框的info中配置该工程的文本文件编码位UTF-8。3） 也可以给整个工作区设置整体字符集，在工作空间上设置UTF-8，如下图：2.5. 配置JDK1）选择“窗口 | 首选项”菜单，进入配置界面。2）在java-编译器下，配置编译器jdk 6.03）在java-JRE下配置JDK6.02.6. Tomcat配置1） 选择“窗口 | 首选项”菜单，进入配置界面。2） 在Eclipse下选择Server,配置Tomcat路径以及JDK等。3）启用Tomcat63. 框架搭建过程3.1. 创建Java Web工程启动STS程序，选择新建Dynamic Web Project项目，作为框架的Web工程项目，如下图：并将所依赖的Jar包放入工程的WebRootWEB-INFlib目录下面，主要是Spring相关Jar包、Jersey相关Jar包，其他依赖包自行加入。Spring所依赖的Jar包： Jersey所依赖的Jar包：3.2. 配置Java Web项目的Web.xml配置JAVA Web工程中WebRoot/WEB-INF/web.xmlcontextConfigLocationclasspath*:/applicationContext*.xmlencodingFilterorg.springframework.web.filter.CharacterEncodingFilterencodingUTF-8forceEncodingtrueencodingFilter/*org.springframework.web.context.ContextLoaderListenerJerseyServletcom.sun.jersey.spi.spring.container.servlet.SpringServletJerseyServlet/rs/*配置Jersey的拦截器，并指定容器为Spring，拦截所有经过rs的服务。3.3. 创建Spring配置文件applicationContext.xml在Web.xml中配置的Spring配置文件，需要在src或者src/resource目录中建立applicationContext.xml，如果在src/resource目录下面建立，需要把resource目录作为源代码路径，目的是使applicationContext.xml可以输出到WebRootWEB-INFCLASSES目录下面；applicationContext.xml配置文件的内容如下：Spring公共配置文件!- Connection Pooling Info -3.4. Jersey的介绍和配置Representational state transfer（REST）在 2000 年由 Roy Fielding 在博士论文中提出，他是 HTTP 规范 1.0 和 1.1 版的首席作者之一。但是，在 Java 社区中，直到 2008 年 JSR 311(JAX-RS) 规范定稿后才将其标准化。第一个版本的参考实现甚至更晚。JerseyJSR 311 的参考实现，描述其必要的API和注释。我将展示如何通过在Apache Tomcat中集成Jersey从 servlet风格的服务转型到RESTful服务。REST 中最重要的概念是资源（resources），使用全球 ID（通常使用 URI）标识。客户端应用程序使用 HTTP 方法（GET/ POST/ PUT/ DELETE）操作资源或资源集。RESTful Web服务是使用HTTP和REST原理实现的Web服务。通常，RESTful Web服务应该定义以下方面：Web 服务的基/根URI，比如http:/host/resources。支持 MIME 类型的响应数据，包括：JSON/XML/ATOM等等。服务支持的操作集合（例如：POST、GET、PUT或DELETE）。表 1. RESTful Web 服务示例方法/资源资源集合， URI 如：http:/host/rs成员资源，URI 如：http:/host/rs/1GET列出资源集合的所有成员。检索标识为1的资源的表示形式。PUT使用一个集合更新（替换）另一个集合。更新标记为1的数字资源。POST在集合中创建数字资源，其 ID 是自动分配的。在下面创建一个子资源。DELETE删除整个资源集合。删除标记为1的数字资源。Jersey的配置全部基于注解，实体类与XML、JSON之间的转换，rest服务的发布，相关参数的配置等都可以基于注解完成，下面简要介绍使用到的注解：l 注释（Annotation）：在 javax.ws.rs.* 中定义，是 JAX-RS (JSR 311) 规范的一部分。l Path：定义资源基URI。由上下文根和主机名组成，资源标识符类似于 http:/localhost:8080/Jersey/rest/contacts。l GET：这意味着以下方法可以响应 HTTPGET方法。l Produces：以纯文本方式定义响应内容 MIME 类型。l Context：使用该注释注入上下文对象，比如 Request、Response、UriInfo、ServletContext 等。l Path(contact)：这是Path注释，与根路径 “/contacts” 结合形成子资源的 URI。l PathParam(contact)：该注释将参数注入方法参数的路径，就是id。其他可用的注释有FormParam、QueryParam等。l Consumes：声明该方法使用 HTML FORM。l FormParam：注入该方法的 HTML 属性确定的表单输入。l Response.created(uri).build()：构建新的 URI 用于新创建的联系人（/contacts/id） 并设置响应代码（201/created）。您可以使用 http:/localhost:8080/Jersey/rest/contacts/ 访问新联系人。HTTP 方法映射到资源的 CRUD（创建、读取、更新和删除） 操作。尽管您可以做一些小修改，比如让PUT方法变成创建或更新，但基本的模式如下：l HTTPGET：获取/列出/检索单个资源或资源集合。l HTTPPOST：新建资源。l HTTPPUT：更新现有资源或资源集合。l HTTPDELETE：删除资源或资源集合。4. 框架应用4.1. 创建Java服务器端应用首先在Web工程中新建一个实体类，JAX-RS 支持使用 JAXB (Java API for XML Binding) 将 JavaBean 绑定到 XML 或 JSON，反之亦然。JavaBean 必须使用XmlRootElement，没有明确XmlElement注释的字段将包含一个名称与之相同的 XML 元素，注释实体类，如下：XmlRootElementpublic class Role private String name;private List authorityList = Lists.newArrayList();public Role() public Role(Long id, String name) this.id = id; = name;Column(nullable = false, unique = true)public String getName() return name;public void setName(String name) = name;public void setAuthorityList(List authorityList) this.authorityList = authorityList;Overridepublic String toString() return ToStringBuilder.reflectionToString(this);使用注解发布Rest服务，如下：ComponentPath(/users)public class UserResourceService private static Logger logger = LoggerFactory.getLogger(UserResourceService.class);Contextprivate UriInfo uriInfo;Autowiredprivate AccountManager accountManager;/* * 获取所有用户. */GETProduces( MediaType.APPLICATION_JSON )public List getAllUser() try List entityList = accountManager.getAllLoadedUser();return entityList; catch (RuntimeException e) logger.error(e.getMessage(), e);throw new WebApplicationException();/* * 获取用户. * throws IOException */GETPath(id)Produces( MediaType.APPLICATION_JSON )public User getUser(PathParam(id) Long id) try User entity = accountManager.getUser(id);return entity; catch (ObjectNotFoundException e) String message = 用户不存在(id: + id + );logger.error(message, e);throw buildException(Status.NOT_FOUND, message); catch (RuntimeException e) logger.error(e.getMessage(), e);throw new WebApplicationException();可以使用http:/localhost:8088/geoweb/rs/users