Web API 开发 (Web API)
描述
协助开发者使用 expo-gaode-map-web-api 包。该包是纯 JavaScript 实现,封装了高德 Web 服务 API,支持跨平台使用。
使用场景
- •需要使用高德最新的 V5 版路径规划(支持更多策略、新能源车等)。
- •需要跨城公交路径规划。
- •需要在非原生环境(如纯 JS 逻辑层)进行地理编码或算路。
- •原生搜索包无法满足特定的 API 需求时。
⚠️ 性能优化提示
当处理 API 返回的 polyline 数据时,强烈建议结合 ExpoGaodeMapModule 的原生计算能力:
- •解析:使用
ExpoGaodeMapModule.parsePolyline(str)解析坐标串,比 JS 手动 split 快得多。 - •优化:使用
ExpoGaodeMapModule.simplifyPolyline(points, tolerance)进行 RDP 抽稀,显著减少地图渲染压力。
🛡️ 类型安全与稳定性
本库提供了完整的 TypeScript 定义,请参考 类型定义文档 了解详情。
核心原则:请勿使用 any,始终导入并使用正确的类型(如 DrivingRouteResponse, Step, Path 等)。
稳定性特性
- •自动重试:网络波动或限流时自动重试(默认 3 次)。
- •LRU 缓存:可开启内存缓存,减少重复请求,提升性能。
- •请求取消:支持
AbortSignal,防止输入提示等场景下的竞态问题。
指令
- •Key 配置:在基础包初始化时传入
webKey,或构造时传入。 - •实例化:创建
GaodeWebAPI实例。 - •调用服务:
- •路径规划:
api.route.driving/walking/transit - •地理编码:
api.geocode.geocode/regeocode
- •路径规划:
快速模式
✅ 正确:全局下发 Web Key
ts
// 推荐做法:在 Core 或 Navigation 初始化时一并传入
ExpoGaodeMapModule.initSDK({
androidKey: '...',
iosKey: '...',
webKey: 'YOUR_WEB_KEY'
});
// 之后随处可用,可开启缓存
const api = new GaodeWebAPI({ enableCache: true });
✅ 正确:处理 API 错误
ts
try {
await api.route.driving(...);
} catch (e) {
if (e instanceof GaodeAPIError) {
console.log('高德服务报错:', e.info);
}
}