RESTful开发风格

最新推荐文章于 2024-04-20 15:10:47 发布
最新推荐文章于 2024-04-20 15:10:47 发布
阅读量158 收藏
点赞数
分类专栏： SpringMVC 文章标签： web java http ajax js
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/GiantApe/article/details/112534127
版权

RESTful开发风格

REST与RESTful

  • REST(Representational State Transfer)-表现层状态转换，资源在网络中以某种表现形式进行状态转移
  • RESTful是基于REST理念的一套开发风格，是具体的开发规则

RESTful传输数据

在这里插入图片描述

RESTful开发规范

  • 使用URL作为用户交互入口
  • 明确的语义规范(GET|POST|PUT|DELETE->查|增|改|删)
  • 只返回数据(JSON|XML)，不包含任何展现

RESTful命名要求

URI说明修改建议
GET /articles?au=lily正确用法
GET /a/1URI必须具有语义GET /student/1
POST /createArticle/1URI必须使用名词POST /article/1
GET /articles/author/1URI扁平化，不超两级GET /articles/author?id=1
DELETE /articles/1URI名词区分单复数GET /articles?au=lily
DELETE /article/1

开发第一个RESTful应用

RestfulController.java

package com.imooc.restful.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.*;

/**
 * @author Rex
 * @create 2021-01-12 12:00
 */
@Controller
@RequestMapping("/restful")
public class RestfulController {
    @GetMapping("/request")
    @ResponseBody
    public String doGetRequest(){
        return "{\"message\":\"返回查询结果\"}";
    }


    @PostMapping("/request")
    @ResponseBody
    public String doPostRequest(){
        return "{\"message\":\"数据新建成功\"}";
    }

    @PutMapping("/request")
    @ResponseBody
    public String doPutRequest(){
        return "{\"message\":\"数据更新成功\"}";
    }

    @DeleteMapping("/request")
    @ResponseBody
    public String doDeleteRequest(){
        return "{\"message\":\"数据删除成功\"}";
    }

}

client.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>RESTful实验室</title>
    <script src="./jquery-3.5.1.min.js"></script>
    <script>
        $(function () {
            $("#btnGet").click(function () {
                $.ajax({
                    "url":"/restful/request",
                    "type":"get",
                    "dataType":"json",
                    "success": function (json) {
                        $("#message").text(json.message);
                    }
                })
            });
            $("#btnPost").click(function () {
                $.ajax({
                    "url":"/restful/request",
                    "type":"post",
                    "dataType":"json",
                    "success": function (json) {
                        $("#message").text(json.message);
                    }
                })
            });
            $("#btnPut").click(function () {
                $.ajax({
                    "url":"/restful/request",
                    "type":"put",
                    "dataType":"json",
                    "success": function (json) {
                        $("#message").text(json.message);
                    }
                })
            });
            $("#btnDelete").click(function () {
                $.ajax({
                    "url":"/restful/request",
                    "type":"delete",
                    "dataType":"json",
                    "success": function (json) {
                        $("#message").text(json.message);
                    }
                })
            });
        })
    </script>
</head>
<body>
    <input type="button" value="发送Get请求" id="btnGet"/>
    <input type="button" value="发送Post请求" id="btnPost"/>
    <input type="button" value="发送Put请求" id="btnPut"/>
    <input type="button" value="发送Delete请求" id="btnDelete"/>

    <h1 id="message"></h1>
</body>
</html>

结果：

在这里插入图片描述

为了解决json乱码问题需要在applicationContext对MediaTypes进行处理

<mvc:annotation-driven>
    <mvc:message-converters>
        <bean class="org.springframework.http.converter.StringHttpMessageConverter">
            <property name="supportedMediaTypes">
                <list>
                    <value>text/html; charset=utf-8</value>
                    <value>application/json; charset=utf-8</value>
                </list>
            </property>
        </bean>
    </mvc:message-converters>
</mvc:annotation-driven>

RestController注解

@RestController = @ResposneBody + @Controller, 默认将String向请求中输出，而不是将请求转发到该路径下

路径变量(@PathVariable)

路径变量：存放在URI中可变的数值

代码示例：

RestfulController.java

