1 Star 0 Fork 109

enchen1 / ImageKnife

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

ImageKnife

专门为OpenHarmony打造的一款图像加载缓存库,致力于更高效、更轻便、更简单。

简介

本项目基于开源库 Glide 进行OpenHarmony的自研版本:

  • 支持内存缓存,使用LRUCache算法,对图片数据进行内存缓存。
  • 支持磁盘缓存,对于下载图片会保存一份至磁盘当中。
  • 支持进行图片变换,支持自定义变换。
  • 支持用户配置参数使用:(例如:配置是否开启第一级内存缓存,配置磁盘缓存策略,配置仅使用缓存加载数据,配置图片变换效果,配置占位图,配置加载失败占位图等)。
  • 推荐使用ImageKnifeComponent组件配合ImageKnifeOption参数来实现功能。
  • 支持用户自定义配置实现能力参考ImageKnifeComponent组件中对于入参ImageKnifeOption的处理。

下载安装

npm install @ohos/imageknife --save

OpenHarmony npm环境配置等更多内容,参考安装教程 如何安装OpenHarmony npm包

使用说明

1.首先初始化全局ImageKnife实例,在AbilityStage.ts中调用ImageKnife.with(this.context)进行初始化

import AbilityStage from "@ohos.application.AbilityStage"
import {ImageKnife} from '@ohos/imageknife'

export default class MyAbilityStage extends AbilityStage {
    onCreate() {
        globalThis.ImageKnife = ImageKnife.with(this.context);
    }
}

2.参考推荐使用自定义实现

推荐使用:

使用ImageKnifeOption作为入参,配合自定义组件ImageKnifeComponent使用。

@Entry
@Component
struct Index {
  @State imageKnifeOption1: ImageKnifeOption =
    {
      loadSrc: $r('app.media.jpgSample'),
      size: { width: 300, height: 300 },
      placeholderSrc: $r('app.media.icon_loading'),
      errorholderSrc: $r('app.media.icon_failed'),
    };


  build() {
    Scroll() {
      Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
        ImageKnifeComponent({ imageKnifeOption: $imageKnifeOption1 })
      }
    }
    .width('100%')
    .height('100%')
  }
}

自定义实现:

使用原生Image组件,配合用户配置参数实现。

步骤1:

定义自定义类。

export default class PixelMapPack{
   pixelMap:PixelMap;
}

使用@State关联PixelMapPack。

@State  imageKnifePixelMapPack:PixelMapPack = new PixelMapPack();
width:number = 200;
height:number = 200;
步骤2:

在你的component组件中,写下一个Image组件,将基础参数(入参PixelMap,组件的宽、高)配置好。

Image(this.imageKnifePixelMapPack.pixelMap)
        .backgroundColor(Color.Grey)
        .objectFit(ImageFit.Contain)
        .width(this.width)
        .height(this.height)
步骤3:

在aboutToAppear() 函数中调用加载流程。

//配置参数
let requestOptin = new RequestOption();    
   //加载本地图片
    requestOptin.load($r('app.media.jpgSample'))
    .addListener((err,data) => {
      //加载成功/失败回调监听
        if (data.isPixelMap()) {
        let pixelMapPack = new PixelMapPack();
        pixelMapPack.pixelMap = data.imageKnifeValue as PixelMap;
        //当前的PixelMap资源发生变化,jpgSample图片将会由Image组件重新渲染,并展示  
        this.imageKnifePixelMapPack = pixelMapPack;
      }
    })
    .placeholder( $r('app.media.icon_loading'), (data)=>{
        // 占位图回调监听
      })
   .errorholder( $r('app.media.icon_failed'), (data)=>{
        // 失败占位图回调监听
      })
     .thumbnail(0.3, (data) => {
        // 缩略图加载成功回调
    })
      // 一定要把控件大小传给RequestOption,图片变换必须
      .setImageViewSize({width:200, height:200})
      // 设置缓存策略
     .diskCacheStrategy(new AUTOMATIC())
     .addProgressListener((percentValue: string) => {
        // 图片网络加载进度条百分比回调
      })
     .addRetryListener((error: any) => {
           // 加载失败重试监听 图片加载失败时优先展示重试图层,点击重试图层,会重新进行一次加载流程
      })
      // 左上圆角10pixel像素点
    .roundedCorners({top:10})
    // 启动加载流程,执行结果将会返回到上面的回调接口中
    globalThis.ImageKnife.call(requestOptin);
