restful在后端的体现

已于 2022-05-16 09:10:07 修改
阅读量1k 收藏 1
点赞数
分类专栏： java 文章标签： restful
于 2022-03-31 11:37:23 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_51705526/article/details/123867810
版权

前言:

之前寒假做互联网+项目的时候,看到组长的后端api接口写得那叫一个优雅;

在分布式、微服务盛行的今天，绝大部分项目都采用的微服务框架，前后端分离方式。题外话：前后端的工作职责越来越明确，现在的前端都称之为大前端，技术栈以及生态圈都已经非常成熟；以前后端人员瞧不起前端人员，那现在后端人员要重新认识一下前端，前端已经很成体系了。

现代系统架构:

一般系统的大致整体架构图如下：

接口交互

前端和后端进行交互，前端按照约定请求URL路径，并传入相关参数，后端服务器接收请求，进行业务处理，返回数据给前端。

针对URL路径的restful风格，以及传入参数的公共请求头的要求（如：app_version,api_version,device等），老顾这里就不介绍了，小伙伴们可以自行去了解，也比较简单。

着重介绍一下后端服务器如何实现把数据返回给前端？

返回格式

后端返回给前端我们一般用JSON体方式，定义如下：

{
    #返回状态码
    code:integer,       
    #返回信息描述
    message:string,
    #返回值
    data:object
}

CODE状态码

code返回状态码，一般小伙伴们是在开发的时候需要什么，就添加什么。
如接口要返回用户权限异常，我们加一个状态码为101吧，下一次又要加一个数据参数异常，就加一个102的状态码。这样虽然能够照常满足业务，但状态码太凌乱了

我们应该可以参考HTTP请求返回的状态码，下面是常见的HTTP状态码传送门：

200 OK - [GET]：服务器成功返回用户请求的数据，该操作是幂等的（Idempotent）。
201 CREATED - [POST/PUT/PATCH]：用户新建或修改数据成功。
202 Accepted - [*]：表示一个请求已经进入后台排队（异步任务）
204 NO CONTENT - [DELETE]：用户删除数据成功。
400 INVALID REQUEST - [POST/PUT/PATCH]：用户发出的请求有错误，服务器没有进行新建或修改数据的操作，该操作是幂等的。
401 Unauthorized - [*]：表示用户没有权限（令牌、用户名、密码错误）。
403 Forbidden - [*] 表示用户得到授权（与401错误相对），但是访问是被禁止的。
404 NOT FOUND - [*]：用户发出的请求针对的是不存在的记录，服务器没有进行操作，该操作是幂等的。
406 Not Acceptable - [GET]：用户请求的格式不可得（比如用户请求JSON格式，但是只有XML格式）。
410 Gone -[GET]：用户请求的资源被永久删除，且不会再得到的。
422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时，发生一个验证错误。
500 INTERNAL SERVER ERROR - [*]：服务器发生错误，用户将无法判断发出的请求是否成功。
分类区间分类描述
100100~199信息，服务器收到请求，需要请求者这执行操作
200200~299成功，操作被成功接受并处理
300300~399重定向，需要进一步的操作以完成请求
400400~499客户端错误，请求包含语法错误或无法完成请求
500500~599服务器的错误，服务器在处理请求的过程中发生了错误

规定:

#1表示成功
#1001～1999 区间表示参数错误
#2001～2999 区间表示用户错误
#3001～3999 区间表示接口异常

这样前端开发人员在得到返回值后，根据状态码就可以知道，大概什么错误，再根据message相关的信息描述，可以快速定位。

Message

这个字段相对理解比较简单，就是发生错误时，如何友好的进行提示。一般的设计是和code状态码一起设计，如

import lombok.experimental.Accessors;

/**
 * 规定:
 * #1表示成功
 * #1001～1999 区间表示参数错误
 * #2001～2999 区间表示用户错误
 * #3001～3999 区间表示接口异常
 * 统一错误枚举类
 */
@Accessors(chain = true)
public enum ResultCode {

    /* 成功 */
    SUCCESS(200, "成功"),

