Flutter_udid 三方库鸿蒙适配之旅：从零到一的深度实践

{
  "module": {
    "requestPermissions": [
      {
        "name": "ohos.permission.APP_TRACKING_CONSENT",
        "reason": "$string:reason",
        "usedScene": {
          "abilities": [
            "EntryFormAbility"
          ],
          "when": "inuse"
        }
      }
    ]
  }
}

import { identifier } from '@kit.AdsKit';
import { abilityAccessCtrl, common } from '@kit.AbilityKit';
import { hilog } from '@kit.PerformanceAnalysisKit';
import { BusinessError } from '@kit.BasicServicesKit';

function requestOAIDTrackingConsentPermissions(context: common.Context): void {
  // 进入页面时，向用户请求授权广告跨应用关联访问权限
  const atManager: abilityAccessCtrl.AtManager = abilityAccessCtrl.createAtManager();
  try {
    atManager.requestPermissionsFromUser(context, ["ohos.permission.APP_TRACKING_CONSENT"]).then((data) => {
      if (data.authResults[0] === 0) {
        hilog.info(0x0000, 'testTag', '%{public}s', 'succeeded in requesting permission');
        identifier.getOAID((err: BusinessError, data: string) => {
          if (err.code) {
            hilog.error(0x0000, 'testTag', '%{public}s', `get oaid failed, error: ${err.code}${err.message}`);
          } else {
            const oaid: string = data;
            hilog.info(0x0000, 'testTag', '%{public}s', `succeeded in getting oaid by callback , oaid: ${oaid}`);
          }
        });
      } else {
        hilog.error(0x0000, 'testTag', '%{public}s', 'user rejected');
      }
    }).catch((err: BusinessError) => {
      hilog.error(0x0000, 'testTag', '%{public}s', `request permission failed, error: ${err.code}${err.message}`);
    })
  } catch (err) {
    hilog.error(0x0000, 'testTag', '%{public}s', `catch err->${err.code}, ${err.message}`);
  }
}

dependencies:
  flutter_udid:
    git:
      url: "https://gitcode.com/nutpi/flutter_udid.git"
      path: ""

flutter create . --template=plugin --platforms=ohos

name: flutter_udid
description:PlugintoretrieveapersistentUDIDacrossreinstallsoniOSandAndroid
version:4.0.0
homepage:https://github.com/GigaDroid/flutter_udid

environment:
sdk:">=3.0.0 <4.0.0"
flutter:">=3.10.0"

dependencies:
flutter:
    sdk:flutter
crypto:^3.0.0

dev_dependencies:
flutter_test:
    sdk:flutter
flutter_lints:^4.0.0

flutter:
plugin:
    platforms:
      android:
        package:de.gigadroid.flutter_udid
        pluginClass:FlutterUdidPlugin
      ios:
        pluginClass:FlutterUdidPlugin
      macos:
        pluginClass:FlutterUdidPlugin
      windows:
        pluginClass:FlutterUdidPluginCApi
      linux:
        pluginClass:FlutterUdidPlugin
      ohos:
        pluginClass:FlutterUdidPlugin

/node_modules
/oh_modules
/local.properties
/.preview
/.idea
/build
/libs
/.cxx
/.test
*.har
/BuildProfile.ets
/oh-package-lock.json5

{
  "name": "flutter_udid",
"version": "1.0.0",
"description": "Plugin to retrieve a persistent UDID accross reinstalls on HarmonyOS and OpenHarmony",
"main": "index.ets",
"author": "nutpi",
"license": "Apache-2.0",
"dependencies": {
    "@ohos/flutter_ohos": "file:./libs/flutter.har"
  },
"modelVersion": "5.0.4"
}

import FlutterUdidPlugin from './src/main/ets/de/gigadroid/flutter_udid/FlutterUdidPlugin'

export default FlutterUdidPlugin

import {
  MethodCallHandler,
  FlutterPlugin,
  BinaryMessenger,
  FlutterPluginBinding,
  AbilityPluginBinding,
  MethodCall,
  MethodChannel,
  MethodResult,
  Log
} from'@ohos/flutter_ohos';
import {  common } from'@kit.AbilityKit';
import { identifier } from'@kit.AdsKit';
import { UIAbility } from'@kit.AbilityKit';
import { requestPermissions } from'./RequestPermissions';

