java restful neo4j
- 作者: 佑耳_钉
- 来源: 51数据库
- 2020-09-25
通过REST风格体系架构,请求和响应都是基于资源表示的传输来构建的。资源是通过全局ID来标识的,这些ID一般使用的是一个统一资源标识符(URI)。客户端应用使用HTTP方法(如,GET、POST、PUT或DELETE)来操作一个或多个资源。通常,GET是用于获取或列出一个或多个资源,POST用于创建,PUT用于更新或替换,而DELETE则用于删除资源。
例如,GET http //host/context/employees/12345将获取ID为12345的员工的表示。这个响应表示可以是包含详细的员工信息的XML或ATOM,或者是具有更好UI的JSP/HTML页面。您看到哪种表示方式取决于服务器端实现和您的客户端请求的MIME类型。
RESTful Web Service是一个使用HTTP和REST原理实现的Web Service。通常,一个RESTful Web Service将定义基本资源URI、它所支持的表示/响应MIME,以及它所支持的操作。
本文将介绍如何使用Spring创建Java实现的服务器端RESTful Web Services。这个例子将使用浏览器、curl和Firefox插件RESTClient作为发出请求的客户端。
本文假定您是熟悉REST基本知识的。
Spring 3的REST支持
在Spring框架支持REST之前,人们会使用其他几种实现技术来创建Java RESTful Web Services,如Restlet、RestEasy和Jersey。Jersey是其中最值得注意的,它是JAX-RS(JSR 311)的参考实现。
Spring是一个得到广泛应用的Java EE框架,它在版本3以后就增加了RESTful Web Services开发的支持。虽然,对REST的支持并不是JAX-RS的一种实现,但是它具有比标准定义更多的特性。REST支持被无缝整合到Spring的MVC层,它可以很容易应用到使用Spring构建的应用中。
Spring REST支持的主要特性包括:
注释,如@RequestMapping 和 @PathVariable,支持资源标识和URL映射
ContentNegotiatingViewResolver支持为不同的MIME/内容类型使用不同的表示方式
使用相似的编程模型无缝地整合到原始的 MVC 层
创建一个示例RESTful Web Service
本节中的例子将演示Spring 3环境的创建过程,并创建一个可以部署到Tomcat中的“Hello World”应用。然后我们再完成一个更复杂的应用来了解Spring 3 REST支持的重要概念,如多种MIME类型表示支持和JAXB支持。另外,本文还使用一些代码片断来帮助理解这些概念。
Hello World:使用Spring 3 REST支持
要创建这个例子所使用的开发环境,您需要:
IDE:Eclipse IDE for JEE (v3.4+)
Java SE5 以上
Web 容器:Apache Tomcat 6.0(Jetty或其他容器也可)
Spring 3框架(v3.0.3是本文编写时的最新版本)
其他程序库:JAXB 2、JSTL、commons-logging
在 Eclipse 中创建一个Web应用,然后设置Tomcat 6作为它的运行环境。然后,您需要设置web.xml文件来激活Spring
WebApplicationContext。这个例子将Spring bean配置分成两个文件:rest-servlet.xml 包含与MVC/REST有关的配置,rest-context.xml包含服务级别的配置(如数据源 beans)。清单 1 显示了web.xml中的Spring配置的部分。
清单 1. 在web.xml中激活Spring WebApplicationContext
以下是引用片段:
contextConfigLocation
/WEB-INF/rest-context.xml
org.springframework.web.context.ContextLoaderListener
rest
org.springframework.web.servlet.DispatcherServlet
1
rest
/service/*
在rest-servlet.xml文件中创建Spring MVC的相关配置(Controller、View、View Resolver)。清单 2 显示了其中最重要的部分。
清单 2. 在rest-servlet.xml文件中创建Spring MVC配置
以下是引用片段:
dw.spring3.rest.bean.Employee
dw.spring3.rest.bean.EmployeeList
上面的代码中:
Component-scan启用对带有Spring注释的类进行自动扫描,在实践中,它将检查控制器类中所定义的@Controller注释。
DefaultAnnotationHanlderMappings和AnnotationMethodHandlerAdapter使用@ReqeustMapping注释的类或函数的beans由Spring处理这个注释将在下一节进行详细介绍。
Jaxb2Mashaller定义使用JAXB 2进行对象XML映射(OXM)的编组器(marshaller)和解组器(unmarshaller )
MashallingView定义一个使用Jaxb2Mashaller的XML表示view
BeanNameViewResolver使用用户指定的bean名称定义一个视图解析器
本例将使用名为“employees”的MarshallingView。
这样就完成了Spring的相关配置。下一步是编写一个控制器来处理用户请求。清单3显示的是控制器类。
1. 什么是restful
其实早在web service概念产生前就有了restful的概念,或者说restful是和http一起诞生的。
可以参阅 roy fielding 的论文“architectural styles and the design of network-based software architectures”, 我本身并没有读过。
restful的意思是‘宁静的’,你可以理解为‘简约而不简单’,或者‘和谐的’。一个协议只有足够的简约才有扩展性和生命力,复杂的东西往往伴随的是大量bug和规模膨胀后的不可控。
restful就是http的本质,仅仅是一个资源uri,和get,post,put,delete四种操作。一切web的行为皆源于此。
所以早期的网站,或者说是静态的网站的都是restful的,如果广义的把浏览器获取web page当做一种web service的话,那么他们都提供了restful web service。
所以restful并不是个陌生的概念,更不是个新的概念,只不过是一直被忽略了。
一样东西之所以被忽略,因为没有对立面, 或者说没有可比较的东西。世界上的概念都是相对的,有了丑才有美,有了胖才有瘦。
同样当仅仅只有restful的时候,便很少有人真正了解restful的意思。
直到有一天,restful的原则被打破,世界上出现了非restful的web行为,我们可以把它称做‘rpc-style’的web service。2. rpc-style
rpc是个大家都很熟悉的东西,remote procedure call,就是说我要调用其他机器上的程序就象调用我本机的函数一样。
早期的做法开个socket端口,把参数传过去,然后执行完再通过socket把结果传回来。
这样的缺点是就是不同的解决方案的传参数和结果的协议不同,大家之间没发通用,还有就是可能无法穿越防火墙。
直到xml技术诞生,用xml来规范接口,并且xml文档本身就是纯文本可以方便的通过http端口传输,这样就大大的方便了在web互相之间的调用。
于是web service的概念诞生了,而这种web service是‘rpc-style’的。3. http
顺便聊一下http协议,http诞生就是为了进行web访问,用来传输html文档的。不过他的能力远远大于此。
http本身就是个envelope协议,他并不管envelop里面装的是什么,所以其实你可以通过http传输任意数据(图片,音乐),只要可以将它编码成文本(如用base64)。
http本身规定了4种操作,可是他并没有强制服务器真正的行为。比如你通过http发出的get指令,服务器在收到这个指令后可以做些完全和get不相关的事情。
http的灵活性带来了很多好处,但同时也带来了副作用,web不再restful,变的有点小乱。4. roa
其实rpc-style和restful看待事物的角度是不同的,大家都说restful是一种ro,即面向资源的,那么rpc-style应该仍难是传统的oo,即面向对象的。
对于rpc-style而言,server就是一个对象,这个对象有许多的属性和方法,我们通过http传递参数来调用这些方法,这里http仅仅被用来做为一个传递者,request的真正含义皆在soap envelop中。
对于restful而言,server就是个资源的集合,里面有web pages,web services,或其他资源,对于资源的操作是固定的。我们可以用http象访问网页一样访问web service。
对于web而言,似乎roa这种架构更能保持web访问的一致性,也更简单。5. ajax
ajax出现的初始动机就是我们可以仅仅刷新部分网页,这样更快,也更合理,不然每次都要刷新整个网页。
同时,ajax的出现也为遵守restful原则提供了一种很好的solution。
restful很重要的原则是无状态性,即服务器不会保存http request的上下文。这是很必要的,否则当用户很多时,服务器的负荷会爆掉的。
我们应该在客户端记录request上下文,然后每次发给服务器。
ajax出现前,每次request都会刷新这个页面,所以很难记录之前request的上下文,现在有了ajax, 用户不用每次刷新整个页面,所以可以有效的记录上下文。
所以可以比较简单的完成胖客户端-瘦服务器的架构。
例如,GET http //host/context/employees/12345将获取ID为12345的员工的表示。这个响应表示可以是包含详细的员工信息的XML或ATOM,或者是具有更好UI的JSP/HTML页面。您看到哪种表示方式取决于服务器端实现和您的客户端请求的MIME类型。
RESTful Web Service是一个使用HTTP和REST原理实现的Web Service。通常,一个RESTful Web Service将定义基本资源URI、它所支持的表示/响应MIME,以及它所支持的操作。
本文将介绍如何使用Spring创建Java实现的服务器端RESTful Web Services。这个例子将使用浏览器、curl和Firefox插件RESTClient作为发出请求的客户端。
本文假定您是熟悉REST基本知识的。
Spring 3的REST支持
在Spring框架支持REST之前,人们会使用其他几种实现技术来创建Java RESTful Web Services,如Restlet、RestEasy和Jersey。Jersey是其中最值得注意的,它是JAX-RS(JSR 311)的参考实现。
Spring是一个得到广泛应用的Java EE框架,它在版本3以后就增加了RESTful Web Services开发的支持。虽然,对REST的支持并不是JAX-RS的一种实现,但是它具有比标准定义更多的特性。REST支持被无缝整合到Spring的MVC层,它可以很容易应用到使用Spring构建的应用中。
Spring REST支持的主要特性包括:
注释,如@RequestMapping 和 @PathVariable,支持资源标识和URL映射
ContentNegotiatingViewResolver支持为不同的MIME/内容类型使用不同的表示方式
使用相似的编程模型无缝地整合到原始的 MVC 层
创建一个示例RESTful Web Service
本节中的例子将演示Spring 3环境的创建过程,并创建一个可以部署到Tomcat中的“Hello World”应用。然后我们再完成一个更复杂的应用来了解Spring 3 REST支持的重要概念,如多种MIME类型表示支持和JAXB支持。另外,本文还使用一些代码片断来帮助理解这些概念。
Hello World:使用Spring 3 REST支持
要创建这个例子所使用的开发环境,您需要:
IDE:Eclipse IDE for JEE (v3.4+)
Java SE5 以上
Web 容器:Apache Tomcat 6.0(Jetty或其他容器也可)
Spring 3框架(v3.0.3是本文编写时的最新版本)
其他程序库:JAXB 2、JSTL、commons-logging
在 Eclipse 中创建一个Web应用,然后设置Tomcat 6作为它的运行环境。然后,您需要设置web.xml文件来激活Spring
WebApplicationContext。这个例子将Spring bean配置分成两个文件:rest-servlet.xml 包含与MVC/REST有关的配置,rest-context.xml包含服务级别的配置(如数据源 beans)。清单 1 显示了web.xml中的Spring配置的部分。
清单 1. 在web.xml中激活Spring WebApplicationContext
以下是引用片段:
contextConfigLocation
/WEB-INF/rest-context.xml
org.springframework.web.context.ContextLoaderListener
rest
org.springframework.web.servlet.DispatcherServlet
1
rest
/service/*
在rest-servlet.xml文件中创建Spring MVC的相关配置(Controller、View、View Resolver)。清单 2 显示了其中最重要的部分。
清单 2. 在rest-servlet.xml文件中创建Spring MVC配置
以下是引用片段:
dw.spring3.rest.bean.Employee
dw.spring3.rest.bean.EmployeeList
上面的代码中:
Component-scan启用对带有Spring注释的类进行自动扫描,在实践中,它将检查控制器类中所定义的@Controller注释。
DefaultAnnotationHanlderMappings和AnnotationMethodHandlerAdapter使用@ReqeustMapping注释的类或函数的beans由Spring处理这个注释将在下一节进行详细介绍。
Jaxb2Mashaller定义使用JAXB 2进行对象XML映射(OXM)的编组器(marshaller)和解组器(unmarshaller )
MashallingView定义一个使用Jaxb2Mashaller的XML表示view
BeanNameViewResolver使用用户指定的bean名称定义一个视图解析器
本例将使用名为“employees”的MarshallingView。
这样就完成了Spring的相关配置。下一步是编写一个控制器来处理用户请求。清单3显示的是控制器类。
1. 什么是restful
其实早在web service概念产生前就有了restful的概念,或者说restful是和http一起诞生的。
可以参阅 roy fielding 的论文“architectural styles and the design of network-based software architectures”, 我本身并没有读过。
restful的意思是‘宁静的’,你可以理解为‘简约而不简单’,或者‘和谐的’。一个协议只有足够的简约才有扩展性和生命力,复杂的东西往往伴随的是大量bug和规模膨胀后的不可控。
restful就是http的本质,仅仅是一个资源uri,和get,post,put,delete四种操作。一切web的行为皆源于此。
所以早期的网站,或者说是静态的网站的都是restful的,如果广义的把浏览器获取web page当做一种web service的话,那么他们都提供了restful web service。
所以restful并不是个陌生的概念,更不是个新的概念,只不过是一直被忽略了。
一样东西之所以被忽略,因为没有对立面, 或者说没有可比较的东西。世界上的概念都是相对的,有了丑才有美,有了胖才有瘦。
同样当仅仅只有restful的时候,便很少有人真正了解restful的意思。
直到有一天,restful的原则被打破,世界上出现了非restful的web行为,我们可以把它称做‘rpc-style’的web service。2. rpc-style
rpc是个大家都很熟悉的东西,remote procedure call,就是说我要调用其他机器上的程序就象调用我本机的函数一样。
早期的做法开个socket端口,把参数传过去,然后执行完再通过socket把结果传回来。
这样的缺点是就是不同的解决方案的传参数和结果的协议不同,大家之间没发通用,还有就是可能无法穿越防火墙。
直到xml技术诞生,用xml来规范接口,并且xml文档本身就是纯文本可以方便的通过http端口传输,这样就大大的方便了在web互相之间的调用。
于是web service的概念诞生了,而这种web service是‘rpc-style’的。3. http
顺便聊一下http协议,http诞生就是为了进行web访问,用来传输html文档的。不过他的能力远远大于此。
http本身就是个envelope协议,他并不管envelop里面装的是什么,所以其实你可以通过http传输任意数据(图片,音乐),只要可以将它编码成文本(如用base64)。
http本身规定了4种操作,可是他并没有强制服务器真正的行为。比如你通过http发出的get指令,服务器在收到这个指令后可以做些完全和get不相关的事情。
http的灵活性带来了很多好处,但同时也带来了副作用,web不再restful,变的有点小乱。4. roa
其实rpc-style和restful看待事物的角度是不同的,大家都说restful是一种ro,即面向资源的,那么rpc-style应该仍难是传统的oo,即面向对象的。
对于rpc-style而言,server就是一个对象,这个对象有许多的属性和方法,我们通过http传递参数来调用这些方法,这里http仅仅被用来做为一个传递者,request的真正含义皆在soap envelop中。
对于restful而言,server就是个资源的集合,里面有web pages,web services,或其他资源,对于资源的操作是固定的。我们可以用http象访问网页一样访问web service。
对于web而言,似乎roa这种架构更能保持web访问的一致性,也更简单。5. ajax
ajax出现的初始动机就是我们可以仅仅刷新部分网页,这样更快,也更合理,不然每次都要刷新整个网页。
同时,ajax的出现也为遵守restful原则提供了一种很好的solution。
restful很重要的原则是无状态性,即服务器不会保存http request的上下文。这是很必要的,否则当用户很多时,服务器的负荷会爆掉的。
我们应该在客户端记录request上下文,然后每次发给服务器。
ajax出现前,每次request都会刷新这个页面,所以很难记录之前request的上下文,现在有了ajax, 用户不用每次刷新整个页面,所以可以有效的记录上下文。
所以可以比较简单的完成胖客户端-瘦服务器的架构。
推荐阅读
