开发模式

目前主流的开发模式为：前后端分离开发

前后端分离开发

• 开发流程：
  • 需求分析->接口设计(阅读API接口文档)->前后端分离开发->测试->部署上线
• 上面是整个项目的开发流程，具体业务开发请查看，业务功能开发流程。

开发规范-RESTful

• REST（Representational State Transfer）表述性状态转换，是一种基于Web的架构风格，强调资源的表现形式和状态转移。
• 简单来说，RESTful风格就是用请求方式(GET、POST、PUT、DELETE)来表示对资源模块的操作。而不是通过具体的动作(如/getById)来表示操作。

传统开发和RESTful开发的区别

• RESTful开发的特点
  • 统一接口：使用标准的HTTP方法（GET、POST、PUT、DELETE）来操作资源。
• RESTful四种请求方式及对应操作
  • GET：查询
  • POST：新增
  • PUT：修改
  • DELETE：删除

RESTful API设计原则

• 资源导向：每个资源都有唯一的URI表示，如/users
• 使用HTTP方法：使用GET、POST、PUT、DELETE等HTTP方法来表示对资源的操作。
• 无状态性：每个请求都应包含所有必要的信息，服务器不应存储客户端状态。
• 支持多种数据格式：通常使用JSON或XML作为数据交换格式。
• 分页和过滤：对于大量数据的查询，支持分页和过滤参数。
• 错误处理：使用标准的HTTP状态码来表示请求的结果，如404表示资源未找到，500表示服务器错误。

示例

• 资源：用户（User）
• API设计：

HTTP方法	URI	描述
GET	/users	查询所有用户
GET	/users/	查询指定ID的用户
POST	/users	创建新用户
PUT	/users/	更新指定ID的用户
DELETE	/users/	删除指定ID的用户

• 通过遵循RESTful设计原则，可以使API更加清晰、易于理解和维护，有助于前后端的协作开发。

开发规范-统一响应结果

为了前后端交互统一响应结果格式，一般会定义一个统一的响应结果类Result，例如：

@Data
@NoArgsConstructor
@AllArgsConstructor
public class Result {
    private Integer code;//响应码，1 代表成功; 0 代表失败
    private String msg;  //响应信息 描述字符串
    private Object data; //返回的数据

    //增删改 成功响应
    public static Result success(){
        return new Result(1,"success",null);
    }
    //查询 成功响应
    public static Result success(Object data){
        return new Result(1,"success",data);
    }
    //失败响应
    public static Result error(String msg){
        return new Result(0,msg,null);
    }
}

业务功能开发流程

查看页面原型明确需求->阅读接口文档->开发思路分析->接口开发->接口测试->前后端联调