ImageLoader.ets 9.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317
  1. import { LogHelper } from '../log/LogHelper';
  2. import { Context } from '@kit.AbilityKit';
  3. import { fileIo } from '@kit.CoreFileKit';
  4. import { http } from '@kit.NetworkKit';
  5. const TAG = "ImageLoader";
  6. /**
  7. * ImageView 接口(用于类型定义)
  8. */
  9. export interface ImageView {
  10. src?: string;
  11. }
  12. /**
  13. * 图片尺寸接口
  14. */
  15. export interface ImageSize {
  16. width: number;
  17. height: number;
  18. }
  19. /**
  20. * 图片加载器
  21. *
  22. * 统一封装图片加载功能,提供便捷的图片加载方式
  23. *
  24. * 注意:HarmonyOS 的图片加载通常使用 Image 组件的 src 属性直接加载
  25. * 这个类主要用于提供统一的 API 接口和缓存管理
  26. *
  27. * 使用方式:
  28. * ```typescript
  29. * // 加载网络图片
  30. * ImageLoader.load(imageView, "https://example.com/image.jpg")
  31. *
  32. * // 加载本地图片
  33. * ImageLoader.load(imageView, "/data/storage/image.jpg")
  34. *
  35. * // 加载并缓存
  36. * ImageLoader.loadWithCache(imageView, "https://example.com/image.jpg")
  37. * ```
  38. */
  39. export class ImageLoader {
  40. private static imageCache: Map<string, string> = new Map(); // URL -> 本地路径
  41. private static context: Context | null = null;
  42. /**
  43. * 初始化图片加载器(设置 Context 用于文件存储)
  44. */
  45. static init(context: Context): void {
  46. ImageLoader.context = context;
  47. LogHelper.d(TAG, "ImageLoader 初始化完成");
  48. }
  49. /**
  50. * 加载图片
  51. *
  52. * @param imageView Image 组件引用(在 HarmonyOS 中直接使用 src 属性)
  53. * @param url 图片 URL(网络或本地路径)
  54. * @param placeholder 占位图(可选)
  55. * @param errorImage 错误占位图(可选)
  56. */
  57. static load(
  58. imageView: ImageView,
  59. url: string,
  60. placeholder?: string,
  61. errorImage?: string
  62. ): void {
  63. try {
  64. // HarmonyOS 中图片加载直接使用 Image 组件的 src 属性
  65. // 这里提供统一的 API 接口
  66. if (imageView && typeof imageView.src !== 'undefined') {
  67. imageView.src = url;
  68. } else {
  69. LogHelper.w(TAG, "ImageLoader.load: imageView 不支持 src 属性");
  70. }
  71. } catch (e) {
  72. LogHelper.e(TAG, `加载图片失败: ${url}`, e as Error);
  73. if (errorImage && imageView) {
  74. imageView.src = errorImage;
  75. }
  76. }
  77. }
  78. /**
  79. * 加载图片(带缓存)
  80. *
  81. * 如果是网络图片,会下载到本地并缓存;如果是本地图片,直接加载
  82. *
  83. * @param imageView Image 组件引用
  84. * @param url 图片 URL(网络或本地路径)
  85. * @param placeholder 占位图(可选)
  86. * @param errorImage 错误占位图(可选)
  87. */
  88. static async loadWithCache(
  89. imageView: ImageView,
  90. url: string,
  91. placeholder?: string,
  92. errorImage?: string
  93. ): Promise<void> {
  94. try {
  95. // 如果是本地路径,直接加载
  96. if (!url.startsWith('http://') && !url.startsWith('https://')) {
  97. ImageLoader.load(imageView, url, placeholder, errorImage);
  98. return;
  99. }
  100. // 检查缓存
  101. if (ImageLoader.imageCache.has(url)) {
  102. const cachedPath = ImageLoader.imageCache.get(url);
  103. if (cachedPath) {
  104. // 检查缓存文件是否存在
  105. try {
  106. const stat = await fileIo.stat(cachedPath);
  107. if (stat.isFile()) {
  108. ImageLoader.load(imageView, cachedPath, placeholder, errorImage);
  109. return;
  110. } else {
  111. // 缓存文件不存在,移除缓存记录
  112. ImageLoader.imageCache.delete(url);
  113. }
  114. } catch (e) {
  115. // 缓存文件不存在,移除缓存记录
  116. ImageLoader.imageCache.delete(url);
  117. }
  118. }
  119. }
  120. // 显示占位图
  121. if (placeholder && imageView) {
  122. imageView.src = placeholder;
  123. }
  124. // 下载图片
  125. const localPath = await ImageLoader.downloadImage(url);
  126. if (localPath) {
  127. // 缓存成功,加载本地图片
  128. ImageLoader.imageCache.set(url, localPath);
  129. ImageLoader.load(imageView, localPath, placeholder, errorImage);
  130. } else {
  131. // 下载失败,加载原 URL 或错误图片
  132. if (errorImage && imageView) {
  133. imageView.src = errorImage;
  134. } else {
  135. ImageLoader.load(imageView, url, placeholder, errorImage);
  136. }
  137. }
  138. } catch (e) {
  139. LogHelper.e(TAG, `加载图片失败: ${url}`, e as Error);
  140. if (errorImage && imageView) {
  141. imageView.src = errorImage;
  142. }
  143. }
  144. }
  145. /**
  146. * 下载图片到本地
  147. *
  148. * @param url 图片 URL
  149. * @return Promise<string | null> 本地文件路径,失败返回 null
  150. */
  151. private static async downloadImage(url: string): Promise<string | null> {
  152. if (!ImageLoader.context) {
  153. LogHelper.w(TAG, "ImageLoader 未初始化,无法下载图片");
  154. return null;
  155. }
  156. try {
  157. // 生成缓存文件名(使用 URL 的 MD5 或简单哈希)
  158. const urlHash = ImageLoader.hashUrl(url);
  159. const cacheDir = `${ImageLoader.context.cacheDir}/image_cache`;
  160. const fileName = `${urlHash}.jpg`;
  161. const filePath = `${cacheDir}/${fileName}`;
  162. // 确保缓存目录存在
  163. try {
  164. await fileIo.mkdir(cacheDir, true);
  165. } catch (e) {
  166. // 目录可能已存在
  167. }
  168. // 下载图片(使用 http 模块直接下载)
  169. // 注意:NetworkManager 的 get 方法返回的是 JSON 解析后的数据,不适合下载二进制文件
  170. // 这里需要使用 http 模块直接下载
  171. const httpRequest = http.createHttp();
  172. try {
  173. const response: http.HttpResponse = await httpRequest.request(url, {
  174. method: http.RequestMethod.GET,
  175. header: {
  176. 'Accept': 'image/*'
  177. },
  178. readTimeout: 60000,
  179. connectTimeout: 60000
  180. });
  181. if (response.responseCode >= 200 && response.responseCode < 300) {
  182. // response.result 可能是 ArrayBuffer 或 string
  183. if (response.result instanceof ArrayBuffer) {
  184. // 保存到本地
  185. const file = await fileIo.open(filePath, fileIo.OpenMode.CREATE | fileIo.OpenMode.WRITE_ONLY | fileIo.OpenMode.TRUNC);
  186. await fileIo.write(file.fd, response.result);
  187. await fileIo.close(file.fd);
  188. LogHelper.d(TAG, `图片下载成功: ${url} -> ${filePath}`);
  189. return filePath;
  190. } else if (typeof response.result === 'string') {
  191. // 如果是字符串,转换为 Uint8Array 再保存
  192. const uint8Array = new Uint8Array(response.result.length);
  193. for (let i = 0; i < response.result.length; i++) {
  194. uint8Array[i] = response.result.charCodeAt(i);
  195. }
  196. const file = await fileIo.open(filePath, fileIo.OpenMode.CREATE | fileIo.OpenMode.WRITE_ONLY | fileIo.OpenMode.TRUNC);
  197. await fileIo.write(file.fd, uint8Array.buffer);
  198. await fileIo.close(file.fd);
  199. LogHelper.d(TAG, `图片下载成功: ${url} -> ${filePath}`);
  200. return filePath;
  201. } else {
  202. LogHelper.w(TAG, `下载图片失败: 响应格式不正确`);
  203. return null;
  204. }
  205. } else {
  206. LogHelper.w(TAG, `下载图片失败: HTTP ${response.responseCode}`);
  207. return null;
  208. }
  209. } finally {
  210. httpRequest.destroy();
  211. }
  212. } catch (e) {
  213. LogHelper.e(TAG, `下载图片失败: ${url}`, e as Error);
  214. return null;
  215. }
  216. }
  217. /**
  218. * 简单的 URL 哈希函数(用于生成缓存文件名)
  219. */
  220. private static hashUrl(url: string): string {
  221. let hash = 0;
  222. for (let i = 0; i < url.length; i++) {
  223. const char = url.charCodeAt(i);
  224. hash = ((hash << 5) - hash) + char;
  225. hash = hash & hash; // Convert to 32bit integer
  226. }
  227. return Math.abs(hash).toString(16);
  228. }
  229. /**
  230. * 清除图片缓存
  231. */
  232. static async clearCache(): Promise<void> {
  233. if (!ImageLoader.context) {
  234. LogHelper.w(TAG, "ImageLoader 未初始化,无法清除缓存");
  235. return;
  236. }
  237. try {
  238. const cacheDir = `${ImageLoader.context.cacheDir}/image_cache`;
  239. // 删除缓存目录中的所有文件
  240. const files = await fileIo.listFile(cacheDir);
  241. for (let i = 0; i < files.length; i++) {
  242. const filePath = `${cacheDir}/${files[i]}`;
  243. try {
  244. await fileIo.unlink(filePath);
  245. } catch (e) {
  246. LogHelper.w(TAG, `删除缓存文件失败: ${filePath}`);
  247. }
  248. }
  249. ImageLoader.imageCache.clear();
  250. LogHelper.d(TAG, "图片缓存已清除");
  251. } catch (e) {
  252. LogHelper.e(TAG, "清除图片缓存失败", e as Error);
  253. }
  254. }
  255. /**
  256. * 预加载图片
  257. *
  258. * @param urls 图片 URL 数组
  259. */
  260. static async preload(urls: string[]): Promise<void> {
  261. const promises: Promise<void>[] = [];
  262. for (let i = 0; i < urls.length; i++) {
  263. const url = urls[i];
  264. // 如果是网络图片,下载到缓存
  265. if (url.startsWith('http://') || url.startsWith('https://')) {
  266. promises.push(ImageLoader.downloadImage(url).then(localPath => {
  267. if (localPath) {
  268. ImageLoader.imageCache.set(url, localPath);
  269. LogHelper.d(TAG, `预加载图片成功: ${url}`);
  270. }
  271. }));
  272. }
  273. }
  274. await Promise.all(promises);
  275. LogHelper.d(TAG, `预加载完成,共 ${urls.length} 张图片`);
  276. }
  277. /**
  278. * 获取图片尺寸
  279. *
  280. * @param url 图片 URL
  281. * @return Promise<ImageSize | null> 图片尺寸
  282. */
  283. static async getImageSize(url: string): Promise<ImageSize | null> {
  284. try {
  285. // HarmonyOS 需要使用 image 模块获取图片尺寸
  286. // 这里返回 null,提示需要实现
  287. LogHelper.w(TAG, "getImageSize 需要使用 @kit.CoreFileKit 实现");
  288. return null;
  289. } catch (e) {
  290. LogHelper.e(TAG, `获取图片尺寸失败: ${url}`, e as Error);
  291. return null;
  292. }
  293. }
  294. }