@PostMapping("/request/{rid}")
public String doPostRequest(@PathVariable("rid") Integer requestId){
    return "{\"message\":\"数据新建成功\", \"id\":\""+requestId+"\"}";
}

client.html

$("#btnPost").click(function () {
    $.ajax({
        "url":"/restful/request/100",
        "type":"post",
        "dataType":"json",
        "success": function (json) {
            $("#message").text(json.message + ":"+json.id);
        }
    })
});

结果：

在这里插入图片描述

简单请求和非简单请求

  • 简单请求是指标准结构的HTTP请求，对应GET/POST请求
  • 非简单请求是指复杂要求的HTTP请求，指PUT/DELETE、扩展标准请求
  • 两者最大区别是非简单请求发送前需要发送预检请求

非简单请求

在这里插入图片描述

非简单请求中参数传递

需要配置FormContentFilter过滤器

代码示例：

web.xml

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

RestfulController.java

@PutMapping("/request")
public String doPutRequest(Person person){
    System.out.println(person.getName()+":"+person.getAge());
    return "{\"message\":\"数据更新成功\"}";
}

client.html

$("#btnPut").click(function () {
    $.ajax({
        "url":"/restful/request",
        "type":"put",
        "dataType":"json",
        "data":"name=lily&age=23",
        "success": function (json) {
            $("#message").text(json.message);
        }
    })
});

结果：

在这里插入图片描述

JSON序列化

  • 引入jackson-core -> jack核心包
  • 引入jackson-databind->用于jackson与目标对象交互
  • 引入jackson-annotations用于jackson的注解

tip：日期类型、数字类型、货币类型的处理需要加上@JsonFormat注解，如@JsonFormat(pattern="", timezone=“GMT+8”)

使用示例：

RestController.java

@GetMapping("/persons")
public List<Person> findPersons(){
    List list = new ArrayList();
    Person p1 = new Person();
    p1.setName("lily");
    p1.setAge(23);
    p1.setBirthday(new Date());
    Person p2 = new Person();
    p2.setName("smith");
    p2.setAge(22);
    p2.setBirthday(new Date());
    list.add(p1);
    list.add(p2);
    return list;
}

Person.java

package com.imooc.restful.entity;

import com.fasterxml.jackson.annotation.JsonFormat;

import java.util.Date;

/**
 * @author Rex
 * @create 2021-01-12 14:02
 */
public class Person {
    private String name;
    private Integer age;
    @JsonFormat(pattern = "yyyy-MM-dd HH-mm-ss", timezone = "GMT+8")
    private Date birthday;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    public Date getBirthday() {
        return birthday;
    }

    public void setBirthday(Date birthday) {
        this.birthday = birthday;
    }
}

client.html

<script>
    //...
    $("#btnPersons").click(function () {
        $.ajax({
            "url":"/restful/persons",
            "type":"get",
            "dataType":"json",
            "success": function (json) {
                console.log(json)
                // $("#message").text(json.message);
                for (var i = 0; i < json.length; i++) {
                    var p = json[i];
                    $("#divPersons").append("<h2>"+p.name+"-"+p.age+"-"+p.birthday+"</h2>")
                }
            }
        })
    });
</script>
<!--...-->
<input type="button" id="btnPersons" value="查询所有人员">
<div id="divPersons"></div>

结果：

在这里插入图片描述

浏览器的跨域访问

浏览器的同源策略

  • 同源策略阻止从一个域加载的脚本去获取另一个域上的资源
  • 只要协议、域名、端口号有任何一个不同，都被当作是不同的域
  • 浏览器Console看到Access-Control-Allow-Origin就代表跨域了

同源策略示例

源URL目标URL直接访问？
http://imooc.comhttps://xxx.com:8080/test不能
http://imooc.comhttps://imooc.com不能
http://imooc.comhttp://abc.imooc.com不能
http://imooc.comhttp://imooc.com:8080不能
http://localhosthttp://127.0.0.1不能
http://imooc.comhttp://imooc.com/user/test可以

HTML中允许跨域的标签

  • <img> - 显示远程图片
  • <script> - 加载远程JS
  • <link> - 加载远程CSS

SpringMVC跨域访问

CORS跨域资源访问
  • CORS是一种机制，使用额外的HTTP头通知浏览器可以访问其他域
  • URL响应头包含 Access-Control-*指明请求允许跨域

