Skip to content

Commit 55d5ac4

Browse files
2 parents 6309dc9 + d0495ec commit 55d5ac4

File tree

1 file changed

+10
-12
lines changed

1 file changed

+10
-12
lines changed

README_ZH.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,25 @@
11
# [敏捷开关](https://featureflag.co) 微信小程序 SDK
22
[Check English version](./README.md)
33

4+
45
**[查看 demo](./demos/README_ZH.MD)**
56

6-
## 发布小程序前请确保已将 https://api.featureflag.co 添加到小程序合法域名中
7+
**发布小程序前请确保已将 https://api.featureflag.co 添加到小程序合法域名中**
78

89
## 概述
9-
1010
SDK 主要完成以下工作:
11-
- 从服务端获取 feature flags 并保持数据并保持和服务端数据的同步
11+
- 从服务端获取 feature flags 并保持和服务端数据的同步
1212

1313
## 数据同步
14-
SDK 使用 WebSocket 来保持与服务端的数据同步,获取数据后存入 localStorage. 无论何时当任意 feature flag 发生变化时,变更会被接近实时地推送到 SDK, 经过测试,同步过程平均耗时少于 **100** ms. 当网络发生中断时数据同步会停止,当网络恢复后 SDK 会自动重新建立 WebSocket 连接
14+
SDK 使用 WebSocket 来保持与服务端的数据同步,从服务端获取的数据均会存入 localStorage无论何时当任意 feature flag 发生变化时,变更会被接近实时地推送到 SDK经过测试,同步过程平均耗时少于 **100 ms**。当网络发生中断时 SDK 会尝试以渐增的时间间隔与服务器重新建立连接,及时恢复数据同步
1515

1616
## 离线模式
17-
所有数据都存储于本地 localStorage, 所以在以下情况下,在没有网络的情况下 SDK 仍能正常工作:
18-
- SDK 已经从之前的连接中取得过数据
19-
- ffcClient.bootstrap(featureFlags) 方法被调用, 并且 featureFlags 参数包含所有当前使用中的 feature flags
20-
21-
与此同时,SDK 会尝试以渐增的时间间隔重新与服务器建立连接以确保网络恢复后第一时间恢复与服务器的数据同步。
17+
SDK 所需的所有数据都存储于本地 localStorage, 因此在没有网络的环境中,满足下述条件之一的情况下,SDK 仍能正常工作:
18+
- SDK 已经从之前的 WebSocket 连接中取得过数据
19+
- ffcClient.bootstrap(featureFlags) 方法被手动调用, 并且 featureFlags 参数包含所有当前使用中的 feature flags
2220

2321
## feature flag 的计算
24-
由于所有数据都在本地,所有计算过程也都在本地,并且是实时同步计算的。计算过程时间复杂度 O(1), 小于 1 ms。
22+
所有数据都在本地,所有计算过程也都在本地,并且是实时同步计算的。计算过程时间复杂度 O(1), 小于 1 ms。
2523

2624
## 集成 SDK
2725
### 使用 npm
@@ -75,7 +73,7 @@ App({
7573
}
7674
};
7775

78-
// initialization client
76+
// initialize client
7977
ffcClient.init(option);
8078

8179
// set user,this usually happens after login
@@ -284,4 +282,4 @@ ffcClient.on('ff_update:feature_flag_key', (change) => {
284282
...
285283
});
286284

287-
```
285+
```

0 commit comments

Comments
 (0)