步骤4:

更多细节设置请参考自定义Component的ImageKnifeComponent实现。

接口说明

RequestOption 用户配置参数

方法名 入参 接口描述
load(src: string | PixelMap | Resource) string | PixelMap | Resource 待加载图片的资源
setImageViewSize(imageSize: { width: number, height: number }) { width: number, height: number } 传入显示图片组件的大小,变换的时候需要作为参考
diskCacheStrategy(strategy: DiskStrategy) DiskStrategy 配置磁盘缓存策略 NONE SOURCE RESULT ALL AUTOMATIC
placeholder(src: PixelMap | Resource, func?: AsyncSuccess) src: PixelMap | Resource, func?: AsyncSuccess 配置占位图,其中func为数据回调函数
errorholder(src: PixelMap | Resource, func?: AsyncSuccess) src: PixelMap | Resource, func?: AsyncSuccess 配置加载失败占位图,其中func为数据回调函数
addListener(func: AsyncCallback) func: AsyncCallback 配置整个监听回调,数据正常加载返回,加载失败返回错误信息
thumbnail(sizeMultiplier:number, func?: AsyncSuccess) sizeMultiplier:number, func?: AsyncSuccess 设置缩略图比例,缩略图返回后,加载并展示缩略图
addProgressListener(func?: AsyncSuccess){ this.progressFunc = func; return this; } func?: AsyncSuccess 设置网络下载百分比监听,返回数据加载百分比数值
addRetryListener(func?: AsyncSuccess){ this.retryFunc = func; return this; } func?: AsyncSuccess 设置重试监听
addAllCacheInfoCallback(func: IAllCacheInfoCallback) func: IAllCacheInfoCallback 设置获取所有缓存信息监听
skipMemoryCache(skip: boolean) skip: boolean 配置是否跳过内存缓存
retrieveDataFromCache(flag: boolean) flag: boolean 配置仅从缓存中加载数据

同时支持图片变换相关接口。

ImageKnife 启动器/门面类

方法名 入参 接口描述
call(request: RequestOption) request: RequestOption 根据用户配置参数具体执行加载流程
preload(request: RequestOption) request: RequestOption 根据用户配置参数具体执行预加载流程

缓存策略相关

使用方法 类型 策略描述
request.diskCacheStrategy(new ALL()) ALL 表示既缓存原始图片,也缓存转换过后的图片
request.diskCacheStrategy(new AUTOMATIC()) AUTOMATIC 表示尝试对本地和远程图片使用最佳的策略
request.diskCacheStrategy(new DATA()) DATA 表示只缓存原始图片
request.diskCacheStrategy(new NONE()) NONE 表示不缓存任何内容
request.diskCacheStrategy(new RESOURCE()) RESOURCE 表示只缓存转换过后的图片

图片变换相关

使用方法 类型 相关描述
request.centerCrop() CenterCrop 可以根据图片文件,目标显示大小,进行对应centerCrop
request.centerInside() CenterInside 可以根据图片文件,目标显示大小,进行对应centerInside
request.fitCenter() FitCenter 可以根据图片文件,目标显示大小,进行对应fitCenter
request.blur() BlurTransformation 模糊处理
request.brightnessFilter() BrightnessFilterTransformation 亮度滤波器
request.contrastFilter() ContrastFilterTransformation 对比度滤波器
request.cropCircle() CropCircleTransformation 圆形剪裁显示
request.cropCircleWithBorder() CropCircleWithBorderTransformation 圆环展示
request.cropSquare() CropSquareTransformation 正方形剪裁
request.crop() CropTransformation 自定义矩形剪裁
request.grayscale() GrayscaleTransformation 灰度级转换
request.invertFilter() InvertFilterTransformation 反转滤波器
request.pixelationFilter() PixelationFilterTransformation 像素化滤波器
request.rotateImage() RotateImageTransformation 图片旋转
request.roundedCorners() RoundedCornersTransformation 圆角剪裁
request.sepiaFilter() SepiaFilterTransformation 乌墨色滤波器
request.sketchFilter() SketchFilterTransformation 素描滤波器
request.mask() MaskTransformation 遮罩
request.swirlFilter() SwirlFilterTransformation 扭曲滤波器

