SpringMVC结合REST

「爱情、让人受尽委屈。」 2022-06-18 02:38 214阅读 0赞

一、什么是REST  
REST即 Representational State Transfer，也就是(资源)表现层状态转化。资源是指网络上的一个实体或者说是网络上的一个具体信息。 每种资源对应一个特定的URI，因此URI为每一个资源的独一无二的识别符。状态转化指的是每发出一个请求，就代表了客户端和服务器端的一次交互过程。HTTP协议是一个无状态协议，即所有的状态都保存在服务器上。因此用户想要操作服务器，必须通过某种手段，让服务器发生状态变化。而这种状态变化是建立在表现层之上的，所以就是“表现层状态变化”。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来实现各种操作。  
  
二、SpringMVC结合REST  
因为浏览器的form表单只支持GET与POST请求，因此只通过浏览器无法完成REST的操作。而Spring3.0增加了一个过滤器，可以将这些HTTP请求（GET或者POST）转换为标准的HTTP方法，使得Spring支持GET、POST、PUT与DELETE四种请求。  
这个过滤器就是HiddenHttpMethodFilter。  
其源码如下：

public class HiddenHttpMethodFilter extends OncePerRequestFilter {
    
    
        /** Default method parameter: {@code _method} */
        public static final String DEFAULT_METHOD_PARAM = "_method";
    
    
        private String methodParam = DEFAULT_METHOD_PARAM;
    
    
    
    
        /**
         * Set the parameter name to look for HTTP methods.
         * @see #DEFAULT_METHOD_PARAM
         */
        public void setMethodParam(String methodParam) {
            Assert.hasText(methodParam, "'methodParam' must not be empty");
            this.methodParam = methodParam;
        }
    
    
        @Override
        protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
                throws ServletException, IOException {
    
    
            String paramValue = request.getParameter(this.methodParam);
            if ("POST".equals(request.getMethod()) && StringUtils.hasLength(paramValue)) {
                String method = paramValue.toUpperCase(Locale.ENGLISH);
                HttpServletRequest wrapper = new HttpMethodRequestWrapper(request, method);
                filterChain.doFilter(wrapper, response);
            }
            else {
                filterChain.doFilter(request, response);
            }
        }
    //...

从上面的源码可以看出，当request.getMethod() 等于POST 且 通过String paramValue = request.getParameter(this.methodParam); 得到的paramValue不为null 或空，那么将执行对应的paramValue方法。  
要使用HiddenHttpMethodFilter过滤器，需要在web.xml作如下配置：  
web.xml

<filter>
            <filter-name>HiddenHttpMethodFilter</filter-name>
            <filter-class>org.springframework.web.filter.HiddenHttpMethodFilter</filter-class>
    </filter>
    
    
    <filter-mapping>
            <filter-name>HiddenHttpMethodFilter</filter-name>
            <url-pattern>/*</url-pattern>
    </filter-mapping>

1、处理GET请求  
浏览器默认支持GET请求，在REST中用来获取资源。在JSP页面中不需要使用隐藏域。例如：  
<a href="testRest/1">Test Rest Get</a>  
与之对应的后台处理代码：

@RequestMapping(value = "/testRest/{id}", method = RequestMethod.GET)
        public String testRest(@PathVariable Integer id) {
            System.out.println("testRest GET: " + id);
            return SUCCESS;
        }

2、处理POST请求  
浏览器默认支持POST请求，在REST中用来新建资源。在JSP页面中不需要使用隐藏域。例如：

与之对应的后台处理代码：

@RequestMapping(value = "/testRest", method = RequestMethod.POST)
        public String testRest() {
            System.out.println("testRest POST");
            return SUCCESS;
        }

3、处理PUT请求  
浏览器不支持PUT请求，在REST中用来更新资源。在JSP页面中需要使用隐藏域。例如：

与之对应的后台处理代码：SpringMVC自动用\_method对应的value来取代原来的POST方法。

@RequestMapping(value = "/testRest/{id}", method = RequestMethod.PUT)
        public String testRestPut(@PathVariable("id") Integer id) {
            System.out.println("testRest Put: " + id);
            return SUCCESS;
        }

4、处理DELETE请求  
浏览器不支持DELETE请求，在REST中用来删除资源。在JSP页面中需要使用隐藏域。例如：

与之对应的后台处理代码：SpringMVC自动用\_method对应的value来取代原来的POST方法。

@RequestMapping(value = "/testRest/{id}", method = RequestMethod.DELETE)
        public String testRestDELETE(@PathVariable("id") Integer id) {
            System.out.println("testRest Put: " + id);
            return SUCCESS;
        }

三、Spring通过POST方法出现中文乱码  
解决方案：使用Spring的字符过滤器。  
web.xml作如下配置：

<filter>
            <filter-name>encoding</filter-name>
            <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
            <init-param>
                <param-name>encoding</param-name>
                <param-value>UTF-8</param-value>
            </init-param>
            <init-param>  
                <param-name>forceEncoding</param-name>  
                <param-value>true</param-value>  
            </init-param> 
        </filter>
        <filter-mapping>
            <filter-name>encoding</filter-name>
            <url-pattern>/*</url-pattern>
        </filter-mapping>

注意要把这个过滤器放在所有过滤器中最前方，保证先进性字符过滤。例如可以紧接着放在springdispatcherServlet下。

四、RESTful API设计小结

1、设计的基本要求  
当标准合理的时候遵守标准。  
API应该对程序员友好，并且在浏览器地址栏容易输入。  
API应该简单，直观，容易使用的同时秉持优雅。  
API应该具有足够的灵活性来支持上层ui。  
API设计权衡上述几个原则。  
2、使用RESTful URLs 和action.  
虽然前面我说没有一个万能的API设计标准。但确实有一个被普遍承认和遵守：RESTfu设计原则。它被Roy Felding提出（在他的”基于网络的软件架构“论文中第五章）。而REST的核心原则是将你的API拆分为逻辑上的资源。这些资源通过http被操作（GET ,POST,PUT,DELETE）。  
显然从API用户的角度来看，”资源“应该是个名词。即使你的内部数据模型和资源已经有了很好的对应，API设计的时候你不需要把它们一对一的都暴露出来。这里的关键是隐藏内部资源，暴露必需的外部资源。  
一旦定义好了要暴露的资源，你可以定义资源上允许的操作，以及这些操作和你的API的对应关系：  
GET /tickets \# 获取ticket列表  
GET /tickets/12 \# 查看某个具体的ticket  
POST /tickets \# 新建一个ticket  
PUT /tickets/12 \# 更新ticket 12.  
DELETE /tickets/12 \#删除ticekt 12  
可以看出使用REST的好处在于可以充分利用http的强大实现对资源的CURD功能。而这里你只需要一个统一的URL接口：/tickets,再没有其他什么命名规则和url规则了。  
3、出错处理  
就像html错误页面能够显示错误信息一样，API 也应该能返回可读的错误信息–它应该和一般的资源格式一致。API应该始终返回相应的状态码，以反映服务器或者请求的状态。API的错误码可以分为两部分，400系列和500系列，400系列表明客户端错误：如错误的请求格式等。500系列表示服务器错误。API应该至少将所有的400系列的错误以json形式返回。如果可能500系列的错误也应该如此。json格式的错误应该包含以下信息：一个有用的错误信息，一个唯一的错误码，以及任何可能的详细错误描述。  
常见HTTP状态码如下：  
200 OK  
301 Moved Permanently  
302 Found  
304 Not Modified  
307 Temporary Redirect  
400 Bad Request  
401 Unauthorized  
403 Forbidden  
404 Not Found  
410 Gone  
500 Internal Server Error  
501 Not Implemented  
详解：  
100 Continue  
初始的请求已经接受，客户应当继续发送请求的其余部分  
101 Switching Protocols  
服务器将遵从客户的请求转换到另外一种协议  
200 OK  
一切正常，对GET和POST请求的应答文档跟在后面  
201 Created  
服务器已经创建了文档，Location头给出了它的URL。  
202 Accepted  
已经接受请求，但处理尚未完成。  
203 Non-Authoritative Information  
文档已经正常地返回，但一些应答头可能不正确，因为使用的是文档的拷贝  
204 No Content  
没有新文档，浏览器应该继续显示原来的文档。如果用户定期地刷新页面，而Servlet可以确定用户文档足够新，这个状态代码是很有用的  
205 Reset Content  
没有新的内容，但浏览器应该重置它所显示的内容。用来强制浏览器清除表单输入内容  
206 Partial Content  
客户发送了一个带有Range头的GET请求，服务器完成了它  
300 Multiple Choices  
客户请求的文档可以在多个位置找到，这些位置已经在返回的文档内列出。如果服务器要提出优先选择，则应该在Location应答头指明。  
301 Moved Permanently  
客户请求的文档在其他地方，新的URL在Location头中给出，浏览器应该自动地访问新的URL。  
302 Found  
类似于301，但新的URL应该被视为临时性的替代，而不是永久性的。  
303 See Other  
类似于301/302，不同之处在于，如果原来的请求是POST，Location头指定的重定向目标文档应该通过GET提取  
304 Not Modified  
客户端有缓冲的文档并发出了一个条件性的请求（一般是提供If-Modified-Since头表示客户只想比指定日期更新的文档）。服务器告诉客户，原来缓冲的文档还可以继续使用。  
305 Use Proxy  
客户请求的文档应该通过Location头所指明的代理服务器提取  
307 Temporary Redirect  
和302（Found）相同。许多浏览器会错误地响应302应答进行重定向，即使原来的请求是 POST，即使它实际上只能在POST请求的应答是303时才能重定向。由于这个原因，HTTP 1.1新增了307，以便更加清除地区分几个状态代码： 当出现303应答时，浏览器可以跟随重定向的GET和POST请求；如果是307应答，则浏览器只能跟随对GET请求的重定向。  
400 Bad Request  
请求出现语法错误。  
401 Unauthorized  
客户试图未经授权访问受密码保护的页面。应答中会包含一个WWW-Authenticate头，浏览器据此显示用户名字/密码对话框，然后在填写合适的Authorization头后再次发出请求。  
403 Forbidden  
资源不可用。  
404 Not Found  
无法找到指定位置的资源  
405 Method Not Allowed  
请求方法（GET、POST、HEAD、Delete、PUT、TRACE等）对指定的资源不适用。  
406 Not Acceptable  
指定的资源已经找到，但它的MIME类型和客户在Accpet头中所指定的不兼容  
407 Proxy Authentication Required  
类似于401，表示客户必须先经过代理服务器的授权。  
408 Request Timeout  
在服务器许可的等待时间内，客户一直没有发出任何请求。客户可以在以后重复同一请求。  
409 Conflict  
通常和PUT请求有关。由于请求和资源的当前状态相冲突，因此请求不能成功。  
410 Gone  
所请求的文档已经不再可用，而且服务器不知道应该重定向到哪一个地址。它和404的不同在于，返回407表示文档永久地离开了指定的位置，而404表示由于未知的原因文档不可用。  
411 Length Required  
服务器不能处理请求，除非客户发送一个Content-Length头。  
412 Precondition Failed  
请求头中指定的一些前提条件失败  
413 Request Entity Too Large  
目标文档的大小超过服务器当前愿意处理的大小。如果服务器认为自己能够稍后再处理该请求，则应该提供一个Retry-After头  
414 Request URI Too Long  
URI太长  
416 Requested Range Not Satisfiable  
服务器不能满足客户在请求中指定的Range头  
500 Internal Server Error  
服务器遇到了意料不到的情况，不能完成客户的请求  
501 Not Implemented  
服务器不支持实现请求所需要的功能。例如，客户发出了一个服务器不支持的PUT请求  
502 Bad Gateway  
服务器作为网关或者代理时，为了完成请求访问下一个服务器，但该服务器返回了非法的应答  
503 Service Unavailable  
服务器由于维护或者负载过重未能应答。例如，Servlet可能在数据库连接池已满的情况下返回503。服务器返回503时可以提供一个Retry-After头  
504 Gateway Timeout  
由作为代理或网关的服务器使用，表示不能及时地从远程服务器获得应答  
505 HTTP Version Not Supported  
服务器不支持请求中所指明的HTTP版本