模板版本：v0.2.2

`react-native-amap-geolocation`

[!TIP] Github 地址

安装与使用

请到三方库的 Releases 发布地址查看配套的版本信息：@react-native-oh-tpl/react-native-amap-geolocation Releases 。对于未发布到npm的旧版本，请参考安装指南安装tgz包。

进入到工程目录并输入以下命令：

npm

npm install @react-native-oh-tpl/react-native-amap-geolocation

yarn

yarn add @react-native-oh-tpl/react-native-amap-geolocation

下面的代码展示了这个库的基本使用场景：

[!WARNING] 使用时 import 的库名不变。

import * as React from "react";
import {
    Button,
    Platform,
    ScrollView,
    StyleSheet,
    Text,
    View,
} from "react-native";
import {
    Geolocation, setInterval, addLocationListener, setAllowsBackgroundLocationUpdates,
    setGeoLanguage, setDistanceFilter, setDesiredAccuracy, init, setNeedAddress, start,
    stop, setLocationTimeout, setOnceLocation, GeoLanguage
} from "react-native-amap-geolocation";


const style = StyleSheet.create({
    body: {
        padding: 16,
        paddingTop: Platform.OS === "ios" ? 48 : 16,
    },
    button: {
        flexDirection: "column",
        marginRight: 8,
        marginBottom: 5,
        marginTop: 5
    },
    result: {
        fontFamily: Platform.OS === "ios" ? "menlo" : "monospace",
    },
});

