移动平台

# 替换高德地图 KEY 数据操作文档

# 一、适用范围

本文档适用于 V8.2SP1 以下版本，用于将系统中的高德地图 KEY 数据替换为客户自行在高德开放平台申请或购买的配置。

V8.2SP1 及以上版本使用高德地图服务代理方案，不适用本文档。请勿在这些版本中使用 替换高德地图key数据 功能。

# 二、操作前准备

操作前请确认已具备以下条件：

  • 已准备客户自行申请或购买的 Web 端 Key。
  • 已准备客户自行申请或购买的 Web 服务 Key。
  • 已准备与上述 Key 配套的 私钥。
  • 已获取待处理环境的 ApacheJetspeed\webapps 目录。
  • 已启动高德地图服务替换工具。

如果客户未提供完整的 Key 和私钥，请勿执行替换。

# KEY 数据从哪里获取

本文档中使用的 KEY 数据由客户在高德开放平台 (opens new window)申请，不是替换工具自动生成的，也不包含在补丁包中。

大致申请流程如下：

  1. 使用客户自己的高德开放平台账号登录控制台，并按平台要求完成账号认证。
  2. 进入 应用管理，创建一个应用；如果已有用于当前 OA 系统的应用，也可以在已有应用中继续添加 Key。
  3. 在应用中点击 添加 Key，根据实际用途选择对应的服务平台：
    • 选择 Web端（JS API），申请页面地图功能使用的 Web 端 Key。
    • 选择 Web服务，申请后端调用高德 Web 服务接口使用的 Web 服务 Key。
  4. 按高德开放平台控制台的提示，获取与 Key 配套的安全配置。工具界面中要求填写的 私钥，应以客户在高德开放平台申请 Key 时获得的配套值为准。
  5. 客户将申请完成的 Web 端 Key、Web 服务 Key 和 私钥 提供给实施人员，再使用本工具执行替换。

申请时应注意：

  • 建议由客户使用自己的企业账号申请和管理，避免使用实施人员或其他项目的账号。
  • Key 可能涉及调用额度、计费、服务授权、域名或 IP 等限制，具体规则以高德开放平台当前控制台和服务协议为准。
  • 不同类型的 Key 用途不同，Web 端 Key 和 Web 服务 Key 不应混用。
  • 不要直接复制其他客户或其他环境的 Key，否则可能出现鉴权失败、额度不足或服务不可用等问题。

# 三、字段说明

字段 用途
Web 端 Key 供高德地图 JavaScript API 使用的 Web 端 Key。
Web 服务 Key 供高德 Web 服务接口使用的 Key。
私钥 客户申请高德地图服务时获得的、与 Key 配套的私钥。

以上配置均由客户自行在高德开放平台申请或购买，不由补丁包提供。

# 四、操作步骤

  1. 打开高德地图服务替换工具。
  2. 选择 替换高德地图key数据。
  3. 点击进入该功能页面。
  4. 点击 浏览，选择待处理环境的 ApacheJetspeed\webapps 目录。
  5. 填写客户提供的 Web 端 Key。
  6. 填写客户提供的 Web 服务 Key。
  7. 填写客户提供的 私钥。
  8. 点击 开始扫描。
  9. 检查扫描结果，确认文件路径和文件内容属于本次替换范围。
  10. 勾选需要替换的文件。
  11. 点击 开始替换。
  12. 查看工具日志，确认所有勾选文件均替换成功。

操作界面如下：

# 五、目录选择说明

目标目录必须选择：

ApacheJetspeed\webapps

不要选择整个 ApacheJetspeed 目录。工具会递归扫描目标目录；选择范围过大会扫描日志、临时文件和配置文件等无关内容，增加扫描耗时及误操作风险。

Windows 目录示例：

D:\Seeyon\ApacheJetspeed\webapps

如果客户服务器为无图形界面的 Linux，可先将 ApacheJetspeed/webapps 下载到 Windows，替换完成并检查无误后，再上传覆盖服务器中的对应目录。

# 六、替换结果检查

替换完成后，依次检查以下内容：

  1. 工具日志中没有失败记录。
  2. 扫描列表中的目标文件均已成功处理。
  3. 工具生成的 Excel 结果文件中，替换前后的内容符合预期。
  4. 抽查 ApacheJetspeed\webapps 下被替换的文件，确认 KEY 数据已更新。
  5. 如果在 Windows 离线处理，将处理后的文件上传至服务器的相同目录。
  6. 重启相关服务或清理缓存后，进入地图相关页面验证功能是否正常。

工具生成的结果文件名称通常为：

高德地图定位服务key替换结果_yyyyMMdd_HHmmss.xlsx

# 七、备份与还原

工具执行替换前，会在目标目录下自动创建备份目录：

back_yyyyMMdd_HHmmss

替换结果验证完成前，请勿删除该备份目录。

如果替换结果不符合预期，可根据实际情况使用：

  • 还原当前勾选文件
  • 一键还原所有文件

# 八、常见问题

# 8.1 扫描结果为空

优先确认目标目录是否正确选择为 ApacheJetspeed\webapps，并确认该目录中包含待处理的系统文件。

# 8.2 KEY 或私钥不完整

停止操作，联系客户补充完整的 Web 端 Key、Web 服务 Key 和 私钥 后再执行替换。

# 8.3 替换后地图功能异常

按以下顺序排查：

  1. 核对填写的 KEY 和私钥是否准确、是否相互匹配。
  2. 查看工具日志和 Excel 结果文件中是否存在失败记录。
  3. 确认处理后的文件已覆盖到正确的服务器目录。
  4. 清理缓存或重启相关服务后再次验证。
  5. 仍无法恢复时，使用工具备份执行还原。
编撰人：mashan

快速跳转

←