SpringMVC解决跨域访问

  • @CrossOrigin - Controller跨域注解

    代码示例：

    80端口下的RestfulController.java：

    package com.imooc.restful.controller;

import com.imooc.restful.entity.Person;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.*;

import java.util.ArrayList;
import java.util.Date;
import java.util.List;

/**
 * @author Rex
 * @create 2021-01-12 12:00
 */
@RestController
@RequestMapping("/restful")
//@CrossOrigin(origins = {"http://localhost:8080", "http://www.imooc.com"})
@CrossOrigin(origins = "*", maxAge = 3600)//匹配每一个URL, maxAge->设置预检请求的访问时间
public class RestfulController {
    //....
}

    8080端口下的client.html

    $("#btnPersons").click(function () {
    $.ajax({
        "url":"http://localhost/restful/persons",
        "type":"get",
        "dataType":"json",
        "success": function (json) {
            console.log(json)
            // $("#message").text(json.message);
            for (var i = 0; i < json.length; i++) {
                var p = json[i];
                $("#divPersons").append("<h2>"+p.name+"-"+p.age+"-"+p.birthday+"</h2>")
            }
        }
    })
});

    结果：

    在这里插入图片描述

  • <mvc:cors> - Spring MVC 全局跨域配置

    applicationContext.xml

    <mvc:cors>
    <mvc:mapping path="/restful/**"
                 allowed-origins="http://localhost:8080, http://www.imooc.com"
                 max-age="3600"/>