class AmapGeoLocationDemo extends React.Component {
    state = {
        location: null, needAddressText: "setNeedAddress(false)",
        language: "setLanguage(chinese)", interval: "setInterval(默认2000)", onceText: "setOnceLocation(false) 设置单次定位",
        startText: "start 持续定位", timeoutText: "setLocationTimeout 设置请求定位超时时间",distanceText:"setDistanceFilter(0) 设置定位的最小更新距离"
    };
    watchId = 0;
    needAddress = true;
    currLanguage = GeoLanguage.ZH;
    currInterval = false;
    onceLocationJudge = false;
    timeout5000 = false;
    distanseJudge = true;
    init = () => {
        console.log("rn AMapLocationManagerImpl init");
        init("5f7389b845cbd89b1c32e24f526728f4").then(() => {
            console.log("rn AMapLocationManagerImpl init success");
        });

    };
    addLocationListener = () => {
        console.log("rn AMapLocationManagerImpl addLocationListener");
        addLocationListener((locationData) => {
            console.log("rn AMapLocationManagerImpl callback success:" + JSON.stringify(locationData, null, 2));
            let location = locationData;
            this.setState({ location: location });
        });
    };
    setDistanceFilter = () => {
        console.log("rn AMapLocationManagerImpl setDistanceFilter");
        this.distanseJudge = !this.distanseJudge;
        if (this.distanseJudge) {
            setDistanceFilter(0);
            this.setState({ distanceText: "setDistanceFilter(0) 设置定位的最小更新距离" });
        } else {
            setDistanceFilter(1);
            this.setState({ distanceText: "setDistanceFilter(1) 设置定位的最小更新距离" });
        }

    };
    setLocationTimeout = () => {
        console.log("rn AMapLocationManagerImpl setLocationTimeout");
        this.timeout5000 = !this.timeout5000;
        if (this.timeout5000) {
            setLocationTimeout(5000);
            this.setState({ timeoutText: "setLocationTimeout(5000) 设置请求定位超时时间" });
        } else {
            setLocationTimeout(10000);
            this.setState({ timeoutText: "setLocationTimeout(10000) 设置请求定位超时时间" });
        }
    };
    start = () => {
        console.log("rn AMapLocationManagerImpl start");
        start();
    };
    stop = () => {
        console.log("rn AMapLocationManagerImpl stop");
        stop();
    }
    onceLocation = () => {
        this.onceLocationJudge = !this.onceLocationJudge;
        if (this.onceLocationJudge) {
            setOnceLocation(true);
            this.setState({ onceText: "setOnceLocation(true) 设置单次定位", startText: "start 单次定位" });
        } else {
            setOnceLocation(false);
            this.setState({ onceText: "setOnceLocation(false) 设置单次定位", startText: "start 持续定位" });
        }
        console.log("rn AMapLocationManagerImpl current onceLocation:" + this.onceLocationJudge);
    };
    setInterval = () => {
        if (this.currInterval) {
            setInterval(2000);
            this.setState({ interval: "setInterval:2000" });
        } else {
            setInterval(10000);
            this.setState({ interval: "setInterval:10000" });
        }
        this.currInterval = !this.currInterval;
    }
    setNeedAddress = () => {
        this.needAddress = !this.needAddress;
        console.log("rn AMapLocationManagerImpl setNeedAddress:" + this.needAddress);
        if (this.needAddress) {
            setNeedAddress(true);
            this.setState({ needAddressText: "setNeedAddress(true)" });
        } else {
            setNeedAddress(false);
            this.setState({ needAddressText: "setNeedAddress(false)" });
        }
    }
    setLanguage = () => {
        // default = 0,chinese = 1, engilish=2;
        console.log("rn AMapLocationManagerImpl setLanguage");
        if (this.currLanguage == GeoLanguage.ZH) {
            this.currLanguage = GeoLanguage.EN;
            setGeoLanguage(GeoLanguage.EN);
            this.setState({ language: "setLanguage(engilish)" });
        } else {
            this.currLanguage = GeoLanguage.ZH;
            setGeoLanguage(GeoLanguage.ZH);
            this.setState({ language: "setLanguage(chinese)" });
        }

    }
    updateLocationState(location: any) {
    console.log("rn AMapLocationManagerImpl updateLocationState");
    if (location) {
        this.setState({ location: location });
        console.log(location);
    }
}
getCurrentPosition = () => {
    Geolocation.getCurrentPosition(
        (position) => this.updateLocationState(position),
        (error) => this.updateLocationState(error)
    );
};
watchPosition = () => {
    if (!this.watchId) {
        this.watchId = Geolocation.watchPosition(
            (position) => this.updateLocationState(position),
            (error) => this.updateLocationState(error)
        );
        console.log("rn AMapLocationManagerImpl watchPosition watchId:" + this.watchId);
    }
};
clearWatch = () => {
    if (this.watchId) {
        console.log("rn AMapLocationManagerImpl clearWatch watchId:" + this.watchId);
        Geolocation.clearWatch(this.watchId);
        this.watchId = 0;
    }
    stop();
    this.setState({ location: null });
};
render() {
    const location = this.state.location;
    const needAddressText = this.state.needAddressText;
    const language = this.state.language;
    const currInterval = this.state.interval;
    const onceText = this.state.onceText;
    const startText = this.state.startText;
    const timeoutText = this.state.timeoutText;
    const distanceText = this.state.distanceText;
    return (
        <ScrollView contentContainerStyle={style.body}>
        <View style={style.button}>
        <Button onPress={this.init} title="init 初始化接口" />
        </View>
        <View style={style.button}>
        <Button onPress={this.addLocationListener} title="addLocationListener 设置监听回调,原生接口不设置监听回调,text不会显示数据" />
        </View>
        <View style={style.button}>
        <Button onPress={this.setDistanceFilter} title={distanceText} />
        </View>
        <View style={style.button}>
        <Button onPress={this.setLocationTimeout} title={timeoutText} />
        </View>
        <View style={style.button}>
        <Button onPress={this.onceLocation} title={onceText} />
        </View>
        <View style={style.button}>
        <Button onPress={this.start} title={startText} />
        </View>
        <View style={style.button}>
        <Button onPress={this.stop} title="stop 结束持续定位" />
        </View>
        <View style={style.button}>
        <Button onPress={this.setInterval} title={currInterval} />
        </View>
        <View style={style.button}>
        <Button onPress={this.setNeedAddress} title={needAddressText} />
        </View>
        <View style={style.button}>
        <Button onPress={this.setLanguage} title={language} />
        </View>
        <View style={style.button}>
        <Button onPress={this.getCurrentPosition} title="Geolocation.getCurrentPosition 获取当前位置，相当于单次请求" />
        </View>
        <View style={style.button}>
        <Button onPress={this.watchPosition} title="Geolocation.watchPosition 开启持续定位" />
        </View>
        <View style={style.button}>
        <Button onPress={this.clearWatch} title="Geolocation.clearWatch 结束持续定位" />
        </View>
        <Text style={style.result}>{`${JSON.stringify(location, null, 2)}`}</Text>
    </ScrollView>
);
}

}

export default AmapGeoLocationDemo;

使用 Codegen

本库已经适配了 Codegen ，在使用前需要主动执行生成三方库桥接代码，详细请参考 Codegen 使用文档。

Link

目前HarmonyOS暂不支持 AutoLink，所以 Link 步骤需要手动配置。

