@georstat/react-native-image-cache

中文文档
3.1.0发布于 2023/09/07MITTypeScriptESM + CJS近 30 天下载 6969

对 iOS 和 Android 的原生图像文件系统缓存

中文使用文档
文档目录13 节
  1. 特征
  2. 注意:
  3. 如果你要找一个有缩略图的图像库 @georstat/ react-native-image-gallery (英语)
  4. 预览
  5. iOS: (英语)
  6. 机器人:
  7. 自定义装入图像组件 : (参见 实例 (中文(简体) )
  8. 安装
  9. 记着!
  10. 使用量
  11. 道具
  12. 待办事宜:
  13. 作者数 :

在文件系统中以渐进加载方式重现原生图像缓存

npm version npm downloads npm License: MIT GitHub package.json version Platform - Android and iOS

灵感来自:

特征

  • 缓存 远程 文件系统中带有渐进加载的图像
  • 可用于本地图像
  • 用途 react-native-file-access 文件系统访问
  • 写入 Typescript
  • 用途 react-native-reanimated 用于动画
  • 网络故障重试
  • 支持新建筑,两者均 react-native-file-access 财务报告和审定财务报表 react-native-reanimated 装潢准备好了.

注意:

如果你没有用 react-native-reanimated 2.x.x版本然后使用本模块的1.x.x版本

预览

iOS: (英语)

@georstat:react-native-image-cache_iOS_demo

机器人:

@georstat:react-native-image-cache_Android_demo

自定义装入图像组件 : (参见 实例(中文(简体) )

@georstat:react-native-image-cache_custom_loading_image_component_demo

安装

线条 :

yarn add @georstat/react-native-image-cache react-native-file-access react-native-reanimated

无 :

npm i @georstat/react-native-image-cache react-native-file-access react-native-reanimated
 cd ios
 pod install

记着!

用于原生反应 0.65 使用 react-native-file-access >= 2.0.0

使用量

把这个全局配置放到您的应用程序条目 eg 上 . App.tsx 或者说 index.js (单位:千美元)需求:

说明数字 : retryDelay 财务报告和审定财务报表 maxRetries 是可选的,它们默认为 0 这意味着重试逻辑是 已禁用

import { CacheManager } from '@georstat/react-native-image-cache';
import { Dirs } from 'react-native-file-access';

CacheManager.config = {
  baseDir: `${Dirs.CacheDir}/images_cache/`,
  blurRadius: 15,
  cacheLimit: 0,
  maxRetries: 3 /* optional, if not provided defaults to 0 */,
  retryDelay: 3000 /* in milliseconds, optional, if not provided defaults to 0 */,
  sourceAnimationDuration: 1000,
  thumbnailAnimationDuration: 1000,
};

自定义缓存密钥, 用于缓存来自 Amazon S3 和类似服务的图像, 请添加此( 或任何适合您需要的) CacheManager.config数字 :

CacheManager.config = {
  // ...
  getCustomCacheKey: (source: string) => {
    // Remove params from the URL for caching images (useful for caching images from Amazons S3 bucket and etc)
    let newCacheKey = source;
    if (source.includes('?')) {
      newCacheKey = source.substring(0, source.lastIndexOf('?'));
    }
    return newCacheKey;
  },
};

cacheLimit 配置 : (自动搜索缓存文件)

若为 cacheLimit 设置为 0 (默认值) 那么缓存永远不会被自动浏览 。 此设置接受多个字节 eg . 1024 * 1024 * 256(~256MB)和要求 react-native-file-access 2.4.0,如果使用 < 2.4.0,则留下默认值 0 (残疾).

缓存缓存流 :

  1. 从中获取所有文件 baseDir。 。 。 .
  2. 按顺序排列 lastModified,最古老的第一.
  3. 使用 reduce 数组方法.
  4. 从第3步检查总大小并减去 cacheLimit 数值.
  5. 运行一段时间循环并不断删除文件, 只要当前缓存大小( 第 4 步) 大于触发缓存搜索所需的大小( C)cacheLimit 数值).
  6. 上面所有步骤只有在图像尚未被缓存时才会运行,它会在下载到缓存后运行.

Pruning在iOS模拟器上以5.7MB图像和从缓存上取出~5.00副本作为基准,没有任何问题. 请注意,各装置的螺旋速度/性能可能有所不同。 使用 cacheLimit 明智和不设大值.

如果您想在模拟器上运行自己的测试,那么缓存的图像就存储在这个位置上的Mac上: /Users/<your_name>/Library/Developer/CoreSimulator/Devices/<simulator_device_id>/ data/Containers/Data/Application/<application_id>/Library/Caches/images_cache, (中文(简体) ), 只要复制和粘贴 多个图像在那里, 有没有必要下载 通过应用程序.

目录常数, 明智选择 : (反应-内存-文件-访问文件(中文(简体) )

  • Dirs.CacheDir
  • Dirs.DatabaseDir (仅限机器人)
  • Dirs.DocumentDir
  • Dirs.LibraryDir (仅iOS)
  • Dirs.MainBundleDir
  • Dirs.SDCardDir (仅限机器人)
    • 偏爱 FileSystem.cpExternal() 可能的话.

组件 :

import { CachedImage } from '@georstat/react-native-image-cache';

<CachedImage
  source="https://via.placeholder.com/3500x3500"
  style={{ height: 350, width: 150 }}
  thumbnailSource="https://via.placeholder.com/350x150"
/>;

前置图像并保存在缓存中 :

接受2个参数:

参数类型说明
imageArray or String(需要) 远程图像的尿液或远程尿液串阵列
optionsObject获取图像的自定义选项 http request eg. {headers:{}, body:{}}
import { CacheManager } from '@georstat/react-native-image-cache';

const url = 'https://..../image.jpg';

const urls = [
  'https://..../image.jpg',
  'https://..../image2.jpg',
  'https://..../image3.jpg',
];

CacheManager.prefetch(url); // prefetch single image

CacheManager.prefetch(urls); // prefetch mutliple images

前置图像并返回 blob/ base64 :

接受2个参数:

参数类型说明
imageString(需要) 远程图像的 uri
optionsObject获取图像的自定义选项 http request eg. {headers:{}, body:{}}
import { CacheManager } from '@georstat/react-native-image-cache';

const url = 'https://..../image.jpg';

CacheManager.prefetchBlob(url).then(response => console.log(response)); // response is the base64 string

清除本地缓存 :

import { CacheManager } from '@georstat/react-native-image-cache';

await CacheManager.clearCache();

删除单个缓存项 :

const uri = 'https://.../example.jpg';

await CacheManager.removeCacheEntry(uri);

获取本地缓存大小 :

await CacheManager.getCacheSize();

检查图像是否被缓存 :

await CacheManager.isImageCached(uri);

道具

CachedImage 接受下列道具:

属性螺旋管说明
sourceString(单位:千美元)需求(原始内容存档于2018-10-21). Uri of image.
sourceAnimationDurationNumbersource 装入时图像动画持续时间, 默认为 1000ms( 覆盖配置)
thumbnailSourceString(单位:千美元)需求缩略图图像的 Uri
thumbnailAnimationDurationNumber缩略图的动画持续时间, 默认为 1000ms( 覆盖配置)
blurRadiusNumber模糊度可应用于 thumbnailSource 图像,默认为 15 (覆盖配置)
loadingImageComponentReact.CompnentType默认为图像 loadingSource 道具
noCacheBoolean不缓存图像, 默认为 false 这意味着总是缓存图像
maxAgeNumber缓存图像的最大时长, 默认为 undefined (无限入棺. 自动浏览不会考虑这个值, 如果图像 cacheLimit 到达
loadingImageStyleObject装入图像组件的样式 。 工作,如果你不提供 loadingImageComponent
imageStyleObject图像样式,在通过本地图像加载时使用 require()
loadingSourceobject装入图像组件的来源 。 工作,如果你不提供 loadingImageComponent
onErrorFunc从缓存中装入图像时运行
onLoadFunc装入成功时已启动
onLoadEndFunc装入成功或失败时已启动
resizeModeString反应本地图像组件 调整模式大小 默认为 contain
testIDString测试ID,用于测试
tintColorString源图像的颜色
styleObjectsource 和 thumbnailSource 图像样式
optionsObject获取图像的自定义选项 http request eg. {headers:{}, body:{}}
accessibilityHintstring访问提示 source (可选)
accessibilityLabelstring访问标签 source (可选)
accessibilityRolestring无障碍角色 source (可选,默认为) image(中文(简体) )
accessibilityHintThumbnailstring访问提示 thumbnailSource (可选)
accessibilityLabelThumbnailstring访问标签 thumbnailSource (可选)
accessibilityRoleThumbnailstring无障碍角色 thumbnailSource (可选,默认为) image(中文(简体) )
accessibilityHintLoadingImagestring访问提示 loadingSource (可选)
accessibilityLabelLoadingImagestring访问标签 loadingSource (可选)
accessibilityRoleLoadingImagestring无障碍角色 loadingSource (可选,默认为) image(中文(简体) )

更多关于反应土著无障碍的信息

关于反应土著无障碍的博客文章

待办事宜:

  • 将库转换为反应钩
  • 制作 baseDir 可配置
  • 删除单个缓存条目

发起人

此库为免费开发.

用这个链接给我们买杯咖啡: "Buy Me A Coffee"

作者数 :

版本与发布记录

@georstat/react-native-image-cache 共发布 38 个版本,首次发布于 2021/05/06;过去 12 个月发布了 0 个版本。

版本发布日期距今
3.1.0latest2023/09/073 年前
3.0.02023/09/073 年前
2.9.02023/08/103 年前
2.8.02023/08/073 年前
2.7.02023/07/313 年前
2.6.02023/07/313 年前

关于 @georstat/react-native-image-cache 的常见问题

@georstat/react-native-image-cache 是什么?

对 iOS 和 Android 的原生图像文件系统缓存

如何安装 @georstat/react-native-image-cache?

在项目目录运行 npm install @georstat/react-native-image-cache,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(*)、react-native(*)、react-native-file-access(>=3.0.0)、react-native-reanimated(>=2.2.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@georstat/react-native-image-cache 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@georstat/react-native-image-cache 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@georstat/react-native-image-cache 可以商用吗?

@georstat/react-native-image-cache 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@georstat/react-native-image-cache 的下载量有多少?

根据 npm 官方下载统计,@georstat/react-native-image-cache 在 2026/10/16 – 2026/11/14 这 30 天内被下载 6,969 次,日均约 232 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@georstat/react-native-image-cache 还在维护吗?

最新版本 3.1.0 发布于 2023/09/07(3 年前);至今共发布 38 个版本,其中过去 12 个月发布了 0 个;首次发布于 2021/05/06。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。