Flutter 三方库「safe_device」的鸿蒙化适配指南
开发工具: 华为云码道
本文配套仓库(预定地址): oh-flutter/safe_device
safe_device 提供设备环境风险查询接口,OHOS 端读取可访问的 Root 路径、设备特征、调试设置和模拟定位信息。本文以 safe_device 1.4.1 为例,介绍源码准备、OHOS 工程配置、ArkTS 实现和 example 真机运行。
插件声明 Android、iOS 和 OHOS,各平台检测依据不同;iOS 专用的自定义越狱接口在 OHOS 返回兼容默认值。配套仓库地址统一规划为 oh-flutter/safe_device;尚未创建或同步时,先使用本地源码。本文依据本地 1.4.1 适配工作区,当前 HEAD 为 6ed80e40b6bd30f810d60f30183515dfc01f6234,OHOS 相关实现还包含未提交内容,该 HEAD 不能单独还原本文代码。
截图标注:操作步骤与截图命令真机运行图(从左到右):安全项/调试环境/设备信息。采集于 2026-09-09,设备 ALN-AL00 / HUAWEI Mate 60 Pro,系统 OpenHarmony 6.1.1.120(API 24);使用本地当前源码构建的签名 Release HAP。
图中“未检测到”是插件返回值;本次 HDC 实际已连接,调试状态存在漏检。
执行目录:本文 Markdown 所在目录。先用 hdc list targets 获取设备 ID,将下列 <device-id> 替换为实际值。截图使用仓库完整 Demo;snapshot_display 在本机要求 .jpeg 后缀,图片保持原始真机画面。
mkdir -p blog-assets/safe_device
安全项: 启动完整 Demo,定位授权选择“本次使用允许”,等待安全项显示。
hdc -t <device-id> shell snapshot_display -f /data/local/tmp/safe_device-safety-checks.jpeg
hdc -t <device-id> file recv /data/local/tmp/safe_device-safety-checks.jpeg ./blog-assets/safe_device/safety-checks.jpeg
调试环境: 向上滚动页面,让“开发者模式”和“HDC / USB 调试”完整进入画面。
hdc -t <device-id> shell snapshot_display -f /data/local/tmp/safe_device-debug-environment.jpeg
hdc -t <device-id> file recv /data/local/tmp/safe_device-debug-environment.jpeg ./blog-assets/safe_device/debug-environment.jpeg
设备信息: 继续向上滚动,保留设备平台、品牌、型号、系统版本和 Root 路径结果。
hdc -t <device-id> shell snapshot_display -f /data/local/tmp/safe_device-device-info.jpeg
hdc -t <device-id> file recv /data/local/tmp/safe_device-device-info.jpeg ./blog-assets/safe_device/device-info.jpeg
一、插件简介与适配目标
设备风险检测需要结合公开信息与运行环境判断。OHOS 适配保留 SafeDevice 接口,通过可访问路径、设备标识、调试状态及位置来源提供检测信号。
例如,业务可以在调试页面显示环境信息,排查模拟器行为,或辅助判断定位数据的来源。普通应用受沙箱与系统 API 限制,不能把这些信号当成完整的系统安全证明。
各检测项通过一次性异步查询返回。isSafeDevice 在 Dart 侧组合 Root、真实设备和模拟定位结果;调试状态并没有直接加入该组合。
二、环境准备
环境搭建参考社区文档:Flutter OH 开发环境搭建,完成 Flutter OH SDK 安装、环境变量和 DevEco Studio 配置。
完成后,在宿主机终端执行以下命令,确认当前选中的是支持 OHOS 的 Flutter 工具链,并能发现目标设备:
flutter --version
flutter doctor -v
hdc list targets
本文使用的工具链和复现时补全的 SDK 配置如下:
| 项目 | 版本或配置 | 用途 |
|---|---|---|
| Flutter OHOS SDK | 3.44.9+ohos-0.0.1-canary1 | Flutter 编译与 OHOS 平台工具链 |
| Flutter 分支 | oh-3.44.9-dev | CPF-Flutter 对应开发分支 |
| Dart SDK | 3.12.2 | Dart 语言与包管理环境 |
| HarmonyOS 开发套件 | 7.0.0(API 26) | 开发套件版本及对应的 API 级别 |
compileSdkVersion | 26.0.0(本文补全) | 编译时使用的 SDK API |
targetSdkVersion | 26.0.0 | 应用面向的行为版本 |
compatibleSdkVersion | 5.1.0(18) | 当前工程声明的最低兼容版本 |
| 插件版本 | 1.4.1 | pubspec.yaml 中的包版本 |
| 原生语言 | ArkTS | HarmonyOS 插件实现 |
| 插件产物 | HAR | 被应用 entry 模块依赖 |
2.1 开发套件版本与工程中的 SDK 版本配置
7.0.0(API 26) 和 26.0.0 涉及 HarmonyOS 开发套件版本(API 版本)及其底座 OpenHarmony 的版本号体系。在本文工程中,相关版本的含义与配置方式如下:
7.0.0(API 26)表示 HarmonyOS 开发套件版本为7.0.0,对应 API 26。26.0.0是本文 HarmonyOS 应用工程中compileSdkVersion和targetSdkVersion的属性值。5.1.0(18)是本文工程中compatibleSdkVersion的属性值,声明最低兼容 API 18。
本地示例未显式填写 compileSdkVersion。下面为沿用 API 26 工具链时需合并的 product 片段,补全值不代表原文件已包含这些字段:
{
"name": "default",
"compatibleSdkVersion": "5.1.0(18)",
"compileSdkVersion": "26.0.0",
"targetSdkVersion": "26.0.0",
"runtimeOS": "HarmonyOS"
}
这组配置使用 API 26 SDK 编译,并以 API 26 为目标版本,最低兼容 API 18。Root、模拟器与调试检测属于尽力判断,可能误报或漏报。无定位权限或没有可用位置时 isMockLocation 返回 false,这不等于已经验证了位置真实。
三、从源码仓库开始准备适配工程
3.1 将上游源码同步到 AtomGit
适配已有第三方插件时,先从 Pub 包信息或项目 README 确认上游地址、包名、版本和许可证。同步仓库时保留源码、许可证和提交历史,方便后续跟踪上游更新。
在 AtomGit 网页的新建仓库流程中,找到从已有仓库导入的入口,填写上游 Git 地址,选择自己有写权限的组织或个人空间,设置目标仓库名称后执行导入。完成后检查目标分支、pubspec.yaml、LICENSE 和提交历史是否完整,并记录适配起点的提交号。如果上游本身托管在 AtomGit,也可以通过 Fork 获得自己的工作仓库。
上游源码为 https://github.com/ufukhawk/safe_device,本文基于 1.4.1。配套仓库预定为 safe_device。仓库创建并同步适配代码后,再执行下面的拉取命令;尚未同步时使用本地副本。需要提交修改时,使用自己有写权限的仓库或 Fork。
3.2 将代码拉取到宿主机
在安装了 Flutter OH 和 DevEco Studio 的开发电脑上打开终端,进入准备存放项目的目录,执行:
git clone https://atomgit.com/oh-flutter/safe_device.git
cd safe_device
pwd
ls
git remote -v
git status --short --branch
git rev-parse HEAD
git clone 会创建 safe_device/ 目录;cd 后的位置就是下文所说的插件仓库根目录,这里应能看到 pubspec.yaml、lib/ 和 example/。Git 仓库名和 Dart 包名均为 safe_device。
需要使用与本文相同的代码版本时,先将适配工作区整理、提交并同步到配套仓库,再将下方占位符替换为实际适配提交号。在没有未提交修改的仓库中执行:
git switch --detach <适配提交号>
适配其他插件时,使用该插件对应版本的 tag 或 commit 作为分支起点。

