四、SpringMVC实战：构建高效表述层框架(四)

最新推荐文章于 2024-08-03 20:43:02 发布
最新推荐文章于 2024-08-03 20:43:02 发布
阅读量777 收藏 26
点赞数 13
分类专栏： SSM 文章标签： java SSM
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_65644655/article/details/139888862
版权

四、RESTFul风格设计和实战

4.1 RESTFul风格概述

4.1.1 RESTFul风格简介

RESTful（Representational State Transfer）是一种软件架构风格，用于设计网络应用程序和服务之间的通信。它是一种基于标准 HTTP 方法的简单和轻量级的通信协议，广泛应用于现代的Web服务开发。

通过遵循 RESTful 架构的设计原则，可以构建出易于理解、可扩展、松耦合和可重用的 Web 服务。RESTful API 的特点是简单、清晰，并且易于使用和理解，它们使用标准的 HTTP 方法和状态码进行通信，不需要额外的协议和中间件。

总而言之，RESTful 是一种基于 HTTP 和标准化的设计原则的软件架构风格，用于设计和实现可靠、可扩展和易于集成的 Web 服务和应用程序！

学习RESTful设计原则可以帮助我们更好去设计HTTP协议的API接口！！

4.1.2 RESTFul风格特点
  1. 每一个URI代表1种资源（URI 是名词）；
  2. 客户端使用GET、POST、PUT、DELETE 4个表示操作方式的动词对服务端资源进行操作：GET用来获取资源，POST用来新建资源（也可以用于更新资源），PUT用来更新资源，DELETE用来删除资源；
  3. 资源的表现形式是XML或者JSON；
  4. 客户端与服务端之间的交互在请求之间是无状态的，从客户端到服务端的每个请求都必须包含理解请求所必需的信息。
4.1.3 RESTFul风格设计规范

  1. HTTP协议请求方式要求

    REST 风格主张在项目设计、开发过程中，具体的操作符合HTTP协议定义的请求方式的语义。

    操作请求方式
    查询操作GET
    保存操作POST
    删除操作DELETE
    更新操作PUT

  2. URL路径风格要求

    REST风格下每个资源都应该有一个唯一的标识符，例如一个 URI（统一资源标识符）或者一个 URL（统一资源定位符）。资源的标识符应该能明确地说明该资源的信息，同时也应该是可被理解和解释的！

    使用URL+请求方式确定具体的动作，他也是一种标准的HTTP协议请求！

    操作传统风格REST 风格
    保存/CRUD/saveEmpURL 地址：/CRUD/emp 请求方式：POST
    删除/CRUD/removeEmp?empId=2URL 地址：/CRUD/emp/2 请求方式：DELETE
    更新/CRUD/updateEmpURL 地址：/CRUD/emp 请求方式：PUT
    查询/CRUD/editEmp?empId=2URL 地址：/CRUD/emp/2 请求方式：GET

  • 总结

    根据接口的具体动作，选择具体的HTTP协议请求方式

    路径设计从原来携带动标识，改成名词，对应资源的唯一标识即可！

4.1.4 RESTFul风格好处

  1. 含蓄，安全

    使用问号键值对的方式给服务器传递数据太明显，容易被人利用来对系统进行破坏。使用 REST 风格携带数据不再需要明显的暴露数据的名称。

  2. 风格统一

    URL 地址整体格式统一，从前到后始终都使用斜杠划分各个单词，用简单一致的格式表达语义。

  3. 无状态

    在调用一个接口（访问、操作资源）的时候，可以不用考虑上下文，不用考虑当前状态，极大的降低了系统设计的复杂度。

  4. 严谨，规范

    严格按照 HTTP1.1 协议中定义的请求方式本身的语义进行操作。

  5. 简洁，优雅

    过去做增删改查操作需要设计4个不同的URL，现在一个就够了。

    操作传统风格REST 风格
    保存/CRUD/saveEmpURL 地址：/CRUD/emp 请求方式：POST
    删除/CRUD/removeEmp?empId=2URL 地址：/CRUD/emp/2 请求方式：DELETE
    更新/CRUD/updateEmpURL 地址：/CRUD/emp 请求方式：PUT
    查询/CRUD/editEmp?empId=2URL 地址：/CRUD/emp/2 请求方式：GET

  6. 丰富的语义

    通过 URL 地址就可以知道资源之间的关系。它能够把一句话中的很多单词用斜杠连起来，反过来说就是可以在 URL 地址中用一句话来充分表达语义。

    http://localhost:8080/shop http://localhost:8080/shop/product http://localhost:8080/shop/product/cellPhone http://localhost:8080/shop/product/cellPhone/iPhone