    /* 默认失败 */
    COMMON_FAIL(999, "失败"),

    CUSTOM_FAIL(9999, "自定义错误"),

    /* 参数错误：1000～1999 */
    PARAM_NOT_VALID(1001, "参数无效"),
    PARAM_IS_BLANK(1002, "参数为空"),
    PARAM_TYPE_ERROR(1003, "参数类型错误"),
    PARAM_NOT_COMPLETE(1004, "参数缺失"),
    FAIL_COPY_PROPERTIES(1076, "创建对象失败或拷贝对象属性失败"),

    /* 微信小程序登录 */
    WEI_XIN_CODE_ERROR(3001, "携带code向小程序请求失败"),
    WEI_XIN_SKEY_VALID(3002, "skey无效"),

    /* 用户错误 */
    USER_NOT_LOGIN(2001, "用户未登录"),
    USER_ACCOUNT_EXPIRED(2002, "账号已过期"),
    USER_CREDENTIALS_ERROR(2003, "密码错误"),
    USER_CREDENTIALS_EXPIRED(2004, "密码过期"),
    USER_ACCOUNT_DISABLE(2005, "账号不可用"),
    USER_ACCOUNT_LOCKED(2006, "账号被锁定"),
    USER_ACCOUNT_NOT_EXIST(2007, "账号不存在"),
    USER_ACCOUNT_ALREADY_EXIST(2008, "账号已存在"),
    USER_ACCOUNT_USE_BY_OTHERS(2009, "账号下线"),
    USER_IS_EMPTY(2010, "用户为空"),

    /*Token错误*/
    TOKEN_EXPIRED(4001, "登陆信息过期"),
    TOKEN_ERROR(4002, "信息被更改,请重新登陆"),

    /* 业务错误 */
    NO_PERMISSION(5001, "没有权限"),

    /*订单错误*/
    EXISTED_ORDER(6001, "该商品的订单已存在，请支付或取消后再重新下单"),

    /*商品错误*/
    EXISTED_GOOD(7001, "已存在该商品"),
    EXISTED_GOOD_INCART(7002,"购物车中已经存在该商品"),

    /*招投标错误*/
    EXISTED_SUBMISSION(8001,"已经存在该投标了"),
    EXISTED_INVITATION(8002,"已经存在该招标了");

    private Integer code;
    private String message;


    ResultCode(Integer code, String message) {
        this.code = code;
        this.message = message;
    }

    public Integer getCode() {
        return code;
    }

    public ResultCode setCode(Integer code) {
        this.code = code;
        return this;
    }

    public String getMessage() {
        return message;
    }

    public ResultCode setMessage(String message) {
        this.message = message;
        return this;
    }

    /**
     * 根据code获取message
     *
     * @param code 状态码
     * @return String
     */
    public static String getMessageByCode(Integer code) {
        for (ResultCode ele : values()) {
            if (ele.getCode().equals(code)) {
                return ele.getMessage();
            }
        }
        return null;
    }
}

状态码和信息就会一一对应，比较好维护。

DATA

返回数据体，JSON格式，根据不同的业务又不同的JSON体。
我们要设计一个返回体类Result

import java.io.Serializable;

public class CommonResult<T> implements Serializable {
    private Boolean succeed;
    private Integer code;
    private String message;
    private T data;

    public CommonResult() {
    }

    public CommonResult(boolean succeed) {
        this.succeed = succeed;
        this.code = succeed ? ResultCode.SUCCESS.getCode() : ResultCode.COMMON_FAIL.getCode();
        this.message = succeed ? ResultCode.SUCCESS.getMessage() : ResultCode.COMMON_FAIL.getMessage();
    }

    public CommonResult(boolean succeed, ResultCode resultEnum) {
        this.succeed = succeed;
        this.code = succeed ? ResultCode.SUCCESS.getCode() : (resultEnum == null ? ResultCode.COMMON_FAIL.getCode() : resultEnum.getCode());
        this.message = succeed ? ResultCode.SUCCESS.getMessage() : (resultEnum == null ? ResultCode.COMMON_FAIL.getMessage() : resultEnum.getMessage());
    }