首先需要使用 DevEco Studio 打开项目里的HarmonyOS工程 harmony

1.在工程根目录的 `oh-package.json` 添加 overrides 字段

{
  ...
  "overrides": {
    "@rnoh/react-native-openharmony" : "./react_native_openharmony"
  }
}

2.引入原生端代码

目前有两种方法：

通过 har 包引入（在 IDE 完善相关功能后该方法会被遗弃，目前首选此方法）；
直接链接源码。

方法一：通过 har 包引入（推荐）

[!TIP] har 包位于三方库安装路径的 harmony 文件夹下。

打开 entry/oh-package.json5，添加以下依赖

"dependencies": {
    "@rnoh/react-native-openharmony": "file:../react_native_openharmony",
    "@react-native-oh-tpl/react-native-amap-geolocation": "file:../../node_modules/@react-native-oh-tpl/react-native-amap-geolocation/harmony/amap_geolocation.har"
  }

点击右上角的 sync 按钮

或者在终端执行：

cd entry
ohpm install

方法二：直接链接源码

[!TIP] 如需使用直接链接源码，请参考直接链接源码说明

3.在 ArkTs 侧引入 AmapGeolocationPackage

打开 entry/src/main/ets/RNPackagesFactory.ts，添加：

...
+  import {AMapGeolocationPackage} from '@react-native-oh-tpl/react-native-amap-geolocation/ts';

export function createRNPackages(ctx: RNPackageContext): RNPackage[] {
  return [
    new SamplePackage(ctx),
+   new AMapGeolocationPackage(ctx)
  ];
}

4.运行

点击右上角的 sync 按钮

或者在终端执行：

cd entry
ohpm install

然后编译、运行即可。

约束与限制

兼容性

要使用此库，需要使用正确的 React-Native 和 RNOH 版本。另外，还需要使用配套的 DevEco Studio 和手机 ROM。

请到三方库相应的 Releases 发布地址查看 Release 配套的版本信息：@react-native-oh-tpl/react-native-amap-geolocation Releases

权限要求

在 entry 目录下的module.json5中添加权限

打开 entry/src/main/module.json5，添加：

...
"requestPermissions": [
  {
    "name": "ohos.permission.LOCATION",
    "reason": "$string:Access_Location",
    "usedScene": {
      "when":"inuse"
    }
  },
  {
    "name": "ohos.permission.APPROXIMATELY_LOCATION",
    "reason": "$string:Access_AppRoximatelyLocation",
    "usedScene": {
      "when":"inuse"
    }
  },
  {
    "name": "ohos.permission.INTERNET",
  }
]

在 entry 目录下添加位置权限的原因

打开 entry/src/main/resources/base/element/string.json，添加：

...
{
  "string": [
    {
      "name": "Access_Location",
      "value": "access Location"
    },
    {
      "name": "Access_AppRoximatelyLocation",
      "value": "access AppRoximatelyLocation"
    }
  ]
}

API

[!TIP] "Platform"列表示该属性在原三方库上支持的平台。

[!TIP] "HarmonyOS Support"列为 yes 表示 HarmonyOS 平台支持该属性；no 则表示不支持；partially 表示部分支持。使用方法跨平台一致，效果对标 iOS 或 Android 的效果。

