拉起导航类应用(startAbilityByType)

本章节介绍如何拉起导航类应用扩展面板。

导航类应用扩展面板参数说明

startAbilityByType接口中type字段为navigation,支持路线规划、导航、位置搜索三种意图场景,对应的wantParam参数如下:

本文中的经纬度均采用GCJ-02坐标系统。

拉起方开发步骤

  1. 导入相关模块。

    import { common } from '@kit.AbilityKit';
  2. 构造接口参数并调用startAbilityByType接口。

    终点POI ID列表(destinationPoiIds)和起点POI ID列表(originPoiIds)需开发者自行从各地图系统中获取,并按照对应关系传参。

    @Entry
    @Component
    struct Index {
      @State hideAbility: string = 'hideAbility'
    
      build() {
        Row() {
          Column() {
            Text(this.hideAbility)
              .fontSize(30)
              .fontWeight(FontWeight.Bold)
              .onClick(() => {
                let context = this.getUIContext().getHostContext() as common.UIAbilityContext;
                let wantParam: Record<string, Object> = {
                  'sceneType': 1,
                  'destinationLatitude': 32.060844,
                  'destinationLongitude': 118.78315,
                  'destinationName': 'xx市xx路xx号',
                  'destinationPoiIds': {
                    1: '1001', // key为1代表花瓣地图,value需为花瓣地图POI
                    2: '2002', // key为2代表高德地图,value需为高德地图POI
                    3: '3003'  // key为3代表百度地图,value需为百度地图POI
                  } as Record<number, string>,
                  'originName': 'xx市xx公园',
                  'originLatitude': 31.060844,
                  'originLongitude': 120.78315,
                  'originPoiIds': {
                    1: '1101', // key为1代表花瓣地图,value需为花瓣地图POI
                    2: '2202', // key为2代表高德地图,value需为高德地图POI
                    3: '3303'  // key为3代表百度地图,value需为百度地图POI
                  } as Record<number, string>,
                  'vehicleType': 0
                };
                let abilityStartCallback: common.AbilityStartCallback = {
                  onError: (code: number, name: string, message: string) => {
                    console.error(`onError code ${code} name: ${name} message: ${message}`);
                  },
                  onResult: (result) => {
                    console.info(`onResult result: ${JSON.stringify(result)}`);
                  }
                }
    
                context.startAbilityByType("navigation", wantParam, abilityStartCallback,
                  (err) => {
                    if (err) {
                      console.error(`startAbilityByType fail, err: ${JSON.stringify(err)}`);
                    } else {
                      console.info(`success`);
                    }
                  });
              });
          }
          .width('100%')
        }
        .height('100%')
      }
    }

    效果示例图:

目标方开发步骤

  1. 在module.json5中配置uris,步骤如下:

    1. 设置linkFeature属性以声明当前应用支持的特性功能,从而系统可以从设备已安装应用中找到当前支持该特性的应用,取值范围如下:
      取值 含义
      Navigation 声明应用支持导航功能
      RoutePlan 声明应用支持路线规划功能
      PlaceSearch 声明应用支持位置搜索功能
      DetailLocation 声明应用支持地点详情功能
    2. 设置scheme、host、port、path/pathStartWith属性,与Want中URI相匹配,以便区分不同功能。
    {
      "abilities": [
          {
          "skills": [
              {
              "uris": [
                  {
                  "scheme": "maps", // 这里仅示意,应用需确保这里声明的uri能被外部正常拉起
                  "host": "navigation",
                  "path": "",
                  "linkFeature": "Navigation" // 声明应用支持导航功能
                  },
                  {
                  "scheme": "maps", // 这里仅示意,应用需确保这里声明的uri能被外部正常拉起
                  "host": "routePlan",
                  "path": "",
                  "linkFeature": "RoutePlan" // 声明应用支持路线规划功能
                  },
                  {
                  "scheme": "maps", // 这里仅示意,应用需确保这里声明的uri能被外部正常拉起
                  "host": "search",
                  "path": "",
                  "linkFeature": "PlaceSearch" // 声明应用支持位置搜索功能
                  },
                  {
                  "scheme": "maps", // 这里仅示意,应用需确保这里声明的uri能被外部正常拉起
                  "host": "detailLocation",
                  "path": "",
                  "linkFeature": "DetailLocation" // 声明应用支持地点详情功能
                  }
              ]
              }
          ]
          }
      ]
    }
  2. 解析参数并做对应处理。

    UIAbility.onCreate(want: Want, launchParam: AbilityConstant.LaunchParam): void

    在参数want.uri中会携带目标方配置的linkFeature对应的uri。

    在参数want.parameters中会携带Caller方传入的参数,不同场景参数如下所示。

    • 路线规划场景

      参数名 类型 必填 说明
      originName string 否 起点名称。
      originLatitude number 否 起点纬度。
      originLongitude number 否 起点经度。
      originPoiId string 否 起点POI ID,当前仅支持花瓣地图、高德地图、百度地图获取此参数。
      destinationName string 否 终点名称。
      destinationLatitude number 是 终点纬度。
      destinationLongitude number 是 终点经度。
      destinationPoiId string 否 终点POI ID,当前仅支持花瓣地图、高德地图、百度地图获取此参数。
      vehicleType number 否 交通出行工具,取值:0-驾车,1-步行,2-骑行,3-公交。
    • 导航场景

      参数名 类型 必填 说明
      destinationName string 否 终点名称。
      destinationLatitude number 是 终点纬度。
      destinationLongitude number 是 终点经度。
      destinationPoiId string 否 终点POI ID,当前仅支持花瓣地图、高德地图、百度地图获取此参数。
      vehicleType number 否 交通出行工具,取值:0-驾车,1-步行,2-骑行,3-公交。
    • 位置搜索场景

      参数名 类型 必填 说明
      destinationName string 是 地点名称。
    • 地点详情场景

      参数名 类型 必填 说明
      destinationName string 否 地点名称。
      destinationLatitude number 是 地点纬度。
      destinationLongitude number 是 地点经度。
      zoom number 否 地图缩放级别,取值为大于0的整数。
      destinationPoiIds Record<number, string> 否 地点POI ID列表,当前仅支持传入花瓣地图、高德地图、百度地图的POI ID。

    应用可根据linkFeature中定义的特性功能,比如路线规划、导航、位置搜索和地点详情,结合接收到的uri和参数开发不同的样式页面。

完整示例:

import { AbilityConstant, UIAbility, Want } from '@kit.AbilityKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { window } from '@kit.ArkUI';

const TAG = 'EntryAbility';

export default class EntryAbility extends UIAbility {
    windowStage: window.WindowStage | null = null;

    uri?: string;
    destinationLatitude?: number;
    destinationLongitude?: number;
    destinationName?: string;
    originName?: string;
    originLatitude?: number;
    originLongitude?: number;
    vehicleType?: number;
    destinationPoiId?: string;
    originPoiId?: string;
    zoom?: number;

    onCreate(want: Want, launchParam: AbilityConstant.LaunchParam): void {
        hilog.info(0x0000, TAG, `onCreate, want=${JSON.stringify(want)}`);
        super.onCreate(want, launchParam);
        this.parseWant(want);
    }

    onNewWant(want: Want, launchParam: AbilityConstant.LaunchParam): void {
        hilog.info(0x0000, TAG, `onNewWant, want=${JSON.stringify(want)}`);
        super.onNewWant(want, launchParam);
        this.parseWant(want);
        if (!this.windowStage) {
            hilog.error(0x0000, TAG, 'windowStage is null');
            this.context.terminateSelf();
            return;
        }
        this.loadPage(this.windowStage);
    }

