鸿蒙5.0开辟进阶：API ArkUI框架-ArkTS组件（组件标识）

往期鸿蒙全套实战文章必看：（文中附带全栈鸿蒙学习资料）

• 鸿蒙开辟核心知识点，看这篇文章就够了
  
• 最新版！鸿蒙HarmonyOS Next应用开辟实战学习门路
  
• 鸿蒙HarmonyOS NEXT开辟技术最全学习门路指南
  
• 鸿蒙应用开辟实战项目，看这一篇文章就够了（部分项目附源码）
  

---

组件标识

id为组件的唯一标识，在整个应用内唯一。本模块提供组件标识相关接口，可以获取指定id组件的属性，也提供向指定id组件发送事件的功能。
   阐明
  

• 从API Version 8开始支持。后续版本如有新增内容，则采取上角标单独标志该内容的起始版本。
  
• 若同一个组件设置了多个id或者key，最后设置的生效。
  

  属性

id

id(value: string): T
组件的唯一标识，唯一性由利用者保证。
卡片能力： 从API version 9开始，该接口支持在ArkTS卡片中利用。
元服务API： 从API version 11开始，该接口支持在元服务中利用。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
名称范例必填阐明valuestring是 组件的唯一标识，唯一性由利用者保证。
默认值：''
  key12+

key(value: string): T
组件的唯一标识，唯一性由利用者保证。
此接口仅用于对应用的测试。与id同时利用时，后赋值的属性会覆盖先赋值的属性，建议仅设置id。
系统能力： SystemCapability.ArkUI.ArkUI.Full
参数：
名称范例必填阐明valuestring是 组件的唯一标识，唯一性由利用者保证。
默认值：''
  接口

getInspectorByKey9+

getInspectorByKey(id: string): string
获取指定id的组件的所有属性，不包罗子组件信息。
此接口仅用于对应用的测试。由于耗时长，不建议利用。
元服务API： 从API version 11开始，该接口支持在元服务中利用。
参数:
参数名范例必填阐明idstring是要获取属性的组件id。 返回值:
范例阐明string 组件属性列表的JSON字符串。
阐明：
字符串信息包含组件的tag、id、位置信息(相对于窗口左上角的坐标)以及用于测试查抄的组件所包含的相关属性信息。
  getInspectorTree9+

getInspectorTree(): Object
获取组件树及组件属性。
此接口仅用于对应用的测试。由于耗时长，不建议利用。
元服务API： 从API version 11开始，该接口支持在元服务中利用。
返回值:
范例阐明Object组件树及组件属性列表的JSON对象。 sendEventByKey9+

sendEventByKey(id: string, action: number, params: string): boolean
给指定id的组件发送事件。
此接口仅用于对应用的测试。由于耗时长，不建议利用。
元服务API： 从API version 11开始，该接口支持在元服务中利用。
参数:
参数名范例必填阐明idstring是要触发事件的组件的id。actionnumber是 要触发的事件范例，现在支持取值：
- 点击事件Click: 10
- 长按事件LongClick: 11。
paramsstring是事件参数，无参数传空字符串 ""。 返回值:
范例阐明boolean找不到指定id的组件时返回false，其余环境返回true。 sendTouchEvent9+

sendTouchEvent(event: TouchObject): boolean
发送触摸事件。
此接口仅用于对应用的测试。由于耗时长，不建议利用。
元服务API： 从API version 11开始，该接口支持在元服务中利用。
参数:
参数名范例必填阐明eventTouchObject是触发触摸事件的位置，event参数见TouchEvent中TouchObject的先容。 返回值:
范例阐明boolean事件发送失败时返回false，其余环境返回true。 sendKeyEvent9+

sendKeyEvent(event: KeyEvent): boolean
发送按键事件。
此接口仅用于对应用的测试。由于耗时长，不建议利用。
元服务API： 从API version 11开始，该接口支持在元服务中利用。
参数:
参数名范例必填阐明eventKeyEvent是按键事件，event参数见KeyEvent先容。 返回值:
范例阐明boolean事件发送失败时时返回false，其余环境返回true。 sendMouseEvent9+