    public CommonResult(boolean succeed, T data) {
        this.succeed = succeed;
        this.code = succeed ? ResultCode.SUCCESS.getCode() : ResultCode.COMMON_FAIL.getCode();
        this.message = succeed ? ResultCode.SUCCESS.getMessage() : ResultCode.COMMON_FAIL.getMessage();
        this.data = data;
    }

    public CommonResult(boolean succeed, ResultCode resultEnum, T data) {
        //如多成功true,就走成功的code和message,否者就看传进来的resultEnum
        this.succeed = succeed;
        this.code = succeed ? ResultCode.SUCCESS.getCode() : (resultEnum == null ? ResultCode.COMMON_FAIL.getCode() : resultEnum.getCode());
        this.message = succeed ? ResultCode.SUCCESS.getMessage() : (resultEnum == null ? ResultCode.COMMON_FAIL.getMessage() : resultEnum.getMessage());
        this.data = data;
    }

    public Boolean getSucceed() {
        return succeed;
    }

    public void setSucceed(Boolean succeed) {
        this.succeed = succeed;
    }

    public Integer getCode() {
        return code;
    }

    public void setCode(Integer code) {
        this.code = code;
    }

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }

    public T getData() {
        return data;
    }

    public void setData(T data) {
        this.data = data;
    }

    @Override
    public String toString() {
        return "CommonResult{" +
                "succeed=" + succeed +
                ", code=" + code +
                ", message='" + message + '\'' +
                ", data=" + data +
                '}';
    }
}

控制层Controller

我们会在controller层处理业务请求，并返回给前端，以下面的材料查询为例:

    @GetMapping("/details/{id}")
    public CommonResult<GoodDetailInfoVO> getDetailsByGoodId(@PathVariable Long id) {
        GoodDetailInfoVO goodDetailInfoVO = goodService.getGoodDetailById(id);
        CommonResult<GoodDetailInfoVO>  result = new CommonResult<>(true,ResultCode.SUCCESS,goodDetailInfoVO);
        return result;
    }

如果加上结果封装类ResultUtil类:

public class ResultUtil {
    public static CommonResult success() {
        return new CommonResult(true);
    }

    public static <T> CommonResult<T> success(T data) {
        return new CommonResult(true, data);
    }

    public static CommonResult fail() {
        return new CommonResult(false);
    }

    public static CommonResult fail(ResultCode resultEnum) {
        return new CommonResult(false, resultEnum);
    }
}

材料查询就可以变成这样(更加简洁了):

    @GetMapping("/detail/{id}")
    public CommonResult<GoodDetailInfoVO> getDetailByGoodId(@PathVariable Long id) {
        return ResultUtil.success(goodService.getGoodDetailById(id));
    }

代码比较简洁了，也美观了。

到这里一般都满足日常开发的需求了如果还需要更简洁的话,可以参考以下内容:

优雅优化

上面我们看到在Result类中增加了静态方法，使得业务处理代码简洁了。但小伙伴们有没有发现这样有几个问题：

1、每个方法的返回都是Result封装对象，没有业务含义

2、在业务代码中，成功的时候我们调用Result.success，异常错误调用Result.failure。是不是很多余

3、上面的代码，判断id是否为null，其实我们可以使用hibernate validate做校验，没有必要在方法体中做判断。

我们最好的方式直接返回真实业务对象，最好不要改变之前的业务方式，如下图

img

实现方案

小伙伴们怎么去实现是不是有点思路，在这个过程中，我们需要做几个事情

  • 1、定义一个注解@ResponseResult，表示这个接口返回的值需要包装一下
  • 2、拦截请求，判断此请求是否需要被@ResponseResult注解
  • 3、核心步骤就是实现接口ResponseBodyAdvice和@ControllerAdvice，判断是否需要包装返回值，如果需要，就把Controller接口的返回值进行重写。

注解类

用来标记方法的返回值，是否需要包装

image-20220322171452303

拦截器

拦截请求，是否此请求返回的值需要包装，其实就是运行的时候，解析@ResponseResult注解

img

