【feature】支持设置全局自定义RequestHeader；ol webmap 出图支持自定义的tileRequestParameters；review by luox

xiongjiaojiao · xiongjiaojiao · commit a828bb0a3a94 · 2025-01-17T09:21:15.000+08:00
diff --git a/src/common/index.common.js b/src/common/index.common.js
@@ -329,6 +329,7 @@ import { ElasticSearch } from './thirdparty';
 import {
     isCORS,
     setCORS,
+    setRequestHeaders,
     FetchRequest,
     ColorsPickerUtil,
     ArrayStatistic,
@@ -501,6 +502,7 @@ export { Format, GeoJSONFormat, JSONFormat, WKTFormat };
 export {
     isCORS,
     setCORS,
+    setRequestHeaders,
     FetchRequest,
     EncryptRequest,
     getServiceKey,
diff --git a/src/common/namespace.js b/src/common/namespace.js
@@ -337,6 +337,7 @@ import {
   ElasticSearch,
   isCORS,
   setCORS,
+  setRequestHeaders,
   FetchRequest,
   EncryptRequest,
   getServiceKey,
@@ -497,6 +498,7 @@ SuperMap.setCORS = setCORS;
 SuperMap.isCORS = isCORS;
 SuperMap.setRequestTimeout = setRequestTimeout;
 SuperMap.getRequestTimeout = getRequestTimeout;
+SuperMap.setRequestHeaders = setRequestHeaders;
 SuperMap.FetchRequest = FetchRequest;
 SuperMap.EncryptRequest = EncryptRequest;
 SuperMap.getServiceKey = getServiceKey;
diff --git a/src/common/util/FetchRequest.js b/src/common/util/FetchRequest.js
@@ -171,6 +171,7 @@ export var RequestJSONPPromise = {
 
 var CORS;
 var RequestTimeout;
+var RequestHeadersGetter;
 /**
  * @function setCORS
  * @description 设置是否允许跨域请求，全局配置，优先级低于 service 下的 crossOring 参数。
@@ -279,6 +280,43 @@ export var getRequestTimeout = function () {
     return RequestTimeout || 45000;
 }
 
+/**
+ * @function setRequestHeaders
+ * @category BaseTypes Util
+ * @description 设置请求自定义 request headers。
+ * @param {function} func - 请求自定义 request headers 回调函数。
+ * @usage
+ * ```
+ * // 浏览器
+  <script type="text/javascript" src="{cdn}"></script>
+  <script>
+    const headers = function (url) { return { token: !!url }; };
+    {namespace}.setRequestHeaders(headers);
+
+  </script>
+
+  // ES6 Import
+  import { setRequestHeaders } from '{npm}';
+
+  const headers = function (url) { return { token: !!url }; };
+  setRequestHeaders(headers);
+ * ```
+ */
+export var setRequestHeaders = function (headers) {
+    return RequestHeadersGetter = headers;
+}
+
+/**
+ * @private
+ * @function getRequestTimeout
+ * @category BaseTypes Util
+ * @description 获取请求超时的时间。
+ * @returns {number} 请求超时时间。
+ */
+export var getRequestHeaders = function () {
+    return RequestHeadersGetter;
+}
+
 /**
  * @name FetchRequest
  * @namespace
@@ -501,6 +539,11 @@ export var FetchRequest = {
         if (!options.headers['Content-Type'] && !FormData.prototype.isPrototypeOf(params)) {
             options.headers['Content-Type'] = 'application/x-www-form-urlencoded;charset=UTF-8';
         }
+        const customRequestHeadersGetter = getRequestHeaders();
+        const customRequestHeaders = customRequestHeadersGetter && customRequestHeadersGetter(url);
+        if (customRequestHeaders) {
+            options.headers = Util.extend(options.headers, customRequestHeaders);
+        }
         if (options.timeout) {
             return this._timeout(
                 options.timeout,
diff --git a/src/common/util/index.js b/src/common/util/index.js
@@ -6,6 +6,7 @@ import {
   isCORS,
   setRequestTimeout,
   getRequestTimeout,
+  setRequestHeaders,
   FetchRequest
 } from './FetchRequest';
 
@@ -72,6 +73,7 @@ export {
   isCORS,
   setRequestTimeout,
   getRequestTimeout,
+  setRequestHeaders,
   FetchRequest,
   EncryptRequest,
   getServiceKey,
diff --git a/src/openlayers/mapping/WebMap.js b/src/openlayers/mapping/WebMap.js
@@ -131,6 +131,7 @@ export class WebMap extends Observable {
     this.webMap = options.webMap;
     this.tileFormat = options.tileFormat && options.tileFormat.toLowerCase();
     this.restDataSingleRequestCount = options.restDataSingleRequestCount || 1000;
+    this.tileRequestParameters = options.tileRequestParameters;
     this.createMap(options.mapSetting);
     if (this.webMap) {
       // webmap有可能是url地址，有可能是webmap对象
@@ -590,7 +591,8 @@ export class WebMap extends Observable {
           let options = {
             serverType,
             url,
-            tileGrid: TileSuperMapRest.optionsFromMapJSON(url, result).tileGrid
+            tileGrid: TileSuperMapRest.optionsFromMapJSON(url, result).tileGrid,
+            tileLoadFunction: me.getCustomTileLoadFunction()
           };
           if (url && !CommonUtil.isInTheSameDomain(url) && !this.isIportalProxyServiceUrl(url)) {
             options.tileProxy = me.server + 'apps/viewer/getUrlResource.png?url=';
@@ -1178,6 +1180,36 @@ export class WebMap extends Observable {
         break;
     }
   }
+
+  getCustomTileLoadFunction(transformImageUrl) {
+    const that = this;
+    if (this.tileRequestParameters) {
+      return function(imageTile, url) {
+        const src = transformImageUrl ? transformImageUrl(url) : url;
+        const requestParameters = that.tileRequestParameters(src);
+        if (requestParameters) {
+          FetchRequest.get(src, null, {
+            ...requestParameters,
+            withoutFormatSuffix: true
+          })
+            .then(function (response) {
+              return response.blob();
+            })
+            .then(function (blob) {
+              const imageUrl = URL.createObjectURL(blob);
+              imageTile.getImage().src = imageUrl;
+            })
+            .catch(function (error) {
+              console.error('Error fetching the image:', error);
+              imageTile.setState('error');
+            });
+        } else {
+          imageTile.getImage().src = src;
+        }
+      }
+    }
+  }
+
   /**
    * @private
    * @function WebMap.prototype.createDynamicTiledSource
@@ -1208,7 +1240,8 @@ export class WebMap extends Observable {
       // crossOrigin: 'anonymous', //在IE11.0.9600版本，会影响通过注册服务打开的iserver地图，不出图。因为没有携带cookie会报跨域问题
       // extent: this.baseLayerExtent,
       // prjCoordSys: {epsgCode: isBaseLayer ? layerInfo.projection.split(':')[1] : this.baseProjection.split(':')[1]},
-      format: layerInfo.format
+      format: layerInfo.format,
+      tileLoadFunction: this.getCustomTileLoadFunction()
     };
     if (!isBaseLayer && !this.isCustomProjection(this.baseProjection)) {
       options.prjCoordSys = { epsgCode: this.baseProjection.split(':')[1] };
@@ -1322,7 +1355,8 @@ export class WebMap extends Observable {
     return new XYZ({
       url: layerInfo.url,
       wrapX: false,
-      crossOrigin: 'anonymous'
+      crossOrigin: 'anonymous',
+      tileLoadFunction: this.getCustomTileLoadFunction()
     });
   }
 
@@ -1368,7 +1402,8 @@ export class WebMap extends Observable {
       wrapX: false,
       crossOrigin: 'anonymous',
       tileGrid: this._getTileGrid({ origin, resolutions, tileSize }),
-      projection: this.baseProjection
+      projection: this.baseProjection,
+      tileLoadFunction: this.getCustomTileLoadFunction()
     };
     return new XYZ(options);
   }
@@ -1399,9 +1434,7 @@ export class WebMap extends Observable {
         VERSION: layerInfo.version || '1.3.0'
       },
       projection: layerInfo.projection || that.baseProjection,
-      tileLoadFunction: function (imageTile, src) {
-        imageTile.getImage().src = src;
-      }
+      tileLoadFunction: this.getCustomTileLoadFunction()
     });
   }
 
@@ -1794,13 +1827,12 @@ export class WebMap extends Observable {
         layerInfo.origin,
         layerInfo.matrixIds
       ),
-      tileLoadFunction: function (imageTile, src) {
+      tileLoadFunction: this.getCustomTileLoadFunction(function (src) {
         if (src.indexOf('tianditu.gov.cn') >= 0) {
-          imageTile.getImage().src = `${src}&tk=${CommonUtil.getParameters(layerInfo.url)['tk']}`;
-          return;
+          return `${src}&tk=${CommonUtil.getParameters(layerInfo.url)['tk']}`;
         }
-        imageTile.getImage().src = src;
-      }
+        return src;
+      })
     });
   }
 
@@ -2996,13 +3028,15 @@ export class WebMap extends Observable {
     };
     let featureType = layerInfo.featureType;
     let style = await StyleUtils.toOpenLayersStyle(this.getDataVectorTileStyle(featureType), featureType);
+    const requestParameters = this.tileRequestParameters && this.tileRequestParameters(layerInfo.url);
     return new olLayer.VectorTile({
       //设置避让参数
       source: new VectorTileSuperMapRest({
         url: layerInfo.url,
         projection: layerInfo.projection,
         tileType: 'ScaleXY',
-        format: format
+        format: format,
+        ...requestParameters
       }),
       style: style
     });
@@ -5119,7 +5153,6 @@ export class WebMap extends Observable {
    * @param {Object} layerInfo - 图层信息
    */
   createMVTLayer(layerInfo) {
-    // let that = this;
     let styles = layerInfo.styles;
     const indexbounds = styles && styles.metadata && styles.metadata.indexbounds;
     const visibleResolution = this.createVisibleResolution(
@@ -5132,13 +5165,15 @@ export class WebMap extends Observable {
     const styleResolutions = this.getStyleResolutions(envelope);
     // const origin = [envelope.left, envelope.top];
     let withCredentials = this.isIportalProxyServiceUrl(styles.sprite);
+    const requestParameters = this.tileRequestParameters && this.tileRequestParameters(styles.sprite);
     // 创建MapBoxStyle样式
     let mapboxStyles = new MapboxStyles({
       style: styles,
       source: styles.name,
       resolutions: styleResolutions,
       map: this.map,
-      withCredentials
+      withCredentials,
+      ...requestParameters
     });
     return new Promise((resolve) => {
       mapboxStyles.on('styleloaded', function () {
@@ -5154,7 +5189,8 @@ export class WebMap extends Observable {
             format: new MVT({
               featureClass: olRenderFeature
             }),
-            wrapX: false
+            wrapX: false,
+            ...requestParameters
           }),
           style: mapboxStyles.featureStyleFuntion,
           visible: layerInfo.visible,
diff --git a/test/openlayers/mapping/WebMapSpec.js b/test/openlayers/mapping/WebMapSpec.js
