地理位置

GitHub npm crates.io

API Reference

获取并跟踪设备的当前位置，包括有关高度、航向和速度的信息（如果可用）。

支持的平台

This plugin requires a Rust version of at least 1.77.2

Platform	Level	Notes
windows
linux
macos
android
ios

设置

安装地理位置插件以开始使用。

自动

使用项目的包管理器添加依赖项：

npm

npm run tauri add geolocation

yarn

yarn run tauri add geolocation

pnpm

pnpm tauri add geolocation

deno

deno task tauri add geolocation

bun

bun tauri add geolocation

cargo

cargo tauri add geolocation

手动

1. 在 src-tauri 文件夹中运行以下命令，将插件添加到 Cargo.toml 中的项目依赖项中：

   cargo add tauri-plugin-geolocation --target 'cfg(any(target_os = "android", target_os = "ios"))'

2. 修改 lib.rs 以初始化插件：

   src-tauri/src/lib.rs

   #[cfg_attr(mobile, tauri::mobile_entry_point)]
   pub fn run() {
       tauri::Builder::default()
           .setup(|app| {
               #[cfg(mobile)]
               app.handle().plugin(tauri_plugin_geolocation::init());
               Ok(())
           })
           .run(tauri::generate_context!())
           .expect("error while running tauri application");
   }

3. 使用你喜欢的 JavaScript 包管理器安装 JavaScript Guest 绑定：

   npm

   npm install @tauri-apps/plugin-geolocation

   yarn

   yarn add @tauri-apps/plugin-geolocation

   pnpm

   pnpm add @tauri-apps/plugin-geolocation

   deno

   deno add npm:@tauri-apps/plugin-geolocation

   bun

   bun add @tauri-apps/plugin-geolocation

配置

iOS

Apple 要求在 Info.plist 中为位置信息指定隐私描述，你应该在其中描述你的应用为何需要访问它。下面是一个示例描述：

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
    <dict>
        <key>NSLocationWhenInUseUsageDescription</key>
        <string>执行 XY 所需</string>
    </dict>
</plist>

Android

此插件会自动将以下权限添加到你的 AndroidManifest.xml 文件中：

<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />

如果你的应用需要 GPS 功能才能运行，你应该将以下内容添加到你的 AndroidManifest.xml 文件中：

<uses-feature android:name="android.hardware.location.gps" android:required="true" />

Google Play 商店使用此属性来决定是否应向没有 GPS 功能的设备显示该应用。

用法

地理位置插件在 JavaScript 中可用。

import {
  checkPermissions,
  requestPermissions,
  getCurrentPosition,
  watchPosition,
} from '@tauri-apps/plugin-geolocation';

let permissions = await checkPermissions();
if (
  permissions.location === 'prompt' ||
  permissions.location === 'prompt-with-rationale'
) {
  permissions = await requestPermissions(['location']);
}

if (permissions.location === 'granted') {
  const pos = await getCurrentPosition();

  await watchPosition(
    { enableHighAccuracy: true, timeout: 10000, maximumAge: 0 },
    (pos) => {
      console.log(pos);
    }
  );
}

权限

默认情况下，所有潜在危险的插件命令和范围都被阻止，无法访问。你必须修改 capabilities 配置中的权限以启用这些功能。

有关更多信息，请参阅 功能概述 和 使用插件权限的步骤指南。

src-tauri/capabilities/mobile.json

{
  "$schema": "../gen/schemas/mobile-schema.json",
  "identifier": "mobile-capability",
  "windows": ["main"],
  "platforms": ["iOS", "android"],
  "permissions": [
    "core:default",
    "geolocation:allow-check-permissions",
    "geolocation:allow-request-permissions",
    "geolocation:allow-get-current-position",
    "geolocation:allow-watch-position"
  ]
}

Permission Table

Identifier	Description
geolocation:allow-check-permissions	Enables the check_permissions command without any pre-configured scope.
geolocation:deny-check-permissions	Denies the check_permissions command without any pre-configured scope.
geolocation:allow-clear-permissions	Enables the clear_permissions command without any pre-configured scope.
geolocation:deny-clear-permissions	Denies the clear_permissions command without any pre-configured scope.
geolocation:allow-clear-watch	Enables the clear_watch command without any pre-configured scope.
geolocation:deny-clear-watch	Denies the clear_watch command without any pre-configured scope.
geolocation:allow-get-current-position	Enables the get_current_position command without any pre-configured scope.
geolocation:deny-get-current-position	Denies the get_current_position command without any pre-configured scope.
geolocation:allow-request-permissions	Enables the request_permissions command without any pre-configured scope.
geolocation:deny-request-permissions	Denies the request_permissions command without any pre-configured scope.
geolocation:allow-watch-position	Enables the watch_position command without any pre-configured scope.
geolocation:deny-watch-position	Denies the watch_position command without any pre-configured scope.