</mvc:cors>
Rex·Lin
关注
专栏目录
RESTFul开发风格
fightee的博客
05-04 301
概述 RESTFul不是一种新的开发技术，而是一套开发规范。 传统的MVC架构 1、Servlet起到的是控制器的作用，用来接收前端浏览器接收的数据，到后台查询结果，生成对应的Model。 2、将Model与JSP之类的模板引擎进行渲染，从而得到返回给客户端的html文件。 问题：客户端必然是支持html的浏览器，比如chrome，IE等等； 但目前互联网的发展呈多元趋势，还有微信小程序，APP...
Restful风格开发
only3c的博客
05-14 339
Restful风格开发RESTful含义RESTful概述Spring RESTful含义 全称：Representational State Transfer（强制翻译：表述性状态转移/传输） RESTful概述 1.Restful 是一种风格 而非一种标准 2.根据此风格设计的软件更简洁且有层次 3.与REST 并列的方案（SOAP，RPC） 4.以最适合使用者的任意形式将资源传输出去*(1)...
使用RESTful风格开发Java Web
anye0005的博客
05-29 272
什么是RESTful风格？ REST是REpresentational State Transfer的缩写（一般中文翻译为表述性状态转移），REST 是一种体系结构，而 HTTP 是一种包含了 REST 架构属性的协议，为了便于理解，我们把它的首字母拆分成不同的几个部分： 表述性（REpresentational）： REST 资源实际上可以用各种形式来进行表述，包括 XML、JSO...
Restful开发风格
qq_44058265的博客
12-18 737
文章目录1. Restful开发风格1.1 REST1.2 Restful开发风格1.3 简单请求和非简单请求 1. Restful开发风格 1.1 REST REST(REpresentional State Transfer):表现层状态转换;意思就是所有的资源都是通过URL来识别和定位,对资源的操作(CRUD)是通过HTTP的方法来定义 1.2 Restful开发风格 基于REST理念的一种开发风格,最典型的例子就是前后端分离 在Restful开发风格里面: 使用URL来定位用户的入口 HTTP的方
RestFul风格开发
weixin_58473601的博客
01-21 621
RestFul风格开发
RESTful开发风格1：RESTful开发风格初体验一：RESTful开发风格简介；
小枯林的博客
11-09 787
说明： （1） 零：基于传统MVC模式开发web应用的问题； 说明： （1）上面的开发模式是典型的B/S架构（Browser/Server，浏览器/服务器模式）； ● 上面的开发模式很容易理解；也是我们以前经常经常遇到的； ● 在上面的模式中，客户端是支持HTML的浏览器（如谷歌浏览器、IE浏览器等）； （2）但是，还有很多客户端不是【支持HTML的浏览器】； ● 但是，目前互联网发展呈多元化的趋势，除了像谷歌浏览器这种B...
RESTful开发风格6：RESTful基本使用四：JSON序列化；（jackson组件，以及其中的 @JsonFormat注解来解决时间问题；）
小枯林的博客
11-12 1080
说明： （1）上篇博客【RESTful开发风格3：RESTful基本使用一：客户端是HTML时，Restful演示；】演示了RESTful的最基本的使用；只不过只是RESTful的最基本使用还不够，其还存在一些问题。本篇博客就是来解决三个问题的最后一个： ● 【@RestController注解】：需要优化JSON的产生方式； （2）本篇博客的代码沿用自【RESTful开发风格5：RESTful基本使用三：简单请求（GET和POST）；非简单请求（PUT和DELETE）；（包括...
RESTful开发风格5：RESTful基本使用三：简单请求（GET和POST）；非简单请求（PUT和DELETE）；（包括FormContentFilter过滤器）
小枯林的博客
11-12 1742
说明： （1）本文内容： ●简单请求和非简单请求是什么； ●基本逻辑：【SpringMVC原先只能处理GET和POST这种简单请求】→【但后来有了PUT和DELETE这种非简单请求】→【而，SpringMVC一开始是无法处理这种非简单请求的】→【为了能够处理PUT和DELETE这种非简单请求，Spring MVC可以通过FormContentFilter过滤器，来解决这个需求】； （2）本篇博客的代码沿用自【RESTful开发风格4：RESTful基...
RESTful开发风格3：RESTful基本使用一：客户端是HTML时，Restful演示；（本篇博客，仅仅是RESTful的一个基本演示，还有很多不足的地方需要完善）
小枯林的博客
11-11 1331
说明： （1）本篇博客主要内容：客户端是HTML时，与服务器端进行交互； （2）本篇博客的代码，沿用自【RESTful开发风格2：RESTful开发风格初体验二：开发第一个RESTful风格的项目；（主要是创建工程，为以后的各种演示作准备）】 ...
RESTful 开发风格
weixin_45608986的博客
07-06 260
REST 是表现层状态转换，资源再网络中以某种形式进行状态转移。 RESTful 是基于 REST 理念的一套开发风格，是具体的开发规则。 使用 URL 作为用户交互入口 明确语义规范：GET 、 POST 、PUT、DELETE 只返回数据（JSON/XML），不包含任何展现 RESTful 命名要求： URI 必须具有语义 URI必须使用名词 URI扁平化，不超过两级 URI名词区分单复数 ...
使用RESTful风格开发
02-11 317
在更新资源的操作上，POST 和 PUT 基本相同。 在创建资源时，PUT可以指定资源路径，POST无法指定资源路径。 因而，PUT是幂等的操作，即重复操作不会产生变化，10次PUT 的创建请求与1次PUT 的创建请求相同，只会创建一个资源，其实后面9次的请求只是对已创建资源的更新，且更新内容与原内容相同，所以不会产生变化。 POST 的重复操作截然不同，10次POST请求将会创建10个资源...
RESTFul编程风格
最新发布
小钟不想敲代码
04-20 1555
RESTFul编程风格
RESTful 风格（详细介绍 + 案例实现）
m0_54866636的博客
08-02 1153
概念API，英文全称ApplicationProgrammingInterface，翻译为“应用程序编程接口”。就是将一些功能（逻辑）封装成组件，目的是提供一个应用程序接口给其它程序与开发人员访问，而这些访问人员不需要访问源码以及理解内部工作原理就可以直接使用。举例在WEB项目中A应用暴露一个请求映射方法，B应用通过调用这个请求映射方法从而得到对应功能（请求映射方法赋予的功能）...
REST风格和使用RESTful形式开发
wwl193206126的博客
04-08 538
学习使用RESTful的开发
restful风格注解开发
04-01
Restful风格是一种基于HTTP协议的Web服务开发风格，它的主要特点是使用HTTP方法来表示动作，使用URI来表示资源，使用HTTP状态码来表示结果。 在Java开发中，可以使用注解来实现Restful风格的开发。以下是一些常用的...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

Rex·Lin

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值