4.2 RESTFul风格实战

4.2.1 需求分析
  • 数据结构： User {id 唯一标识,name 用户名，age 用户年龄}
  • 功能分析
    • 用户数据分页展示功能（条件：page 页数 默认1，size 每页数量 默认 10）
    • 保存用户功能
    • 根据用户id查询用户详情功能
    • 根据用户id更新用户数据功能
    • 根据用户id删除用户数据功能
    • 多条件模糊查询用户功能（条件：keyword 模糊关键字，page 页数 默认1，size 每页数量 默认 10）
4.2.2 RESTFul风格接口设计

  1. 接口设计

    功能接口和请求方式请求参数返回值
    分页查询GET /userpage=1&size=10{ 响应数据 }
    用户添加POST /user{ user 数据 }{响应数据}
    用户详情GET /user/1路径参数{响应数据}
    用户更新PUT /user{ user 更新数据}{响应数据}
    用户删除DELETE /user/1路径参数{响应数据}
    条件模糊GET /user/searchpage=1&size=10&keywork=关键字{响应数据}

  2. 问题讨论

    为什么查询用户详情，就使用路径传递参数，多条件模糊查询，就使用请求参数传递？

    误区：restful风格下，不是所有请求参数都是路径传递！可以使用其他方式传递！

    在 RESTful API 的设计中，路径和请求参数和请求体都是用来向服务器传递信息的方式。

    • 对于查询用户详情，使用路径传递参数是因为这是一个单一资源的查询，即查询一条用户记录。使用路径参数可以明确指定所请求的资源，便于服务器定位并返回对应的资源，也符合 RESTful 风格的要求。
    • 而对于多条件模糊查询，使用请求参数传递参数是因为这是一个资源集合的查询，即查询多条用户记录。使用请求参数可以通过组合不同参数来限制查询结果，路径参数的组合和排列可能会很多，不如使用请求参数更加灵活和简洁。
      此外，还有一些通用的原则可以遵循：
    • 路径参数应该用于指定资源的唯一标识或者 ID，而请求参数应该用于指定查询条件或者操作参数。
    • 请求参数应该限制在 10 个以内，过多的请求参数可能导致接口难以维护和使用。
    • 对于敏感信息，最好使用 POST 和请求体来传递参数。
4.2.3 后台接口实现

准备用户实体类：

package com.atguigu.pojo;

/**
 * projectName: com.atguigu.pojo
 * 用户实体类
 */
public class User {

    private Integer id;
    private String name;

    private Integer age;

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    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;
    }

    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", name='" + name + '\'' +
                ", age=" + age +
                '}';
    }
}

准备用户Controller:

/**
 * projectName: com.atguigu.controller
 *
 * description: 用户模块的控制器
 */
@RequestMapping("user")
@RestController
public class UserController {

    /**
     * 模拟分页查询业务接口
     */
    @GetMapping
    public Object queryPage(@RequestParam(name = "page",required = false,defaultValue = "1")int page,
                            @RequestParam(name = "size",required = false,defaultValue = "10")int size){
        System.out.println("page = " + page + ", size = " + size);
        System.out.println("分页查询业务!");
        return "{'status':'ok'}";
    }


    /**
     * 模拟用户保存业务接口
     */
    @PostMapping
    public Object saveUser(@RequestBody User user){
        System.out.println("user = " + user);
        System.out.println("用户保存业务!");
        return "{'status':'ok'}";
    }

    /**
     * 模拟用户详情业务接口
     */
    @PostMapping("/{id}")
    public Object detailUser(@PathVariable Integer id){
        System.out.println("id = " + id);
        System.out.println("用户详情业务!");
        return "{'status':'ok'}";
    }


    /**
     * 模拟用户更新业务接口
     */
    @PutMapping
    public Object updateUser(@RequestBody User user){
        System.out.println("user = " + user);
        System.out.println("用户更新业务!");
        return "{'status':'ok'}";
    }


    /**
     * 模拟条件分页查询业务接口
     */
    @GetMapping("search")
    public Object queryPage(@RequestParam(name = "page",required = false,defaultValue = "1")int page,
                            @RequestParam(name = "size",required = false,defaultValue = "10")int size,
                            @RequestParam(name = "keyword",required= false)String keyword){
        System.out.println("page = " + page + ", size = " + size + ", keyword = " + keyword);
        System.out.println("条件分页查询业务!");
        return "{'status':'ok'}";
    }
}

回顾复习

其他小的细节与包都省略

编写实体类

