1# 消息摘要计算(ArkTS)
2
3对应的算法规格请查看[消息摘要计算算法规格](crypto-generate-message-digest-overview.md#支持的算法与规格)。
4
5> **说明：**
6>
7> 从API version 12开始，轻量级智能穿戴设备支持消息摘要的计算与操作。
8
9## 开发步骤
10
11在调用update接口传入数据时，可以[一次性传入所有数据](#摘要算法一次性传入)，也可以把数据人工分段，然后[分段update](#分段摘要算法)。对于同一段数据而言，计算结果没有差异。对于数据量较大的数据，开发者可以根据实际需求选择是否分段传入。
12
13下面分别提供两种方式的示例代码。
14
15
16### 摘要算法（一次性传入）
17
181. 调用[cryptoFramework.createMd](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#cryptoframeworkcreatemd)，指定摘要算法SHA256，生成摘要实例（Md）。
19
202. 调用[Md.update](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#update-6)，传入自定义消息，进行摘要更新计算。单次update长度没有限制。
21
223. 调用[Md.digest](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#digest)，获取摘要计算结果。
23
244. 调用[Md.getMdLength](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#getmdlength)，获取摘要计算长度，单位为字节。
25
26- 以使用await方式单次传入数据，获取摘要计算结果为例：
27
28  ```ts
29  import { cryptoFramework } from '@kit.CryptoArchitectureKit';
30  import { buffer } from '@kit.ArkTS';
31
32  async function doMd() {
33    let mdAlgName = 'SHA256'; // 摘要算法名
34    let message = 'mdTestMessgae'; // 待摘要的数据
35    let md = cryptoFramework.createMd(mdAlgName);
36    // 数据量较少时，可以只做一次update，将数据全部传入，接口未对入参长度做限制
37    await md.update({ data: new Uint8Array(buffer.from(message, 'utf-8').buffer) });
38    let mdResult = await md.digest();
39    console.info('Md result:' + mdResult.data);
40    let mdLen = md.getMdLength();
41    console.info("md len: " + mdLen);
42  }
43  ```
44
45- 以使用同步方式单次传入数据，获取摘要计算结果为例：
46
47  ```ts
48  import { cryptoFramework } from '@kit.CryptoArchitectureKit';
49  import { buffer } from '@kit.ArkTS';
50
51  function doMdBySync() {
52    let mdAlgName = 'SHA256'; // 摘要算法名
53    let message = 'mdTestMessgae'; // 待摘要的数据
54    let md = cryptoFramework.createMd(mdAlgName);
55    // 数据量较少时，可以只做一次update，将数据全部传入，接口未对入参长度做限制
56    md.updateSync({ data: new Uint8Array(buffer.from(message, 'utf-8').buffer) });
57    let mdResult = md.digestSync();
58    console.info('[Sync]:Md result:' + mdResult.data);
59    let mdLen = md.getMdLength();
60    console.info("md len: " + mdLen);
61  }
62  ```
63
64### 分段摘要算法
65
661. 调用[cryptoFramework.createMd](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#cryptoframeworkcreatemd)，指定摘要算法SHA256，生成摘要实例（Md）。
67
682. 传入自定义消息，将一次传入数据量设置为20字节，多次调用[Md.update](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#update-7)，进行摘要更新计算。
69
703. 调用[Md.digest](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#digest-1)，获取摘要计算结果。
71
724. 调用[Md.getMdLength](../../reference/apis-crypto-architecture-kit/js-apis-cryptoFramework.md#getmdlength)，获取摘要计算长度，单位为字节。
73
74- 以使用await方式分段传入数据，获取摘要计算结果为例：
75
76  ```ts
77  import { cryptoFramework } from '@kit.CryptoArchitectureKit';
78  import { buffer } from '@kit.ArkTS';
79
80  async function doLoopMd() {
81    let mdAlgName = "SHA256"; // 摘要算法名
82    let md = cryptoFramework.createMd(mdAlgName);
83    // 假设信息总共43字节，根据utf-8解码后，也是43字节
84    let messageText = "aaaaa.....bbbbb.....ccccc.....ddddd.....eee";
85    let messageData = new Uint8Array(buffer.from(messageText, 'utf-8').buffer);
86    let updateLength = 20; // 假设以20字节为单位进行分段update，实际并无要求
87    for (let i = 0; i < messageData.length; i += updateLength) {
88      let updateMessage = messageData.subarray(i, i + updateLength);
89      let updateMessageBlob: cryptoFramework.DataBlob = { data: updateMessage };
90      await md.update(updateMessageBlob);
91    }
92    let mdOutput = await md.digest();
93    console.info("md result: " + mdOutput.data);
94    let mdLen = md.getMdLength();
95    console.info("md len: " + mdLen);
96  }
97  ```
98
99- 以使用同步方式分段传入数据，获取摘要计算结果为例：
100
101  ```ts
102  import { cryptoFramework } from '@kit.CryptoArchitectureKit';
103  import { buffer } from '@kit.ArkTS';
104
105  function doLoopMdBySync() {
106    let mdAlgName = "SHA256"; // 摘要算法名
107    let md = cryptoFramework.createMd(mdAlgName);
108    // 假设信息总共43字节，根据utf-8解码后，也是43字节
109    let messageText = "aaaaa.....bbbbb.....ccccc.....ddddd.....eee";
110    let messageData = new Uint8Array(buffer.from(messageText, 'utf-8').buffer);
111    let updateLength = 20; // 假设以20字节为单位进行分段update，实际并无要求
112    for (let i = 0; i < messageData.length; i += updateLength) {
113      let updateMessage = messageData.subarray(i, i + updateLength);
114      let updateMessageBlob: cryptoFramework.DataBlob = { data: updateMessage };
115      md.updateSync(updateMessageBlob);
116    }
117    let mdOutput = md.digestSync();
118    console.info("[Sync]:md result: " + mdOutput.data);
119    let mdLen = md.getMdLength();
120    console.info("md len: " + mdLen);
121  }
122  ```