图 1:在宿主机终端输入 AtomGit 仓库拉取命令。
3.3 在仓库根目录创建适配分支
接着在 safe_device/ 根目录创建分支。分支名统一使用 feat/ohos_库名称_版本号,库名称取 pubspec.yaml 的 name,版本号取此次适配的基线版本。本例为:
git switch -c feat/ohos_safe_device_1.4.1
git branch --show-current
如果该分支已存在,使用 git switch feat/ohos_safe_device_1.4.1 切换即可。

图 2:在 safe_device 仓库根目录输入适配分支创建命令。
3.4 自动补全 OHOS 适配结构
分支创建后,仍在同一个插件根目录执行结构补全。以下命令适用于尚无 ohos/ 目录的既有 Flutter 平台插件:
flutter create --template=plugin --platforms=ohos --project-name safe_device .
git status --short
git diff -- pubspec.yaml lib example
--template=plugin指定插件模板。--platforms=ohos指定需要补全的平台。--project-name safe_device使用 Dart 包名,避免当前目录重命名后生成错误的包名。- 最后的
.表示在当前插件目录补全工程,不是另建一层safe_device/。
该命令生成 OHOS 平台脚手架,业务逻辑需要在 ArkTS 中实现。生成后通过 diff 检查 pubspec.yaml、lib/ 和 example/ 的变化,保留已有 API、其他平台注册项及依赖配置。不同 Flutter OH 版本生成的模板可能略有差异。
如果生成后 example/ohos/ 仍不存在,进入已有示例应用补全平台:
cd example
flutter create --platforms=ohos .
cd ..
本地适配工作区已经包含 ohos/ 和 example/ohos/,直接运行示例时可以跳过结构补全。新建插件则使用 flutter create --org com.nutpi --template=plugin --platforms=ohos safe_device;已有插件使用上面的 . 在当前目录补全。

图 3:在插件根目录输入 OHOS 结构补全命令。
3.5 适配后的项目目录
适配后的关键目录如下:
safe_device/
├── lib/
│ ├── safe_device.dart
│ └── safe_device_config.dart
├── ohos/
│ ├── src/
│ │ └── main/
│ │ ├── ets/
│ │ │ └── components/
│ │ │ └── plugin/
│ │ │ └── SafeDevicePlugin.ets
│ │ └── module.json5
│ ├── index.ets
│ └── oh-package.json5
├── example/
│ ├── lib/
│ │ └── main.dart
│ └── ohos/
│ ├── entry/
│ │ └── src/
│ │ └── main/
│ │ └── module.json5
│ └── build-profile.json5
├── pubspec.yaml
├── README.OpenHarmony_CN.md
├── README.OpenHarmony.md
├── CHANGELOG.OpenHarmony.md
└── test/
项目根目录如下,其中包含 ohos/、example/ 及实际保留的说明文件;交付文档清单见第六节:

图 4:适配后的 safe_device 项目根目录。
| 文件 | 主要职责 |
|---|---|
lib/safe_device.dart | 提供业务公开 API |
lib/safe_device_config.dart | 实现平台协议或数据模型 |
ohos/src/main/ets/components/plugin/SafeDevicePlugin.ets | 注册通道并实现 OHOS 原生能力 |
ohos/src/main/module.json5 | 声明 HAR 模块和权限 |
example/lib/main.dart | 演示接口调用与结果显示 |
四、Dart 接口与通道分析
OHOS 实现需要遵循 Dart 层已有的方法、参数和回调约定。先阅读 lib/safe_device.dart、lib/safe_device_config.dart,再在 ohos/src/main/ets/components/plugin/SafeDevicePlugin.ets 中实现对应的原生调用。适配其他已有平台的插件时,也应保留其公开接口和其他平台实现。
本例的对应关系如下:
| Dart 入口或模型 | 通道协议 | OHOS 实现 | 应保持的行为 |
|---|---|---|---|
isJailBroken | isJailBroken | 检查可访问 Root 路径 | 未发现不代表绝对无 Root |
isRealDevice | isRealDevice | deviceInfo 特征判断 | 启发式结果 |
isMockLocation | isMockLocation | Location.isFromMock | 当前定位失败回退最后定位,再失败为 false |
isDevelopmentModeEnable / isUsbDebuggingEnabled | 开发设置 / usbDebuggingCheck | settings 与 hidebug | 尽力检测 |
isSafeDevice | Dart 聚合多个方法 | 组合风险值 | 不包含调试状态 |
原生端需要保持方法名、参数键和返回类型一致,不能只保留方法名称而改变业务语义。
4.1 跨端架构与调用时序
Flutter 侧通过 MethodChannel('safe_device') 调用 OHOS 实现。本插件使用一次性的异步调用,不提供持续事件流。
4.1.1 一次完整查询风险信息的时序
4.2 配置、布尔结果与详情 Map
class SafeDeviceConfig {
final bool mockLocationCheckEnabled;
const SafeDeviceConfig({this.mockLocationCheckEnabled = true});
Map<String, dynamic> toMap() {
return {
'mockLocationCheckEnabled': mockLocationCheckEnabled,
};
}
}
| 字段或结果 | 含义 |
|---|---|
| mockLocationCheckEnabled | 首次初始化时是否启用模拟定位检测 |
| rootDetectionDetails | 设备信息、Root 路径与调试信息 |
| isOnExternalStorage | OHOS 固定 false |
| isJailBrokenCustom / jailbreakDetails | OHOS 的 iOS 专用接口分别返回 false / 空 Map |
多数 Dart 查询捕获异常后返回 false;详情查询失败返回空 Map。业务必须结合可用权限与日志解释结果,不能把所有 false 都解读为通过安全检查。
4.3 公开 API 与平台接口
SafeDevice 使用静态 API,ensureInitiated 会用默认配置初始化。init 返回 void 且只生效一次,不能在界面开关变化时反复调用 init 当成配置更新。
static void init(SafeDeviceConfig config) {
if (isInitiated) {
debugPrint('SafeDevice has already been initiated, skipping');
return;
}
_channel.invokeMethod('init', config.toMap());
_safeDeviceConfig = config;
isInitiated = true;
}
static Future<bool> get isSafeDevice async {
ensureInitiated();
try {
final bool jailBroken = await isJailBroken;
final bool realDevice = await isRealDevice;
final bool mockLocation = await isMockLocation;
final bool onExternalStorage =
Platform.isAndroid ? await isOnExternalStorage : false;
return !(jailBroken || mockLocation || !realDevice || onExternalStorage);
} catch (e) {
debugPrint('Error checking SafeDevice status: $e');
return false;
}
}
4.4 Dart 通道协议分析
4.4.1 通道名称必须两端完全一致
const methodChannel = MethodChannel('safe_device');
通道名称属于跨语言协议。Dart 和 ArkTS 任何一端拼写不一致,都会出现“方法未实现”或“调用找不到插件”等问题。
4.4.2 查询模拟定位与详情
static Future<bool> get isMockLocation async {
ensureInitiated();
try {
if (Platform.isAndroid || _isOhos) {
if (_safeDeviceConfig?.mockLocationCheckEnabled == false) {
return false; // Skip mock location check if disabled in config
}
final bool isMockLocation =
await _channel.invokeMethod('isMockLocation');
return isMockLocation;
} else {
return !await isRealDevice || await isJailBroken;
}
} catch (e) {
debugPrint('Error checking MockLocation status: $e');
return false;
}
}
static Future<Map<String, dynamic>> get rootDetectionDetails async {
ensureInitiated();
if (Platform.isAndroid || _isOhos) {
try {
final Map<Object?, Object?> result =
await _channel.invokeMethod('rootDetectionDetails');
return Map<String, dynamic>.from(result);
} catch (e) {
debugPrint('Error getting root detection details: $e');
}
}
return {};
}
OHOS 判断使用 Platform.operatingSystem。isSafeDevice 中的外部存储项只对 Android 参与计算;开发者模式与 HDC 查询只是单独信息项。
4.4.3 处理查询失败与配置边界
static Future<bool> get isRealDevice async {
ensureInitiated();
try {
final bool isRealDevice = await _channel.invokeMethod('isRealDevice');
return isRealDevice;
} catch (e) {
debugPrint('Error checking RealDevice status: $e');
return false;
}
}
当前实现大量错误被捕获为 false。init 的通道调用没有被 await,调用方不能从 init 的 void 返回值判断原生配置已成功;需要在原始日志和实际查询中验证。
五、补全 OHOS 原生实现与工程配置
5.1 在 SafeDevicePlugin.ets 中实现原生能力
业务层沿用已有 API,原生侧在 SafeDevicePlugin 中接入 deviceInfo、settings、hidebug 与 LocationKit,通过 Flutter 通道回传结果。
下面列出类中的主要成员和方法,完整文件还包含 getUniqueClassName() 等插件接口;各段均为核心摘录,需要结合完整类使用。
原生插件位于:
ohos/src/main/ets/components/plugin/SafeDevicePlugin.ets
5.1.1 引入 Flutter 和 HarmonyOS 能力
import {
FlutterPlugin,
FlutterPluginBinding,
MethodCall,
MethodCallHandler,
MethodChannel,
MethodResult,
} from '@ohos/flutter_ohos';
import { common } from '@kit.AbilityKit';
import { BusinessError, deviceInfo, settings } from '@kit.BasicServicesKit';
import { fileIo } from '@kit.CoreFileKit';
import { geoLocationManager } from '@kit.LocationKit';
import { hidebug, hilog } from '@kit.PerformanceAnalysisKit';
FlutterPlugin 负责接入 Flutter Engine 生命周期,MethodChannel 接收 Dart 命令;系统能力由 deviceInfo、settings、hidebug 与 LocationKit 提供。错误和事件处理以对应方法实现为准。
5.1.2 连接 Flutter Engine
private channel: MethodChannel | null = null;
private applicationContext: common.Context | null = null;
private mockLocationCheckEnabled: boolean = true;
onAttachedToEngine(binding: FlutterPluginBinding): void {
this.applicationContext = binding.getApplicationContext();
this.channel = new MethodChannel(binding.getBinaryMessenger(), CHANNEL_NAME);
this.channel.setMethodCallHandler(this);
}
Engine 保存应用 Context,用于读取 settings,并注册 safe_device 方法通道。插件没有 EventChannel,example 的恢复前台刷新来自页面 WidgetsBindingObserver。
5.1.3 检测 Root 与模拟器特征
private getExistingRootPaths(): Array<string> {
const suspiciousPaths: Array<string> = [
'/system/bin/su',
'/system/xbin/su',
'/vendor/bin/su',
'/data/local/bin/su',
'/data/local/xbin/su',
'/system/bin/busybox',
'/data/adb/magisk',
'/sbin/.magisk',
];
const matches: Array<string> = [];
suspiciousPaths.forEach((path: string) => {
try {
if (fileIo.accessSync(path)) {
matches.push(path);
}
} catch (_error) {
// Sandboxed applications cannot inspect every system path.
}
});
return matches;
}
private isLikelyEmulator(): boolean {
const identity = [
deviceInfo.brand,
deviceInfo.manufacture,
deviceInfo.productModel,
deviceInfo.marketName,
deviceInfo.productSeries,
].join(' ').toLowerCase();
const emulatorIndicators: Array<string> = [
'emulator',
'simulator',
'generic',
'virtual',
'sdk_phone',
'sdk_gphone',
'x86_64',
];
return emulatorIndicators.some((indicator: string) => identity.includes(indicator));
}
应用无法访问的系统路径会被忽略,设备字段也可能随厂商变化。Root 检测与模拟器识别都是风险线索,不是对系统完整性的密码学证明。
5.1.4 读取位置来源与调试状态
private checkMockLocation(result: MethodResult): void {
if (!this.mockLocationCheckEnabled) {
result.success(false);
return;
}
geoLocationManager.getCurrentLocation({ timeoutMs: 5000 })
.then((location: geoLocationManager.Location) => {
result.success(location.isFromMock === true);
})
.catch((error: BusinessError) => {
hilog.warn(0, TAG, `Unable to obtain current location: ${error.code} ${error.message}`);
try {
const lastLocation = geoLocationManager.getLastLocation();
result.success(lastLocation.isFromMock === true);
} catch (lastLocationError) {
const businessError = lastLocationError as BusinessError;
hilog.warn(
0,
TAG,
`Unable to obtain last location: ${businessError.code} ${businessError.message}`,
);
result.success(false);
}
});
}
private isDevelopmentModeEnabled(): boolean {
return this.readBooleanSetting(settings.general.DEVELOPMENT_SETTINGS_STATUS) || this.isDebuggerAttached();
}
private isHdcEnabled(): boolean {
return this.readBooleanSetting(settings.general.HDC_STATUS);
}
private readBooleanSetting(name: string): boolean {
const context = this.applicationContext;
if (context === null) {
return false;
}
try {
const value = settings.getValueSync(context, name, '0').toLowerCase();
return value === '1' || value === 'true' || value === 'on' || value === 'enabled';
} catch (error) {
const businessError = error as BusinessError;
hilog.warn(0, TAG, `Unable to read setting ${name}: ${businessError.code} ${businessError.message}`);
return false;
}
}
当前定位最多等待 5000ms,失败后尝试最后位置,仍失败返回 false。项目说明指出相关开发者/HDC 设置在新 API 中已废弃,读取时使用默认值并结合当前调试状态,不能宣称全设备精确检测。
5.1.5 处理 MethodChannel 命令
onMethodCall(call: MethodCall, result: MethodResult): void {
switch (call.method) {
case 'getPlatformVersion':
result.success(deviceInfo.osFullName);
break;
case 'init':
this.mockLocationCheckEnabled = call.argument('mockLocationCheckEnabled') !== false;
result.success(null);
break;
case 'isJailBroken':
result.success(this.getExistingRootPaths().length > 0);
break;
case 'isRealDevice':
result.success(!this.isLikelyEmulator());
break;
case 'isOnExternalStorage':
// HarmonyOS applications are installed and run in an application sandbox.
result.success(false);
break;
case 'isDevelopmentModeEnable':
result.success(this.isDevelopmentModeEnabled());
break;
case 'usbDebuggingCheck':
result.success(this.isHdcEnabled());
break;
case 'isMockLocation':
this.checkMockLocation(result);
break;
case 'rootDetectionDetails':
result.success(this.buildRootDetectionDetails());
break;
default:
result.notImplemented();
break;
}
}
原生未知方法返回 notImplemented,模拟定位与设置读取失败主要写日志并返回默认值。Dart 多数 API 也捕获错误为 false,不能统一描述为全部失败都会抛 PlatformException。
5.1.6 Engine 解绑时释放资源
onDetachedFromEngine(_binding: FlutterPluginBinding): void {
this.channel?.setMethodCallHandler(null);
this.channel = null;
this.applicationContext = null;
}
Engine 解绑清空方法通道与应用 Context。插件没有持续位置订阅,不需要编造取消定位订阅 API;尚在等待的异步查询与页面生命周期分开处理。
5.2 声明插件和宿主权限
基础设备信息与风险路径检查不需要新增定位权限。模拟定位检测需要 APPROXIMATELY_LOCATION 和 LOCATION,并在运行时授权;不需要该项时,在首次 init 中禁用 mockLocationCheckEnabled。
5.2.1 插件 HAR 的权限
插件 ohos/src/main/module.json5 的模块配置如下:
{
"module": {
"name": "safe_device",
"type": "har",
"deviceTypes": [
"default",
"tablet",
"2in1"
]
}
}
5.2.2 应用 entry 的权限
最终安装的是宿主应用。以下片段来自 example/ohos/entry/src/main/module.json5,合并时保留原有 Ability 等配置:
{
"module": {
"requestPermissions": [
{
"name": "ohos.permission.INTERNET"
},
{
"name": "ohos.permission.APPROXIMATELY_LOCATION",
"reason": "$string:location_reason",
"usedScene": {
"abilities": [
"EntryAbility"
],
"when": "inuse"
}
},
{
"name": "ohos.permission.LOCATION",
"reason": "$string:location_reason",
"usedScene": {
"abilities": [
"EntryAbility"
],
"when": "inuse"
}
}
]
}
}
在 example/ohos/entry/src/main/resources/base/element/string.json 保留 location_reason 文本。示例 EntryAbility.onCreate 调用 requestPermissionsFromUser 申请前台定位;声明不会自动完成授权。授权完成后再刷新检测结果,拒绝或无定位结果时必须把“未确认”与“非模拟位置”区分。
5.3 注册并导出插件
pubspec.yaml 通过以下配置声明 OHOS 插件类:
flutter:
plugin:
platforms:
ohos:
pluginClass: SafeDevicePlugin
插件的 ohos/index.ets 需要导出实现:
import SafeDevicePlugin from './src/main/ets/components/plugin/SafeDevicePlugin';
export default SafeDevicePlugin;
执行 flutter pub get 和构建后,Flutter 工具会为应用生成插件注册代码。通常不应手工编辑 GeneratedPluginRegistrant.ets,因为下次构建可能覆盖它。
注册异常的排查步骤见第九节 MissingPluginException。
5.4 检查 example 的 OHOS 应用结构
本例的 example/ohos/build-profile.json5 应在 products 中设置版本。下面按第二节补全 compileSdkVersion,请合并到现有工程;其中 signingConfig: "default" 需要与本机配置的签名名称一致,签名材料保留在本地。
{
"app": {
"products": [
{
"name": "default",
"signingConfig": "default",
"compatibleSdkVersion": "5.1.0(18)",
"runtimeOS": "HarmonyOS",
"compileSdkVersion": "26.0.0",
"targetSdkVersion": "26.0.0"
}
]
},
"modules": [
{
"name": "entry",
"srcPath": "./entry",
"targets": [
{
"name": "default",
"applyToProducts": [
"default"
]
}
]
}
]
}
配置后,在 DevEco Studio 中执行一次 Sync Project。如果 entry 模块正常识别,Project 视图中会出现 entry,并能打开 entry 模块的签名配置。
六、补全交付文件并提交适配分支
6.1 除代码外还要补全哪些文件
代码适配完成后,还需要整理安装说明、接口文档、版本记录和开源信息。接收仓库有专用模板时,按其格式填写:
| 文件 | 应写清楚的内容 |
|---|---|
README.OpenSource | 上游名称、源码地址、适配版本或提交、版权及许可证信息;按仓库模板列出第三方依赖 |
README.md | 原项目说明、OHOS 支持入口、配套 Demo 和文档链接;保留上游信息 |
README.OpenHarmony_CN.md | 简介、AtomGit 安装方式、版本对应关系、环境约束、权限、接口表、示例、已验证范围和遗留问题 |
README.OpenHarmony.md | 与中文说明对应的英文文档 |
CHANGELOG.OpenHarmony.md | OHOS 新增能力、适配版本、兼容限制与测试范围 |
LICENSE / NOTICE | 保留上游许可证;NOTICE 按许可证和原项目要求保留或补充 |
example/README.md | 依赖方式、运行目录、签名、操作步骤与效果图;覆盖各风险项、详情、授权拒绝、无定位数据和恢复前台刷新 |
pubspec.yaml、ohos/oh-package.json5 | 核对包名、版本、插件注册、仓库地址、许可证和依赖 |
.gitignore | 忽略构建缓存及本机签名材料,不漏提交必要源码和配置 |
README.OpenSource 记录库本身的来源与版本。本例的包名为 safe_device,版本为 1.4.1,采用 MIT 许可证;Flutter 和 HarmonyOS SDK 版本写入环境说明。
现有说明文件以目录树为准。README.OpenSource 等缺失交付文件按接收仓库要求补全;安装与反馈链接统一替换为本文预定的 AtomGit 地址,并在仓库创建、适配代码同步后核对。
6.2 提交前检查
提交前先完成第八节的插件、example 和真机测试,再从根目录检查改动:
git branch --show-current
git diff --check
git status --short
git diff --stat
git diff
检查 diff 中的接口、平台注册和依赖变化,移除本机路径及签名信息,并使文档中的版本和分支与提交内容一致。
6.3 提交并推送到 AtomGit
文档和代码整理完成后,在 Git 仓库根目录暂存并提交。以下命令以第 6.1 节文档已经补全为前提,文件名按项目实际情况调整:
git add lib ohos pubspec.yaml example test
git add README.md README.OpenSource README.OpenHarmony_CN.md
git add README.OpenHarmony.md CHANGELOG.OpenHarmony.md
git diff --cached --check
git diff --cached --stat
git diff --cached
git commit -m "feat: add OHOS support for safe_device 1.4.1"
git remote -v
git branch --show-current
git push -u origin feat/ohos_safe_device_1.4.1
DevEco 可能向 example/ohos/build-profile.json5 写入本机签名配置,需要在提交前从暂存内容中移除。推送时,origin 应指向自己的 AtomGit 仓库,当前分支为 feat/ohos_safe_device_1.4.1。
推送后在 AtomGit 发起合并请求,说明上游来源和版本、OHOS 实现范围、依赖及权限、测试环境、操作结果、已知限制,并附 Demo 运行图。目标分支和评审流程以接收仓库要求为准。
七、使用根目录 example 演示接入
插件包自带 example/,可以直接用来调试插件和体验设备风险信息检测。
7.1 本地适配时使用路径依赖
当前 example/pubspec.yaml 的依赖是:
dependencies:
flutter:
sdk: flutter
safe_device:
path: ../
../ 相对于 example/pubspec.yaml 指向插件根目录,修改根目录插件后可直接联调。
7.2 通过 AtomGit 引入插件
业务应用通过 AtomGit 引入时,将 safe_device 的 path 配置替换为下面的 Git 依赖。仓库同步后,将 ref 替换为实际适配提交号:
dependencies:
flutter:
sdk: flutter
safe_device:
git:
url: https://atomgit.com/oh-flutter/safe_device.git
ref: <适配提交号>
使用自己的适配版本时,先推送分支,再将 url 改为对应仓库,ref 改为 feat/ohos_safe_device_1.4.1。正式发布后可固定到 tag 或 commit。
从插件根目录执行:
cd example
flutter pub get
flutter pub deps
检查 example/pubspec.lock 中 safe_device 的来源为 git,并核对 url、ref 和 resolved-ref。同时检查没有 dependency_overrides 或 pubspec_overrides.yaml 将其覆盖回本地依赖,确认应用使用的是 Git 依赖。
7.3 调用接口实现设备风险信息检测
下面的页面可用于插件包内的 example/lib/main.dart,是便于讲解的最小页面;仓库完整 Demo 的入口和布局可能不同,第八节截图与验收步骤以仓库完整 Demo 为准。
最小页面在首次初始化时关闭模拟定位检测,仅演示基础信息,不需要为它申请定位权限。第八节使用仓库完整 Demo,其 EntryAbility 保留了定位授权流程。
import 'dart:async';
import 'package:flutter/material.dart';
import 'package:safe_device/safe_device.dart';
import 'package:safe_device/safe_device_config.dart';
void main() {
runApp(const MaterialApp(home: DemoPage()));
}
class DemoPage extends StatefulWidget {
const DemoPage({super.key});
State<DemoPage> createState() => _DemoPageState();
}
class _DemoPageState extends State<DemoPage> {
String _status = '尚未操作';
bool _busy = false;
void initState() {
super.initState();
SafeDevice.init(const SafeDeviceConfig(mockLocationCheckEnabled: false));
}
void _show(String value) {
if (mounted) setState(() => _status = value);
}
Future<void> _run(Future<String> Function() action) async {
if (_busy) return;
setState(() => _busy = true);
try {
_show(await action());
} catch (error) {
_show('调用失败:$error');
} finally {
if (mounted) setState(() => _busy = false);
}
}
Widget build(BuildContext context) {
return Scaffold(
appBar: AppBar(title: const Text('设备风险信息')),
body: ListView(
padding: const EdgeInsets.all(16),
children: [
Text(_status),
const SizedBox(height: 16),
FilledButton(onPressed: _busy ? null : () => _run(() async {
final rooted = await SafeDevice.isJailBroken;
final real = await SafeDevice.isRealDevice;
return 'Root 风险:$rooted,真实设备:$real';
}), child: const Text('查询基础风险')),
FilledButton(onPressed: _busy ? null : () => _run(() async {
final dev = await SafeDevice.isDevelopmentModeEnable;
final hdc = await SafeDevice.isUsbDebuggingEnabled;
return '开发者模式:$dev,HDC:$hdc';
}), child: const Text('查询调试信息')),
FilledButton(onPressed: _busy ? null : () => _run(() async {
return '${await SafeDevice.rootDetectionDetails}';
}), child: const Text('查询详情')),
],
),
);
}
}
7.4 页面退出时处理未完成查询
异步回调先检查 mounted。最小示例没有持续订阅;完整 Demo 在 dispose 移除 WidgetsBindingObserver,恢复前台时重新查询。页面退出不会把先前返回的风险结果变成持续监控结果。
八、验证、构建与鸿蒙设备运行效果
8.1 分别验证插件与 example
从插件仓库根目录执行:
flutter pub get
flutter analyze
flutter test
cd example
flutter pub get
flutter analyze
flutter test
根目录现有 safe_device_test.dart 主要保留通道级 getPlatformVersion 用例,不能据此认为所有安全 API 已覆盖。example 包含中文结果页测试与集成入口;检测是否返回 bool 也不能证明每项风险判断准确。Widget 测试应匹配实际保留的 Demo 页面;如果替换成第七节最小页面,也要相应调整原来的 UI 断言。
Dart 测试覆盖接口和页面逻辑,各风险项、详情、授权拒绝、无定位数据和恢复前台刷新还需要在鸿蒙设备上验证。以上为 Dart 测试复现命令,本次未重新执行这些测试;本次已重新构建、安装并运行签名 Release HAP,具体真机采集范围见 8.5。
8.2 确认设备连接
hdc list targets
flutter devices
设备首次连接电脑时,需要在手机端确认调试授权。列表为空时,检查 USB 连接、调试模式和电脑授权。
8.3 配置签名
真机安装的 HAP 通常需要有效签名。推荐使用 DevEco Studio 为 entry 模块配置自动签名:
- 用 DevEco Studio 打开
example/ohos,不是仓库根目录; - 等待工程 Sync 成功,确认 Project 视图中存在
entry模块; - 打开 File > Project Structure > Signing Configs;
- 为
defaultproduct 选择或生成签名; - 确认设备、应用包名、证书和 Profile 匹配;
- 再回到终端执行 Flutter 构建或运行。
签名材料保存在本机,公开仓库中只保留构建所需的通用配置。
8.4 运行示例
以下命令在 example/ 目录执行,将 <device-id> 替换为设备列表中的实际 ID:
flutter run -d <device-id>
也可以先构建 HAP:
flutter build hap --debug
典型产物位于:
example/ohos/entry/build/default/outputs/default/
目录中通常包含已签名和未签名 HAP。真机安装应选择与当前设备匹配的已签名产物。
本次真机截图使用签名 Release HAP。在插件包的 example/ 目录完成签名配置后执行:
flutter build hap --release
hdc -t <device-id> install -r build/ohos/hap/entry-default-signed.hap
hdc -t <device-id> shell aa start -a EntryAbility -b com.xamdesign.safe_device_example
8.5 在设备上测试设备风险信息检测
- 运行完整 Demo,处理定位授权,等待“设备安全检测”页面加载。
- 核对真实设备、Root 风险、模拟定位与外部存储项。
- 查看开发者模式和 HDC / USB 调试,结合实际系统状态记录差异。
- 查看设备详情中的平台、型号、Root 路径与调试字段。
- 拒绝定位授权或关闭定位后刷新,记录 false 的降级语义,不当作真实位置验证。
- 切换后台再回到应用,检查恢复前台刷新和未完成异步结果。
页面初始提示来自 Demo 默认值,调用结果或事件到达后才反映系统状态。上述列表为完整验收步骤,本次实际采集范围如下。
8.6 鸿蒙设备运行效果
OHOS 实现提供设备风险信息检测。以下为仓库完整 Demo 的三张真机运行截图,按实际状态记录。
截图标注:操作步骤与截图命令真机运行图(从左到右):安全项/调试环境/设备信息。采集于 2026-09-09,设备 ALN-AL00 / HUAWEI Mate 60 Pro,系统 OpenHarmony 6.1.1.120(API 24);使用本地当前源码构建的签名 Release HAP。
图中“未检测到”是插件返回值;本次 HDC 实际已连接,调试状态存在漏检。
执行目录:本文 Markdown 所在目录。先用 hdc list targets 获取设备 ID,将下列 <device-id> 替换为实际值。截图使用仓库完整 Demo;snapshot_display 在本机要求 .jpeg 后缀,图片保持原始真机画面。
mkdir -p blog-assets/safe_device
安全项: 启动完整 Demo,定位授权选择“本次使用允许”,等待安全项显示。
hdc -t <device-id> shell snapshot_display -f /data/local/tmp/safe_device-safety-checks.jpeg
hdc -t <device-id> file recv /data/local/tmp/safe_device-safety-checks.jpeg ./blog-assets/safe_device/safety-checks.jpeg
调试环境: 向上滚动页面,让“开发者模式”和“HDC / USB 调试”完整进入画面。
hdc -t <device-id> shell snapshot_display -f /data/local/tmp/safe_device-debug-environment.jpeg
hdc -t <device-id> file recv /data/local/tmp/safe_device-debug-environment.jpeg ./blog-assets/safe_device/debug-environment.jpeg
设备信息: 继续向上滚动,保留设备平台、品牌、型号、系统版本和 Root 路径结果。
hdc -t <device-id> shell snapshot_display -f /data/local/tmp/safe_device-device-info.jpeg
hdc -t <device-id> file recv /data/local/tmp/safe_device-device-info.jpeg ./blog-assets/safe_device/device-info.jpeg
| 安全项 | 调试环境 | 设备信息 |
|---|---|---|
| 风险项结果 | 尽力检测值 | 诊断详情 |
Root、模拟器与调试检测属于尽力判断,可能误报或漏报。无定位权限或没有可用位置时 isMockLocation 返回 false,这不等于已经验证了位置真实。
九、FAQ:适配过程与使用问题
9.1 Missing SDK components
典型错误如下:
Missing SDK components. SDK path: ...,
missing components: toolchains,ets,js,native,previewer.
这个错误发生在 Hvigor 同步阶段。通常需要检查构建工具使用的 SDK 路径、组件是否完整,以及 Hvigor 与 SDK 的版本是否匹配。
处理顺序:
- 在 DevEco Studio SDK Manager 中确认 API 26 组件已经下载完整;
- 检查 Flutter 和 DevEco Studio 使用的 SDK 路径是否一致;
- 避免误用
/Applications/DevEco-Studio.app/Contents/sdk之类的不完整目录; - 确认 SDK 根目录下存在
toolchains、ets、js、native、previewer; - 执行
flutter config --ohos-sdk <正确路径>; - 重新执行
flutter doctor -v和 DevEco Studio Sync。
因为 Sync 和 Compile 首先读取 Mac 本地 SDK。手机 API 版本只在部署、安装和运行时参与兼容判断。即使完全不连接手机,本地 SDK 不完整时也会得到相同错误。
当前工程的 compatibleSdkVersion 是 API 18,因此 API 24 在安装版本门槛上是满足的;但功能是否可用还取决于目标系统能力、权限和运行环境,不能仅凭最低版本判断。
9.2 DevEco Studio 中看不到 entry 模块
插件的 ohos/ 目录是 HAR 模块,可安装应用的 entry 模块位于 example/ohos/entry。
请直接使用 DevEco Studio 打开:
safe_device/example/ohos
如果仍看不到 entry,先解决 SDK Sync 错误,再检查 example/ohos/build-profile.json5 的 modules 是否包含 ./entry。同步失败时,Project Structure 无法正确解析模块,签名界面也可能不显示 entry。
9.3 无法手动签名
签名配置依附于可构建的应用模块和 product。只有 HAR 插件模块、工程 Sync 失败,或者打开了错误目录时,DevEco Studio 都可能无法提供 entry 签名入口。
建议先确认:
- 打开的是
example/ohos; - SDK 组件完整并且 Sync 成功;
entry的模块类型为entry;defaultproduct 和 target 已正确关联;- 当前账号、证书和调试设备状态有效。
9.4 所有风险项都是 false,能否认为设备安全
不能。部分查询异常或不可访问时也返回 false;isMockLocation 无权限、无位置均可能返回 false。需要同时核对权限、数据可用性与日志,Root 检测也受沙箱限制。
9.5 MissingPluginException
这通常表示 Dart 通道找不到已注册的原生插件。新增原生插件后需要重新构建应用。从仓库根目录执行:
cd example
flutter clean
flutter pub get
flutter run -d <device-id>
如果仍然出现,检查自动生成的插件注册文件中是否包含 SafeDevicePlugin,同时核对 pubspec.yaml、ohos/index.ets 和 oh-package.json5。
9.6 反复 init 为什么配置没有变化
SafeDevice.isInitiated 为 true 后 init 直接跳过,当前 API 不提供重新初始化。首次检测前决定 mockLocationCheckEnabled;不要通过重复调用 init 实现动态切换。
9.7 编译成功但安装失败
常见原因包括:
- HAP 未签名或使用了错误的 Profile;
- 设备未加入调试设备列表;
- 包名与签名 Profile 不匹配;
- 安装包的
compatibleSdkVersion高于设备 API; - 手机上已经安装了使用不同证书签名的同包名应用。
根据安装错误码区分签名、版本和包名冲突,再处理对应配置。
9.8 flutter create 不认识 ohos,或包名不合法
先执行 flutter --version,确认使用的是 OHOS 版工具链,环境配置回到第二节的社区链接核对。包名报错时,确认当前目录包含目标插件的 pubspec.yaml,并显式传入 --project-name safe_device;本例仓库名和 Dart 包名均为 safe_device。生成后检查 diff,再补充 ArkTS 业务实现。
9.9 AtomGit 依赖提示找不到分支或无权限
先检查 URL 是否指向已同步的目标仓库,再确认 feat/ohos_safe_device_1.4.1 已推送。仓库未创建、适配分支未推送或提交未同步时,应先完成同步;不能直接使用仅存在本地的提交号。私有仓库还需在本机配置 Git 认证。
9.10 改了本地 ArkTS,Demo 为什么没变化
先检查 example/pubspec.yaml:Git 依赖读取远程提交,不会自动读取本地插件改动。本地联调切回 path: ../;测试远程版本则先提交推送,再更新依赖并核对 pubspec.lock 的 resolved-ref。原生代码变动后停止应用并重新构建运行,不能只做 Dart 热重载。
9.11 开发者模式开启了,isSafeDevice 为什么仍为 true
isSafeDevice 组合的是 Root、真实设备、模拟定位,以及 Android 专用外部存储项;开发者模式和 HDC 没有参与。业务如需这些条件,应自行组合,且注意 OHOS 设置读取是尽力检测。
相关链接
更多推荐
所有评论(0)