vault backup: 2026-05-13 11:17:21
This commit is contained in:
@@ -17,12 +17,48 @@ FieldMask 是 protobuf WKT 中最实用的工具类类型之一，用于实现 *
|
||||
```protobuf
|
||||
import "google/protobuf/field_mask.proto";
|
||||
|
||||
message User {
|
||||
string display_name = 1;
|
||||
string email = 2;
|
||||
string phone = 3;
|
||||
string avatar = 4;
|
||||
}
|
||||
|
||||
message UserPatchRequest {
|
||||
google.protobuf.FieldMask update_mask = 1; // 告诉服务端要改哪些字段
|
||||
User user = 2; // 只填新值
|
||||
google.protobuf.FieldMask update_mask = 1;
|
||||
User user = 2;
|
||||
}
|
||||
```
|
||||
|
||||
**关键：`update_mask` 中的字段名来自 `User` 的定义。**
|
||||
它本身不包含字段信息，只引用被包裹的 `user` message 中已存在的字段名。
|
||||
例如 `"display_name,email"` 意味着用 `req.user.display_name` 和 `req.user.email` 的值去覆盖现有记录。
|
||||
如果 mask 中提到的字段在 `User` 里不存在，`ApplyFieldMask` 会返回 `InvalidArgument` 错误。
|
||||
|
||||
> [!warning] Proto 层无约束 —— 全靠服务端约定
|
||||
> 从 proto 定义来看，`google.protobuf.FieldMask` 的内部结构只是：
|
||||
>
|
||||
> ```protobuf
|
||||
> message FieldMask {
|
||||
> repeated string paths = 1;
|
||||
> }
|
||||
> ```
|
||||
>
|
||||
> 它是一个**通用的字符串列表**，与任何具体的 target message 都没有绑定关系。
|
||||
> 这解释了为什么 `update_mask` 字段上不会标注「只能填 display_name 或 email」。
|
||||
>
|
||||
> **字段名的关联是在服务端代码中建立的：**
|
||||
>
|
||||
> ```go
|
||||
> proto.ApplyFieldMask(&existingUser, req.GetUser())
|
||||
> // ↑ ↑
|
||||
> // target 决定哪些字段可被更新
|
||||
> ```
|
||||
>
|
||||
> - `target`（第一个参数）是 `User` → 所以 mask 里的值只能是 `display_name`、`email`、`phone`、`avatar`
|
||||
> - `source`（第二个参数）提供新值 → 只有被 mask 指定的字段才会取 `source` 中的值
|
||||
> - 如果客户端传了 mask 中没有的字段（如 `wechat_id`），且该字段在 `User` 中不存在，`ApplyFieldMask` 会报错
|
||||
|
||||
两个核心约定：
|
||||
|
||||
| 字段 | 含义 | JSON 表现形式 |
|
||||
@@ -86,6 +122,95 @@ FieldMask 支持用点号访问嵌套字段，例如：
|
||||
> [!note] 点号路径要求目标字段也必须存在
|
||||
> `ApplyFieldMask` 在遇到不存在的嵌套路径时会返回错误。调用方需确保结构完整，或使用 null-safe 路径语法（需自行处理）。
|
||||
|
||||
## 底层机制：字符串到字段的映射过程
|
||||
|
||||
`ApplyFieldMask` 的核心链路可以分解为三步：
|
||||
|
||||
### 第 1 步：把字符串拆成字段路径
|
||||
|
||||
`update_mask` 的值 `"display_name,email"` 在传输时已经被 protobuf JSON 反序列化器转成了 Go 的 `[]string{"display_name", "email"}`。protobuf 的 FieldMask 类型定义只是：
|
||||
|
||||
```protobuf
|
||||
message FieldMask {
|
||||
repeated string paths = 1;
|
||||
}
|
||||
```
|
||||
|
||||
所以到了 `ApplyFieldMask` 调用点，它就是一个普通的字符串切片——**里面只有名字，没有任何元数据**。
|
||||
|
||||
### 第 2 步：通过反射查找字段描述符
|
||||
|
||||
Go protobuf 的反射 API 提供了 `protoreflect.Fields`，内部用一个 map 存储所有字段：
|
||||
|
||||
```go
|
||||
fd := md.Fields().ByName(protoreflect.Name(field))
|
||||
```
|
||||
|
||||
以 `field = "display_name"` 为例：
|
||||
|
||||
| 查找方式 | 源码 | 匹配结果 |
|
||||
|---------|------|---------|
|
||||
| `ByName` | `md.Fields().ByName("display_name")` | ✅ 找到 `User.display_name` |
|
||||
| `ByJSONName` | `md.Fields().ByJSONName("displayName")` | ✅ 找 JSON 别名 |
|
||||
| `ByNumber` | `md.Fields().ByNumber(1)` | ✅ 按字段编号 |
|
||||
|
||||
`ApplyFieldMask` 使用 `ByName`——**匹配的是 proto 文件中声明的原始字段名**（即 `display_name`），不是 JSON camelCase 名。如果你的 proto 写成 `displayName`（驼峰），那 mask 里就必须传 `"displayName"`。
|
||||
|
||||
### 第 3 步：反射赋值
|
||||
|
||||
找到 `FieldDescriptor` 后，protobuf 用反射完成值传递：
|
||||
|
||||
```go
|
||||
// ApplyFieldMask 内部的等价逻辑（伪代码）：
|
||||
fd := dst.Descriptor().Fields().ByName("display_name")
|
||||
dst.Set(fd, src.Get(fd))
|
||||
// ↑ 等价于手写：existingUser.DisplayName = req.User.DisplayName
|
||||
```
|
||||
|
||||
如果是嵌套路径 `"profile.display_name"`，则先解析出 `profile` 的 descriptor，再通过 `fd.Message()` 进入嵌套 message，对第二段 `"display_name"` 重复上述流程。
|
||||
|
||||
> [!note] 运行时校验
|
||||
> 由于整个过程是「字符串 → 反射查找 → 赋值」，如果 mask 中包含了一个根本不在 User message 里的字段名（如 `"wechat_id"`），`ByName` 会返回 nil，此时 `ApplyFieldMask` 立即返回错误。**proto 编译器不会检查这种跨消息引用的合法性**，校验全部依赖运行时的反射查找。
|
||||
|
||||
### 谁来决定 `update_mask` 的值？
|
||||
|
||||
`"display_name,email"` 这个值 **不是由任何代码生成的**——它是调用方（client）自己决定的。
|
||||
|
||||
整个链路中没有任何机制在编译期或运行期约束 "只能选这几个字段名"：
|
||||
|
||||
| 环节 | 做什么 | 有没有强制约束？ |
|
||||
|------|--------|-----------------|
|
||||
| **客户端** | UI 表单检测到用户改了名字和邮箱 → 拼出 `update_mask = "display_name,email"` | ❌ 纯业务逻辑 |
|
||||
| **Proto 定义** | 声明 `FieldMask update_mask = 1` | ❌ 只是一个开放字符串列表 |
|
||||
| **网络传输** | 把字符串发给服务端 | ❌ 不做任何校验 |
|
||||
| **服务端** | 收到值后，用反射逐个查找是否在 `User` 中存在 | ✅ 只拒绝非法字段名 |
|
||||
|
||||
```mermaid
|
||||
sequenceDiagram
|
||||
participant Client as 前端 / CLI
|
||||
participant Network as gRPC Client
|
||||
participant Server as Server
|
||||
|
||||
Client->>Network: 用户改了 display_name 和 email
|
||||
Note over Client,Network: ① 开发者自己决定要改哪些字段
|
||||
activate Network
|
||||
Network->>Server: serialize({ update_mask: "display_name,email", user: {...} })
|
||||
deactivate Network
|
||||
activate Server
|
||||
Server->>Server: ApplyFieldMask(target, source)
|
||||
Note right of Server: 反射校验：display_name? yes<br/>email? yes → 赋值 ✓
|
||||
Server-->>Client: { ... updated User ... }
|
||||
deactivate Server
|
||||
```
|
||||
|
||||
这意味著：
|
||||
|
||||
1. **协议本身不限制可选值**——客户端理论上可以传任何字符串，包括 `"hello_world"`、`"random_value"`
|
||||
2. **只有服务端在做兜底**——你传了个 `"wechat_id"` 会报错说这个字段不存在
|
||||
3. **客户端的合理做法**是在 UI 层面维护一份可用的字段白名单，根据哪些字段被修改来自动生成 mask
|
||||
|
||||
所以 `"display_name,email"` 的本质是：**开发人员在客户端知道用户改了这两个字段，于是手动把它们填进了 mask 里**。没有框架在背后自动生成它。
|
||||
|
||||
## 客户端最佳实践
|
||||
|
||||
### Go 构造示例
|
||||
@@ -118,7 +243,7 @@ const req = {
|
||||
| 坑 | 说明 | 规避方法 |
|
||||
|----|------|---------|
|
||||
| 空 mask | `update_mask` 为空数组时不会报错，但也不会更新任何字段 | 在服务层校验 `len(mask.Paths) > 0` |
|
||||
| 大小写敏感 | 字段名严格匹配 camelCase（JSON 映射后的格式），不支持 snake_case | 前端统一使用 proto 定义的 CamelCase |
|
||||
| 大小写敏感 | `ByName` 匹配的是 proto 文件中声明的原始字段名。proto 写成 `display_name` 则 mask 必须传 `"display_name"`；写成 `displayName` 则传 `"displayName"` | 保持 proto 定义与 mask 中的命名一致 |
|
||||
| 字段不存在 | mask 中提到不存在的字段会抛出 `InvalidArgument` 错误 | 服务端捕获并返回清晰错误信息 |
|
||||
| Oneof 冲突 | 对 oneof 组中的一个字段应用 mask 时，其他 oneof 字段会被清除 | 业务逻辑中提前规避互斥冲突 |
|
||||
|
||||
@@ -143,4 +268,4 @@ graph LR
|
||||
## 关联笔记
|
||||
|
||||
- [[hhs/gRPC/1. Protobuf 基础篇/02-数据类型详解]] — WKT 类型的概览入口，FieldMask 是其中的一种
|
||||
- [[hhs/gRPC/2. gRPC 实战指南/01-RPC 设计与 RESTful 对应]] — RPC 与 RESTful API 的语义对照，PATCH 场景在此展开
|
||||
- [[../../2. gRPC 核心篇/07-HTTP2 传输原理/07-RPC 设计与 RESTful 对应]] — RPC 与 RESTful API 的语义对照，PATCH 场景在此展开
|
||||
|
||||
Reference in New Issue
Block a user