jersey spring
想要在Java中使用REST? 然后您来对地方了,因为在博客文章中,我将向您介绍如何“美丽”地设计REST API,以及如何使用Jersey框架在Java中实现它。 本教程中开发的RESTful API将演示针对存储在MySql数据库中的播客资源的完整的Create__read,_update_and_delete(CRUD)功能。
1.例子
为什么?
在开始之前,让我告诉你为什么写这篇文章–好吧,我的意图是将来为Podcastpedia.org提供REST API。 当然,我可以像现在对AJAX调用那样使用Spring自己的REST实现 ,但是我还想看看“正式”实现的样子。 因此,了解该技术的最佳方法是使用该技术构建原型。 这就是我所做的,也是我在这里介绍的,我可以说我对泽西岛非常满意。 继续阅读以了解原因!!!
注意:您可以使用jQuery和Spring MVC访问我的帖子自动完成搜索框,以了解Spring如何处理REST请求。
它有什么作用?
本教程中管理的资源是播客。 REST API将允许创建,检索,更新和删除此类资源。
建筑与技术
该演示应用程序基于“德米特法则(LoD)或最少知识原理” [16]使用了多层体系结构:
- 第一层是通过Jersey实施的REST支持,具有立面的作用并将逻辑委托给业务层
- 业务层是逻辑发生的地方
- 数据访问层是与持久性存储(在本例中为MySql数据库)进行通信的地方
关于所用技术/框架的几句话:
1.3.1。 泽西岛(门面)
Jersey RESTful Web服务框架是开源,生产质量的,用于在Java中开发RESTful Web服务的框架,该框架提供对JAX-RS API的支持,并充当JAX-RS (JSR 311和JSR 339)参考实现。
1.3.2。 Spring(业务层)
我喜欢将东西与Spring粘在一起,这个示例也不例外。 我认为没有更好的方法来制作具有不同功能的POJO。 您将在本教程中找到将Jersey 2与Spring集成所需的内容。
1.3.3。 JPA 2 / Hibernate(持久层)
对于持久层,我仍然使用DAO模式,尽管要实现它,我使用的是JPA 2,正如某些人所说,它应该使DAO变得多余(我不喜欢EntityManager / JPA专用代码)。 JPA 2的AS支持框架我正在使用Hibernate。
有关Java中的持久性主题的有趣讨论,请参见我的Spring,JPA2和Hibernate的Java持久性示例 。
1.3.4。 网络容器
一切都与Maven打包为.war
文件,并且可以部署在任何Web容器上–我使用Tomcat和Jetty ,但也可以是Glassfih,Weblogic,JBoss或WebSphere。
1.3.5。 MySQL
示例数据存储在MySQL表中:
1.3.6。 技术版本
- 泽西2.9
- Spring4.0.3
- Hibernate4
- Maven的3
- Tomcat7
- 码头9
- MySQL的5.6
注意:帖子中的主要焦点将是REST api设计及其通过Jersey JAX-RS实现的实现,所有其他技术/层均被视为实现因素。
源代码
此处提供的项目的源代码可在GitHub上获得,其中包含有关如何安装和运行项目的完整说明:
2.配置
在开始介绍REST API的设计和实现之前,我们需要做一些配置,以便所有这些奇妙的技术可以一起发挥作用
项目依赖
Jersey Spring扩展名必须出现在项目的类路径中。 如果使用的是Maven,请将其添加到项目的pom.xml
文件中:
pom.xml中的Jersey-spring依赖项
<dependency>
<groupId>org.glassfish.jersey.ext</groupId>
<artifactId>jersey-spring3</artifactId>
<version>${jersey.version}</version>
<exclusions>
<exclusion>
<groupId>org.springframework</groupId>
<artifactId>spring-core</artifactId>
</exclusion>
<exclusion>
<groupId>org.springframework</groupId>
<artifactId>spring-web</artifactId>
</exclusion>
<exclusion>
<groupId>org.springframework</groupId>
<artifactId>spring-beans</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.glassfish.jersey.media</groupId>
<artifactId>jersey-media-json-jackson</artifactId>
<version>2.4.1</version>
</dependency>
注意: jersey-spring3.jar为Spring库使用其自己的版本,因此要使用所需的库(在本例中为Spring 4.0.3,请释放),您需要手动排除这些库。
代码警报:如果您想查看项目中还需要哪些其他依赖项(例如Spring,Hibernate,Jetty maven插件,测试等),则可以查看GitHub上完整的pom.xml文件。
web.xml
Web应用程序部署描述符
<?xml version="1.0" encoding="UTF-8"?>
<web-app version="3.0" 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">
<display-name>Demo - Restful Web Application</display-name>
<listener>
<listener-class>
org.springframework.web.context.ContextLoaderListener
</listener-class>
</listener>
<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:spring/applicationContext.xml</param-value>
</context-param>
<servlet>
<servlet-name>jersey-serlvet</servlet-name>
<servlet-class>
org.glassfish.jersey.servlet.ServletContainer
</servlet-class>
<init-param>
<param-name>javax.ws.rs.Application</param-name>
<param-value>org.codingpedia.demo.rest.RestDemoJaxRsApplication</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>jersey-serlvet</servlet-name>
<url-pattern>/*</url-pattern>
</servlet-mapping>
<resource-ref>
<description>Database resource rest demo web application </description>
<res-ref-name>jdbc/restDemoDB</res-ref-name>
<res-type>javax.sql.DataSource</res-type>
<res-auth>Container</res-auth>
</resource-ref>
</web-app>
泽西小服务器
注意Jersey Servlet配置[行18-33]。 javax.ws.rs.core.Application
类定义JAX-RS应用程序的组件(根资源和提供程序类)。 我使用了ResourceConfig,
它是Jersey类Application
自己的实现,并且提供了高级功能来简化JAX-RS组件的注册。 请查阅文档中的JAX-RS应用程序模型 ,以了解更多可能性。
我对ResourceConfig
类的实现org.codingpedia.demo.rest.RestDemoJaxRsApplication ,
注册了应用程序资源,过滤器,异常映射器和功能:
org.codingpedia.demo.rest.service.MyDemoApplication
package org.codingpedia.demo.rest.service;
//imports omitted for brevity
/**
* Registers the components to be used by the JAX-RS application
*
* @author ama
*
*/
public class RestDemoJaxRsApplication extends ResourceConfig {
/**
* Register JAX-RS application components.
*/
public RestDemoJaxRsApplication() {
// register application resources
register(PodcastResource.class);
register(PodcastLegacyResource.class);
// register filters
register(RequestContextFilter.class);
register(LoggingResponseFilter.class);
register(CORSResponseFilter.class);
// register exception mappers
register(GenericExceptionMapper.class);
register(AppExceptionMapper.class);
register(NotFoundExceptionMapper.class);
// register features
register(JacksonFeature.class);
register(MultiPartFeature.class);
}
}
请注意:
-
org.glassfish.jersey.server.spring.scope.RequestContextFilter
,它是一个Spring过滤器,提供了JAX-RS和Spring请求属性之间的桥梁 -
org.codingpedia.demo.rest.resource.PodcastsResource
,这是一个“外观”组件,它通过注释公开了REST API,并将在稍后的文章中进行详尽介绍。 -
org.glassfish.jers