@lytjs/platform-adapter 6.5.0 → 6.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +676 -684
- package/dist/index.cjs +1 -3
- package/dist/index.cjs.map +1 -1
- package/dist/index.mjs +1 -3
- package/dist/index.mjs.map +1 -1
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -1,684 +1,676 @@
|
|
|
1
|
-
# @lytjs/platform-adapter
|
|
2
|
-
|
|
3
|
-
> LytJS 跨平台渲染适配器,提供统一的渲染器抽象层,支持多平台扩展。
|
|
4
|
-
|
|
5
|
-
[](https://www.npmjs.com/package/@lytjs/platform-adapter)
|
|
6
|
-
[](https://gitee.com/lytjs/lytjs/blob/main/LICENSE)
|
|
7
|
-
|
|
8
|
-
## 简介
|
|
9
|
-
|
|
10
|
-
`@lytjs/platform-adapter` 是 LytJS 框架的跨平台渲染适配器包,提供了一套统一的渲染器抽象接口,允许开发者为不同平台(Web、移动端、桌面端、服务端等)创建自定义渲染适配器。它实现了适配器注册表模式,支持插件扩展和运行时平台切换。
|
|
11
|
-
|
|
12
|
-
### 核心特性
|
|
13
|
-
|
|
14
|
-
- **统一抽象层**:为不同平台提供统一的渲染器接口
|
|
15
|
-
- **适配器注册表**:集中管理所有平台适配器
|
|
16
|
-
- **插件扩展系统**:支持通过插件扩展适配器功能
|
|
17
|
-
- **运行时切换**:支持在运行时动态切换平台
|
|
18
|
-
- **类型安全**:完整的 TypeScript 类型推导
|
|
19
|
-
- **零外部依赖**:完全基于原生 API 实现
|
|
20
|
-
- **可扩展架构**:易于添加新的平台支持
|
|
21
|
-
|
|
22
|
-
## 安装
|
|
23
|
-
|
|
24
|
-
```bash
|
|
25
|
-
npm install @lytjs/platform-adapter
|
|
26
|
-
```
|
|
27
|
-
|
|
28
|
-
或使用 pnpm:
|
|
29
|
-
|
|
30
|
-
```bash
|
|
31
|
-
pnpm add @lytjs/platform-adapter
|
|
32
|
-
```
|
|
33
|
-
|
|
34
|
-
## 依赖关系
|
|
35
|
-
|
|
36
|
-
`@lytjs/platform-adapter` 依赖以下 LytJS 核心包:
|
|
37
|
-
|
|
38
|
-
- `@lytjs/vdom` - 虚拟 DOM
|
|
39
|
-
- `@lytjs/common-vnode` - VNode 类型定义
|
|
40
|
-
- `@lytjs/common-is` - 工具函数
|
|
41
|
-
- `@lytjs/common-constants` - 常量定义
|
|
42
|
-
|
|
43
|
-
## 快速开始
|
|
44
|
-
|
|
45
|
-
### 创建渲染器
|
|
46
|
-
|
|
47
|
-
```typescript
|
|
48
|
-
import { createPlatformRenderer } from '@lytjs/platform-adapter';
|
|
49
|
-
|
|
50
|
-
const renderer = createPlatformRenderer({
|
|
51
|
-
name: 'web',
|
|
52
|
-
platform: 'web',
|
|
53
|
-
createElement(type) {
|
|
54
|
-
return document.createElement(type);
|
|
55
|
-
},
|
|
56
|
-
insert(child, parent, anchor) {
|
|
57
|
-
parent.insertBefore(child, anchor);
|
|
58
|
-
},
|
|
59
|
-
remove(child, parent) {
|
|
60
|
-
parent.removeChild(child);
|
|
61
|
-
},
|
|
62
|
-
setElementText(el, text) {
|
|
63
|
-
el.textContent = text;
|
|
64
|
-
},
|
|
65
|
-
setElementAttribute(el, key, value) {
|
|
66
|
-
el.setAttribute(key, value);
|
|
67
|
-
},
|
|
68
|
-
createTextNode(text) {
|
|
69
|
-
return document.createTextNode(text);
|
|
70
|
-
}
|
|
71
|
-
});
|
|
72
|
-
```
|
|
73
|
-
|
|
74
|
-
### 注册适配器
|
|
75
|
-
|
|
76
|
-
```typescript
|
|
77
|
-
import { adapterRegistry } from '@lytjs/platform-adapter';
|
|
78
|
-
|
|
79
|
-
adapterRegistry.register('web', webRenderer);
|
|
80
|
-
adapterRegistry.register('ssr', ssrRenderer);
|
|
81
|
-
adapterRegistry.register('wechat', wechatRenderer);
|
|
82
|
-
```
|
|
83
|
-
|
|
84
|
-
### 使用适配器
|
|
85
|
-
|
|
86
|
-
```typescript
|
|
87
|
-
import { adapterRegistry } from '@lytjs/platform-adapter';
|
|
88
|
-
|
|
89
|
-
const renderer = adapterRegistry.get('web');
|
|
90
|
-
if (renderer) {
|
|
91
|
-
renderer.render(vnode, container);
|
|
92
|
-
}
|
|
93
|
-
```
|
|
94
|
-
|
|
95
|
-
## 主要 API
|
|
96
|
-
|
|
97
|
-
### `createPlatformRenderer(config)`
|
|
98
|
-
|
|
99
|
-
创建平台渲染器。
|
|
100
|
-
|
|
101
|
-
```typescript
|
|
102
|
-
import { createPlatformRenderer } from '@lytjs/platform-adapter';
|
|
103
|
-
|
|
104
|
-
const renderer = createPlatformRenderer({
|
|
105
|
-
name: 'my-platform',
|
|
106
|
-
platform: 'custom',
|
|
107
|
-
features: {
|
|
108
|
-
portals: true,
|
|
109
|
-
suspense: true,
|
|
110
|
-
errorBoundary: true
|
|
111
|
-
},
|
|
112
|
-
render(vnode, container) {
|
|
113
|
-
// 渲染逻辑
|
|
114
|
-
},
|
|
115
|
-
hydrate(vnode, container) {
|
|
116
|
-
// 水合逻辑
|
|
117
|
-
}
|
|
118
|
-
});
|
|
119
|
-
```
|
|
120
|
-
|
|
121
|
-
### `adapterRegistry`
|
|
122
|
-
|
|
123
|
-
适配器注册表,提供适配器的注册、获取和枚举功能。
|
|
124
|
-
|
|
125
|
-
#### `register(platform, adapter)`
|
|
126
|
-
|
|
127
|
-
注册平台适配器。
|
|
128
|
-
|
|
129
|
-
```typescript
|
|
130
|
-
import { adapterRegistry } from '@lytjs/platform-adapter';
|
|
131
|
-
|
|
132
|
-
adapterRegistry.register('web', webRenderer);
|
|
133
|
-
adapterRegistry.register('miniapp', miniappRenderer);
|
|
134
|
-
```
|
|
135
|
-
|
|
136
|
-
#### `get(platform)`
|
|
137
|
-
|
|
138
|
-
获取指定平台的适配器。
|
|
139
|
-
|
|
140
|
-
```typescript
|
|
141
|
-
import { adapterRegistry } from '@lytjs/platform-adapter';
|
|
142
|
-
|
|
143
|
-
const renderer = adapterRegistry.get('web');
|
|
144
|
-
if (renderer) {
|
|
145
|
-
renderer.render(vnode, container);
|
|
146
|
-
}
|
|
147
|
-
```
|
|
148
|
-
|
|
149
|
-
#### `has(platform)`
|
|
150
|
-
|
|
151
|
-
检查平台是否已注册。
|
|
152
|
-
|
|
153
|
-
```typescript
|
|
154
|
-
import { adapterRegistry } from '@lytjs/platform-adapter';
|
|
155
|
-
|
|
156
|
-
if (adapterRegistry.has('web')) {
|
|
157
|
-
console.log('Web 平台已注册');
|
|
158
|
-
}
|
|
159
|
-
```
|
|
160
|
-
|
|
161
|
-
#### `unregister(platform)`
|
|
162
|
-
|
|
163
|
-
注销平台适配器。
|
|
164
|
-
|
|
165
|
-
```typescript
|
|
166
|
-
import { adapterRegistry } from '@lytjs/platform-adapter';
|
|
167
|
-
|
|
168
|
-
adapterRegistry.unregister('web');
|
|
169
|
-
```
|
|
170
|
-
|
|
171
|
-
#### `list()`
|
|
172
|
-
|
|
173
|
-
列出所有已注册的适配器。
|
|
174
|
-
|
|
175
|
-
```typescript
|
|
176
|
-
import { adapterRegistry } from '@lytjs/platform-adapter';
|
|
177
|
-
|
|
178
|
-
const platforms = adapterRegistry.list();
|
|
179
|
-
console.log('已注册的适配器:', platforms);
|
|
180
|
-
```
|
|
181
|
-
|
|
182
|
-
#### `getDefault()`
|
|
183
|
-
|
|
184
|
-
获取默认平台适配器。
|
|
185
|
-
|
|
186
|
-
```typescript
|
|
187
|
-
import { adapterRegistry } from '@lytjs/platform-adapter';
|
|
188
|
-
|
|
189
|
-
const defaultRenderer = adapterRegistry.getDefault();
|
|
190
|
-
```
|
|
191
|
-
|
|
192
|
-
#### `setDefault(platform)`
|
|
193
|
-
|
|
194
|
-
设置默认平台适配器。
|
|
195
|
-
|
|
196
|
-
```typescript
|
|
197
|
-
import { adapterRegistry } from '@lytjs/platform-adapter';
|
|
198
|
-
|
|
199
|
-
adapterRegistry.setDefault('web');
|
|
200
|
-
```
|
|
201
|
-
|
|
202
|
-
#### `clear()`
|
|
203
|
-
|
|
204
|
-
清除所有注册的适配器。
|
|
205
|
-
|
|
206
|
-
```typescript
|
|
207
|
-
import { adapterRegistry } from '@lytjs/platform-adapter';
|
|
208
|
-
|
|
209
|
-
adapterRegistry.clear();
|
|
210
|
-
```
|
|
211
|
-
|
|
212
|
-
## 类型定义
|
|
213
|
-
|
|
214
|
-
### PlatformAdapter
|
|
215
|
-
|
|
216
|
-
平台适配器接口。
|
|
217
|
-
|
|
218
|
-
```typescript
|
|
219
|
-
interface PlatformAdapter {
|
|
220
|
-
name: string;
|
|
221
|
-
platform: string;
|
|
222
|
-
features?: PlatformFeatures;
|
|
223
|
-
createElement(type: string, props?: VNodeProps): VNode;
|
|
224
|
-
insert(child: VNode, parent: VNode, anchor?: VNode): void;
|
|
225
|
-
remove(child: VNode, parent: VNode): void;
|
|
226
|
-
setElementText(el: VNode, text: string): void;
|
|
227
|
-
setElementAttribute(el: VNode, key: string, value: any): void;
|
|
228
|
-
removeElementAttribute(el: VNode, key: string): void;
|
|
229
|
-
createTextNode(text: string): VNode;
|
|
230
|
-
render(vnode: VNode, container: VNode): void;
|
|
231
|
-
hydrate?(vnode: VNode, container: VNode): void;
|
|
232
|
-
unmount?(vnode: VNode): void;
|
|
233
|
-
createPortal?(vnode: VNode, container: VNode): void;
|
|
234
|
-
}
|
|
235
|
-
```
|
|
236
|
-
|
|
237
|
-
### PlatformConfig
|
|
238
|
-
|
|
239
|
-
平台配置选项。
|
|
240
|
-
|
|
241
|
-
```typescript
|
|
242
|
-
interface PlatformConfig {
|
|
243
|
-
name: string;
|
|
244
|
-
platform: string;
|
|
245
|
-
features?: PlatformFeatures;
|
|
246
|
-
render: (vnode: VNode, container: VNode) => void;
|
|
247
|
-
hydrate?: (vnode: VNode, container: VNode) => void;
|
|
248
|
-
unmount?: (vnode: VNode) => void;
|
|
249
|
-
}
|
|
250
|
-
```
|
|
251
|
-
|
|
252
|
-
### PlatformPlugin
|
|
253
|
-
|
|
254
|
-
平台插件接口。
|
|
255
|
-
|
|
256
|
-
```typescript
|
|
257
|
-
interface PlatformPlugin {
|
|
258
|
-
name: string;
|
|
259
|
-
version: string;
|
|
260
|
-
install(platform: PlatformAdapter, options?: any): void;
|
|
261
|
-
uninstall?(platform: PlatformAdapter): void;
|
|
262
|
-
}
|
|
263
|
-
```
|
|
264
|
-
|
|
265
|
-
### PlatformFeatures
|
|
266
|
-
|
|
267
|
-
平台特性支持。
|
|
268
|
-
|
|
269
|
-
```typescript
|
|
270
|
-
interface PlatformFeatures {
|
|
271
|
-
portals?: boolean;
|
|
272
|
-
suspense?: boolean;
|
|
273
|
-
errorBoundary?: boolean;
|
|
274
|
-
transition?: boolean;
|
|
275
|
-
teleport?: boolean;
|
|
276
|
-
}
|
|
277
|
-
```
|
|
278
|
-
|
|
279
|
-
## 使用示例
|
|
280
|
-
|
|
281
|
-
### Web 平台适配器
|
|
282
|
-
|
|
283
|
-
```typescript
|
|
284
|
-
import { createPlatformRenderer } from '@lytjs/platform-adapter';
|
|
285
|
-
|
|
286
|
-
const webRenderer = createPlatformRenderer({
|
|
287
|
-
name: 'web',
|
|
288
|
-
platform: 'web',
|
|
289
|
-
features: {
|
|
290
|
-
portals: true,
|
|
291
|
-
suspense: true,
|
|
292
|
-
errorBoundary: true,
|
|
293
|
-
transition: true,
|
|
294
|
-
teleport: true
|
|
295
|
-
},
|
|
296
|
-
|
|
297
|
-
createElement(type, props) {
|
|
298
|
-
const el = document.createElement(type);
|
|
299
|
-
if (props) {
|
|
300
|
-
Object.entries(props).forEach(([key, value]) => {
|
|
301
|
-
if (key.startsWith('on')) {
|
|
302
|
-
el.addEventListener(key.slice(2).toLowerCase(), value);
|
|
303
|
-
} else if (key === 'className') {
|
|
304
|
-
el.className = value;
|
|
305
|
-
} else {
|
|
306
|
-
el.setAttribute(key, value);
|
|
307
|
-
}
|
|
308
|
-
});
|
|
309
|
-
}
|
|
310
|
-
return el;
|
|
311
|
-
},
|
|
312
|
-
|
|
313
|
-
insert(child, parent, anchor) {
|
|
314
|
-
parent.insertBefore(child, anchor || null);
|
|
315
|
-
},
|
|
316
|
-
|
|
317
|
-
remove(child, parent) {
|
|
318
|
-
parent.removeChild(child);
|
|
319
|
-
},
|
|
320
|
-
|
|
321
|
-
setElementText(el, text) {
|
|
322
|
-
el.textContent = text;
|
|
323
|
-
},
|
|
324
|
-
|
|
325
|
-
setElementAttribute(el, key, value) {
|
|
326
|
-
if (value === null || value === undefined) {
|
|
327
|
-
el.removeAttribute(key);
|
|
328
|
-
} else {
|
|
329
|
-
el.setAttribute(key, String(value));
|
|
330
|
-
}
|
|
331
|
-
},
|
|
332
|
-
|
|
333
|
-
removeElementAttribute(el, key) {
|
|
334
|
-
el.removeAttribute(key);
|
|
335
|
-
},
|
|
336
|
-
|
|
337
|
-
createTextNode(text) {
|
|
338
|
-
return document.createTextNode(text);
|
|
339
|
-
},
|
|
340
|
-
|
|
341
|
-
render(vnode, container) {
|
|
342
|
-
const el = this.createElement(vnode.type, vnode.props);
|
|
343
|
-
// 渲染逻辑
|
|
344
|
-
container.appendChild(el);
|
|
345
|
-
}
|
|
346
|
-
});
|
|
347
|
-
|
|
348
|
-
export default webRenderer;
|
|
349
|
-
```
|
|
350
|
-
|
|
351
|
-
### 服务端渲染适配器
|
|
352
|
-
|
|
353
|
-
```typescript
|
|
354
|
-
import { createPlatformRenderer } from '@lytjs/platform-adapter';
|
|
355
|
-
|
|
356
|
-
const ssrRenderer = createPlatformRenderer({
|
|
357
|
-
name: 'ssr',
|
|
358
|
-
platform: 'server',
|
|
359
|
-
features: {
|
|
360
|
-
portals: true,
|
|
361
|
-
suspense: true,
|
|
362
|
-
errorBoundary: true
|
|
363
|
-
},
|
|
364
|
-
|
|
365
|
-
createElement(type, props) {
|
|
366
|
-
return {
|
|
367
|
-
type,
|
|
368
|
-
props: props || {},
|
|
369
|
-
children: [],
|
|
370
|
-
text: ''
|
|
371
|
-
};
|
|
372
|
-
},
|
|
373
|
-
|
|
374
|
-
insert(child, parent) {
|
|
375
|
-
child.parent = parent;
|
|
376
|
-
parent.children = parent.children || [];
|
|
377
|
-
parent.children.push(child);
|
|
378
|
-
},
|
|
379
|
-
|
|
380
|
-
setElementText(el, text) {
|
|
381
|
-
el.text = text;
|
|
382
|
-
},
|
|
383
|
-
|
|
384
|
-
render(vnode, container) {
|
|
385
|
-
const html = this.stringify(vnode);
|
|
386
|
-
return html;
|
|
387
|
-
},
|
|
388
|
-
|
|
389
|
-
stringify(node) {
|
|
390
|
-
if (node.text) {
|
|
391
|
-
return node.text;
|
|
392
|
-
}
|
|
393
|
-
const children = (node.children || [])
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
```
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
const
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
};
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
}
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
this
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
}
|
|
557
|
-
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
|
|
569
|
-
|
|
570
|
-
|
|
571
|
-
|
|
572
|
-
|
|
573
|
-
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
}
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
|
|
587
|
-
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
|
|
606
|
-
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
|
|
625
|
-
|
|
626
|
-
|
|
627
|
-
|
|
628
|
-
|
|
629
|
-
|
|
630
|
-
|
|
631
|
-
|
|
632
|
-
|
|
633
|
-
|
|
634
|
-
|
|
635
|
-
|
|
636
|
-
|
|
637
|
-
|
|
638
|
-
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
|
|
642
|
-
|
|
643
|
-
|
|
644
|
-
|
|
645
|
-
|
|
646
|
-
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
|
|
651
|
-
|
|
652
|
-
|
|
653
|
-
|
|
654
|
-
|
|
655
|
-
|
|
656
|
-
|
|
657
|
-
|
|
658
|
-
|
|
659
|
-
|
|
660
|
-
|
|
661
|
-
|
|
662
|
-
|
|
663
|
-
|
|
664
|
-
|
|
665
|
-
|
|
666
|
-
|
|
667
|
-
|
|
668
|
-
|
|
669
|
-
|
|
670
|
-
|
|
671
|
-
##
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
MIT License - [查看许可证](https://gitee.com/lytjs/lytjs/blob/main/LICENSE)
|
|
678
|
-
|
|
679
|
-
## 贡献指南
|
|
680
|
-
|
|
681
|
-
欢迎提交 Issue 和 Pull Request!
|
|
682
|
-
|
|
683
|
-
- [Gitee 仓库](https://gitee.com/lytjs/lytjs)
|
|
684
|
-
- [问题反馈](https://gitee.com/lytjs/lytjs/issues)
|
|
1
|
+
# @lytjs/platform-adapter
|
|
2
|
+
|
|
3
|
+
> LytJS 跨平台渲染适配器,提供统一的渲染器抽象层,支持多平台扩展。
|
|
4
|
+
|
|
5
|
+
[](https://www.npmjs.com/package/@lytjs/platform-adapter)
|
|
6
|
+
[](https://gitee.com/lytjs/lytjs/blob/main/LICENSE)
|
|
7
|
+
|
|
8
|
+
## 简介
|
|
9
|
+
|
|
10
|
+
`@lytjs/platform-adapter` 是 LytJS 框架的跨平台渲染适配器包,提供了一套统一的渲染器抽象接口,允许开发者为不同平台(Web、移动端、桌面端、服务端等)创建自定义渲染适配器。它实现了适配器注册表模式,支持插件扩展和运行时平台切换。
|
|
11
|
+
|
|
12
|
+
### 核心特性
|
|
13
|
+
|
|
14
|
+
- **统一抽象层**:为不同平台提供统一的渲染器接口
|
|
15
|
+
- **适配器注册表**:集中管理所有平台适配器
|
|
16
|
+
- **插件扩展系统**:支持通过插件扩展适配器功能
|
|
17
|
+
- **运行时切换**:支持在运行时动态切换平台
|
|
18
|
+
- **类型安全**:完整的 TypeScript 类型推导
|
|
19
|
+
- **零外部依赖**:完全基于原生 API 实现
|
|
20
|
+
- **可扩展架构**:易于添加新的平台支持
|
|
21
|
+
|
|
22
|
+
## 安装
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
npm install @lytjs/platform-adapter
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
或使用 pnpm:
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
pnpm add @lytjs/platform-adapter
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
## 依赖关系
|
|
35
|
+
|
|
36
|
+
`@lytjs/platform-adapter` 依赖以下 LytJS 核心包:
|
|
37
|
+
|
|
38
|
+
- `@lytjs/vdom` - 虚拟 DOM
|
|
39
|
+
- `@lytjs/common-vnode` - VNode 类型定义
|
|
40
|
+
- `@lytjs/common-is` - 工具函数
|
|
41
|
+
- `@lytjs/common-constants` - 常量定义
|
|
42
|
+
|
|
43
|
+
## 快速开始
|
|
44
|
+
|
|
45
|
+
### 创建渲染器
|
|
46
|
+
|
|
47
|
+
```typescript
|
|
48
|
+
import { createPlatformRenderer } from '@lytjs/platform-adapter';
|
|
49
|
+
|
|
50
|
+
const renderer = createPlatformRenderer({
|
|
51
|
+
name: 'web',
|
|
52
|
+
platform: 'web',
|
|
53
|
+
createElement(type) {
|
|
54
|
+
return document.createElement(type);
|
|
55
|
+
},
|
|
56
|
+
insert(child, parent, anchor) {
|
|
57
|
+
parent.insertBefore(child, anchor);
|
|
58
|
+
},
|
|
59
|
+
remove(child, parent) {
|
|
60
|
+
parent.removeChild(child);
|
|
61
|
+
},
|
|
62
|
+
setElementText(el, text) {
|
|
63
|
+
el.textContent = text;
|
|
64
|
+
},
|
|
65
|
+
setElementAttribute(el, key, value) {
|
|
66
|
+
el.setAttribute(key, value);
|
|
67
|
+
},
|
|
68
|
+
createTextNode(text) {
|
|
69
|
+
return document.createTextNode(text);
|
|
70
|
+
},
|
|
71
|
+
});
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
### 注册适配器
|
|
75
|
+
|
|
76
|
+
```typescript
|
|
77
|
+
import { adapterRegistry } from '@lytjs/platform-adapter';
|
|
78
|
+
|
|
79
|
+
adapterRegistry.register('web', webRenderer);
|
|
80
|
+
adapterRegistry.register('ssr', ssrRenderer);
|
|
81
|
+
adapterRegistry.register('wechat', wechatRenderer);
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
### 使用适配器
|
|
85
|
+
|
|
86
|
+
```typescript
|
|
87
|
+
import { adapterRegistry } from '@lytjs/platform-adapter';
|
|
88
|
+
|
|
89
|
+
const renderer = adapterRegistry.get('web');
|
|
90
|
+
if (renderer) {
|
|
91
|
+
renderer.render(vnode, container);
|
|
92
|
+
}
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
## 主要 API
|
|
96
|
+
|
|
97
|
+
### `createPlatformRenderer(config)`
|
|
98
|
+
|
|
99
|
+
创建平台渲染器。
|
|
100
|
+
|
|
101
|
+
```typescript
|
|
102
|
+
import { createPlatformRenderer } from '@lytjs/platform-adapter';
|
|
103
|
+
|
|
104
|
+
const renderer = createPlatformRenderer({
|
|
105
|
+
name: 'my-platform',
|
|
106
|
+
platform: 'custom',
|
|
107
|
+
features: {
|
|
108
|
+
portals: true,
|
|
109
|
+
suspense: true,
|
|
110
|
+
errorBoundary: true,
|
|
111
|
+
},
|
|
112
|
+
render(vnode, container) {
|
|
113
|
+
// 渲染逻辑
|
|
114
|
+
},
|
|
115
|
+
hydrate(vnode, container) {
|
|
116
|
+
// 水合逻辑
|
|
117
|
+
},
|
|
118
|
+
});
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
### `adapterRegistry`
|
|
122
|
+
|
|
123
|
+
适配器注册表,提供适配器的注册、获取和枚举功能。
|
|
124
|
+
|
|
125
|
+
#### `register(platform, adapter)`
|
|
126
|
+
|
|
127
|
+
注册平台适配器。
|
|
128
|
+
|
|
129
|
+
```typescript
|
|
130
|
+
import { adapterRegistry } from '@lytjs/platform-adapter';
|
|
131
|
+
|
|
132
|
+
adapterRegistry.register('web', webRenderer);
|
|
133
|
+
adapterRegistry.register('miniapp', miniappRenderer);
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
#### `get(platform)`
|
|
137
|
+
|
|
138
|
+
获取指定平台的适配器。
|
|
139
|
+
|
|
140
|
+
```typescript
|
|
141
|
+
import { adapterRegistry } from '@lytjs/platform-adapter';
|
|
142
|
+
|
|
143
|
+
const renderer = adapterRegistry.get('web');
|
|
144
|
+
if (renderer) {
|
|
145
|
+
renderer.render(vnode, container);
|
|
146
|
+
}
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
#### `has(platform)`
|
|
150
|
+
|
|
151
|
+
检查平台是否已注册。
|
|
152
|
+
|
|
153
|
+
```typescript
|
|
154
|
+
import { adapterRegistry } from '@lytjs/platform-adapter';
|
|
155
|
+
|
|
156
|
+
if (adapterRegistry.has('web')) {
|
|
157
|
+
console.log('Web 平台已注册');
|
|
158
|
+
}
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
#### `unregister(platform)`
|
|
162
|
+
|
|
163
|
+
注销平台适配器。
|
|
164
|
+
|
|
165
|
+
```typescript
|
|
166
|
+
import { adapterRegistry } from '@lytjs/platform-adapter';
|
|
167
|
+
|
|
168
|
+
adapterRegistry.unregister('web');
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
#### `list()`
|
|
172
|
+
|
|
173
|
+
列出所有已注册的适配器。
|
|
174
|
+
|
|
175
|
+
```typescript
|
|
176
|
+
import { adapterRegistry } from '@lytjs/platform-adapter';
|
|
177
|
+
|
|
178
|
+
const platforms = adapterRegistry.list();
|
|
179
|
+
console.log('已注册的适配器:', platforms);
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
#### `getDefault()`
|
|
183
|
+
|
|
184
|
+
获取默认平台适配器。
|
|
185
|
+
|
|
186
|
+
```typescript
|
|
187
|
+
import { adapterRegistry } from '@lytjs/platform-adapter';
|
|
188
|
+
|
|
189
|
+
const defaultRenderer = adapterRegistry.getDefault();
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
#### `setDefault(platform)`
|
|
193
|
+
|
|
194
|
+
设置默认平台适配器。
|
|
195
|
+
|
|
196
|
+
```typescript
|
|
197
|
+
import { adapterRegistry } from '@lytjs/platform-adapter';
|
|
198
|
+
|
|
199
|
+
adapterRegistry.setDefault('web');
|
|
200
|
+
```
|
|
201
|
+
|
|
202
|
+
#### `clear()`
|
|
203
|
+
|
|
204
|
+
清除所有注册的适配器。
|
|
205
|
+
|
|
206
|
+
```typescript
|
|
207
|
+
import { adapterRegistry } from '@lytjs/platform-adapter';
|
|
208
|
+
|
|
209
|
+
adapterRegistry.clear();
|
|
210
|
+
```
|
|
211
|
+
|
|
212
|
+
## 类型定义
|
|
213
|
+
|
|
214
|
+
### PlatformAdapter
|
|
215
|
+
|
|
216
|
+
平台适配器接口。
|
|
217
|
+
|
|
218
|
+
```typescript
|
|
219
|
+
interface PlatformAdapter {
|
|
220
|
+
name: string;
|
|
221
|
+
platform: string;
|
|
222
|
+
features?: PlatformFeatures;
|
|
223
|
+
createElement(type: string, props?: VNodeProps): VNode;
|
|
224
|
+
insert(child: VNode, parent: VNode, anchor?: VNode): void;
|
|
225
|
+
remove(child: VNode, parent: VNode): void;
|
|
226
|
+
setElementText(el: VNode, text: string): void;
|
|
227
|
+
setElementAttribute(el: VNode, key: string, value: any): void;
|
|
228
|
+
removeElementAttribute(el: VNode, key: string): void;
|
|
229
|
+
createTextNode(text: string): VNode;
|
|
230
|
+
render(vnode: VNode, container: VNode): void;
|
|
231
|
+
hydrate?(vnode: VNode, container: VNode): void;
|
|
232
|
+
unmount?(vnode: VNode): void;
|
|
233
|
+
createPortal?(vnode: VNode, container: VNode): void;
|
|
234
|
+
}
|
|
235
|
+
```
|
|
236
|
+
|
|
237
|
+
### PlatformConfig
|
|
238
|
+
|
|
239
|
+
平台配置选项。
|
|
240
|
+
|
|
241
|
+
```typescript
|
|
242
|
+
interface PlatformConfig {
|
|
243
|
+
name: string;
|
|
244
|
+
platform: string;
|
|
245
|
+
features?: PlatformFeatures;
|
|
246
|
+
render: (vnode: VNode, container: VNode) => void;
|
|
247
|
+
hydrate?: (vnode: VNode, container: VNode) => void;
|
|
248
|
+
unmount?: (vnode: VNode) => void;
|
|
249
|
+
}
|
|
250
|
+
```
|
|
251
|
+
|
|
252
|
+
### PlatformPlugin
|
|
253
|
+
|
|
254
|
+
平台插件接口。
|
|
255
|
+
|
|
256
|
+
```typescript
|
|
257
|
+
interface PlatformPlugin {
|
|
258
|
+
name: string;
|
|
259
|
+
version: string;
|
|
260
|
+
install(platform: PlatformAdapter, options?: any): void;
|
|
261
|
+
uninstall?(platform: PlatformAdapter): void;
|
|
262
|
+
}
|
|
263
|
+
```
|
|
264
|
+
|
|
265
|
+
### PlatformFeatures
|
|
266
|
+
|
|
267
|
+
平台特性支持。
|
|
268
|
+
|
|
269
|
+
```typescript
|
|
270
|
+
interface PlatformFeatures {
|
|
271
|
+
portals?: boolean;
|
|
272
|
+
suspense?: boolean;
|
|
273
|
+
errorBoundary?: boolean;
|
|
274
|
+
transition?: boolean;
|
|
275
|
+
teleport?: boolean;
|
|
276
|
+
}
|
|
277
|
+
```
|
|
278
|
+
|
|
279
|
+
## 使用示例
|
|
280
|
+
|
|
281
|
+
### Web 平台适配器
|
|
282
|
+
|
|
283
|
+
```typescript
|
|
284
|
+
import { createPlatformRenderer } from '@lytjs/platform-adapter';
|
|
285
|
+
|
|
286
|
+
const webRenderer = createPlatformRenderer({
|
|
287
|
+
name: 'web',
|
|
288
|
+
platform: 'web',
|
|
289
|
+
features: {
|
|
290
|
+
portals: true,
|
|
291
|
+
suspense: true,
|
|
292
|
+
errorBoundary: true,
|
|
293
|
+
transition: true,
|
|
294
|
+
teleport: true,
|
|
295
|
+
},
|
|
296
|
+
|
|
297
|
+
createElement(type, props) {
|
|
298
|
+
const el = document.createElement(type);
|
|
299
|
+
if (props) {
|
|
300
|
+
Object.entries(props).forEach(([key, value]) => {
|
|
301
|
+
if (key.startsWith('on')) {
|
|
302
|
+
el.addEventListener(key.slice(2).toLowerCase(), value);
|
|
303
|
+
} else if (key === 'className') {
|
|
304
|
+
el.className = value;
|
|
305
|
+
} else {
|
|
306
|
+
el.setAttribute(key, value);
|
|
307
|
+
}
|
|
308
|
+
});
|
|
309
|
+
}
|
|
310
|
+
return el;
|
|
311
|
+
},
|
|
312
|
+
|
|
313
|
+
insert(child, parent, anchor) {
|
|
314
|
+
parent.insertBefore(child, anchor || null);
|
|
315
|
+
},
|
|
316
|
+
|
|
317
|
+
remove(child, parent) {
|
|
318
|
+
parent.removeChild(child);
|
|
319
|
+
},
|
|
320
|
+
|
|
321
|
+
setElementText(el, text) {
|
|
322
|
+
el.textContent = text;
|
|
323
|
+
},
|
|
324
|
+
|
|
325
|
+
setElementAttribute(el, key, value) {
|
|
326
|
+
if (value === null || value === undefined) {
|
|
327
|
+
el.removeAttribute(key);
|
|
328
|
+
} else {
|
|
329
|
+
el.setAttribute(key, String(value));
|
|
330
|
+
}
|
|
331
|
+
},
|
|
332
|
+
|
|
333
|
+
removeElementAttribute(el, key) {
|
|
334
|
+
el.removeAttribute(key);
|
|
335
|
+
},
|
|
336
|
+
|
|
337
|
+
createTextNode(text) {
|
|
338
|
+
return document.createTextNode(text);
|
|
339
|
+
},
|
|
340
|
+
|
|
341
|
+
render(vnode, container) {
|
|
342
|
+
const el = this.createElement(vnode.type, vnode.props);
|
|
343
|
+
// 渲染逻辑
|
|
344
|
+
container.appendChild(el);
|
|
345
|
+
},
|
|
346
|
+
});
|
|
347
|
+
|
|
348
|
+
export default webRenderer;
|
|
349
|
+
```
|
|
350
|
+
|
|
351
|
+
### 服务端渲染适配器
|
|
352
|
+
|
|
353
|
+
```typescript
|
|
354
|
+
import { createPlatformRenderer } from '@lytjs/platform-adapter';
|
|
355
|
+
|
|
356
|
+
const ssrRenderer = createPlatformRenderer({
|
|
357
|
+
name: 'ssr',
|
|
358
|
+
platform: 'server',
|
|
359
|
+
features: {
|
|
360
|
+
portals: true,
|
|
361
|
+
suspense: true,
|
|
362
|
+
errorBoundary: true,
|
|
363
|
+
},
|
|
364
|
+
|
|
365
|
+
createElement(type, props) {
|
|
366
|
+
return {
|
|
367
|
+
type,
|
|
368
|
+
props: props || {},
|
|
369
|
+
children: [],
|
|
370
|
+
text: '',
|
|
371
|
+
};
|
|
372
|
+
},
|
|
373
|
+
|
|
374
|
+
insert(child, parent) {
|
|
375
|
+
child.parent = parent;
|
|
376
|
+
parent.children = parent.children || [];
|
|
377
|
+
parent.children.push(child);
|
|
378
|
+
},
|
|
379
|
+
|
|
380
|
+
setElementText(el, text) {
|
|
381
|
+
el.text = text;
|
|
382
|
+
},
|
|
383
|
+
|
|
384
|
+
render(vnode, container) {
|
|
385
|
+
const html = this.stringify(vnode);
|
|
386
|
+
return html;
|
|
387
|
+
},
|
|
388
|
+
|
|
389
|
+
stringify(node) {
|
|
390
|
+
if (node.text) {
|
|
391
|
+
return node.text;
|
|
392
|
+
}
|
|
393
|
+
const children = (node.children || []).map((child) => this.stringify(child)).join('');
|
|
394
|
+
return `<${node.type}>${children}</${node.type}>`;
|
|
395
|
+
},
|
|
396
|
+
});
|
|
397
|
+
|
|
398
|
+
export default ssrRenderer;
|
|
399
|
+
```
|
|
400
|
+
|
|
401
|
+
### 微信小程序适配器
|
|
402
|
+
|
|
403
|
+
```typescript
|
|
404
|
+
import { createPlatformRenderer } from '@lytjs/platform-adapter';
|
|
405
|
+
|
|
406
|
+
const miniappRenderer = createPlatformRenderer({
|
|
407
|
+
name: 'wechat-miniapp',
|
|
408
|
+
platform: 'miniapp',
|
|
409
|
+
features: {
|
|
410
|
+
portals: false,
|
|
411
|
+
suspense: false,
|
|
412
|
+
errorBoundary: false,
|
|
413
|
+
},
|
|
414
|
+
|
|
415
|
+
createElement(type, props) {
|
|
416
|
+
return {
|
|
417
|
+
type,
|
|
418
|
+
props: props || {},
|
|
419
|
+
children: [],
|
|
420
|
+
};
|
|
421
|
+
},
|
|
422
|
+
|
|
423
|
+
render(vnode, container) {
|
|
424
|
+
const data = this.flatten(vnode);
|
|
425
|
+
container.setData({ elements: data });
|
|
426
|
+
},
|
|
427
|
+
|
|
428
|
+
flatten(node, depth = 0) {
|
|
429
|
+
return {
|
|
430
|
+
tag: node.type,
|
|
431
|
+
attrs: node.props,
|
|
432
|
+
children: (node.children || []).map((child) => this.flatten(child, depth + 1)),
|
|
433
|
+
};
|
|
434
|
+
},
|
|
435
|
+
});
|
|
436
|
+
|
|
437
|
+
export default miniappRenderer;
|
|
438
|
+
```
|
|
439
|
+
|
|
440
|
+
### 使用插件扩展
|
|
441
|
+
|
|
442
|
+
```typescript
|
|
443
|
+
import { adapterRegistry, createPlatformRenderer } from '@lytjs/platform-adapter';
|
|
444
|
+
|
|
445
|
+
const loggerPlugin = {
|
|
446
|
+
name: 'logger-plugin',
|
|
447
|
+
version: '1.0.0',
|
|
448
|
+
install(platform) {
|
|
449
|
+
const originalRender = platform.render;
|
|
450
|
+
platform.render = (vnode, container) => {
|
|
451
|
+
console.log(`[${platform.name}] 开始渲染`);
|
|
452
|
+
const start = performance.now();
|
|
453
|
+
originalRender.call(platform, vnode, container);
|
|
454
|
+
console.log(`[${platform.name}] 渲染完成,耗时: ${performance.now() - start}ms`);
|
|
455
|
+
};
|
|
456
|
+
},
|
|
457
|
+
};
|
|
458
|
+
|
|
459
|
+
const webRenderer = createPlatformRenderer({
|
|
460
|
+
/* ... */
|
|
461
|
+
});
|
|
462
|
+
webRenderer.use?.(loggerPlugin);
|
|
463
|
+
|
|
464
|
+
adapterRegistry.register('web', webRenderer);
|
|
465
|
+
```
|
|
466
|
+
|
|
467
|
+
### 运行时平台切换
|
|
468
|
+
|
|
469
|
+
```typescript
|
|
470
|
+
import { adapterRegistry } from '@lytjs/platform-adapter';
|
|
471
|
+
|
|
472
|
+
function renderApp(vnode) {
|
|
473
|
+
const platform = getPlatformFromUA();
|
|
474
|
+
const renderer = adapterRegistry.get(platform);
|
|
475
|
+
|
|
476
|
+
if (!renderer) {
|
|
477
|
+
console.warn(`平台 ${platform} 未注册,使用默认渲染器`);
|
|
478
|
+
return adapterRegistry.getDefault()?.render(vnode, container);
|
|
479
|
+
}
|
|
480
|
+
|
|
481
|
+
return renderer.render(vnode, container);
|
|
482
|
+
}
|
|
483
|
+
|
|
484
|
+
function getPlatformFromUA() {
|
|
485
|
+
const ua = navigator.userAgent;
|
|
486
|
+
if (ua.includes('MiniProgram')) return 'wechat';
|
|
487
|
+
return 'web';
|
|
488
|
+
}
|
|
489
|
+
```
|
|
490
|
+
|
|
491
|
+
### 动态加载适配器
|
|
492
|
+
|
|
493
|
+
```typescript
|
|
494
|
+
import { adapterRegistry } from '@lytjs/platform-adapter';
|
|
495
|
+
|
|
496
|
+
async function loadPlatformAdapter(platform) {
|
|
497
|
+
const modules = {
|
|
498
|
+
web: () => import('./adapters/web'),
|
|
499
|
+
ssr: () => import('./adapters/ssr'),
|
|
500
|
+
miniapp: () => import('./adapters/miniapp'),
|
|
501
|
+
};
|
|
502
|
+
|
|
503
|
+
if (modules[platform]) {
|
|
504
|
+
const { default: adapter } = await modules[platform]();
|
|
505
|
+
adapterRegistry.register(platform, adapter);
|
|
506
|
+
return adapter;
|
|
507
|
+
}
|
|
508
|
+
|
|
509
|
+
throw new Error(`未知的平台: ${platform}`);
|
|
510
|
+
}
|
|
511
|
+
|
|
512
|
+
await loadPlatformAdapter('web');
|
|
513
|
+
```
|
|
514
|
+
|
|
515
|
+
## 高级用法
|
|
516
|
+
|
|
517
|
+
### 自定义渲染流水线
|
|
518
|
+
|
|
519
|
+
```typescript
|
|
520
|
+
import { createPlatformRenderer } from '@lytjs/platform-adapter';
|
|
521
|
+
|
|
522
|
+
const pipelineRenderer = createPlatformRenderer({
|
|
523
|
+
name: 'pipeline',
|
|
524
|
+
platform: 'custom',
|
|
525
|
+
features: {
|
|
526
|
+
portals: true,
|
|
527
|
+
suspense: true,
|
|
528
|
+
errorBoundary: true,
|
|
529
|
+
},
|
|
530
|
+
|
|
531
|
+
render(vnode, container) {
|
|
532
|
+
const pipeline = [this.optimize, this.transform, this.render];
|
|
533
|
+
|
|
534
|
+
let current = vnode;
|
|
535
|
+
for (const step of pipeline) {
|
|
536
|
+
current = step.call(this, current);
|
|
537
|
+
}
|
|
538
|
+
return current;
|
|
539
|
+
},
|
|
540
|
+
|
|
541
|
+
optimize(vnode) {
|
|
542
|
+
// 优化阶段
|
|
543
|
+
return vnode;
|
|
544
|
+
},
|
|
545
|
+
|
|
546
|
+
transform(vnode) {
|
|
547
|
+
// 转换阶段
|
|
548
|
+
return vnode;
|
|
549
|
+
},
|
|
550
|
+
});
|
|
551
|
+
```
|
|
552
|
+
|
|
553
|
+
### 性能监控适配器
|
|
554
|
+
|
|
555
|
+
```typescript
|
|
556
|
+
import { createPlatformRenderer } from '@lytjs/platform-adapter';
|
|
557
|
+
|
|
558
|
+
function createMonitoredRenderer(config) {
|
|
559
|
+
const renderer = createPlatformRenderer(config);
|
|
560
|
+
|
|
561
|
+
const metrics = {
|
|
562
|
+
renderCount: 0,
|
|
563
|
+
totalTime: 0,
|
|
564
|
+
};
|
|
565
|
+
|
|
566
|
+
const originalRender = renderer.render;
|
|
567
|
+
renderer.render = function (vnode, container) {
|
|
568
|
+
const start = performance.now();
|
|
569
|
+
originalRender.call(this, vnode, container);
|
|
570
|
+
metrics.renderCount++;
|
|
571
|
+
metrics.totalTime += performance.now() - start;
|
|
572
|
+
};
|
|
573
|
+
|
|
574
|
+
renderer.getMetrics = () => ({ ...metrics });
|
|
575
|
+
|
|
576
|
+
return renderer;
|
|
577
|
+
}
|
|
578
|
+
```
|
|
579
|
+
|
|
580
|
+
### 调试适配器
|
|
581
|
+
|
|
582
|
+
```typescript
|
|
583
|
+
import { createPlatformRenderer } from '@lytjs/platform-adapter';
|
|
584
|
+
|
|
585
|
+
const debugRenderer = createPlatformRenderer({
|
|
586
|
+
name: 'debug',
|
|
587
|
+
platform: 'web',
|
|
588
|
+
// ... 基础配置
|
|
589
|
+
});
|
|
590
|
+
|
|
591
|
+
debugRenderer.debug = {
|
|
592
|
+
logVNode(vnode) {
|
|
593
|
+
console.log('VNode:', JSON.stringify(vnode, null, 2));
|
|
594
|
+
},
|
|
595
|
+
logTree(vnode, depth = 0) {
|
|
596
|
+
const indent = ' '.repeat(depth);
|
|
597
|
+
console.log(`${indent}${vnode.type}`);
|
|
598
|
+
(vnode.children || []).forEach((child) => this.logTree(child, depth + 1));
|
|
599
|
+
},
|
|
600
|
+
logOperations(operations) {
|
|
601
|
+
console.table(operations);
|
|
602
|
+
},
|
|
603
|
+
};
|
|
604
|
+
```
|
|
605
|
+
|
|
606
|
+
## 最佳实践
|
|
607
|
+
|
|
608
|
+
### 适配器命名规范
|
|
609
|
+
|
|
610
|
+
```typescript
|
|
611
|
+
// ✅ 推荐:使用平台标识符
|
|
612
|
+
adapterRegistry.register('web', webRenderer);
|
|
613
|
+
adapterRegistry.register('ssr', ssrRenderer);
|
|
614
|
+
adapterRegistry.register('wechat-miniapp', wechatRenderer);
|
|
615
|
+
adapterRegistry.register('alipay-miniapp', alipayRenderer);
|
|
616
|
+
|
|
617
|
+
// ❌ 避免:使用模糊名称
|
|
618
|
+
adapterRegistry.register('main', webRenderer);
|
|
619
|
+
adapterRegistry.register('alt', ssrRenderer);
|
|
620
|
+
```
|
|
621
|
+
|
|
622
|
+
### 特性检测
|
|
623
|
+
|
|
624
|
+
```typescript
|
|
625
|
+
import { createPlatformRenderer } from '@lytjs/platform-adapter';
|
|
626
|
+
|
|
627
|
+
const renderer = createPlatformRenderer({
|
|
628
|
+
name: 'adaptive',
|
|
629
|
+
platform: 'web',
|
|
630
|
+
|
|
631
|
+
features: {
|
|
632
|
+
portals: typeof document.createElement === 'function',
|
|
633
|
+
suspense: 'requestIdleCallback' in window,
|
|
634
|
+
errorBoundary: true,
|
|
635
|
+
},
|
|
636
|
+
});
|
|
637
|
+
```
|
|
638
|
+
|
|
639
|
+
### 错误处理
|
|
640
|
+
|
|
641
|
+
```typescript
|
|
642
|
+
import { createPlatformRenderer } from '@lytjs/platform-adapter';
|
|
643
|
+
|
|
644
|
+
const safeRenderer = createPlatformRenderer({
|
|
645
|
+
name: 'safe',
|
|
646
|
+
platform: 'web',
|
|
647
|
+
|
|
648
|
+
render(vnode, container) {
|
|
649
|
+
try {
|
|
650
|
+
// 渲染逻辑
|
|
651
|
+
} catch (error) {
|
|
652
|
+
console.error('渲染错误:', error);
|
|
653
|
+
this.handleError?.(error, vnode);
|
|
654
|
+
}
|
|
655
|
+
},
|
|
656
|
+
|
|
657
|
+
handleError(error, vnode) {
|
|
658
|
+
// 显示错误边界
|
|
659
|
+
},
|
|
660
|
+
});
|
|
661
|
+
```
|
|
662
|
+
|
|
663
|
+
## 浏览器兼容性
|
|
664
|
+
|
|
665
|
+
`@lytjs/platform-adapter` 支持所有现代浏览器。不同平台的适配器可能有特定的浏览器要求。
|
|
666
|
+
|
|
667
|
+
## 许可证
|
|
668
|
+
|
|
669
|
+
MIT License - [查看许可证](https://gitee.com/lytjs/lytjs/blob/main/LICENSE)
|
|
670
|
+
|
|
671
|
+
## 贡献指南
|
|
672
|
+
|
|
673
|
+
欢迎提交 Issue 和 Pull Request!
|
|
674
|
+
|
|
675
|
+
- [Gitee 仓库](https://gitee.com/lytjs/lytjs)
|
|
676
|
+
- [问题反馈](https://gitee.com/lytjs/lytjs/issues)
|