# checksum

**Repository Path**: si-dongpo/checksum

## Basic Information

- **Project Name**: checksum
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 14
- **Created**: 2022-05-23
- **Last Updated**: 2022-05-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Checksum

## 简介
用于计算最典型的散列函数，如 md5 或 sha1

## 效果展示：
<img src="preview/preview.gif"/>

## 下载安装
```shell
npm install @ohos/checksum --save
```
OpenHarmony npm环境配置等更多内容，请参考 [如何安装OpenHarmony npm包](https://gitee.com/openharmony-tpc/docs/blob/master/OpenHarmony_npm_usage.md) 。

## 使用说明
1. sha1、md5 编码文字

 ```ets
 @Entry
 @Component
 struct Index {
   @State mgs: string = "空"
   @State path: string = ""
   @State mArguments:options = new options();
 
   build() {
     Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
       Button("sha1 编码文字 dshaw ").width(200).height(50).onClick((event: ClickEvent) => {
         this.mArguments.algorithm = "sha1"
         let mChecksum = new Checksum()
         
         this.mgs = mChecksum.checksum("dshaw", this.mArguments)
       })
 
       Button("md5 编码文字 dshaw ").width(200).height(50).onClick((event: ClickEvent) => {
         this.mArguments.algorithm = "md5"
         let mChecksum = new Checksum()
         
         this.mgs = mChecksum.checksum("dshaw", this.mArguments)
       })
       }
 ```
2. sha1、md5 编码文件内容

 ```ets
 @Entry
 @Component
 struct Index {
   @State mgs: string = "空"
   @State path: string = ""
   @State mArguments:options = new options();
 	//文件存在
   build() {
     Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
       Button("sha1 编码文件 Test ").width(200).height(50).onClick((event: ClickEvent) => {
         this.mArguments.algorithm = "sha1"
         let mChecksum = new Checksum()
 
         mChecksum.checksumFile(this.path + "/Test.txt", this.mArguments, (err, data) => {
           this.mgs = "sha1 : " + data
         })
       })
 
       Button("md5 编码文件 Test ").width(200).height(50).onClick((event: ClickEvent) => {
 
         this.mArguments.algorithm = "md5"
         let mChecksum = new Checksum()
 
         mChecksum.checksumFile(this.path + "/Test.txt", this.mArguments, (err, data) => {
           this.mgs = "md5 :" + data
         })
       })
     }
 ```

## 接口说明

1. 编码字符串
```
public checksum(value, options)
```
2. 编码文件
```
checksumFile(filename, options, callback)
```

## 目录结构
```
|---- checksum
|     |---- entry  # 示例代码文件夹
|     |----checksum  # 库文件夹
      |----src
         |----main
            |----ets
              |----checksum.ets #核心库
              |----md5.ets #md5编码库
              |----options.ets #类型实体
              |----sha1.ets #sha1编码库
|           |---- index.ets  # 对外接口
|     |---- README.md  # 安装使用方法  
```

## 贡献代码
使用过程中发现任何问题都可以提 [Issue](https://gitee.com/openharmony-sig/checksum/issues) 给我们，当然，我们也非常欢迎你给我们发 [PR](https://gitee.com/openharmony-sig/checksum/pulls) 。

## 开源协议
本项目基于 [MIT License](https://gitee.com/openharmony-sig/checksum/blob/master/LICENSE) ，请自由地享受和参与开源。