    private parseWant(want: Want): void {
        this.uri = want.uri as string | undefined;
        this.destinationLatitude = want.parameters?.destinationLatitude as number | undefined;
        this.destinationLongitude = want.parameters?.destinationLongitude as number | undefined;
        this.destinationName = want.parameters?.destinationName as string | undefined;
        this.originName = want.parameters?.originName as string | undefined;
        this.originLatitude = want.parameters?.originLatitude as number | undefined;
        this.originLongitude = want.parameters?.originLongitude as number | undefined;
        this.vehicleType = want.parameters?.vehicleType as number | undefined;
        this.destinationPoiId = want.parameters?.destinationPoiId as string | undefined;
        this.originPoiId = want.parameters?.originPoiId as string | undefined;
        this.zoom = want.parameters?.zoom as number | undefined;
    }

    private loadPage(windowStage: window.WindowStage): void {
        hilog.info(0x0000, TAG, `loadPage, uri=${this.uri}`);
        if (this.uri === 'maps://navigation') {
            // 构建导航场景参数
            const storage: LocalStorage = new LocalStorage({
                "destinationLatitude": this.destinationLatitude,
                "destinationLongitude": this.destinationLongitude,
                "destinationPoiId": this.destinationPoiId,
                "vehicleType": this.vehicleType,
            } as Record<string, Object>);
            // 拉起导航页面
            windowStage.loadContent('pages/NavigationPage', storage)
        } else if (this.uri === 'maps://routePlan') {
            // 构建路径规划场景参数
            const storage: LocalStorage = new LocalStorage({
                "destinationLatitude": this.destinationLatitude,
                "destinationLongitude": this.destinationLongitude,
                "destinationName": this.destinationName,
                "originName": this.originName,
                "originLatitude": this.originLatitude,
                "originLongitude": this.originLongitude,
                "vehicleType": this.vehicleType,
                "destinationPoiId": this.destinationPoiId,
                "originPoiId": this.originPoiId
            } as Record<string, Object>);
            // 拉起路径规划页面
            windowStage.loadContent('pages/RoutePlanPage', storage)
        }  else if (this.uri === 'maps://search') {
            // 构建位置搜索场景参数
            const storage: LocalStorage = new LocalStorage({
                "destinationName": this.destinationName
            } as Record<string, Object>);
            // 拉起位置搜索页面
            windowStage.loadContent('pages/PlaceSearchPage', storage)
        }   else if (this.uri === 'maps://detailLocation') {
            // 构建地点详情场景参数
            const storage: LocalStorage = new LocalStorage({
                "destinationName": this.destinationName,
                "destinationLatitude": this.destinationLatitude,
                "destinationLongitude": this.destinationLongitude,
                "zoom": this.zoom,
                "destinationPoiId": this.destinationPoiId,
            } as Record<string, Object>);
            // 拉起地点详情页面
            windowStage.loadContent('pages/DetailLocation', storage)
        } else {
            // 默认拉起首页
            windowStage.loadContent('pages/Index', (err) => {
                if (err.code) {
                    hilog.error(0x0000, TAG, 'Failed to load the content. Cause: %{public}s',
                        JSON.stringify(err) ?? '');
                    return;
                }
                hilog.info(0x0000, TAG, 'Succeeded in loading the content.');
            });
        }
    }

    onDestroy(): void {
        hilog.info(0x0000, TAG, `onDestroy`);
    }

    onWindowStageCreate(windowStage: window.WindowStage): void {
        hilog.info(0x0000, TAG, `onWindowStageCreate`);
        this.windowStage = windowStage;
        this.loadPage(this.windowStage);
    }

    onWindowStageDestroy(): void {
        hilog.info(0x0000, TAG, '%{public}s', 'Ability onWindowStageDestroy');
    }

    onForeground(): void {
        hilog.info(0x0000, TAG, '%{public}s', 'Ability onForeground');
    }

    onBackground(): void {
        hilog.info(0x0000, TAG, '%{public}s', 'Ability onBackground');
    }
}