# 信息摘要及编码

文档类型：函数事实页
是否可直接用于生成代码：是；本页函数条目均包含参数表
遇到不确定时：回到 [../index.md](../index.md)、[../../syntax/index.md](../../syntax/index.md)

这一页描述哈希、摘要、编码与转换能力。生成函数调用时，只按函数条目中的参数表传参。

## 模块范围

- 说明：哈希、摘要、编码与转换能力
- 函数事实数：11

## 信息摘要函数

### `getMsgDigest(...)`

用途：信息摘要函数相关函数。

参数个数：2 或 3
返回值：处理后的摘要结果

调用形态：`getMsgDigest(value, digest_type)`

| 参数位置 | 参数名        | 必填 | 接收类型 | 说明                                                                                       |
| -------- | ------------- | ---- | -------- | ------------------------------------------------------------------------------------------ |
| 1        | `value`       | 是   | 字符串   | 要计算摘要的字符串                                                                         |
| 2        | `digest_type` | 是   | 整数     | 摘要算法编号：`0` CRC32，`1` MD5，`2` SHA1，`3` SHA224，`4` SHA256，`5` SHA384，`6` SHA512 |

调用形态：`getMsgDigest(alias, filename, digest_type)`

| 参数位置 | 参数名        | 必填 | 接收类型 | 说明                                                                                       |
| -------- | ------------- | ---- | -------- | ------------------------------------------------------------------------------------------ |
| 1        | `alias`       | 是   | 字符串   | 文件所在目录别名；不用别名时传空字符串                                                     |
| 2        | `filename`    | 是   | 字符串   | 要计算摘要的文件路径                                                                       |
| 3        | `digest_type` | 是   | 整数     | 摘要算法编号：`0` CRC32，`1` MD5，`2` SHA1，`3` SHA224，`4` SHA256，`5` SHA384，`6` SHA512 |

## BASE64编码

### `strToBase64(value)`

用途：将字符串转换为对应类型。

参数个数：1
返回值：转换后的数值或日期

| 参数位置 | 参数名  | 必填 | 接收类型 | 说明       |
| -------- | ------- | ---- | -------- | ---------- |
| 1        | `value` | 是   | 字符串   | 原始字符串 |

### `base64ToStr(value)`

用途：将输入值转换为字符串。

参数个数：1
返回值：字符串

| 参数位置 | 参数名  | 必填 | 接收类型 | 说明              |
| -------- | ------- | ---- | -------- | ----------------- |
| 1        | `value` | 是   | 字符串   | Base64 编码字符串 |

## 进制编码函数

### `encodeRadixstr(value, affix, radix_mode)`

用途：进制编码函数相关函数。

参数个数：3
返回值：处理后的结果值

| 参数位置 | 参数名       | 必填 | 接收类型 | 说明                                                                       |
| -------- | ------------ | ---- | -------- | -------------------------------------------------------------------------- |
| 1        | `value`      | 是   | 字符串   | 要编码的字符串                                                             |
| 2        | `affix`      | 是   | 字符串   | 前缀或后缀标记                                                             |
| 3        | `radix_mode` | 是   | 整数     | 进制和格式控制；叠加 `0x80000000` 表示后缀，叠加 `0x40000000` 表示小写字母 |

### `decodeRadixstr(value, affix_length, radix_mode)`

用途：进制编码函数相关函数。

参数个数：3
返回值：处理后的结果值

| 参数位置 | 参数名         | 必填 | 接收类型 | 说明                                     |
| -------- | -------------- | ---- | -------- | ---------------------------------------- |
| 1        | `value`        | 是   | 字符串   | 要解码的编码字符串                       |
| 2        | `affix_length` | 是   | 整数     | 前缀或后缀标记长度，不是标记字符串本身   |
| 3        | `radix_mode`   | 是   | 整数     | 进制和格式控制；需与编码时使用的模式匹配 |

### `encoderadixwstr(value, affix, radix_mode)`

用途：进制编码函数相关函数。

参数个数：3
返回值：处理后的结果值

| 参数位置 | 参数名       | 必填 | 接收类型 | 说明                                                                       |
| -------- | ------------ | ---- | -------- | -------------------------------------------------------------------------- |
| 1        | `value`      | 是   | 字符串   | 要编码的字符串                                                             |
| 2        | `affix`      | 是   | 字符串   | 前缀或后缀标记                                                             |
| 3        | `radix_mode` | 是   | 整数     | 进制和格式控制；叠加 `0x80000000` 表示后缀，叠加 `0x40000000` 表示小写字母 |

### `decoderadixwstr(value, affix_length, radix_mode)`

用途：进制编码函数相关函数。

参数个数：3
返回值：处理后的结果值

| 参数位置 | 参数名         | 必填 | 接收类型 | 说明                                     |
| -------- | -------------- | ---- | -------- | ---------------------------------------- |
| 1        | `value`        | 是   | 字符串   | 要解码的宽字符编码字符串                 |
| 2        | `affix_length` | 是   | 整数     | 前缀或后缀标记长度，不是标记字符串本身   |
| 3        | `radix_mode`   | 是   | 整数     | 进制和格式控制；需与编码时使用的模式匹配 |

## URI 编码函数

### `encodeURIComponent(value)`

用途：按 URI component 规则编码字符串。

参数个数：1
返回值：字符串

| 参数位置 | 参数名  | 必填 | 接收类型 | 说明         |
| -------- | ------- | ---- | -------- | ------------ |
| 1        | `value` | 是   | 字符串   | 待编码字符串 |

### `decodeURIComponent(value)`

用途：按 URI component 规则解码字符串。

参数个数：1
返回值：字符串

| 参数位置 | 参数名  | 必填 | 接收类型 | 说明         |
| -------- | ------- | ---- | -------- | ------------ |
| 1        | `value` | 是   | 字符串   | 待解码字符串 |

### `encodeURI(value)`

用途：按 URI 规则编码字符串。

参数个数：1
返回值：字符串

| 参数位置 | 参数名  | 必填 | 接收类型 | 说明         |
| -------- | ------- | ---- | -------- | ------------ |
| 1        | `value` | 是   | 字符串   | 待编码字符串 |

### `decodeURI(value)`

用途：按 URI 规则解码字符串。

参数个数：1
返回值：字符串

| 参数位置 | 参数名  | 必填 | 接收类型 | 说明         |
| -------- | ------- | ---- | -------- | ------------ |
| 1        | `value` | 是   | 字符串   | 待解码字符串 |