7. RdvMedecins 服务器,一个黑盒
示例 22 至 25 以及案例研究都与一个服务器交互:即[RdvMedecins]应用的 JSON 服务器。它就是上一课中的[NestJS]服务器,其控制器不再生成 HTML 页面,而是生成 JSON 响应。它的业务层和数据访问层保持不变。
在本课程中,这个服务器是一个黑盒:我们无需知道它是如何编写的。重要的只是它的API——也就是它接受的 HTTP 请求列表以及它返回的响应。这是客户端开发人员的典型处境:API 是一份契约,服务器团队可以在这份契约背后随意更改任何内容。对于好奇的读者,我们提供了它的源代码([rdvmedecins-nestjs-json]文件夹),并附有详尽的注释。
本章说明如何安装该服务器,描述其 API,并使用[curl]对其进行查询。
7.1. RdvMedecins 应用
该应用用于管理一家医疗诊所的预约。它有三种角色:
角色 | 对象 | 可执行的操作 |
[ADMIN] | 管理员([admin]) | 为所有患者安排和取消预约;管理医生和客户 |
[DOCTOR] | 医生([pelissier]、[tatou]、[dupont]) | 为所有患者安排和取消预约;在日历中查看所有姓名 |
[USER] | 患者([martin]、[durand]、[bistrou]、[german]) | 为自己预约;取消自己的预约;管理自己的账户。在日历中,他们看不到其他患者的姓名 |
演示账户使用其登录名作为密码。管理规则由服务器验证,与客户端无关:
- 不允许预约过去的时间;
- 每位患者只能有一个即将到来的预约;
- 同一时间段每天只能被预约一次;
- 两位医生(或两位客户)不能拥有相同的姓和名;一个登录名只属于一个账户;
- 有预约的医生不能被删除;
- 在此期间已被他人修改的记录不能被覆盖(乐观锁);
- 患者绝不会被分配到另一位患者的姓名。
7.2. 安装
你需要[Node.js] 以及一个[MySQL] (或[MariaDB])服务器:附录中介绍了它们的安装方法。
1. 数据库。脚本[database/dbrdvmedecins2.sql] 会创建数据库[dbrdvmedecins2]、它的表以及示例数据。使用[Laragon]时,在[HeidiSQL] 中运行它(“文件”菜单 / 运行 SQL 文件);在命令行中:
该脚本总是从一个空数据库开始:你可以重新运行它来恢复初始数据。
2. 库。在打开到[rdvmedecins-nestjs-json]文件夹的控制台窗口中:
3. 配置。将文件[.env.example] 复制为[.env] (在[Windows]下:[copy .env.example .env]),然后修改它:
- 第 8 行:服务器监听 8080 端口;
- 第 12–16 行:与[MySQL]的连接。使用[Laragon]时,用户[root] 没有密码:默认值即可;
- 第 25 行:用于签署身份验证令牌的密钥;
- 第 38–45 行:反机器人保护(多次登录失败后锁定、每小时创建的账户数量);
- 第 51 行:验证码(CAPTCHA)测试模式。登录页面要求用户重新输入图片中的字符,这在控制台中是无法做到的。如果该变量有值,则该值会被接受为任何验证码的答案,类似于[Google] 为其[reCAPTCHA]提供的“测试密钥”。对于本章中使用[curl] 进行的测试,请输入[CAPTCHA_TEST=test]。在生产环境中请将其保持为空;
- 第 57–59 行:两项生产环境的设置(参见“部署”一章)。
4. 启动。
控制台显示(节选):
如果数据库无法访问([MySQL]服务器已停止、密码错误),服务器会立即停止,并显示连接错误消息。
7.3. 响应格式
所有 URL 都以[/api]开头。成功的请求会收到 2xx 状态码,并在响应体中收到 JSON 格式的所请求数据。被拒绝的请求会收到 4xx 或 5xx 状态码,并在响应体中收到同样格式的数据:
- [statusCode]:HTTP 状态码,在响应体中重复出现;
- [key]:消息的翻译键。服务器从不返回要显示的文本:它不再知道用户的语言。由客户端使用其字典翻译该键(参见示例 21);
- [params] (可选):消息参数([At least {min} characters], [Try again in {minutes} minute(s)]);
- [fields] (可选):对于被拒绝的表单,给出每个字段的错误。
使用的状态码:
状态码 | 含义 | 键的示例 |
400 | 无效请求 | [ERRORS.INVALID_FORM] (+ fields)、[ERRORS.INVALID_DATE]、[ERRORS.WRONG_CAPTCHA]、[ERRORS.CHOOSE_PATIENT]、[ERRORS.WRONG_CURRENT_PASSWORD]、[ERRORS.BAD_REQUEST]…… |
401 | 未通过身份验证 | [ERRORS.AUTH_REQUIRED] (无令牌)、[ERRORS.SESSION_EXPIRED] (令牌无效或已过期)、[LOGIN.ERROR] |
403 | 拒绝访问 | [ERRORS.FORBIDDEN] (角色权限不足)、[ERRORS.CAPTCHA_BEFORE_ACCOUNT] (没有通行令牌) |
404 | 未找到 | [ERRORS.NOT_FOUND]、[ERRORS.DOCTOR_NOT_FOUND]、[ERRORS.APPOINTMENT_NOT_FOUND]…… |
409 | 违反业务规则 | [ERRORS.PAST_DATE]、[ERRORS.SLOT_ALREADY_BOOKED]、[ERRORS.LOGIN_TAKEN]、[ERRORS.CONCURRENT_UPDATE]…… |
415 | 非 JSON 格式的 POST | [ERRORS.JSON_REQUIRED] |
429 | 尝试次数过多 | [ERRORS.TOO_MANY_ATTEMPTS]、[ERRORS.TOO_MANY_ACCOUNTS] (+ params.minutes) |
500 | 服务器错误 | [ERRORS.SERVER_ERROR] |
7.4. 身份验证
客户端使用[POST /api/auth/login]进行身份验证,提交用户名、密码和验证码答案。作为回应,服务器会在浏览器中放置一个Cookie,其中包含已签名的 JWT 令牌:
它的属性对安全性很重要:
- [HttpOnly]:页面的[JavaScript]代码无法读取此 Cookie。因此,注入页面的恶意脚本无法窃取令牌。对客户端的影响是:它无法自行判断是否已登录,而要询问服务器([GET /api/auth/me]);
- [Path=/api]:浏览器仅在发往 API 的请求中携带它;
- [SameSite=Strict]:浏览器仅在从此站点的页面发出的请求中携带该令牌。另一个站点上的恶意页面无法让浏览器代表用户执行操作(即所谓的 CSRF 攻击);
- [Max-Age=7200]:它在两小时后过期,与令牌的过期时间一致。
此后,浏览器会在发往[/api]的每个请求中自动发送这个 Cookie。因此,只要页面和 API 共享[Angular] 客户端的同源 (相同的协议、相同的机器、相同的端口),客户端就无需做任何事情来验证自己的身份。这就是[Angular]开发服务器上代理的作用(参见示例 22),在生产环境中则由服务器自身承担(参见“部署”一章)。
针对 CSRF 攻击的第二重保护:服务器会拒绝(415)任何请求体不是 JSON 的 POST 请求。其他站点上被篡改的 HTML 表单无法发送 JSON。
7.5. API
方法 | 地址 | 角色 | 发送的/响应的请求体 |
GET | [/api/captcha] | 公开 | 响应:[{ id, svg }] |
POST | [/api/auth/login] | 公开 | [{ login, password, captchaId, captcha }];响应:[{ login, name, role }] + Cookie |
POST | [/api/auth/logout] | 公开 | [{}];删除 Cookie |
GET | [/api/auth/me] | 已登录 | 响应:[{ login, name, role }] |
GET | [/api/schedule?doctorId=&day=] | 全部 | 响应:日程(未指定 doctorId 时:对 DOCTOR 而言,返回其本人的日程) |
POST | [/api/appointments] | 全部 | [{ day, slotId, clientId }](对于 USER,clientId 会被忽略);201 |
DELETE | [/api/appointments/:id] | 全部 | USER 只能取消自己的预约 |
GET | [/api/doctors] | 全部 | 列表(对 ADMIN 包含 login) |
GET | [/api/clients] | ADMIN, DOCTOR | 列表(对 ADMIN 包含 login) |
GET | [/api/doctors/:id]、[/api/clients/:id] | ADMIN | 一条记录 |
POST | [/api/doctors]、[/api/clients] | ADMIN | [{ title, firstName, lastName, login?, password? }];201 |
PUT | [/api/doctors/:id]、[/api/clients/:id] | ADMIN | [{ title, firstName, lastName, login?, password?, version }] |
DELETE | [/api/doctors/:id]、[/api/clients/:id] | ADMIN | 响应:[{}] |
POST | [/api/register/access] | 公开 | [{ captchaId, captcha }];颁发令牌(Cookie) |
GET | [/api/register/access] | 公开 | 响应:[{ valid }] |
POST | [/api/register] | 公开 + 通行令牌 | [{ title, firstName, lastName, login, password, confirmation }];201 |
GET | [/api/my-area] | USER | 响应:[{ patient, appointments }] |
GET | [/api/my-account] | USER | 响应:[{ title, firstName, lastName, login, version }] |
PUT | [/api/my-account] | USER | [{ title, firstName, lastName, login, password?, confirmation?, currentPassword, version }] |
DELETE | [/api/my-account] | USER | [{ currentPassword }];删除账户及其预约 |
日程条目([GET /api/schedule])描述一个时间段,以及已登录用户被授权对它执行的操作:
- [free]:该时间段在当天是否可用?
- [patient]:该预约的患者。对于已登录的患者,该值等于 [null],但他们自己的预约除外:绝不会发送其他患者的姓名;
- [mine]:这是已登录患者自己的预约;
- [bookable]:用户能否预订该时间段(可用、不在过去,并且对患者而言没有未来的预约)?
- [appointmentId]:如果用户可以取消该预约,则会设置该值。
服务器负责决定,客户端负责显示。即使客户端作弊(在不应显示时显示“预订”按钮),服务器在预订时也会再次核实一切。
7.6. 使用 curl 查询 API
服务器上的 [curl] 文件夹包含本章使用的 JSON 请求体,每个请求一个文件。例如 [curl/login-admin.json]:
命令在打开于 [rdvmedecins-nestjs-json] 目录的控制台中输入。[curl] 的一些选项:
- [-i]:同时显示响应头;[-s]:不显示进度条;
- [--json @file]:以 POST 方式发送文件内容,并带有请求头 [Content-Type: application/json] (curl 7.82 及更高版本;如果是旧版本,请使用 [-H "Content-Type: application/json" -d @file]);
- [-X PUT]、[-X DELETE]:HTTP 方法;
- [-c cookies.txt]:将收到的 Cookie 保存到该文件;[-b cookies.txt]:将它们发回。[curl] 就是这样在一条命令到下一条命令之间“保持登录”的,和浏览器的做法一样。
在 [PowerShell] 下,必须输入 [curl.exe] 而不是 [curl] (在那里它指的是另一条命令)。为便于阅读,本文档对较长的 JSON 响应做了格式化,并去掉了 [Date]、[ETag]、[Connection]、和 [Keep-Alive] 这几个响应头。
7.6.1. 登录
首先是验证码(CAPTCHA,图像已裁剪):
没有令牌时,受保护的 URL 会返回 401 响应:
错误的验证码,随后是错误的密码:
登录成功会设置 Cookie,[curl] 将其存储在 [cookies.txt] 中:
有了这个 Cookie,服务器就知道我们是谁:
伪造的(或已过期的)令牌会导致会话过期,服务器会指示浏览器删除该 Cookie:
7.6.2. 医生、客户、日程
ADMIN 看到的医生列表(含登录名):
PELISSIER 医生 2030 年 1 月 15 日的日程:
不存在的日期:
7.6.3. 预约
ADMIN 为 2 号患者(Alice DURAND)预订 3 号时间段。请求体:
日程现在显示了这个预约,以及患者的姓名和取消它的方式([appointmentId]):
再试一次:该患者已有一个未来的预约。过去的预约同样会被拒绝:
标准的 HTML 表单(此处用 [-d] 模拟,它发送 [application/x-www-form-urlencoded])会被拒绝:
7.6.4. 患者的视角
先注销,然后以 [martin] 身份登录:
患者看到的同一份日程:3 号时间段已被占用(["free": false]),但 ["patient"] 等同于 [null]:没有发送 Alice 的姓氏 DURAND:
患者无权访问客户列表:
他为自己预订(请求体不包含 [clientId]),一次成功,第二次则被拒绝:
他的区域:
他无法取消其他患者的预约。服务器会返回“未找到”,就像该预约不存在一样:它不会泄露任何关于其他患者预约的信息:
他自己的预约则可以:
7.6.5. 医生的视角
不带 [doctorId] 时,已登录的医生会收到他自己的日程,其中包含所有姓名:
他不能管理医生:
7.6.6. 管理医生和客户(ADMIN)
添加。如果缺少用户名,默认使用小写的姓名;密码即用户名:
无效的请求体:响应会列出每个字段的错误:
同名情况:两个相关字段都会被标记:
修改。[version] 是从记录中读取的版本(此处为 1):
记录现在是版本 2。如果再次提交同一修改(带有版本 1),就会覆盖已被他人修改过的记录:乐观锁 可以防止这种情况:
有预约的医生不能被删除;其他医生可以:
7.6.7. 创建账户
没有通行码,就无法创建:
首先,你要解答一个验证码(CAPTCHA);服务器会签发一个有效期为 15 分钟的令牌,存放在 Cookie 中:
确认密码必须与密码一致:
该通行码已被使用:不能再用它创建第二个账户:
7.6.8. 管理你的账户
新患者登录并读取她的账户记录:
修改需要提供当前密码。服务器会签发一个包含新姓名的新令牌:
删除账户的同时也会删除 Cookie:
7.6.9. 一些错误
未知的路由,以及不是有效 JSON 的请求体:
关于服务器,我们现在已经掌握了编写客户端所需知道的一切。