package com.atguigu.pojo;

import lombok.Data;

/**
 * projectName: com.atguigu.pojo
 *
 * @author: 赵伟风
 * description:
 */

@Data
public class User {

    private Integer id;
    private String name;

    private Integer age;
}

编写UserConller

package com.atguigu.controller;

import com.atguigu.pojo.User;
import org.springframework.web.bind.annotation.*;

import java.util.List;

/**
 * projectName: com.atguigu.controller
 *
 * @author: 赵伟风
 * description:
 */

@RestController
@RequestMapping("user")
public class UserController {

    @GetMapping
    public List<User> page(@RequestParam(required = false,defaultValue = "1") int page,
                           @RequestParam(required = false,defaultValue = "10") int size){
        System.out.println("page = " + page + ", size = " + size);
        return null;
    }

    @PostMapping
    public User save(@RequestBody User user){

        return user;
    }


    @GetMapping("{id}")
    public User detail(@PathVariable Integer id){

        return null;
    }

    @PutMapping
    public User update(@RequestBody User user){
        return user;
    }

    @DeleteMapping("{id}")
    public User delete(@PathVariable Integer id){
        return null;
    }

    @GetMapping("search")
    public List<User> search(String keywork,
                             @RequestParam(required = false,defaultValue = "1") int page,
                             @RequestParam(required = false,defaultValue = "10") int size){
        return null;
    }
}

ariable Integer id){
return null;
}

@GetMapping("search")
public List<User> search(String keywork,
                         @RequestParam(required = false,defaultValue = "1") int page,
                         @RequestParam(required = false,defaultValue = "10") int size){
    return null;
}

}