sendMouseEvent(event: MouseEvent): boolean
发送鼠标事件。
此接口仅用于对应用的测试。由于耗时长，不建议利用。
元服务API： 从API version 11开始，该接口支持在元服务中利用。
参数：
参数名范例必填阐明eventMouseEvent是鼠标事件，event参数见MouseEvent先容。 返回值：
范例阐明boolean事件发送失败时返回false，其余环境返回true。 示例

该示例主要展示如何通过组件标识接口，获取特定id组件的属性，以及如何向该id的组件触发事件。

1. // xxx.ets
2. import { IntentionCode } from '@kit.InputKit'
4. class Utils {
5.   static rect_left: number
6.   static rect_top: number
7.   static rect_right: number
8.   static rect_bottom: number
9.   static rect_value: Record<string, number>
11.   //获取组件所占矩形区域坐标
12.   static getComponentRect(key:string):Record<string, number> {
13.     let strJson = getInspectorByKey(key)
14.     let obj:Record<string, string> = JSON.parse(strJson)
15.     console.info("[getInspectorByKey] current component obj is: " + JSON.stringify(obj))
16.     let rectInfo:string[] = JSON.parse('[' + obj.$rect + ']')
17.     console.info("[getInspectorByKey] rectInfo is: " + rectInfo)
18.     Utils.rect_left = JSON.parse('[' + rectInfo[0] + ']')[0]     // 相对于组件左上角的水平方向坐标
19.     Utils.rect_top = JSON.parse('[' + rectInfo[0] + ']')[1]      // 相对于组件左上角的垂直方向坐标
20.     Utils.rect_right = JSON.parse('[' + rectInfo[1] + ']')[0]    // 相对于组件右下角的水平方向坐标
21.     Utils.rect_bottom = JSON.parse('[' + rectInfo[1] + ']')[1]   // 相对于组件右下角的垂直方向坐标
22.     return Utils.rect_value = {
23.       "left": Utils.rect_left, "top": Utils.rect_top, "right": Utils.rect_right, "bottom": Utils.rect_bottom
24.     }
25.   }
26. }
28. @Entry
29. @Component
30. struct IdExample {
31.   @State text: string = ''
33.   build() {
34.     Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.Center }) {
36.       Button() {
37.         Text('onKeyTab').fontSize(25).fontWeight(FontWeight.Bold)
38.       }.margin({ top: 20 }).backgroundColor('#0D9FFB')
39.       .onKeyEvent(() => {
40.         this.text = "onKeyTab"
41.       })
43.       Button() {
44.         Text('click to start').fontSize(25).fontWeight(FontWeight.Bold)
45.       }.margin({ top: 20 })
46.       .onClick(() => {
47.         console.info(getInspectorByKey("click"))
48.         console.info(JSON.stringify(getInspectorTree()))
49.         this.text = "Button 'click to start' is clicked"
50.         setTimeout(() => {
51.           sendEventByKey("longClick", 11, "") // 向id为"longClick"的组件发送长按事件
52.         }, 2000)
53.       }).id('click')
55.       Button() {
56.         Text('longClick').fontSize(25).fontWeight(FontWeight.Bold)
57.       }.margin({ top: 20 }).backgroundColor('#0D9FFB')
58.       .gesture(
59.       LongPressGesture().onActionEnd(() => {
60.         console.info('long clicked')
61.         this.text = "Button 'longClick' is longclicked"
62.         setTimeout(() => {
63.           let rect = Utils.getComponentRect('onTouch') // 获取id为"onTouch"组件的矩形区域坐标
64.           let touchPoint: TouchObject = {
65.             id: 1,
66.             type: TouchType.Down,
67.             x: rect.left + (rect.right - rect.left) / 2, // 相对于组件左上角的水平方向坐标
68.             y: rect.top + (rect.bottom - rect.top) / 2, // 相对于组件左上角的垂直方向坐标
69.             screenX: rect.left + (rect.right - rect.left) / 2, // 相对于应用窗口左上角的水平方向坐标，API10已废弃，采用windowX替代
70.             screenY: rect.left + (rect.right - rect.left) / 2, // 相对于应用窗口左上角的垂直方向坐标，API10已废弃，采用windowY替代
71.             windowX: rect.left + (rect.right - rect.left) / 2, // 相对于应用窗口左上角的水平方向坐标
72.             windowY: rect.left + (rect.right - rect.left) / 2, // 相对于应用窗口左上角的垂直方向坐标
73.             displayX: rect.left + (rect.right - rect.left) / 2, // 相对于设备屏幕左上角的水平方向坐标
74.             displayY: rect.left + (rect.right - rect.left) / 2, // 相对于设备屏幕左上角的垂直方向坐标
75.           }
76.           sendTouchEvent(touchPoint) // 发送触摸事件
77.           touchPoint.type = TouchType.Up
78.           sendTouchEvent(touchPoint) // 发送触摸事件
79.         }, 2000)
80.       })).id('longClick')
82.       Button() {
83.         Text('onTouch').fontSize(25).fontWeight(FontWeight.Bold)
84.       }.type(ButtonType.Capsule).margin({ top: 20 })
85.       .onClick(() => {
86.         console.info('onTouch is clicked')
87.         this.text = "Button 'onTouch' is clicked"
88.         setTimeout(() => {
89.           let rect = Utils.getComponentRect('onMouse') // 获取id为"onMouse"组件的矩形区域坐标
90.           let mouseEvent: MouseEvent = {
91.             button: MouseButton.Left,
92.             action: MouseAction.Press,
93.             x: rect.left + (rect.right - rect.left) / 2, // 相对于组件左上角的水平方向坐标
94.             y: rect.top + (rect.bottom - rect.top) / 2, // 相对于组件左上角的垂直方向坐标
95.             screenX: rect.left + (rect.right - rect.left) / 2, // 相对于应用窗口左上角的水平方向坐标，API10已废弃，采用windowX替代
96.             screenY: rect.left + (rect.right - rect.left) / 2, // 相对于应用窗口左上角的垂直方向坐标，API10已废弃，采用windowY替代
97.             windowX: rect.left + (rect.right - rect.left) / 2, // 相对于应用窗口左上角的水平方向坐标
98.             windowY: rect.left + (rect.right - rect.left) / 2, // 相对于应用窗口左上角的垂直方向坐标
99.             displayX: rect.left + (rect.right - rect.left) / 2, // 相对于设备屏幕左上角的水平方向坐标
100.             displayY: rect.left + (rect.right - rect.left) / 2, // 相对于设备屏幕左上角的垂直方向坐标
101.             stopPropagation: () => {
102.             },
103.             timestamp: 1,
104.             target: {
105.               area: {
106.                 width: 1,
107.                 height: 1,
108.                 position: {
109.                   x: 1,
110.                   y: 1
111.                 },
112.                 globalPosition: {
113.                   x: 1,
114.                   y: 1
115.                 }
116.               }
117.             },
118.             source: SourceType.Mouse,
119.             pressure: 1,
120.             tiltX: 1,
121.             tiltY: 1,
122.             sourceTool: SourceTool.Unknown
123.           }
124.           sendMouseEvent(mouseEvent) // 发送鼠标事件
125.         }, 2000)
126.       }).id('onTouch')
128.       Button() {
129.         Text('onMouse').fontSize(25).fontWeight(FontWeight.Bold)
130.       }.margin({ top: 20 }).backgroundColor('#0D9FFB')
131.       .onMouse(() => {
132.         console.info('onMouse')
133.         this.text = "Button 'onMouse' in onMouse"
134.         setTimeout(() => {
135.           let keyEvent: KeyEvent = {
136.             type: KeyType.Down,
137.             keyCode: 2049,
138.             keyText: 'tab',
139.             keySource: 4,
140.             deviceId: 0,
141.             metaKey: 0,
142.             timestamp: 0,
143.             stopPropagation: () => {
144.             },
145.             intentionCode: IntentionCode.INTENTION_DOWN
146.           }
147.           sendKeyEvent(keyEvent) // 发送按键事件
148.         }, 2000)
149.       }).id('onMouse')
151.       Text(this.text).fontSize(25).padding(15)
152.     }
153.     .width('100%').height('100%')
154.   }
155. }

复制代码

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。