14 Star 3 Fork 14

OpenHarmony-TPC / okio

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

okio

简介

okio是一个通过数据流、序列化和文件系统来优化系统输入输出流的能力的库。它依托于系统能力,提供字符串的编解码转换能力,基础数据类型的读写能力以及支持对文件读写的能力。okio为数据容器提供缓冲区,并覆盖了NIO包所支持的特性功能。将okio作为httpclient的一个组件使它更容易访问、存储和处理数据。

下载安装

ohpm install @ohos/okio 

使用说明:

import okio from '@ohos/okio';
  1. 在Buffer里写入和读取Utf8 :
 performWriteUtf8() {
     var buffer = new okio.Buffer();
     buffer.writeUtf8("test");
     var readUtfValue = buffer.readUtf8();
 }
  1. 在Buffer里写入和读取Int:
 performWriteInt() {
     var buffer = new okio.Buffer();
     buffer.writeInt(10);
     var readInt = buffer.readInt();
 }
  1. 在Buffer里写入和读取String :
 performWriteString() {
     var buffer = new okio.Buffer();
     buffer.writeString("Test");
     var readString = buffer.readString();
 }
  1. 在Buffer里写入和读取IntLe:
 performWriteIntLe() {
     var buffer = new okio.Buffer();
     buffer.writeIntLe(25);
     var readIntLe = buffer.readIntLe();
 }
  1. 在Buffer里写入和读取Short:
 performWriteShort() {
     var buffer = new okio.Buffer();
     buffer.writeShort(25);
     var readShort = buffer.readShort();
 }
  1. 在Buffer里写入和读取ShortLe:
 performWriteShortLe() {
     var buffer = new okio.Buffer();
     buffer.writeShortLe(100);
     var readShortLe = buffer.readShortLe();
 }
  1. 在Buffer里写入和读取Byte:
 performWriteByte() {
     var buffer = new okio.Buffer();
     buffer.writeByte(9)
     var readByte = buffer.readByte();
 }
  1. 在Buffer里写入和读取Utf8CodePoint :
 performWriteUtf8CodePoint() {
     var buffer = new okio.Buffer();
     buffer.writeUtf8CodePoint(99);
     var readUtf8CodePointValue = buffer.readUtf8CodePoint();
 }
  1. 将Base64编码的字符串写入ByteString :
 decodeBase64() {
     let decodeBase64 = byteStringCompanObj.decodeBase64('SGVsbG8gd29ybGQ=');
     let decodeBase64Value = JSON.stringify(decodeBase64);
 }
  1. 将十六进制字符串写入ByteString :

    decodeHex() {
        let decodehex = byteStringCompanObj.decodeHex('48656C6C6F20776F726C640D0A');
        let decodeHexValue = JSON.stringify(decodehex);
    }
  2. 将Utf8格式的字符串写入ByteString :

    encodeUtf8() {
        let encodeUtf8 = byteStringCompanObj.encodeUtf8('Hello world #4 ❤ ( ͡ㆆ ͜ʖ ͡ㆆ)');
        let encodeUtf8Value = JSON.stringify(encodeUtf8);
    }
  3. 将字符串写入ByteString :

    ofValue() {
        let ofData = byteStringCompanObj.of(["Hello", "world"]);
        let ofOutputValue = JSON.stringify(ofData);
    }
  4. 将内容写入文件 :

    writeFile() {
       let fileUri = '/data/data/com.openharmony.ohos.okioapplication/cache/test.txt';
       let writeInputValue = "openharmony";
       var sink = new okio.Sink(fileUri);
       var isAppend = false;
       sink.write(writeInputValue,isAppend);
    }
  5. 读取文件内容:

    readFileValue() {
        let fileUri = '/data/data/com.openharmony.ohos.okioapplication/cache/test.txt';
        var source = new okio.Source(fileUri);
        source.read().then(function (data) {
            that.readValue = data;
        }).catch(function (error) {
            //Error
        });
    }

接口说明

Buffer

