增加ImageKnifeComponent组件销毁网络请求中断

Signed-off-by: zgf <zenggaofeng2@h-partners.com>

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 3.2.2-rc.0
+- Add ImageKnifeComponent to destroy network request interruption
+- Code refactoring during the download of image resources stage
+
 ## 3.2.1
 - Release official version
 

entry/src/main/ets/pages/MultipleImageCallBack.ets

@@ -108,7 +108,7 @@ struct MultipleImageCallBack {
                         console.log('image load multiple loadFail:' + this.failIndex)
                       },
                       onLoadCancel:(message,request)=>{
-                        let flag = request?.imageKnifeData?.type ? true : false
+                        let flag = request?.imageKnifeData?.timeInfo?.netRequestStartTime ? true : false
                         if (flag) {
                           this.cancelLoadIndex++
                         } else {

library/src/main/ets/ImageKnife.ets

@@ -25,6 +25,7 @@ import { util } from '@kit.ArkTS';
 import { image } from '@kit.ImageKit';
 import { common } from '@kit.AbilityKit';
 import { LogUtil } from './utils/LogUtil';
+import { emitter } from '@kit.BasicServicesKit';
 
 
 export class ImageKnife {
@@ -176,6 +177,9 @@ export class ImageKnife {
    * @param request 图片请求request
    */
   cancel(request:ImageKnifeRequest) {
+    if (typeof request?.imageKnifeOption.loadSrc === 'string' && !request?.drawMainSuccess) {
+      emitter.emit(request.imageKnifeOption.loadSrc + request.componentId)
+    }
     request.requestState = ImageKnifeRequestState.DESTROY
   }
   /**

library/src/main/ets/ImageKnifeDispatcher.ets

@@ -87,6 +87,7 @@ export class ImageKnifeDispatcher {
 
         if (requestSource == ImageKnifeRequestSource.SRC) {
           request.requestState = ImageKnifeRequestState.COMPLETE
+          request.drawMainSuccess = true
           // 回调请求开结束
           if (request.imageKnifeOption.onLoadListener?.onLoadSuccess !== undefined) {
             this.copyMemoryCacheInfo(memoryCache, request.imageKnifeData);
@@ -177,7 +178,9 @@ export class ImageKnifeDispatcher {
     if (request.imageKnifeOption.placeholderSrc !== undefined && request.drawPlayHolderSuccess == false) {
       this.getAndShowImage(request, request.imageKnifeOption.placeholderSrc, ImageKnifeRequestSource.PLACE_HOLDER)
     }
-
+    if (request.imageKnifeOption.onLoadListener?.onLoadStart !== undefined) {
+      request.imageKnifeOption.onLoadListener?.onLoadStart(request)
+    }
     // 加载主图
     this.getAndShowImage(request, request.imageKnifeOption.loadSrc, ImageKnifeRequestSource.SRC,isAnimator)
     LogUtil.log('executeJob.end:' + request.componentId  + ',version:' + request.componentVersion)
@@ -188,9 +191,6 @@ export class ImageKnifeDispatcher {
    */
   getAndShowImage(currentRequest: ImageKnifeRequest, imageSrc: string | PixelMap | Resource, requestSource: ImageKnifeRequestSource,isAnimator?: boolean): void {
     LogUtil.log('getAndShowImage.start:'  + currentRequest.componentId + ',srcType:' + requestSource + ',version:' + currentRequest.componentVersion)
-    if (requestSource === ImageKnifeRequestSource.SRC && currentRequest.imageKnifeOption.onLoadListener?.onLoadStart !== undefined) {
-      currentRequest.imageKnifeOption.onLoadListener?.onLoadStart(currentRequest)
-    }
 
     let memoryKey: string = this.engineKey.generateMemoryKey(imageSrc, requestSource, currentRequest.imageKnifeOption,isAnimator, currentRequest.componentWidth, currentRequest.componentHeight)
     let requestList: List<ImageKnifeRequestWithSource> | undefined = this.executingJobMap.get(memoryKey)
@@ -353,17 +353,64 @@ export class ImageKnifeDispatcher {
     }
 
     let pixelmap = requestJobResult.pixelMap;
+    // 请求取消
+    if (currentRequest.requestState === ImageKnifeRequestState.DESTROY) {
+      this.executingJobMap.remove(memoryKey);
+      requestList.forEach((requestWithSource: ImageKnifeRequestWithSource) => {
+        if (currentRequest.componentId !== requestWithSource.request.componentId && requestWithSource.request.requestState !== ImageKnifeRequestState.DESTROY) {
+          // 加载占位符
+          if (requestWithSource.source === ImageKnifeRequestSource.PLACE_HOLDER &&
+            requestWithSource.request.imageKnifeOption.placeholderSrc !== undefined &&
+            requestWithSource.request.drawPlayHolderSuccess == false) {
+            this.getAndShowImage(requestWithSource.request, requestWithSource.request.imageKnifeOption.placeholderSrc, ImageKnifeRequestSource.PLACE_HOLDER)
+          } else if (requestWithSource.source === ImageKnifeRequestSource.ERROR_HOLDER &&
+            requestWithSource.request.imageKnifeOption.errorholderSrc !== undefined) {
+            this.getAndShowImage(requestWithSource.request, requestWithSource.request.imageKnifeOption.errorholderSrc, ImageKnifeRequestSource.ERROR_HOLDER)
+          } else if (requestWithSource.source === ImageKnifeRequestSource.SRC) {
+            // 加载主图
+            this.getAndShowImage(requestWithSource.request, requestWithSource.request.imageKnifeOption.loadSrc, ImageKnifeRequestSource.SRC)
+          }
+        } else {
+          if (pixelmap !== undefined && typeof pixelmap !== 'string') {
+            (pixelmap as PixelMap).release()
+          }
+          if (requestWithSource.source == ImageKnifeRequestSource.SRC && requestWithSource.request.imageKnifeOption.onLoadListener?.onLoadCancel) {
+            // 回调请求成功
+            // 回调请求成功
+            //设置失败回调的时间点
+            let callBackData = requestWithSource.request.imageKnifeData;
+
+            if (requestJobResult.imageKnifeData && requestJobResult.imageKnifeData.timeInfo) {
+              requestJobResult.imageKnifeData.timeInfo.requestCancelTime = Date.now();
+              if (requestJobResult.imageKnifeData.errorInfo) {
+                requestJobResult.imageKnifeData.errorInfo.phase = LoadPhase.PHASE_WILL_SHOW;
+                requestJobResult.imageKnifeData.errorInfo.code = LoadPixelMapCode.IMAGE_LOAD_CANCEL_FAILED_CODE;
+              }
+            }
+            this.assembleImageKnifeData(callBackData,requestJobResult.imageKnifeData,requestWithSource.request)
+            LogUtil.log('getAndShowImage cancel:' + requestWithSource.request.componentId  + ',srcType:' + requestSource + ',version:' + requestWithSource.request.componentVersion)
+            requestWithSource.request.imageKnifeOption.onLoadListener.onLoadCancel(requestJobResult.loadFail ?? 'component has destroyed from load', requestWithSource.request)
+          }
+        }
+      })
+      this.dispatchNextJob()
+      return
+    }
+    // 请求失败
     if (pixelmap === undefined) {
       this.executingJobMap.remove(memoryKey);
       requestList.forEach((requestWithSource: ImageKnifeRequestWithSource) => {
         requestWithSource.request.requestState = ImageKnifeRequestState.ERROR
-        LogUtil.error('getAndShowImage_CallBack.pixelmap failed:' + currentRequest.componentId + ',srcType:' + requestSource + ',version:' + currentRequest.componentVersion + " error: " + requestJobResult.loadFail)
+        LogUtil.error('getAndShowImage_CallBack.pixelmap failed:' + currentRequest.componentId + ',srcType:' +
+          requestSource + ',version:' + currentRequest.componentVersion + " error: " + requestJobResult.loadFail)
         // 回调请求失败
         if (requestWithSource.source === ImageKnifeRequestSource.SRC &&
           requestWithSource.request.imageKnifeOption.onLoadListener?.onLoadFailed !== undefined &&
         requestJobResult.loadFail) {
-          this.assembleImageKnifeData(requestWithSource.request.imageKnifeData, requestJobResult.imageKnifeData, requestWithSource.request)
+          this.assembleImageKnifeData(requestWithSource.request.imageKnifeData, requestJobResult.imageKnifeData,
-          requestWithSource.request.imageKnifeOption.onLoadListener.onLoadFailed(requestJobResult.loadFail,requestWithSource.request);
+            requestWithSource.request)
+          requestWithSource.request.imageKnifeOption.onLoadListener.onLoadFailed(requestJobResult.loadFail,
+            requestWithSource.request);
         }
         if (requestWithSource.source === ImageKnifeRequestSource.SRC &&
           requestWithSource.request.imageKnifeOption.errorholderSrc !== undefined) {
@@ -412,8 +459,8 @@ export class ImageKnifeDispatcher {
     //构建缓存保存的ImageKnifeData
     let saveCacheImageData: ImageKnifeData = {
       source: pixelmap!,
-      imageWidth: requestJobResult.size == undefined ? 0 : requestJobResult.size.width,
+      imageWidth: requestJobResult.size?.width ?? 0,
-      imageHeight: requestJobResult.size == undefined ? 0 : requestJobResult.size.height,
+      imageHeight: requestJobResult.size?.height ?? 0,
       type: requestJobResult.type,
       bufSize: requestJobResult.bufferSize,
       imageAnimator: imageKnifeData.imageAnimator
@@ -430,50 +477,31 @@ export class ImageKnifeDispatcher {
     if (requestList !== undefined) {
       // key相同的request，一起绘制
       requestList.forEach((requestWithSource: ImageKnifeRequestWithSource) => {
-        if (requestWithSource.request.requestState !== ImageKnifeRequestState.DESTROY) {
+        // 画主图
-          // 画主图
+        if (requestWithSource.source === ImageKnifeRequestSource.SRC ||
-          if (requestWithSource.source === ImageKnifeRequestSource.SRC ||
+          requestWithSource.source === ImageKnifeRequestSource.ERROR_HOLDER
-            requestWithSource.source === ImageKnifeRequestSource.ERROR_HOLDER
+          || (requestWithSource.source === ImageKnifeRequestSource.PLACE_HOLDER &&
-            || (requestWithSource.source === ImageKnifeRequestSource.PLACE_HOLDER &&
+            requestWithSource.request.requestState === ImageKnifeRequestState.PROGRESS)) {
-              requestWithSource.request.requestState === ImageKnifeRequestState.PROGRESS)) {
+          requestWithSource.request.ImageKnifeRequestCallback.showPixelMap(requestWithSource.request.componentVersion,
-            requestWithSource.request.ImageKnifeRequestCallback.showPixelMap(requestWithSource.request.componentVersion,
+            imageKnifeData.source, { width: imageKnifeData.imageWidth, height: imageKnifeData.imageHeight },
-              imageKnifeData.source, { width: imageKnifeData.imageWidth, height: imageKnifeData.imageHeight },
+            requestWithSource.source, imageKnifeData.imageAnimator);
-              requestWithSource.source, imageKnifeData.imageAnimator);
+        }
-          }
 
-          if (requestWithSource.source == ImageKnifeRequestSource.SRC) {
+        if (requestWithSource.source == ImageKnifeRequestSource.SRC) {
-            requestWithSource.request.requestState = ImageKnifeRequestState.COMPLETE;
+          requestWithSource.request.requestState = ImageKnifeRequestState.COMPLETE;
-            if (requestWithSource.request.imageKnifeOption.onLoadListener &&
+          requestWithSource.request.drawMainSuccess = true
-            requestWithSource.request.imageKnifeOption.onLoadListener.onLoadSuccess) {
+          if (requestWithSource.request.imageKnifeOption.onLoadListener &&
-              // 回调请求成功
+          requestWithSource.request.imageKnifeOption.onLoadListener.onLoadSuccess) {
-              this.assembleImageKnifeData(requestWithSource.request.imageKnifeData, imageKnifeData,requestWithSource.request);
-              requestWithSource.request.imageKnifeOption.onLoadListener.onLoadSuccess(imageKnifeData.source,
-                saveCacheImageData, requestWithSource.request);
-            }
-          } else if (requestWithSource.source == ImageKnifeRequestSource.ERROR_HOLDER) {
-            requestWithSource.request.requestState = ImageKnifeRequestState.ERROR;
-          }
-        } else {
-          if (requestWithSource.source == ImageKnifeRequestSource.SRC && requestWithSource.request.imageKnifeOption.onLoadListener?.onLoadCancel) {
             // 回调请求成功
-            // 回调请求成功
+            this.assembleImageKnifeData(requestWithSource.request.imageKnifeData, imageKnifeData,
-            //设置失败回调的时间点
+              requestWithSource.request);
-            let callBackData = requestWithSource.request.imageKnifeData;
+            requestWithSource.request.imageKnifeOption.onLoadListener.onLoadSuccess(imageKnifeData.source,
-
+              saveCacheImageData, requestWithSource.request);
-            if (requestJobResult.imageKnifeData && requestJobResult.imageKnifeData.timeInfo) {
-              requestJobResult.imageKnifeData.timeInfo.requestCancelTime = Date.now();
-              if (requestJobResult.imageKnifeData.errorInfo) {
-                requestJobResult.imageKnifeData.errorInfo.phase = LoadPhase.PHASE_WILL_SHOW;
-                requestJobResult.imageKnifeData.errorInfo.code = LoadPixelMapCode.IMAGE_LOAD_CANCEL_FAILED_CODE;
-              }
-            }
-            this.assembleImageKnifeData(callBackData,requestJobResult.imageKnifeData,requestWithSource.request)
-            LogUtil.log('getAndShowImage cancel:' + requestWithSource.request.componentId  + ',srcType:' + requestSource + ',version:' + requestWithSource.request.componentVersion)
-            requestWithSource.request.imageKnifeOption.onLoadListener.onLoadCancel('component has destroyed from load', requestWithSource.request)
           }
+        } else if (requestWithSource.source == ImageKnifeRequestSource.ERROR_HOLDER) {
+          requestWithSource.request.requestState = ImageKnifeRequestState.ERROR;
         }
       });
-
       this.executingJobMap.remove(memoryKey);
       this.dispatchNextJob();
     } else {

library/src/main/ets/components/ImageKnifeComponent.ets

@@ -20,6 +20,7 @@ import { LogUtil } from '../utils/LogUtil';
 import { ImageKnifeData, ImageKnifeRequestSource } from '../model/ImageKnifeData';
 import { IEngineKey } from '../key/IEngineKey';
 import { DefaultEngineKey } from '../key/DefaultEngineKey';
+import { emitter } from '@kit.BasicServicesKit';
 
 @Component
 export struct ImageKnifeComponent {
@@ -29,6 +30,7 @@ export struct ImageKnifeComponent {
   @State adaptiveWidth: Length = '100%'
   @State adaptiveHeight: Length | undefined = '100%'
   @State objectFit: ImageFit = ImageFit.Contain
+  private componentId: number = 0
   private request: ImageKnifeRequest | undefined
   private lastWidth: number = 0
   private lastHeight: number = 0
@@ -40,7 +42,7 @@ export struct ImageKnifeComponent {
 
   aboutToAppear(): void {
     this.objectFit = (this.imageKnifeOption.objectFit === undefined || this.imageKnifeOption.objectFit === ImageFit.Auto) ? ImageFit.Contain : this.imageKnifeOption.objectFit
-
+    this.componentId = this.getUniqueId()
     if(this.syncLoad) { //针对部分消息列表最新消息的图片闪动问题，建议使用同步方式在aboutToAppear时加载图片
       let engineKey: IEngineKey = new DefaultEngineKey();
       let memoryCacheSrc: ImageKnifeData | undefined = ImageKnife.getInstance()
@@ -65,13 +67,21 @@ export struct ImageKnifeComponent {
   }
 
   aboutToDisappear(): void {
+    this.emitterDestroy()
     this.clearLastRequest()
   }
 
   aboutToRecycle() {
     this.pixelMap = ImageContent.EMPTY
+    this.emitterDestroy()
     this.clearLastRequest()
   }
+
+  emitterDestroy() {
+    if (typeof this.request?.imageKnifeOption.loadSrc === 'string' && !this.request?.drawMainSuccess) {
+      emitter.emit(this.request.imageKnifeOption.loadSrc + this.componentId)
+    }
+  }
   /**
    * 对已DESTROY的组件不再发起请求
    */
@@ -105,13 +115,13 @@ export struct ImageKnifeComponent {
               ' loadSrc = ' + this.imageKnifeOption.loadSrc +
               ' placeholderSrc = ' + this.imageKnifeOption.placeholderSrc +
               ' errorholderSrc = ' + this.imageKnifeOption.errorholderSrc +
-              ' componentId = ' + this.getUniqueId())
+              ' componentId = ' + this.componentId)
 
             if (this.imageKnifeOption.objectFit === ImageFit.Auto && this.isImageFitAutoResize) {
               this.isImageFitAutoResize = false
             } else {
               ImageKnife.getInstance().execute(this.getRequest(
-                this.currentWidth, this.currentHeight, this.getUniqueId()))
+                this.currentWidth, this.currentHeight, this.componentId))
             }
           }
         }
@@ -127,9 +137,9 @@ export struct ImageKnifeComponent {
       ' loadSrc = ' + this.imageKnifeOption.loadSrc +
       ' placeholderSrc = ' + this.imageKnifeOption.placeholderSrc +
       ' errorholderSrc = ' + this.imageKnifeOption.errorholderSrc +
-      ' componentId = ' + this.getUniqueId())
+      ' componentId = ' + this.componentId)
     ImageKnife.getInstance().execute(this.getRequest(
-      this.currentWidth, this.currentHeight, this.getUniqueId()))
+      this.currentWidth, this.currentHeight, this.componentId))
   }
 
   getCurrentContext(): common.UIAbilityContext {

library/src/main/ets/loaderStrategy/HttpLoaderStrategy.ets

@@ -61,6 +61,9 @@ export class HttpLoaderStrategy implements IImageLoaderStrategy {
         ${request.componentVersion}`);
       callBackTimeInfo.netRequestStartTime = Date.now();
       const httpRequest = http.createHttp();
+      emitter.once((request.src as string) + request.componentId,()=>{
+        httpRequest.destroy()
+      })
       let progress: number = 0;
       const arrayBuffers: ArrayBuffer[] = [];
       const headerObj: Record<string, Object> = ImageKnifeLoader.getHeaderObj(request);
@@ -95,13 +98,12 @@ export class HttpLoaderStrategy implements IImageLoaderStrategy {
         header: headerObj,
         method: http.RequestMethod.GET,
         expectDataType: http.HttpDataType.ARRAY_BUFFER,
-        connectTimeout: request.connectTimeout === undefined || request.connectTimeout === null ?
+        connectTimeout: request.connectTimeout ?? 60000,
-          60000 : request.connectTimeout,
+        readTimeout: request.readTimeout ?? 30000,
-        readTimeout: request.readTimeout === undefined || request.readTimeout === null?
-          30000 : request.readTimeout,
         caPath: request.caPath
       });
       promise.then((data: number) => {
+        emitter.off((request.src as string) + request.componentId)
         callBackData.httpCode = data;
         ImageKnifeLoader.assembleError(callBackData,LoadPhase.PHASE_NET, undefined);
         callBackTimeInfo.netRequestEndTime = Date.now();
@@ -114,6 +116,7 @@ export class HttpLoaderStrategy implements IImageLoaderStrategy {
             LoadPhase.PHASE_NET, LoadPixelMapCode.IMAGE_HTTPS_LOAD_FAILED_CODE));
         }
       }).catch((err: BusinessError) => {
+        emitter.off((request.src as string) + request.componentId)
         callBackData.httpCode = err.code;
         loadError = 'HttpDownloadClient download ERROR : err = ' + JSON.stringify(err);
         callBackTimeInfo.netRequestEndTime = Date.now();

library/src/main/ets/model/ImageKnifeRequest.ets

@@ -22,6 +22,7 @@ export class ImageKnifeRequest {
   componentWidth: number = 0
   componentHeight: number = 0
   drawPlayHolderSuccess: boolean = false
+  drawMainSuccess: boolean = false
   imageKnifeOption: ImageKnifeOption
   context: common.UIAbilityContext
   ImageKnifeRequestCallback: ImageKnifeRequestCallback