feat(renderer): 悦码渲染器增加 sentry 做异常监听
This commit is contained in:
125
apps/docs/src/guide/integration/index.md
Normal file
125
apps/docs/src/guide/integration/index.md
Normal file
@@ -0,0 +1,125 @@
|
||||
# 低代码渲染器接入指南
|
||||
|
||||
## 1. 概述
|
||||
|
||||
- 1.1 什么是低代码渲染器
|
||||
- 1.2 核心功能和优势
|
||||
- 1.3 适用项目
|
||||
- vue2
|
||||
- vue3
|
||||
- react
|
||||
- 其他框架请联系伊利(sy)或王雪峰(sy3570)添加适配器
|
||||
|
||||
## 2. 环境要求
|
||||
|
||||
- node >= 20
|
||||
- vue2 > 2.7.0
|
||||
- vue3 > 3.5.0
|
||||
- react > 18.0.0
|
||||
|
||||
## 3. 准备工作
|
||||
|
||||
1.npmrc 配置文件增加镜像指定,sy 组件库走 shiyue 源,其他走淘宝镜像
|
||||
|
||||
```bash
|
||||
registry=https://registry.npmmirror.com
|
||||
@sy:registry=http://sy-registry.shiyue.com
|
||||
```
|
||||
|
||||
2. node 至少要升级为 20 以上的版本
|
||||
|
||||
```bash
|
||||
nvm install 20
|
||||
nvm use 20
|
||||
```
|
||||
|
||||
若不可行,请查看 node 官网历代大版本的 lts 版本(长期维护),自行安装,查看是否能正常渲染,选取稳定渲染悦码的那一个 node 版本作为开发环境
|
||||
|
||||
## 5. 接入方式
|
||||
|
||||
### vue2 项目接入
|
||||
|
||||
```bash
|
||||
pnpm i @sy/wujie-vue2-renderer-adapter@latest --save
|
||||
# or 或者
|
||||
npm i @sy/wujie-vue2-renderer-adapter@latest --save
|
||||
```
|
||||
|
||||
### vue3 项目接入
|
||||
|
||||
```bash
|
||||
pnpm i @sy/wujie-vue3-renderer-adapter@latest --save
|
||||
# or 或者
|
||||
npm i @sy/wujie-vue3-renderer-adapter@latest --save
|
||||
```
|
||||
|
||||
### react 项目接入
|
||||
|
||||
```bash
|
||||
pnpm i @sy/wujie-react-renderer-adapter@latest --save
|
||||
# or 或者
|
||||
npm i @sy/wujie-react-renderer-adapter@latest --save
|
||||
```
|
||||
|
||||
## API 参考
|
||||
|
||||
- 6.1 Props 参数详解
|
||||
- 6.2 事件监听与回调
|
||||
- 6.3 实例方法
|
||||
- 6.4 拦截器使用
|
||||
|
||||
## 7. 高级用法
|
||||
|
||||
- 7.1 自定义主题
|
||||
- 7.2 数据交互与通信
|
||||
- 7.3 插件扩展
|
||||
- 7.4 微前端降级处理
|
||||
|
||||
## 8. 故障排除
|
||||
|
||||
- 8.1 常见错误及解决方案
|
||||
- 8.2 日志与调试
|
||||
- 悦码的日志输出一般在控制台中有 `console.ts 40` 的源码位置标记
|
||||
- 8.3 兼容性问题处理
|
||||
- renderer-adapter 是默认使用无界降级的 iframe 加载悦码渲染器应用的,你如果希望悦码与你的页面有更深的上下文结合和交互,你可以手动设置 `degrade` 为 `false`,这将开启高级渲染,但有一定的兼容性问题,如果需要在 C 端运行业务,我建议你采用默认的渲染模式
|
||||
|
||||
```vue
|
||||
<script setup>
|
||||
import { ref } from 'vue';
|
||||
import { WujieVue3RendererAdapter } from '@sy/wujie-vue3-renderer-adapter';
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<!-- 高级渲染模式,与原页面深度共享 document 与内存上下文 -->
|
||||
<WujieVue3RendererAdapter
|
||||
:degrade="false"
|
||||
fileId="test123"
|
||||
projectId="test123"
|
||||
/>
|
||||
<!-- 默认降级渲染模式,使用无界 iframe 加载悦码渲染器应用 -->
|
||||
<!-- 缺点在于弹窗与遮罩层会约束在 iframe 空间内,无法与原页面共享 document,但无界的 iframe 可以与原页面共享内存上下文 ,这是比传统 iframe 更优的解决方案 -->
|
||||
<WujieVue3RendererAdapter fileId="test123" projectId="test123" />
|
||||
</template>
|
||||
```
|
||||
|
||||
- 8.4 性能问题诊断
|
||||
- 悦码渲染器内部使用了 sentry 上报错误,你可以跟 徐川(sy0182) 申请对应警告邮箱的使用权,获取报错邮件
|
||||
|
||||

|
||||
|
||||
## 9. 最佳实践
|
||||
|
||||
- 9.1 推荐的项目结构
|
||||
- 9.2 安全性建议
|
||||
- 9.3 性能优化建议
|
||||
- 9.4 版本升级策略
|
||||
|
||||
## 10. 示例
|
||||
|
||||
- 10.1 基础示例
|
||||
- 10.2 完整应用示例
|
||||
- 10.3 实际案例展示
|
||||
|
||||
## 11. 常见问题 (FAQ)
|
||||
|
||||
## 12. 联系支持与反馈渠道
|
||||
Reference in New Issue
Block a user