# xutils

**Repository Path**: zhangjun93/xutils

## Basic Information

- **Project Name**: xutils
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 19
- **Created**: 2022-06-15
- **Last Updated**: 2022-06-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# xutils

## 简介
> 网络、文件、数据库操作工具库。

![preview.gif](preview/preview.gif)

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

## 使用说明
1. 引入依赖

 ```
   import { HttpUtils } from '@ohos/xutils/'
   import { HttpMethod } from '@ohos/xutils/'
   import { RequestCallBack } from '@ohos/xutils/'
   import { RequestParams } from '@ohos/xutils/'
   import { ResponseInfo } from '@ohos/xutils/'
   import { DbUtils } from '@ohos/xutils/'
   import { DaoConfig } from '@ohos/xutils/'
   import { QueryCallBack } from '@ohos/xutils/'
   import { Selector } from '@ohos/xutils/'
   import { BitmapUtils } from '@ohos/xutils/'
   import { BitmapLoadCallBack } from '@ohos/xutils/'
 ```
2. 网络请求

 ```
   //添加Header
   @State requestParams: RequestParams = new RequestParams();
   this.requestParams.addHeader("Content-Type", "application/json");
   //添加传递参数
   this.requestParams.addQueryStringParameter("key", "397c9db4cb0621ad0313123dab416668");
   this.requestParams.addQueryStringParameter("city", "北京");
   //GET请求
   new HttpUtils().send(HttpMethod.GET,
            "http://apis.juhe.cn/simpleWeather/query?key=397c9db4cb0621ad0313123dab416668&city=北京",
            new HttpCallBack())
   //POST请求
   new HttpUtils().sendParams(HttpMethod.POST,
            "http://apis.juhe.cn/simpleWeather/query",
            this.requestParams,
            new HttpCallBack())
 ```
3. 文件下载

 ```
 new HttpUtils().download('https://count.liqucn.com/d.php?id=725672&urlos=android&from_type=web',
            'xUtils/hsh.apk', null)
 ```
4. 数据库操作

 ```
 //创建数据库
 this.db = DbUtils.create(this.config);
 //创建表
 this.config.setDbName(this.dbName)
 this.config.setTableName(this.tableName)
 this.config.setCreateTableSql("ID INTEGER PRIMARY KEY AUTOINCREMENT, NAME TEXT NOT NULL, AGE INTEGER, SALARY REAL, CODES BLOB")
 this.db.createTableIfNotExist();
 //插入数据
 const valueBucket = {
            "NAME": "Lisa",
            "AGE": 18,
            "SALARY": 100.5,
            // @ts-ignore
            "CODES": new Uint8Array([1, 2, 3, 4, 5]),
          };
 this.db.save(valueBucket)
 //查询数据
 this.db.findAll(Selector.from(this.tableName, this.queryColumns), new DbCallBack());
 this.db.findAll(Selector.from(this.tableName, this.queryColumns)
            .where("NAME", "equalTo", "Lisa").and("AGE", "equalTo", 18), new DbCallBack());
 this.db.findFirst(Selector.from(this.tableName, this.queryColumns)
            .where("NAME", "equalTo", "Rose"), new DbCallBack());
 //更新数据
 this.db.update(valueBucket, Selector.from(this.tableName, this.queryColumns)
            .where("NAME", "equalTo", "Rose"));
 //删除数据
 this.db.delete(Selector.from(this.tableName, this.queryColumns)
            .where("NAME", "equalTo", "Rose"));
 //删除数据库
 this.db.dropDb();
 ```

## 接口说明
1. get请求
   ` HttpUtils.send()`
2. post请求
   `HttpUtils.sendParams()`
3. 文件下载
   `HttpUtils.download()`
4. 设置数据库名称
   `DaoConfig.setDbName()`
5. 设置表名称
   `DaoConfig.setTableName()`
6. 查询数据
   `DbUtils.findAll()`
7. 更新数据
   `DbUtils.update()`

## 兼容性
支持 OpenHarmony API version 8 及以上版本。

## 目录结构
````
|---- xutils
      |---- entry  # 示例代码文件夹
      |---- xutils  # xutils库文件夹
         |----src
            |----main
               |----ets
                      |---- bitmap  # 图片操作实现
                      |---- cache  # 缓存实现
                      |---- db  # 数据库操作实现
                      |---- http  # 网络请求操作实现
                      |---- task  # 任务实现
                      |---- ts-md5  # 加密实现
                      |---- util  # 工具类实现
                      |---- BitmapUtils.ets  # 图片缓存对外类
                      |---- DbUtils.ets  # 数据库操作对外类
                      |---- HttpUtils.ets  # 网络请求操作对外类
                      |---- index.ets  # 对外接口
      |---- README.md  # 安装使用方法                    
````

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

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