const TAG: string = "FlutterUdidPlugin";

exportdefaultclass FlutterUdidPlugin implements MethodCallHandler, FlutterPlugin {
  private channel: MethodChannel | null = null
  private applicationContext: common.Context | null = null
  private ability: UIAbility | null = null;

constructor(context?: common.Context) {
    if (context) {
      this.applicationContext = context;
    }
  }

static registerWith(): void {
  }

  getUniqueClassName(): string {
    return TAG;
  }

  onAttachedToEngine(binding: FlutterPluginBinding): void {
    this.onAttachedToEngine1(binding.getApplicationContext(), binding.getBinaryMessenger());
  }

  private onAttachedToEngine1(applicationContext: Context, messenger: BinaryMessenger) {
    this.applicationContext = applicationContext;
    this.channel = new MethodChannel(messenger, "flutter_udid")
    this.channel.setMethodCallHandler(this)
  }

  onAttachedToAbility(binding: AbilityPluginBinding): void {
    this.ability = binding.getAbility()
  }

  onDetachedFromAbility(): void {
    this.ability = null;
  }

  onMethodCall(call: MethodCall, result: MethodResult): void {
    if (call.method == "getUDID") {
      this.requestPermissions().then((data: boolean) => {
        this.getUDID().then((udid: string | null) => {
          if (udid == null || udid == "") {
            result.error("UNAVAILABLE", "UDID not available.", null)

          } else {
            result.success(udid)
          }
        })
      })
    } else {
      result.notImplemented()
    }
  }

  onDetachedFromEngine(binding: FlutterPluginBinding): void {
    this.applicationContext = null;
    this.channel?.setMethodCallHandler(null)
  }

  private async getUDID(): Promise<string | null> {
    try {
      returnawait identifier.getOAID()
    } catch (err) {
      returnnull
    }
  }

  private async requestPermissions(): Promise<boolean> {
    if (!this.ability) {
      Log.i(TAG, "Could not launch BarcodeScanner because the plugin is not attached to any ability")
      returnfalse
    }
    try {
      const results = await requestPermissions(this.ability!.context)
      return results ? results : false
    } catch (e) {
    }
    returnfalse
  }
}

import bundleManager from'@ohos.bundle.bundleManager';
import abilityAccessCtrl, { Permissions } from'@ohos.abilityAccessCtrl';
import { BusinessError } from'@kit.BasicServicesKit';

exportconst appTrackingConsentPermission: Array<Permissions> = ['ohos.permission.APP_TRACKING_CONSENT'];

asyncfunction checkAccessToken(permission: Permissions): Promise<abilityAccessCtrl.GrantStatus> {
let atManager: abilityAccessCtrl.AtManager = abilityAccessCtrl.createAtManager();
let grantStatus: abilityAccessCtrl.GrantStatus = abilityAccessCtrl.GrantStatus.PERMISSION_DENIED;

// 获取应用程序的accessTokenID
let tokenId: number = 0;
try {
    let bundleInfo: bundleManager.BundleInfo =
      await bundleManager.getBundleInfoForSelf(bundleManager.BundleFlag.GET_BUNDLE_INFO_WITH_APPLICATION);
    let appInfo: bundleManager.ApplicationInfo = bundleInfo.appInfo;
    tokenId = appInfo.accessTokenId;
  } catch (error) {
    let err: BusinessError = error as BusinessError;
    console.error(`Failed to get bundle info for self. Code is ${err.code}, message is ${err.message}`);
  }

// 校验应用是否被授予权限
try {
    grantStatus = await atManager.checkAccessToken(tokenId, permission);
  } catch (error) {
    let err: BusinessError = error as BusinessError;
    console.error(`Failed to check access token. Code is ${err.code}, message is ${err.message}`);
  }

return grantStatus;
}

exportasyncfunction checkPermissions(permissions: Array<Permissions>): Promise<boolean> {
let grantStatus: abilityAccessCtrl.GrantStatus = await checkAccessToken(permissions[0]);
return grantStatus === abilityAccessCtrl.GrantStatus.PERMISSION_GRANTED;
}

