开发规范与工程搭建#

定义#

在 Tlias 智能学习辅助系统的实战开发中，首先需要建立统一的开发规范并完成基础工程搭建。这包括前后端分离开发模式、RESTful API 风格约定、接口测试工具的使用，以及 SpringBoot 工程的基础结构搭建。

开发规范#

前后端分离开发#

企业项目开发主要有两种模式：前后台混合开发和前后台分离开发。

前后台混合开发的缺点：

沟通成本高：后台发现前端问题需找前端修改，再交回后台
分工不明确：后台开发需同时写前端代码
不便管理：所有代码在一个工程中
难以维护：前端更新需要整个工程重新打包部署

前后台分离开发将工程分为前端工程和后端工程，前端交给专业前端人员，后端交给专业后端人员，双方通过接口文档约定数据格式。

后端开发功能的具体流程：

需求分析：阅读需求文档，分析需求
接口定义：查询接口文档中关于需求的接口定义（地址、参数、响应数据类型等）
前后台并行开发：各自按照接口文档进行开发
测试：各自按照接口文档进行测试
前后端联调测试：前端工程请求后端工程，测试功能

RESTful 风格#

REST（Representational State Transfer），表述性状态转换，是一种软件架构风格。

传统 URL 风格：

http://localhost:8080/user/getById?id=1 — GET：查询 id 为 1 的用户
http://localhost:8080/user/saveUser — POST：新增用户
http://localhost:8080/user/updateUser — POST：修改用户
http://localhost:8080/user/deleteUser?id=1 — GET：删除 id 为 1 的用户

传统 URL 将资源访问行为暴露在外，且不同开发人员命名习惯各异（getById、selectById、queryById），难以统一维护。

基于 REST 风格 URL：

http://localhost:8080/users/1 — GET：查询 id 为 1 的用户
http://localhost:8080/users — POST：新增用户
http://localhost:8080/users — PUT：修改用户
http://localhost:8080/users/1 — DELETE：删除 id 为 1 的用户

核心原则：通过 URL 定位要操作的资源，通过 HTTP 动词（请求方式）来描述具体的操作。

请求方式	操作
GET	查询
POST	新增
PUT	修改
DELETE	删除

注意事项：

REST 是风格、约定方式，约定不是规定，可以打破
描述模块功能通常使用复数（加 s），表示此类资源而非单个资源。如：users、emps、books

Apifox 工具#

Apifox 是一款集成了 API 文档、API 调试、API Mock、API 测试的一体化协作平台。

作用：接口文档管理、接口请求测试、Mock 服务
官网：https://apifox.com/

在前后端并行开发时，由于浏览器只能发起 GET 请求，无法直接测试 POST、DELETE、PUT 等接口，需要借助 Apifox 等接口测试工具完成接口测试。

工程搭建#

创建 SpringBoot 工程#

引入 web 开发起步依赖、MyBatis、MySQL 驱动、Lombok。

数据库准备#

创建 tlias 数据库，准备 dept 部门表：

1
CREATE TABLE dept (
2
  id int unsigned PRIMARY KEY AUTO_INCREMENT COMMENT 'ID, 主键',
3
  name varchar(10) NOT NULL UNIQUE COMMENT '部门名称',
4
  create_time datetime DEFAULT NULL COMMENT '创建时间',
5
  update_time datetime DEFAULT NULL COMMENT '修改时间'
6
) COMMENT '部门表';
7

8
INSERT INTO dept VALUES (1,'学工部','2023-09-25 09:47:40','2024-07-25 09:47:40'),
9
                      (2,'教研部','2023-09-25 09:47:40','2024-08-09 15:17:04'),
10
                      (3,'咨询部','2023-09-25 09:47:40','2024-07-30 21:26:24'),
11
                      (4,'就业部','2023-09-25 09:47:40','2024-07-25 09:47:40'),
12
                      (5,'人事部','2023-09-25 09:47:40','2024-07-25 09:47:40'),
13
                      (6,'行政部','2023-11-30 20:56:37','2024-07-30 20:56:37');

application.yml 配置#

1
spring:
2
  application:
3
    name: tlias-web-management
4
  datasource:
5
    driver-class-name: com.mysql.cj.jdbc.Driver
6
    url: jdbc:mysql://localhost:3306/tlias
7
    username: root
8
    password: 1234
9
mybatis:
10
  configuration:
11
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

基础代码结构#

实体类 Dept：

1
package com.itheima.pojo;
2

3
import lombok.AllArgsConstructor;
4
import lombok.Data;
5
import lombok.NoArgsConstructor;
6
import java.time.LocalDateTime;
7

8
@Data
9
@NoArgsConstructor
10
@AllArgsConstructor
11
public class Dept {
12
    private Integer id;
13
    private String name;
14
    private LocalDateTime createTime;
15
    private LocalDateTime updateTime;
16
}

统一响应结果 Result：

1
package com.itheima.pojo;
2

3
import lombok.Data;
4
import java.io.Serializable;
5

6
@Data
7
public class Result {
8
    private Integer code;  // 编码：1成功，0失败
9
    private String msg;    // 错误信息
10
    private Object data;   // 数据
11

12
    public static Result success() {
13
        Result result = new Result();
14
        result.code = 1;
15
        result.msg = "success";
16
        return result;
17
    }
18

19
    public static Result success(Object object) {
20
        Result result = new Result();
21
        result.data = object;
22
        result.code = 1;
23
        result.msg = "success";
24
        return result;
25
    }
26

27
    public static Result error(String msg) {
28
        Result result = new Result();
29
        result.msg = msg;
30
        result.code = 0;
31
        return result;
32
    }
33
}

基础骨架类：

1
// DeptMapper
2
@Mapper
3
public interface DeptMapper {
4
}
5

6
// DeptService
7
public interface DeptService {
8
}
9

10
// DeptServiceImpl
11
@Service
12
public class DeptServiceImpl implements DeptService {
13
}
14

15
// DeptController
16
@RestController
17
public class DeptController {
18
}

常见场景#

新项目启动时，首先确定前后端分离架构和接口规范
使用 Apifox 管理 API 文档，前后端并行开发
规范 RESTful 风格的 URL 设计，保证团队协作一致性

注意事项#

REST 是约定而非强制规范，特殊场景可打破
资源路径建议使用复数形式（如 /depts）
接口文档是前后端协作的核心契约，后端必须严格遵守
SpringBoot 工程中 Lombok 可简化实体类代码，减少样板代码

团子和蛋糕

开发规范与工程搭建

开发规范与工程搭建#

定义#

开发规范#

前后端分离开发#

RESTful 风格#

Apifox 工具#

工程搭建#

创建 SpringBoot 工程#

数据库准备#

application.yml 配置#

基础代码结构#

常见场景#

注意事项#

评论区

音乐

团子和蛋糕

开发规范与工程搭建

开发规范与工程搭建

开发规范与工程搭建#

定义#

开发规范#

前后端分离开发#

RESTful 风格#

Apifox 工具#

工程搭建#

创建 SpringBoot 工程#

数据库准备#

application.yml 配置#

基础代码结构#

常见场景#

注意事项#

相关阅读

评论区

音乐