##
阿尔法波
关注
专栏目录
RESTful设计风格
学无止境
12-17 5679
Django-DRF框架 一、RESTfull设计风格 1、什么是RESTfull？ 1）REST：即Representational State Transfer的缩写。维基百科称其为“具象状态传输”，国内大部分人理解为“表现层状态转化”。 2）具象的：就是指表现层，要表现的对象也就是“资源”，什么是资源呢？网站就是资源共享的东西，客户端（浏览器）访问web服务器，所获取的就叫资源。比如html，txt，json，图片，视频等等。 3）表现：比如，文本可以用txt格式表现，也可以用HTML格式、XML格式
聊聊RESTful - 接口设计篇（一）
就浩这口
10-04 1万+
在我的上一篇文章科普篇中为大家介绍了REST的起源与REST成熟度模型。同时我也指出网上有大量介绍RESTful接口设计的文章，如果我们不理解真正的REST，那么单纯的接口设计的讨论会让我们对REST产生误解。那么在我们了解了什么是真正的REST之后，再来讨论接口设计，就是学以致用
RESTFul风格接口如何设计
m0_63949203的博客
10-02 266
RESTFul风格接口如何设计
什么是RESTful？与常用的HTTP的请求方式有什么不同
最新发布
Crime_man的博客
08-03 1121
RESTful（Representational State Transfer，表述性状态转移）是一种设计风格，用于创建网络服务，使之能够通过HTTP协议进行通信。它是一种基于资源的架构风格，通过定义一组约束和原则，来确保Web服务的可扩展性、可维护性和可操作性。在RESTful架构中，所有的内容都被视为资源，例如用户、订单、产品等。每个资源通过URI（统一资源标识符）唯一标识，例如/users/123代表ID为123的用户。每个请求都是独立的，服务器不会在请求之间保存任何客户端状态。
RESTful风格
expleeve
05-15 1751
英文：Representational State Transfer，简称REST）是Roy Fielding博士在2000年他的博士论文中提出来的一种软件架构风格。 目前在三种主流的Web服务实现方案中，因为REST模式的Web服务与复杂的SOAP和XML-RPC对比来讲明显的更加简洁，越来越多的web服务开始采用REST风格设计和实现。例如，Amazon.com提供接近REST风格的Web服
基于SSM框架的秒杀系统【源码+数据库+spring+springMVC+mybatis】
vx1271487114的博客
06-28 1128
基于ssm框架实现的秒杀业务，单个账号单个商品仅限购买一次（使用主键冲突来实现）
分布式服务治理框架Dubbo的前世今生及应用实战
m0_67322837的博客
06-06 479
Dubbo从开源到现在，已经出现了接近10年时间，在国内各大企业被广泛应用。 它到底有什么魔力值得大家去追捧呢？本篇文章给大家做一个详细的说明。当企业开始大规模的服务化以后，远程通信带来的弊端就越来越明显了。比如说服务链路变长了，如何实现对服务链路的跟踪和监控呢？服务的大规模集群使得服务之间需要依赖第三方注册中心来解决服务的发现和服务的感知问题服务通信之间的异常，需要有一种保护机制防止一个节点故障引发大规模的系统故障，所以要有容错机制服务大规模集群会是的客户端需要引入负载均衡机制实现请求分发而这些对于服务治
实战突击 JavaWeb 项目整合开发3
08-14
4. **框架整合**：在JavaWeb开发中，经常使用Struts、Spring、Hibernate等框架进行整合，形成SSH（Struts + Spring + Hibernate）或SSM（Spring + SpringMVC + MyBatis）架构。这些框架可以帮助简化开发流程，提高...
ssm框架学习笔记
Pop_Rain的博客
03-12 2057
title: ssm框架学习笔记 date: 2018-03-21 16:49:52 updated: 2020-03-12 14:34:23 categories: spring tags: - spring 此文档记录研二学习ssm框架的知识点笔记 SSM简介 最初：jsp + servlet + jdbc 现在：springmvc + spring + mybatis 官网地址： lo...
2021 Java面试真题集锦
GL1765852966的博客
12-26 8万+
目录 … 1 大厂面试的基本流程 17 字节跳动 17 阿里 17 腾讯 18 网易游戏 18 面试前需要准备： 18 面试中可以借鉴的套路 19 用简历争取到更多的面试机会 19 自我介绍时，立即全面抛出技术栈和亮点 20 先介绍项目背景，打消面试官疑问 21 通过说项目管理工具，说明你不仅会写代码 22 用 SPRING BOOT 项目举例，说明你的技术基本面 23 用实例说明你在内存调优方面的经验 24 展示你在数据库调优方面的经验 25 总结前文说辞 26 准备项目说辞时，更可以准备后继面试官的问
restful风格
热门推荐
刘超军的博客
08-24 13万+
概念 一种软件架构风格、设计风格，而不是标准，只是提供了一组设计原则和约束条件。它主要用于客户端和服务器交互类的软件。基于这个风格设计的软件可以更简洁，更有层次，更易于实现缓存等机制。 URL定义 资源：互联网所有的事物都可以被抽象为资源 资源操作：使用POST、DELETE、PUT、GET，使用不同方法对资源进行操作。 分别对应 添加、 删除、修改、查询。 ...
RestFul设计风格
mry
10-11 193
RestFul风格 RESTFUL是一种网络应用程序的设计风格和开发方式，基于HTTP，可以使用XML格式定义或JSON格式定义。RESTFUL适用于移动互联网厂商作为业务接口的场景，实现第三方OTT调用移动网络资源的功能，动作类型为新增、变更、删除所调用资源。 (主要是避免代码的冗余，将动词和名词拆分) HTTP动词 Get(select): 查 Post(create) : 增 Put(update) : 改 Delete(delete) : 删 名词举例 名词要用复数形式 Get /users Pos
SpringMVC（三）Restful风格及实例、参数的转换
喜欢历史的码农
11-04 2740
一、Restful风格 1、Restful风格的介绍 Restful 一种软件架构风格、设计风格，而不是标准，只是提供了一组设计原则和约束条件。它主要用于客户端和服务器交互类的软件。基于这个风格设计的软件可以更简洁，更有层次，更易于实现缓存等机制。 REST（英文：Representational State Transfer，简称REST）描述了一个架构样式的网络系统，比如 web ...
RESTful设计
D先生的博客
10-12 924
关于REST的URI设计 1、URI中不应该包含动词 因为"资源"表示一种实体，所以应该是名词，URI不应该有动词， 动词应该放在HTTP协议中。 举例来说，某个URI是/posts/show/1，其中show是动词，这个URI就设计错了，正确的写法应该是/posts/1，然后用GET方法表示show。 如果某些动作是HTTP动词表示不了的，你就应该把动作做成一种资源。比如网上汇款，从账户1向账户...
RESTful 设计风格有了解吗？
灰寨小学的python---小陈
07-19 2181
（视图主要用于封装结果，生成页面展示的html内容） RESTful 是一种开发理念，简洁，；层次感，主要体现在每个URL代表一种资源，所以在开发REST API 接口时，视图中要频繁的进行序列化和反序列化，将数据库数据序列化为前端所需要的格式，并返回，将前端发送的数据反序列化为模型类对象，并保存到数据库中· 之前的开发的一个电商商城就是用这种 RESTful 设计风格，我们将 API部署在专...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

打赏作者

阿尔法波

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

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

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

打赏作者

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

抵扣说明：

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

余额充值