此代码核心思想，就是获取此请求，是否需要返回值包装，设置一个属性标记。

重写返回体

上面代码就是判断是否需要返回值包装，如果需要就直接包装。这里我们只处理了正常成功的包装，如果方法体报异常怎么办？处理异常也比较简单，只要判断body是否为异常类。

img

怎么做全局的异常处理，篇幅原因，这里就不做介绍了，只要思路理清楚了，自行改造就行。

重写Controller

img

在控制器类上或者方法体上加上@ResponseResult注解，这样就ok了，简单吧。到此返回的设计思路完成，是不是又简洁，又优雅。

总结

这个方案还有没有别的优化空间，当然是有的。如：每次请求都要反射一下，获取请求的方法是否需要包装，其实可以做个缓存，不需要每次都需要解析。当然整体思路了解，小伙伴们就可以在此基础上面自行扩展。谢谢！！！

欢迎点赞关注哦！
也欢迎到访我的博客！小小的博客传送门!

兴趣使然的小小
关注
专栏目录
RESTful API风格指南
程序员光剑
08-06 1352
什么是RESTful API？RESTful API是一种设计风格和开发方式，是一种通过互联网通信的Web服务接口，满足客户端（比如浏览器、移动设备）与服务器端之间信息交换的需求。RESTful API定义了一组规范，旨在使客户端更容易地与服务端通信，屏蔽了底层网络传输协议的复杂性。RESTful API基于HTTP协议，并使用HTTP方法（GET、POST、PUT、DELETE等）、URI和媒体类型（如JSON或XML）。
后台调用Restful
02-17
.net 后台 Restful机制 .
前后端分离，后端restful风格代码
12-16
具体实现和一些配合框架都有
后端接口规范Restful
zhangcongyue的博客
05-06 547
我们的项目是前后端分离的项目，而前后端分离的项目中，很重要的一块是前后端项目数据的交互。在项目中，我们可以使用ResultFul规范来编写统一的前后端交互接口，即我们之前所写的Controller。一、 什么是RestfulRestful【规范】是一种面向资源的架构风格，可以简单理解为：使用URL名词定位资源，用HTTP动词【GET，POST，DELETE，PUT，PATCH】描述操作。客户端使用GET，POST，PUT，DELETE，PATCH来表示操作方式的动词对服务端资源进行操作。
后端开发必备的 RestFul API 知识
烂牙大叔
07-31 1096
RestFul API 是每个程序员都应该了解并掌握的基本知识，我们在开发过程中设计API的时候也应该至少要满足RestFul API的最基本的要求（比如接口中尽量使用名词，使用POST 请求创建资源，DELETE请求删除资源等等，示例：GET /notes/id：获取某个指定id的笔记的信息）。最近学习过程中接触到这些东西，自己没有时间总结，所以分享一些不错的文章给大家。 相关阅...
Restful后台系统搭建（四）
w499614870的博客
04-29 748
上篇文章介绍简单启动Jetty+Jersey服务，并可以通过Jmeter进行简单测试。本章再深入搭建一个Service+Action的框架，还会引入JSON解析工具。 请求的执行流程： web前端 -> Service接口（通过@Path(xxx)访问） -> AbstractAction -> json解析成请求体req -> Action中的校验validate -> Action
认识RESTful
Odyssues_lee的博客
07-03 433
认识RESTful在前后端分离的应用模式里，后端API接口如何定义？例如对于后端数据库中保存了商品的信息，前端可能需要对商品数据进行增删改查，那相应的每个操作后端都需要提供一个API接口：POST /add-goods 增加商品POST /delete-goods 删除商品POST /update-goods 修改商品GET /get-goods 查询商品信息对于接口的请求方式与路径，每个后端开发...
如何使用RESTful API构建petstore后端
### 1.1 什么是RESTful API RESTful API是一种基于HTTP协议的架构风格，用于设计和开发网络应用程序的API。它具有以下特点： - **无状态性**：每个请求都是独立的，服务器不会记录任何客户端的状态信息。 - **资源...
构建RESTful API：Java后端开发的实战教程
![RESTful API](https://www.atatus.com/blog/content/images/size/w1140/2023/06/http-post-request-method.png) # 1. RESTful API概念和设计原则 ## 1.1 RESTful API简介 RESTful API是一种基于HTTP...RESTful设计
后端
02-12
2. **插件化架构** - 它的可扩展性体现在其插件系统，开发者可以安装预建插件或创建自定义插件来增强功能，如用户认证、电子邮件服务、缓存管理等。 3. **RESTful API** - 自动生成的RESTful API使得前端可以直接与...
后端开发教程.zip00000000002
最新发布
04-17
后端开发与AI的结合主要体现在机器学习模型的训练和部署上，如TensorFlow、PyTorch等深度学习框架，以及RESTful API的设计，将模型暴露给前端调用。 七、实践项目 通过实践项目来巩固理论知识，可以参与开源项目、...
restful前后端分离开发笔记
01-23
前后端分离 restful风格 .
基于springMVC 的restful风格接口前后端使用说明
11-18
基于springMVC 的restful风格接口前后端使用说明，方便前后端协作开发
使用restful 方式开发后端接口
itzhangzx的博客
06-14 483
1.restful 软件架构风格―遵循rest设计原则就称之为这个架构是restful架构 rest设计原则: 使用唯一URL替换传递URL 使用四种新的动词对应服务端四种操作 增(Post)删(DELEE)改(PUT、PACH)查GET) 2 .springboot框架对Rest支持 @Restcontroller: 标致这个类是一个controller 将类中所有方法的返回值转为json格式字符串= @Controller+@ResponseBody @RequestMapping: 请求映
后台项目搭建 RestFul风格
工地小张
09-28 215
CGB2105-Day07-Day08 闪耀太阳 2021-07-29 14:52:02 ...
Restful后台系统搭建（二）
w499614870的博客
04-26 1297
上一篇文章介绍了我的这个入门框架的一个简介以及一些依赖，本篇文章继续讲解如何搭建Restful后台系统。 按照文章顺序，我罗列一下本章内容点： 1、包分布以及各个包的作用。 2、持久层的编写与测试类测试持久层。 1、包分布 我以framework为根目录，讲解每一个包的用途 bean，直观的数据类的存放位置，如果把Web服务分为三层，那么第一层是北向层发布接口层，外界调
前端的RESTful API和后端的RESTful API
m0_57021623的博客
11-17 864
而前端的RESTful API通常是指在客户端（比如浏览器端、移动端应用）中调用后端RESTful API的方式和规范。前端的RESTful API通常是通过Ajax、Fetch API或者一些库（比如axios）来发起HTTP请求，按照RESTful规范与后端的API进行交互，包括发送GET、POST、PUT、DELETE等请求，处理返回的数据等。在实际开发中，前后端的工程师会根据约定好的API规范来进行协作，前端工程师会根据后端提供的API文档来调用后端的API，并将获取到的数据展示在用户界面上。
javascript和ajax都有什么具体功能,后端写好的数据如何体现在网页上
06-09
JavaScript是一种运行在浏览器端的编程语言，它可以通过DOM（文档对象模型）和BOM（浏览器对象模型）操作网页，实现交互、动态效果、数据渲染等功能。 AJAX（Asynchronous JavaScript and XML）是一种使用JavaScript和XML（现在一般使用JSON）进行异步数据交互的技术，可以在不刷新页面的情况下，向服务器请求数据并渲染到网页中。 当后端写好数据后，可以通过后端API提供数据的方式，将数据以JSON等格式传递给前端。前端可以通过AJAX请求获取数据，并使用JavaScript将数据渲染到网页中。具体步骤如下： 1. 后端提供数据的API，可以是RESTful API等方式。 2. 前端使用JavaScript编写AJAX请求，请求后端API获取数据。 3. 后端返回数据，前端接收到数据后，使用JavaScript将数据渲染到网页中。 4. 渲染完成后，网页中就能显示后端提供的数据了。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

打赏作者

兴趣使然的小小

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

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

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

打赏作者

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

抵扣说明：

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

余额充值