【update】地图打印参数根据模板的配置校验; review by luox

xiongjiaojiao · xiongjiaojiao · commit de7bb4e21fc0 · 2024-03-14T15:47:14.000+08:00
diff --git a/examples/mapboxgl/webPrintingJob.html b/examples/mapboxgl/webPrintingJob.html
@@ -344,7 +344,7 @@ <h4 class="panel-title">
                             window.URL.revokeObjectURL(link.href);
                             $('#printBtn').show();
                             $('.progress').hide();
-                        } else if (!res.result) {
+                        } else if (!res.result || res.result.status === 'ERROR') {
                             alert('打印失败');
                             $('#printBtn').show();
                             $('.progress').hide();
diff --git a/src/common/iServer/WebPrintingJobLayoutOptions.js b/src/common/iServer/WebPrintingJobLayoutOptions.js
@@ -19,8 +19,10 @@ import { WebPrintingJobLegendOptions } from './WebPrintingJobLegendOptions';
  * @param {string} option.subTitle - 地图副标题名称。
  * @param {string} option.author - 地图作者名称。
  * @param {string} option.copyright - 版权描述信息。
- * @param {WebPrintingJobLittleMapOptions} option.littleMapOptions - 小地图参数类。
- * @param {WebPrintingJobLegendOptions} option.legendOptions - 图例参数类。
+ * @param {string} [option.summaryText] - 自定义描述信息。
+ * @param {string} [option.time] - 打印时间。
+ * @param {WebPrintingJobLittleMapOptions} [option.littleMapOptions] - 小地图参数类。
+ * @param {WebPrintingJobLegendOptions} [option.legendOptions] - 图例参数类。
  * @param {WebPrintingJobScaleBarOptions} [option.scaleBarOptions] - 地图比例尺参数类。
  * @param {WebPrintingJobNorthArrowOptions} [option.northArrowOptions] - 地图指北针参数类。
  * @usage
@@ -52,6 +54,16 @@ export class WebPrintingJobLayoutOptions {
          * @description 地图版权描述信息。
          */
         this.copyright = null;
+        /**
+         * @member {string} WebPrintingJobLayoutOptions.prototype.summaryText
+         * @description 自定义描述信息。
+         */
+        this.summaryText = null;
+        /**
+         * @member {string} WebPrintingJobLayoutOptions.prototype.time
+         * @description 打印时间
+         */
+        this.time = null;
         /**
          * @member {WebPrintingJobScaleBarOptions} [WebPrintingJobLayoutOptions.prototype.scaleBarOptions]
          * @description 地图比例尺参数类。
@@ -87,6 +99,8 @@ export class WebPrintingJobLayoutOptions {
         this.subTitle = null;
         this.author = null;
         this.copyright = null;
+        this.summaryText = null;
+        this.time = null;
         if (this.scaleBarOptions instanceof WebPrintingJobScaleBarOptions) {
             this.scaleBarOptions.destroy();
             this.scaleBarOptions = null;
@@ -104,33 +118,5 @@ export class WebPrintingJobLayoutOptions {
             this.legendOptions = null;
         }
     }
-
-    /**
-     * @function WebPrintingJobLayoutOptions.prototype.toJSON
-     * @description 将 WebPrintingJobLayoutOptions 对象转化为 JSON 字符串。
-     * @returns {string} 转换后的 JSON 字符串。
-     */
-    toJSON() {
-        var params = {
-            templateName: this.templateName,
-            title: this.title,
-            subTitle: this.subTitle,
-            author: this.author,
-            copyright: this.copyright
-        };
-        if (this.scaleBarOptions) {
-            params.scaleBarOptions = this.scaleBarOptions;
-        }
-        if (this.northArrowOptions) {
-            params.northArrowOptions = this.northArrowOptions;
-        }
-        if (this.littleMapOptions) {
-            params.littleMapOptions = this.littleMapOptions;
-        }
-        if (this.legendOptions) {
-            params.legendOptions = this.legendOptions;
-        }
-        return Util.toJSON(params);
-    }
 }
 
diff --git a/src/common/iServer/WebPrintingService.js b/src/common/iServer/WebPrintingService.js
@@ -18,136 +18,197 @@ import { CommonServiceBase } from './CommonServiceBase';
  * @usage
  */
 export class WebPrintingService extends CommonServiceBase {
-    constructor(url, options) {
-        super(url, options);
+  constructor(url, options) {
+    super(url, options);
 
-        if (options) {
-            Util.extend(this, options);
-        }
-        this.CLASS_NAME = 'SuperMap.WebPrintingService';
-        if (!this.url) {
-            return;
-        }
+    if (options) {
+      Util.extend(this, options);
     }
-
-    /**
-     * @function WebPrintingService.prototype.destroy
-     * @description 释放资源，将引用资源的属性置空。
-     */
-    destroy() {
-        super.destroy();
+    this.templates = [];
+    this.CLASS_NAME = 'SuperMap.WebPrintingService';
+    if (!this.url) {
+      return;
     }
+  }
 
-    /**
-     * @function WebPrintingService.prototype.createWebPrintingJob
-     * @description 创建 Web 打印任务。
-     * @param {WebPrintingJobParameters} params - Web 打印的请求参数。
-     * @param {RequestCallback} [callback] - 回调函数，该参数未传时可通过返回的 promise 获取结果。
-     * @returns {Promise} Promise 对象。
-     */
-    createWebPrintingJob(params, callback) {
-        if (!params) {
-            return;
-        }
-        if (params.layoutOptions) {
-            if (params.layoutOptions.legendOptions) {
-                !params.layoutOptions.legendOptions.title && (params.layoutOptions.legendOptions.title = '');
-                params.layoutOptions.legendOptions.picAsBase64 =
-                    params.layoutOptions.legendOptions.picAsBase64 &&
-                    params.layoutOptions.legendOptions.picAsBase64.replace(/^data:.+;base64,/, '');
-                if (
-                    params.layoutOptions.legendOptions.customItems &&
-                    params.layoutOptions.legendOptions.customItems.hasOwnProperty('picAsBase64')
-                ) {
-                    params.layoutOptions.legendOptions.customItems.picAsBase64 = params.layoutOptions.legendOptions.customItems.picAsBase64.replace(
-                        /^data:.+;base64,/,
-                        ''
-                    );
-                }
-            }
-        }
-        return this.processAsync('jobs', 'POST', callback, params)
-    }
+  /**
+   * @function WebPrintingService.prototype.destroy
+   * @description 释放资源，将引用资源的属性置空。
+   */
+  destroy() {
+    super.destroy();
+  }
 
-    /**
-     * @function WebPrintingService.prototype.getPrintingJob
-     * @description 获取 Web 打印输出文档任务, 轮询获取打印状态，只有当状态为完成或失败才返回结果。
-     * @param {string} jobId - Web 打印任务 ID
-     * @param {RequestCallback} callback - 回调函数。
-     */
-    getPrintingJob(jobId, callback) {
-        var me = this;
-        me.rollingProcess(me._processUrl(`jobs/${jobId}`), callback);
+  /**
+   * @function WebPrintingService.prototype.createWebPrintingJob
+   * @description 创建 Web 打印任务。
+   * @param {WebPrintingJobParameters} params - Web 打印的请求参数。
+   * @param {RequestCallback} [callback] - 回调函数，该参数未传时可通过返回的 promise 获取结果。
+   * @returns {Promise} Promise 对象。
+   */
+  async createWebPrintingJob(params, callback) {
+    if (!params) {
+      return;
     }
+    await this._processParams(params);
+    return this.processAsync('jobs', 'POST', callback, params);
+  }
 
-    /**
-     * @function WebPrintingService.prototype.getPrintingJobResult
-     * @description 获取 Web 打印任务的输出文档。
-     * @param {string} jobId -  Web 打印输出文档任务 ID。
-     * @param {RequestCallback} [callback] - 回调函数，该参数未传时可通过返回的 promise 获取结果。
-     * @returns {Promise} Promise 对象。
-     */
-    getPrintingJobResult(jobId, callback) {
-        return this.processAsync(`jobs/${jobId}/result`, 'GET', callback);
-    }
+  /**
+   * @function WebPrintingService.prototype.getPrintingJob
+   * @description 获取 Web 打印输出文档任务, 轮询获取打印状态，只有当状态为完成或失败才返回结果。
+   * @param {string} jobId - Web 打印任务 ID
+   * @param {RequestCallback} callback - 回调函数。
+   */
+  getPrintingJob(jobId, callback) {
+    var me = this;
+    me.rollingProcess(me._processUrl(`jobs/${jobId}`), callback);
+  }
 
-    /**
-     * @function WebPrintingService.prototype.getLayoutTemplates
-     * @description 查询 Web 打印服务所有可用的模板信息。
-     * @param {RequestCallback} [callback] - 回调函数，该参数未传时可通过返回的 promise 获取结果。
-     * @returns {Promise} Promise 对象。
-     */
-    getLayoutTemplates(callback) {
-      return this.processAsync('layouts', 'GET', callback);
-    }
+  /**
+   * @function WebPrintingService.prototype.getPrintingJobResult
+   * @description 获取 Web 打印任务的输出文档。
+   * @param {string} jobId -  Web 打印输出文档任务 ID。
+   * @param {RequestCallback} [callback] - 回调函数，该参数未传时可通过返回的 promise 获取结果。
+   * @returns {Promise} Promise 对象。
+   */
+  getPrintingJobResult(jobId, callback) {
+    return this.processAsync(`jobs/${jobId}/result`, 'GET', callback);
+  }
 
-    /**
-     * @function WebPrintingService.prototype.rollingProcess
-     * @description 轮询查询 Web 打印任务。
-     * @param {Object} result - 服务器返回的结果对象。
-     */
-    rollingProcess(url, callback) {
-        var me = this;
-        this.id && clearInterval(this.id);
-        this.id = setInterval(function () {
-          me.request({
-            url,
-            method: 'GET',
-            scope: me,
-            success: callback,
-            failure: callback
-          });
-        }, 1000);
-    }
+  /**
+   * @function WebPrintingService.prototype.getLayoutTemplates
+   * @description 查询 Web 打印服务所有可用的模板信息。
+   * @param {RequestCallback} [callback] - 回调函数，该参数未传时可通过返回的 promise 获取结果。
+   * @returns {Promise} Promise 对象。
+   */
+  getLayoutTemplates(callback) {
+    return this.processAsync('layouts', 'GET', callback);
+  }
 
-    processAsync(url, method, callback, params) {
-      var me = this;
-      let requestConfig = {
-        url: me._processUrl(url),
-        method,
+  /**
+   * @function WebPrintingService.prototype.rollingProcess
+   * @description 轮询查询 Web 打印任务。
+   * @param {Object} result - 服务器返回的结果对象。
+   */
+  rollingProcess(url, callback) {
+    var me = this;
+    this.id && clearInterval(this.id);
+    this.id = setInterval(function () {
+      me.request({
+        url,
+        method: 'GET',
         scope: me,
         success: callback,
         failure: callback
-      };
-      params && (requestConfig.data = Util.toJSON(params));
-      return me.request(requestConfig);
+      });
+    }, 1000);
+  }
+
+  processAsync(url, method, callback, params) {
+    var me = this;
+    let requestConfig = {
+      url: me._processUrl(url),
+      method,
+      scope: me,
+      success: callback,
+      failure: callback
+    };
+    params && (requestConfig.data = Util.toJSON(params));
+    return me.request(requestConfig);
+  }
+
+  transformResult(result, options) {
+    result = Util.transformResult(result);
+    if (result.status === 'FINISHED' || result.status === 'ERROR') {
+      clearInterval(this.id);
+    } else if (result.status === 'RUNNING') {
+      options.success = false;
     }
+    return { result, options };
+  }
 
-    transformResult(result, options) {
-      result = Util.transformResult(result);
-      if (result.status === 'FINISHED' || result.status === 'ERROR') {
-        clearInterval(this.id);
-      } else if (result.status === 'RUNNING') {
-        options.success = false;
-      }
-      return { result, options };
+  _processUrl(appendContent) {
+    if (appendContent) {
+      return Util.urlPathAppend(this.url, appendContent);
     }
+    return this.url;
+  }
 
-    _processUrl(appendContent) {
-        if (appendContent) {
-            return Util.urlPathAppend(this.url, appendContent);
-        }
-        return this.url;
+  async _processParams(params) {
+    if (!params.layoutOptions) {
+      return;
+    }
+    const { legendOptions, templateName } = params.layoutOptions;
+    if (legendOptions) {
+      !params.layoutOptions.legendOptions.title && (params.layoutOptions.legendOptions.title = '');
+      params.layoutOptions.legendOptions.picAsBase64 =
+        params.layoutOptions.legendOptions.picAsBase64 &&
+        params.layoutOptions.legendOptions.picAsBase64.replace(/^data:.+;base64,/, '');
+      if (
+        params.layoutOptions.legendOptions.customItems &&
+        params.layoutOptions.legendOptions.customItems.hasOwnProperty('picAsBase64')
+      ) {
+        params.layoutOptions.legendOptions.customItems.picAsBase64 =
+          params.layoutOptions.legendOptions.customItems.picAsBase64.replace(/^data:.+;base64,/, '');
+      }
+    }
+    if (!this.templates.length) {
+      const res = await this.getLayoutTemplates();
+      this.templates = res.result;
     }
+    const matchTemplate = this.templates.find((item) => item.templateName === templateName);
+    //根据模板判断哪些参数需要传递
+    const {
+      hasCopyright,
+      hasSubtitle,
+      hasAuthor,
+      hasScaleBar,
+      hasTitle,
+      hasTime,
+      hasSummaryText,
+      hasLittleMap,
+      hasNorthArrow,
+      hasLegend
+    } = matchTemplate.layoutOptions;
+    const layoutOptions = params.layoutOptions;
+    if (!hasTitle) {
+      delete params.layoutOptions.title;
+    } else if (layoutOptions.title === void 0) {
+      params.layoutOptions.title = null;
+    }
+    if (!hasSubtitle) {
+      delete params.layoutOptions.subTitle;
+    } else if (layoutOptions.subTitle === void 0) {
+      params.layoutOptions.subTitle = null;
+    }
+    if (!hasAuthor) {
+      delete params.layoutOptions.author;
+    } else if (layoutOptions.author === void 0) {
+      params.layoutOptions.author = null;
+    }
+    if (!hasCopyright) {
+      delete params.layoutOptions.copyright;
+    } else if (layoutOptions.copyright === void 0) {
+      params.layoutOptions.copyright = null;
+    }
+    if (!hasSummaryText || !layoutOptions.summaryText) {
+      delete params.layoutOptions.summaryText;
+    }
+    if (!hasTime || !layoutOptions.time) {
+      delete params.layoutOptions.time;
+    }
+    if (!hasLittleMap || !layoutOptions.littleMapOptions) {
+      delete params.layoutOptions.littleMapOptions;
+    }
+    if (!hasScaleBar || !layoutOptions.scaleBarOptions) {
+      delete params.layoutOptions.scaleBarOptions;
+    }
+    if (!hasNorthArrow || !layoutOptions.northArrowOptions) {
+      delete params.layoutOptions.northArrowOptions;
+    }
+    if (!hasLegend || !layoutOptions.legendOptions) {
+      delete params.layoutOptions.legendOptions;
+    }
+  }
 }
-
diff --git a/test/common/iServer/WebPrintingServiceSpec.js b/test/common/iServer/WebPrintingServiceSpec.js
