Restful风格API接口开发springMVC篇

 

Restful风格API接口开发springMVC篇 Restful风格的API是一种软件架构风格，设计风格而不是标准，只是提供了一组设计原则和约束条件。它主要用于客户端和服务器交互类的软件。基于这个风格设计的软件能够更简洁，更有层次，更易于实现缓存等机制。 在Restful风格中，用户请求的url使用同一个url而用请求方式：get，post，delete，put...等方式对请求的处理方法进行区分，这样能够在先后台分离式的开发中使得前端开发人员不会对请求的资源地址产生混淆和大量的检查方法名的麻烦，造成一个统一的接口。 在Restful风格中，现有规定以下： GET（SELECT）：从服务器查询，能够在服务器经过请求的参数区分查询的方式。 POST（CREATE）：在服务器新建一个资源，调用insert操做。 PUT（UPDATE）：在服务器更新资源，调用update操做。 PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性）。(目前jdk7未实现，tomcat7也不行)。 DELETE（DELETE）：从服务器删除资源，调用delete语句。 了解这个风格定义之后，咱们举个例子： 若是当前url是 http://localhost:8080/User 那么用户只要请求这样同一个URL就能够实现不一样的增删改查操做，例如 http://localhost:8080/User?_method=get&id=1001　　这样就能够经过get请求获取到数据库 user 表里面 id=1001 的用户信息 http://localhost:8080/User?_method=post&id=1001&name=zhangsan　　这样能够向数据库 user 表里面插入一条记录 http://localhost:8080/User?_method=put&id=1001&name=lisi　　这样能够将 user表里面 id=1001 的用户名改成lisi http://localhost:8080/User?_method=delete&id=1001　　这样用于将数据库 user 表里面的id=1001 的信息删除 这样定义的规范咱们就能够称之为restful风格的API接口，咱们能够经过同一个url来实现各类操做。 接下来咱们讲解spring-mvc中是如何实现restful风格API接口的，而且对其中出现的问题进行解决！（java web对 put 和 delete 请求的不支持问题） 首先咱们搭建好spring mvc的项目接口，并按照restful风格写好控制器，这里我写了一个User控制器类和一个User "Action" ->

这里的controller 和 action的url地址是按照restful风格编写的 访问地址 /User/User 用method区分请求方法 咱们的前台使用的是jquery ajax进行请求->

有人会问了？ 为何delete 和put用的也是post的请求，这里就要说说java里面对put和delete的不支持了-> java里面本来是对put和delete请求进行过滤掉的（不知道为何要这么作），并且在servlet里面还有doGet，doPost，doDelete,doPut的对应方法，可是不可使用（尴尬不尴尬），一样spring mvc里面也有对应的method=RequestMethod.PUT 和Delete,可是ajax里面type写成Put、Delete是能够访问到对应的方法的，可是参数却没法传递过去，全部传递过去的参数都是null（郁闷不郁闷）！C#就不会这样，C#的API编程须要开启一下PUT和Delete就能够了，并不须要java里面这么复杂，说到这里咱们解决一下这个问题-> 首先在springMVC 项目的Web.xml里面增长一个过滤器filter 1 <!-- 浏览器不支持put,delete等method,由该filter将/xxx?_method=delete转换为标准的http delete方法 --> 2 <filter> 3 <filter-name>hiddenHttpMethodFilter</filter-name> 4 <filter-class>org.springframework.web.filter.HiddenHttpMethodFilter</filter-class> 5 </filter> 6 <filter-mapping> 7 <filter-name>hiddenHttpMethodFilter</filter-name> 8 <url-pattern>/*</url-pattern> 9 </filter-mapping> 固然有些新手不知道这段代码加在哪里，那么我就将个人web.xml一并粘贴在此处（我也搞这个半天...）  1 <?xml version="1.0" encoding="UTF-8"?> 2 <web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 3 xmlns="http://java.sun.com/xml/ns/javaee" 4 xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" 5 version="3.0"> 6 7 <!-- 浏览器不支持put,delete等method,由该filter将/xxx?_method=delete转换为标准的http delete方法 --> 8 <filter> 9 <filter-name>hiddenHttpMethodFilter</filter-name> 10 <filter-class>org.springframework.web.filter.HiddenHttpMethodFilter</filter-class> 11 </filter> 12 <filter-mapping> 13 <filter-name>hiddenHttpMethodFilter</filter-name> 14 <url-pattern>/*</url-pattern> 15 </filter-mapping> 16 17 <!--这段代码若是不用上面的的话是能够实现put的--> 18 <!--<filter> 19 <filter-name>HttpMethodPutFilter</filter-name> 20 <filter-class>org.springframework.web.filter.HttpPutFormContentFilter</filter-class> 21 </filter> 22 <filter-mapping> 23 <filter-name>HttpMethodPutFilter</filter-name> 24 <url-pattern>/*</url-pattern> 25 </filter-mapping>--> 26 27 28 <welcome-file-list> 29 <welcome-file>/index.jsp</welcome-file> 30 </welcome-file-list> 31 <!-- Spring MVC配置 --> 32 <servlet> 33 <servlet-name>spring</servlet-name> 34 <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class> 35 36 <!-- load-on-startup元素标记容器是否在启动的时候就加载这个servlet(实例化并调用其init()方法) --> 37 <load-on-startup>1</load-on-startup> 38 </servlet> 39 40 <servlet-mapping> 41 <servlet-name>spring</servlet-name> 42 <url-pattern>/</url-pattern> 43 </servlet-mapping> 44 45 <!-- Spring配置 --> 46 <listener> 47 <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class> 48 </listener> 49 50 <!-- 指定Spring Bean的配置文件所在目录。默认配置在WEB-INF目录下 --> 51 <context-param> 52 <param-name>contextConfigLocation</param-name> 53 <param-value>classpath:applicationContext.xml</param-value> 54 </context-param> 55 </web-app> 这里咱们将过滤器配置好了，我有一段注释掉了，若是用下面这个配置文件-> 1 <!--这段代码若是不用上面的的话是能够实现put的--> 2 <filter> 3 <filter-name>HttpMethodPutFilter</filter-name> 4 <filter-class>org.springframework.web.filter.HttpPutFormContentFilter</filter-class> 5 </filter> 6 <filter-mapping> 7 <filter-name>HttpMethodPutFilter</filter-name> 8 <url-pattern>/*</url-pattern> 9 </filter-mapping> 这个配置项若是写在这里的话是能够支持PUT请求的，可是DELETE请求依然不能够，那么我只能选择第一种方法了 1 <filter> 2 <filter-name>hiddenHttpMethodFilter</filter-name> 3 <filter-class>org.springframework.web.filter.HiddenHttpMethodFilter</filter-class> 4 </filter> 5 <filter-mapping> 6 <filter-name>hiddenHttpMethodFilter</filter-name> 7 <url-pattern>/*</url-pattern> 8 </filter-mapping> 这一段的方法是用 org.springframework.web.filter.HiddenHttpMethodFilter 的内置过滤器类进行对http请求的标准化。这样让咱们能够本身声明请求的方式。 配置完成这个之后，咱们在ajax里面须要传递一个参数_method:"PUT" 和 _method:"DELETE"，可是请求方式仍然是POST

这样配置的话，咱们已经能够实现对DELETE修饰的方法进行访问，一样_method:'PUT'咱们能够对PUT修饰的方法进行访问，这样咱们上面定义的控制器类已经能够实现了。