接口名 参数 返回值 说明
writeUtf8 data: string Buffer 在Buffer中写入Utf8类型的数据
readUtf8 string 从Buffer中读取字符串
writeInt data: int Buffer 在Buffer中写入Int类型数据
readInt int 从Buffer中读取Int类型数据
writeString data: string Buffer 在Buffer中写入字符串类型的数据
readString string 从Buffer中读取字符串
writeIntLe data: intLe Buffer 在Buffer中写入IntLe类型数据
readIntLe intLe 从Buffer中读取IntLe类型数据
writeShortLe data: shortLe Buffer 在Buffer中写入ShortLe类型数据
readShortLe shortLe 从Buffer中读取ShortLe类型数据
writeShort data: Short Buffer 在Buffer中写入Short类型数据
readShort short 从Buffer中读取Short类型数据
writeByte data: byte Buffer 在Buffer中写入Byte类型数据
readByte byte 从Buffer中读取Byte类型数据
writeUtf8CodePoint data: Utf8CodePoint Buffer 在Buffer中写入Utf8CodePoint
readUtf8CodePoint Utf8CodePoint 从Buffer中读取Utf8CodePoint
readUtf8ByteCount byteCount string 从Buffer中返读取长度为byteCount的字符串数据并返回
writableSegment minimumCapacity int 根据写入的数据长度获取可用于写入的Segment
writeSubString string, beginIndex, endIndex Buffer 在Buffer中写入传入的字符串的子字符串并返回该Buffer
writeUtf8BeginEndIndex string, beginIndex, endIndex Buffer 在Buffer中写入传入的字符串的子字符串并返回该Buffer
getCommonResult pos: int string 在Buffer中读取pos长度的数据并以string类型返回
skipByteCount bytecount: int void 跳过bytecount从Buffer中读取数据
readByteArray byteCount string 从Buffer中读取byteCount长度的数据并以字符串形式返回
readFully sink: int Buffer 按照给定的长度读取数据并返回Buffer
read sink, offset, int 从offset开始读取byteCount的数据

ByteString

接口名 参数 返回值 说明
ByteString data: buffer void 获取数据缓冲区并创建ByteString示实例
decodeBase64 data: Base64String ByteString 对输入的Base64编码的数据进行解码,并将结果以ByteString的形式返回
decodeHex data: HexString ByteString 对输入的十六进制数据进行解码,并将结果以ByteString的形式返回
encodeUtf8 data: string ByteString 对输入的字符串进行UTF-8编码,并将结果以ByteString的形式返回
of data: array ByteString 返回一个复制了参数data的数据的新ByteString
toAsciiLowercase data: string ByteString 将输入的字符串转换为小写形式,并将结果以ByteString的形式返回
toAsciiUppercase data: string ByteString 将输入的字符串转换为大写形式,并将结果以ByteString的形式返回
toByteArray ByteArray 将ByteString中字节数组复制后以ByteArray形式返回
getWithIndex index: int ByteValue 以整数作为输入并返回 ByteValue
getSize DataLength 返回ByteString中的字节数
internalArray ByteArray 返回ByteString中的原始字节,而不是复制的数据
hashCode Hashcode 返回ByteString的哈希吗值
compareToOther other: Buffer ByteArray 用于比较两个ByteString并返回:
(a) 如果ByteString的大小相同,字符串相等,则返回0;
(b) 如果原始ByteString的第一个字符小于比较ByteString的第一个字符,则返回-1;
(c)如果原始ByteString的第一个字符大于比较ByteString的第一个字符,则返回1;

FIleHandler(Sink, Source)

接口名 参数 返回值 说明
read string 从文件中读取内容并返回
write writeInputValue: string, isAppend: boolean void 如果 isAppend 设置为 false,则将字符串值写入新文件;如果 isAppend 设置为 true,则附加更新到现有文件

约束与限制

在下述版本验证通过:

  • Deveco Studio:4.0 (4.0.3.512),SDK:API10 (4.0.10.9)

目录结构

|---- okio  
|     |---- entry  # 示例代码文件夹
|     |---- library  # okio 库文件夹
|           |---- index.ets  # okio对外接口
|     |---- README.MD  # 安装使用方法                   

贡献代码

使用过程中发现任何问题都可以提Issue 给我们,当然,我们也非常欢迎你给我们提PR

开源协议

本项目基于 Apache License 2.0,请自由地享受和参与开源。

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

暂无描述 展开 收起
JavaScript 等 4 种语言
Apache-2.0
取消

发行版 (1)

全部

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/openharmony-tpc/okio.git
git@gitee.com:openharmony-tpc/okio.git
openharmony-tpc
okio
okio
master

搜索帮助