Name	Description	Type	Required	Platform	HarmonyOS Support
init	初始化 SDK	Promise	yes	iOS/Android	yes
addLocationListener	添加定位监听函数	void	yes	iOS/Android	yes
isStarted	获取当前是否正在定位的状态	boolean	no	Android	no
setAllowsBackgroundLocationUpdates	是否允许后台定位	void	no	iOS	no
setDesiredAccuracy	设定期望的定位精度（米）	void	no	iOS	no
setDistanceFilter	设定定位的最小更新距离（米）	void	no	iOS	yes
setGeoLanguage	设置逆地理信息的语言，目前支持中文和英文	void	no	iOS/Android	yes
setGpsFirst	设置首次定位是否等待卫星定位结果	void	no	Android	no
setGpsFirstTimeout	设置优先返回卫星定位信息时等待卫星定位结果的超时时间（毫秒）	void	no	Android	no
setHttpTimeout	设置联网超时时间（毫秒）	void	no	Android	no
setInterval	设置发起定位请求的时间间隔（毫秒），默认 2000，最小值为 1000	void	no	Android	yes
setLocatingWithReGeocode	连续定位是否返回逆地理编码	void	no	iOS	no
setLocationCacheEnable	设置是否使用缓存策略	void	no	Android	no
setLocationMode	设置定位模式	void	no	Android	no
setLocationPurpose	设置定位场景	void	no	Android	no
setLocationTimeout	指定单次定位超时时间（秒）	no	yes	iOS	yes
setMockEnable	设置是否允许模拟位置	void	no	Android	no
setNeedAddress	设置是否返回地址信息，默认返回地址信息	no	yes	Android	yes
setOnceLocation	设置是否单次定位	void	no	Android	yes
setOnceLocationLatest	设置定位是否等待 WiFi 列表刷新	void	no	Android	no
setOpenAlwaysScanWifi	设置是否开启wifi始终扫描	void	no	Android	no
setPausesLocationUpdatesAutomatically	指定定位是否会被系统自动暂停	void	no	iOS	no
setReGeocodeTimeout	指定单次定位逆地理超时时间（秒）最小值是 2s。注意在单次定位请求前设置。	void	no	iOS	no
setSensorEnable	设置是否使用设备传感器	void	no	Android	no
setWifiScan	设置是否允许调用 WiFi 刷新	void	no	Android	no
start	开始持续定位	void	no	iOS/Android	yes
stop	停止持续定位	void	no	iOS/Android	yes
Geolocation.getCurrentPosition	获取当前位置信息	void	no	iOS/Android	yes
Geolocation.watchPosition	注册监听器进行持续定位	void	no	iOS/Android	yes
Geolocation.clearWatch	移除位置监听	void	no	iOS/Android	yes

遗留问题

isStarted()接口获取当前是否正在定位的状态,harmony暂不支持issue#2
setGpsFirst()接口获取当前是否正在定位的状态,harmony暂不支持issue#3
setGpsFirstTimeout()接口获取当前是否正在定位的状态,harmony暂不支持issue#4
setHttpTimeout()接口获取当前是否正在定位的状态,harmony暂不支持issue#5
setMockEnable()接口获取当前是否正在定位的状态,harmony暂不支持issue#6
setOnceLocationLatest()接口获取当前是否正在定位的状态,harmony暂不支持issue#7
setOpenAlwaysScanWifi()接口获取当前是否正在定位的状态,harmony暂不支持issue#8
setPausesLocationUpdatesAutomatically()接口获取当前是否正在定位的状态,harmony暂不支持issue#9
setReGeocodeTimeout()接口获取当前是否正在定位的状态,harmony暂不支持issue#10
setSensorEnable()接口获取当前是否正在定位的状态,harmony暂不支持issue#11
setWifiScan()接口获取当前是否正在定位的状态,harmony暂不支持issue#12
setLocationCacheEnable()接口获取当前是否正在定位的状态,harmony暂不支持issue#13
setLocationMode()接口获取当前是否正在定位的状态,harmony暂不支持issue#14
setLocationPurpose()接口获取当前是否正在定位的状态,harmony暂不支持issue#15
setLocatingWithReGeocode()接口获取当前是否正在定位的状态设置连续定位是否返回逆地理编码,harmony暂不支持issue#19
setDesiredAccuracy()接口设定期望的定位精度,harmony暂不支持issue#22
setAllowsBackgroundLocationUpdates()接口是否允许后台定位,harmony暂不支持issue#23

其他

开源协议

本项目基于 The MIT License (MIT) ，请自由地享受和参与开源。

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

react-native-amap-geolocation.md

react-native-amap-geolocation.md

`react-native-amap-geolocation`

安装与使用

npm

yarn

使用 Codegen

Link

1.在工程根目录的 `oh-package.json` 添加 overrides 字段

2.引入原生端代码

3.在 ArkTs 侧引入 AmapGeolocationPackage

4.运行

约束与限制

兼容性

权限要求

在 entry 目录下的module.json5中添加权限

在 entry 目录下添加位置权限的原因

API

遗留问题

其他

开源协议

Files

react-native-amap-geolocation.md

Latest commit

History

react-native-amap-geolocation.md

File metadata and controls

react-native-amap-geolocation

安装与使用

npm

yarn

使用 Codegen

Link

1.在工程根目录的 oh-package.json 添加 overrides 字段

2.引入原生端代码

3.在 ArkTs 侧引入 AmapGeolocationPackage

4.运行

约束与限制

兼容性

权限要求

在 entry 目录下的module.json5中添加权限

在 entry 目录下添加位置权限的原因

API

遗留问题

其他

开源协议

`react-native-amap-geolocation`

1.在工程根目录的 `oh-package.json` 添加 overrides 字段