exportasyncfunction requestPermissions(
  context: Context
) {
const hasAppTrackingConsentPermission: boolean = await checkPermissions(appTrackingConsentPermission);

if (!hasAppTrackingConsentPermission) {
    let atManager: abilityAccessCtrl.AtManager = abilityAccessCtrl.createAtManager();

    // requestPermissionsFromUser会判断权限的授权状态来决定是否唤起弹窗
    try {
      let data = await atManager.requestPermissionsFromUser(context, appTrackingConsentPermission)
      let grantStatus: Array<number> = data.authResults;
      let length: number = grantStatus.length;
      for (let i = 0; i < length; i++) {
        if (grantStatus[i] !== 0) {
          // 用户拒绝授权
          returnfalse;
        }
      }
      // 用户授权，可以继续访问目标操作
      returntrue;
    } catch (error) {
      let err: BusinessError = error as BusinessError;
      console.error(`Failed to request permissions from user. Code is ${err.code}, message is ${err.message}`);
      returnfalse;
    }
  } else {
    // Permissions already exist. Call the callback with success.
    returntrue;
  }
}

import FlutterUdidPlugin from './src/main/ets/de/gigadroid/flutter_udid/FlutterUdidPlugin'

export default FlutterUdidPlugin

flutter create . --template=plugin --platforms=ohos

flutter pub get

 flutter build hap --debug

// RequestPermissions.ets (简化示例)
import bundleManager from'@ohos.bundle.bundleManager';
import abilityAccessCtrl, { Permissions } from'@ohos.abilityAccessCtrl';

exportconst appTrackingConsentPermission: Array<Permissions> = ['ohos.permission.APP_TRACKING_CONSENT'];

asyncfunction checkAccessToken(permission: Permissions): Promise<abilityAccessCtrl.GrantStatus> {
// ... 获取 tokenId
// ... 调用 atManager.checkAccessToken(tokenId, permission)
// ... 返回 grantStatus
}

exportasyncfunction checkPermissions(permissions: Array<Permissions>): Promise<boolean> {
let grantStatus: abilityAccessCtrl.GrantStatus = await checkAccessToken(permissions[0]);
return grantStatus === abilityAccessCtrl.GrantStatus.PERMISSION_GRANTED;
}

// RequestPermissions.ets (简化示例)
exportasyncfunction requestPermissions(
  context: Context
): Promise<boolean> {
const hasPermission: boolean = await checkPermissions(appTrackingConsentPermission);

if (!hasPermission) {
    let atManager = abilityAccessCtrl.createAtManager();
    try {
      let data = await atManager.requestPermissionsFromUser(context, appTrackingConsentPermission);
      // ... 检查 data.authResults ...
      // ... 返回 true 或 false
    } catch (error) {
      // ... 处理错误，返回 false
    }
  } else {
    returntrue;
  }
}

// FlutterUdidPlugin.ets (简化示例)
import { requestPermissions as requestAppPermissions } from'./RequestPermissions';
import { identifier } from'@kit.AdsKit';

exportdefaultclass FlutterUdidPlugin implements MethodCallHandler, FlutterPlugin {
// ... 其他成员和方法 ...
private ability: UIAbility | null = null;

  onMethodCall(call: MethodCall, result: MethodResult): void {
    if (call.method == "getUDID") {
      this.requestPermissions().then((granted: boolean) => {
        // 注意：原始代码在这里没有显式检查 granted 的值
        // 理想情况下，应该检查 granted 是否为 true
        // if (granted) { ... } else { result.error(...) }
        this.getUDID().then((udid: string | null) => {
          if (udid) {
            result.success(udid);
          } else {
            result.error("UNAVAILABLE", "UDID not available.", null);
          }
        });
      });
    } else {
      result.notImplemented();
    }
  }

privateasync getUDID(): Promise<string | null> {
    try {
      returnawait identifier.getOAID();
    } catch (err) {
      returnnull;
    }
  }

privateasync requestPermissions(): Promise<boolean> {
    if (!this.ability) {
      returnfalse;
    }
    try {
      // 调用 RequestPermissions.ets 中的函数
      returnawait requestAppPermissions(this.ability!.context);
    } catch (e) {
      returnfalse;
    }
  }
}

flutter pub get

 flutter build hap --debug



flutter config --ohos-sdk=/Users/jianguo/Library/OpenHarmony/Sdk

flutter config --ohos-sdk=""