兼容性

支持 OpenHarmony API version 9 及以上版本。

目录结构

/imageknife/src/
- main/ets/components
    - cache               # 缓存相关内容
       - diskstrategy    # 缓存策略
       - key           # 缓存key生成策略
       - Base64.ets      # Base64算法
       - CustomMap.ets       # 自定义Map封装
       - DiskCacheEntry.ets# 磁盘缓存entry
       - DiskLruCache.ets  # 磁盘LRU缓存策略
       - FileReader.ets   # 文件读取相关
       - FileUtils.ets       # 文件工具类
       - LruCache.ets    # 内存LRU缓存策略
       - Md5.ets        # MD5算法
       
    - imageknife               # imageknife主要内容
       - compress       # 压缩相关
       - constants          # 常量相关
       - entry             # 部分数据结构
       - holder         # 占位图相关解析
       - interface          # 接口相关
       - networkmanage       # 网络相关
       - pngj          # pngj相关
       - requestmanage       # imageknife请求相关
       - resourcemanage   # 本地资源解析相关
       - transform          # 图片变换相关
       - utils             # 工具类相关
       - ImageKnife.ets         # imageknife门面,app持久化类
       - ImageKnifeData.ets      # 数据封装
       - ImageKnifeComponent.ets  # 自定义控件封装
       - ImageKnifeOption.ets # 用户传参数封装
       - PixelMapPack.ets # PixelMap封装
       - RequestOption.ets # 用户设置参数封装
       
/entry/src/
- main/ets/MainAbility     
    - pages               # 测试page页面列表
       - basicTestFeatureAbilityPage.ets     # 测试元能力
       - basicTestFileIOPage.ets           # 测试fileio
       - basicTestMediaImage.ets           # 测试媒体image
       - basicTestResourceManagerPage.ets    # 测试本地资源解析
       - compressPage.ets                # 压缩页面
       - cropImagePage.ets                # 裁剪页面
       - cropImagePage2.ets                # 手势裁剪页面
       - frescoImageTestCasePage.ets        # 测试属性动画组件切换
       - frescoLayerTestCasePage.ets        # 测试ImageKnifeComponent组件切换配合属性动画
       - frescoRetryTestCasePage.ets        # 测试ImageKnifeComponent加载失败重试
       - index.ets                         # 测试页面入口
       - indexFresco.ets                 # 二级测试页面入口
       - loadNetworkTestCasePage.ets        # 网络加载测试
       - loadResourceTestCasePage.ets       # 本地加载测试
       - showErrorholderTestCasePage.ets     # 加载失败占位图测试
       - storageTestDiskLruCache.ets        # 磁盘缓存测试
       - storageTestLruCache.ets           # 内存缓存测试
       - testAllCacheInfoPage.ets          # 所有缓存信息获取测试
       - testAllTypeImageKnifeComponentPage.ets      # 所有类型图片加载测试
       - testAllTypeNativeImagePage.ets      # 所有类型本地图片加载测试
       - testGifDontAnimatePage.ets         # gif加载静态图片测试
       - testImageKnifeOptionChangedPage.ets     # ImageKnifeOption数据切换测试
       - testImageKnifeOptionChangedPage2.ets        # ImageKnifeOption数据切换测试
       - testMultiThreadWorkerPage2.ets      # 多线程测试
       - testPlaceholderPage.ets           # 加载占位图测试
       - testPreloadPage.ets              # 预加载测试
       - testResourceManagerPage.ets        # 解析本地资源测试
       - transformPixelMapPage.ets          # 所有类型变换测试
       - transformTestCasePage.ets          # 所有类型变换配合ImageKnifeComponent测试
       
    - workers             # 测试worker多线程
       - worker1.js         # worker多线程测试

贡献代码

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

开源协议

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

遗留问题

1.目前只支持一种图片变换效果。

2.目前svg和gif动图不支持变换效果。

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.

简介

暂无描述 展开 收起
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/enchen1/ImageKnife.git
git@gitee.com:enchen1/ImageKnife.git
enchen1
ImageKnife
ImageKnife
master

搜索帮助

344bd9b3 5694891 D2dac590 5694891