自定义网络方法增加请求头参数

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

CHANGELOG.md

@@ -1,3 +1,6 @@
+## 3.0.3-rc.0
+- Custom network method to add request header parameters
+
 ## 3.0.2
 - Added new image reloading interface reload
 - Added return request preload interface preload

README_zh.md

@@ -288,7 +288,7 @@ ImageKnifeAnimatorComponent({
 ### ImageKnifeOption参数列表
 
 | 参数名称                  | 入参内容                                                                                                                                  | 功能简介          |
-|-----------------------|-------------------------------------------------------|-----------------|
+|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------|---------------|
 | loadSrc               | string、PixelMap、Resource                                                                                                              | 主图展示          |
 | placeholderSrc        | PixelMap、Resource                                                                                                                     | 占位图图展示（可选）    |
 | errorholderSrc        | PixelMap、Resource                                                                                                                     | 错误图展示（可选）     |
@@ -297,7 +297,7 @@ ImageKnifeAnimatorComponent({
 | errorholderObjectFit  | ImageFit                                                                                                                              | 错误图填充效果（可选）   |
 | writeCacheStrategy    | CacheStrategyType                                                                                                                     | 写入缓存策略(可选)    |
 | onlyRetrieveFromCache | boolean                                                                                                                               | 是否跳过网络和本地请求（可选） |
-| customGetImage        | (context: Context, src: string                        | 自定义下载图片（可选）     |                                                                                                                                                                              | Resource                                      | 错误占位图数据源                    |
+| customGetImage        | customGetImage?:(context: Context, src: string、PixelMap、Resource ,headers?: Record<string, Object>) => Promise<ArrayBuffer、undefined> | 自定义下载图片（可选）    |                                                                                                                                                                              | Resource                                      | 错误占位图数据源                    |
 | border                | BorderOptions                                                                                                                         | 边框圆角（可选）      |
 | priority              | taskpool.Priority                                                                                                                     | 加载优先级（可选）     | 
 | context               | common.UIAbilityContext                                                                                                               | 上下文（可选）       |
@@ -307,7 +307,7 @@ ImageKnifeAnimatorComponent({
 | transformation        | PixelMapTransformation                                                                                                                | 图片变换（可选）      |
 | drawingColorFilter    | ColorFilter                                                                                                                           | drawing.ColorFilter                  | 图片变换（可选）        |
 | onComplete            | (event:EventImage                                                                                                                     | undefined) => voi              | 颜色滤镜效果（可选）        |
-| onLoadListener        | onLoadStart: () => void、onLoadSuccess: (data: string | PixelMap | undefined) => void、onLoadFailed: (err: string) => void| 监听图片加载成功与失败     |
+| onLoadListener        | onLoadStart: () => void，onLoadSuccess: (data: string、PixelMap、undefined) => void，onLoadFailed: (err: string) => void                  | 监听图片加载成功与失败     |
 
 ### ImageKnife接口
 
@@ -323,7 +323,7 @@ ImageKnifeAnimatorComponent({
 | addHeader         | key: string, value: Object                                                                            | 全局添加http请求头      |
 | setHeaderOptions  | Array<HeaderOptions>                                                                                  | 全局设置http请求头      |
 | deleteHeader      | key: string                                                                                           | 全局删除http请求头      |
-| setCustomGetImage | customGetImage?: (context: Context, src: string                                                       | PixelMap         | Resource) => Promise<ArrayBuffer | undefined>   | 全局设置自定义下载 |
+| setCustomGetImage | customGetImage?: (context: Context, src: string、PixelMap、Resource ,headers?: Record<string, Object>) => Promise<ArrayBuffer、undefined>                                                      | PixelMap         | Resource) => Promise<ArrayBuffer | undefined>   | 全局设置自定义下载 |
 | setEngineKeyImpl  | IEngineKey                                                                                            | 全局配置缓存key生成策略    |
 | putCacheImage     | url: string, pixelMap: PixelMap, cacheType: CacheStrategy = CacheStrategy.Default, signature?: string | 写入内存磁盘缓存         |
 | removeMemoryCache | url: string                                                                                           | ImageKnifeOption | 清理指定内存缓存      |

entry/src/main/ets/pages/SingleImage.ets

@@ -88,6 +88,10 @@ struct SingleImage {
             placeholderSrc: $r("app.media.loading"),
             errorholderSrc: $r("app.media.failed"),
             objectFit: ImageFit.Contain,
+            headerOption:[{
+              key:"refer",
+              value:"xx.xx.xx.xx"
+            }],
             customGetImage: custom,
             transformation: new BlurTransformation(10)
           }
@@ -124,8 +128,9 @@ struct SingleImage {
 
 // 自定义下载方法
 @Concurrent
-async function custom(context: Context, src: string | PixelMap | Resource): Promise<ArrayBuffer | undefined> {
+async function custom(context: Context, src: string | PixelMap | Resource,headers?: Record<string, Object>): Promise<ArrayBuffer | undefined> {
-  console.info("ImageKnife::  custom download：" + src)
+  let refer = headers!["refer"] as string
+  console.info("ImageKnife::  custom download：" + src,"refer:"+refer)
   // 举例写死从本地文件读取，也可以自己请求网络图片
   return context.resourceManager.getMediaContentSync($r("app.media.startIcon").id).buffer as ArrayBuffer
 }

library/oh-package.json5

@@ -14,7 +14,7 @@
   "main": "index.ets",
   "repository": "https://gitee.com/openharmony-tpc/ImageKnife",
   "type": "module",
-  "version": "3.0.2",
+  "version": "3.0.3-rc.0",
   "dependencies": {
     "@ohos/gpu_transform": "^1.0.2"
   },

library/src/main/ets/ImageKnife.ets

@@ -423,10 +423,10 @@ export class ImageKnife {
    * 全局设置自定义下载
    * @param customGetImage 自定义请求函数
    */
-  setCustomGetImage(customGetImage?: (context: Context, src: string | PixelMap | Resource) => Promise<ArrayBuffer | undefined>) {
+  setCustomGetImage(customGetImage?: (context: Context, src: string | PixelMap | Resource,headers?: Record<string, Object>) => Promise<ArrayBuffer | undefined>) {
     this.customGetImage = customGetImage
   }
-  getCustomGetImage(): undefined | ((context: Context, src: string | PixelMap | Resource) => Promise<ArrayBuffer | undefined>){
+  getCustomGetImage(): undefined | ((context: Context, src: string | PixelMap | Resource,headers?: Record<string, Object>) => Promise<ArrayBuffer | undefined>){
     return this.customGetImage
   }
 }

library/src/main/ets/ImageKnifeLoader.ets

@@ -193,7 +193,19 @@ export class ImageKnifeLoader {
       return ImageKnifeLoader.makeEmptyResult("ImageKnifeAnimatorComponent组件仅支持动态图")
     }
   }
-
+  static getHeaderObj(request:RequestJobRequest){
+    const headerObj: Record<string, Object> = {}
+    if (request.headers != undefined) {
+      request.headers.forEach((value) => {
+        headerObj[value.key] = value.value
+      })
+    } else if (request.allHeaders.size > 0) {
+      request.allHeaders.forEach((value, key) => {
+        headerObj[key] = value
+      })
+    }
+    return headerObj
+  }
   // 获取图片资源
   static async getImageArrayBuffer(request: RequestJobRequest, requestList: List<ImageKnifeRequestWithSource> | undefined,fileKey:string): Promise<ArrayBuffer> {
     let resBuf: ArrayBuffer | undefined
@@ -205,7 +217,8 @@ export class ImageKnifeLoader {
       if (resBuf === undefined) {
         LogUtil.log("start customGetImage src=" + request.src)
         try {
-          resBuf = await request.customGetImage(request.context, request.src)
+          const headerObj: Record<string, Object> = ImageKnifeLoader.getHeaderObj(request)
+          resBuf = await request.customGetImage(request.context, request.src,headerObj)
           LogUtil.log("end customGetImage src=" + request.src)
         } catch (err) {
           throw new Error('customGetImage loadFile failed! err = ' + err)
@@ -234,16 +247,7 @@ export class ImageKnifeLoader {
             let httpRequest = http.createHttp();
             let progress: number = 0
             let arrayBuffers = new Array<ArrayBuffer>()
-            const headerObj: Record<string, object> = {}
+            const headerObj: Record<string, Object> = ImageKnifeLoader.getHeaderObj(request)
-            if (request.headers != undefined) {
-              request.headers.forEach((value) => {
-                headerObj[value.key] = value.value
-              })
-            } else if (request.allHeaders.size > 0) {
-              request.allHeaders.forEach((value, key) => {
-                headerObj[key] = value
-              })
-            }
             httpRequest.on("dataReceive", (data: ArrayBuffer) => {
               arrayBuffers.push(data)
             });

library/src/main/ets/model/ImageKnifeData.ets

@@ -91,7 +91,7 @@ export interface RequestJobRequest {
   allHeaders: Map<string, Object>,
   componentWidth: number,
   componentHeight: number,
-  customGetImage?: (context: Context, src: string | PixelMap | Resource) => Promise<ArrayBuffer | undefined>,
+  customGetImage?: (context: Context, src: string | PixelMap | Resource ,headers?: Record<string, Object>) => Promise<ArrayBuffer | undefined>,
   onlyRetrieveFromCache?: boolean
   requestSource: ImageKnifeRequestSource
   transformation?: PixelMapTransformation

library/src/main/ets/model/ImageKnifeOption.ets

@@ -61,7 +61,7 @@ export class ImageKnifeOption {
   placeholderObjectFit?: ImageFit
   // 错误图填充效果
   errorholderObjectFit?: ImageFit
-  customGetImage?: (context: Context, src: string | PixelMap | Resource) => Promise<ArrayBuffer | undefined>
+  customGetImage?: (context: Context, src: string | PixelMap | Resource,headers?: Record<string, Object>) => Promise<ArrayBuffer | undefined>
   border?: BorderOptions
   // 缓存策略
   writeCacheStrategy?: CacheStrategy