UniverJS Sheets 集成问题解析与解决方案

背景介绍

UniverJS 是一款功能强大的开源电子表格解决方案，为开发者提供了丰富的 API 和组件来构建类似 Excel 的在线表格应用。近期有开发者反馈在 Laravel 应用中集成 UniverJS Sheets 时遇到了渲染问题，本文将深入分析问题原因并提供完整的解决方案。

问题现象

开发者在使用 UNPKG CDN 方式集成 UniverJS Sheets 时，遇到了以下典型问题：

1. 表格突然停止渲染
2. 浏览器控制台出现大量核心库和依赖相关的错误
3. 尝试多个版本(0.5.0-0.6.0)均无法解决问题
4. 官方示例代码也无法正常运行

根本原因分析

经过技术团队调查，发现问题主要源于以下几个方面：

1. UMD 使用方式变更：从 Univer 0.6.0 开始，UMD 的集成方式发生了较大变化，特别是对 React 19 的支持引入了一些兼容性调整。

2. React 版本适配问题：新版本需要特定的 React 版本适配代码，特别是针对 createRoot 和 JSX 运行时的处理。

3. 依赖管理复杂：UniverJS 作为一个功能丰富的电子表格解决方案，内部依赖关系较为复杂，版本间的兼容性要求严格。

完整解决方案

基础环境准备

首先需要确保正确加载 React 和相关依赖：

<script src="https://unpkg.com/react@18.3.1/umd/react.production.min.js"></script>
<script src="https://unpkg.com/react-dom@18.3.1/umd/react-dom.production.min.js"></script>
<script src="https://unpkg.com/rxjs@7.8.1/dist/bundles/rxjs.umd.min.js"></script>
<script src="https://unpkg.com/@wendellhu/redi@0.17.1/dist/redi.js"></script>
<script src="https://unpkg.com/@wendellhu/redi@0.17.1/dist/react-bindings.js"></script>

React 兼容性处理

针对 React 18 及以上版本的适配代码：

// 解决 createRoot 兼容性问题
(function (global) {
    if (!global.ReactDOM) {
        throw new Error('ReactDOM 必须在 ReactCreateRoot 之前加载');
    }
    const ReactDOM = global.ReactDOM;
    if (!ReactDOM.createRoot) {
        ReactDOM.createRoot = function (container) {
            return {
                render: (element) => {
                    ReactDOM.render(element, container);
                },
            };
        };
    }
})(this);

// 解决 JSX 运行时问题
(function (global) {
    if (!global.React) {
        throw new Error('React 必须在 ReactJSXRuntime 之前加载');
    }
    const React = global.React;
    if (!React.jsx || !React.jsxs) {
        const REACT_ELEMENT_TYPE = Symbol.for('react.element');
        const hasOwnProperty = Object.prototype.hasOwnProperty;
        const RESERVED_PROPS = {
            key: true,
            ref: true,
            __self: true,
            __source: true,
        };
        const ReactCurrentOwner = React.__SECRET_INTERNALS_DO_NOT_USE_OR_YOU_WILL_BE_FIRED.ReactCurrentOwner;
        function createReactElement(type, config, maybeKey) {
            const props = {};
            let key = null;
            let ref = null;
            if (maybeKey !== undefined) {
                key = `${maybeKey}`;
            }
            if (config.key !== undefined) {
                key = `${config.key}`;
            }
            if (config.ref !== undefined) {
                ref = config.ref;
            }
            for (var propName in config) {
                if (hasOwnProperty.call(config, propName) && !RESERVED_PROPS.hasOwnProperty(propName)) {
                    props[propName] = config[propName];
                }
            }
            if (type && type.defaultProps) {
                const defaultProps = type.defaultProps;
                for (var propName in defaultProps) {
                    if (props[propName] === undefined) {
                        props[propName] = defaultProps[propName];
                    }
                }
            }
            return {
                $$typeof: REACT_ELEMENT_TYPE,
                type,
                key,
                ref,
                props,
                _owner: ReactCurrentOwner.current,
            };
        }
        React.jsx = createReactElement;
        React.jsxs = createReactElement;
    }
})(this);

UniverJS 核心依赖加载

<script src="https://unpkg.com/@univerjs/protocol@0.1.43/lib/umd/index.js"></script>
<script src="https://unpkg.com/@univerjs/core@0.6.0/lib/umd/index.js"></script>
<script src="https://unpkg.com/@univerjs/telemetry@0.6.0/lib/umd/index.js"></script>
<script src="https://unpkg.com/@univerjs/rpc@0.6.0/lib/umd/index.js"></script>
<script src="https://unpkg.com/@univerjs/design@0.6.0/lib/umd/index.js"></script>
<script src="https://unpkg.com/@univerjs/engine-render@0.6.0/lib/umd/index.js"></script>
<script src="https://unpkg.com/@univerjs/engine-numfmt@0.6.0/lib/umd/index.js"></script>
<script src="https://unpkg.com/@univerjs/engine-formula@0.6.0/lib/umd/index.js"></script>
<script src="https://unpkg.com/@univerjs/drawing@0.6.0/lib/umd/index.js"></script>

表格相关组件加载

<script src="https://unpkg.com/@univerjs/ui@0.6.0/lib/umd/index.js"></script>
<script src="https://unpkg.com/@univerjs/docs@0.6.0/lib/umd/index.js"></script>
<script src="https://unpkg.com/@univerjs/docs-ui@0.6.0/lib/umd/index.js"></script>
<script src="https://unpkg.com/@univerjs/sheets@0.6.0/lib/umd/index.js"></script>
<script src="https://unpkg.com/@univerjs/sheets-ui@0.6.0/lib/umd/index.js"></script>
<script src="https://unpkg.com/@univerjs/sheets-formula@0.6.0/lib/umd/index.js"></script>
<script src="https://unpkg.com/@univerjs/sheets-formula-ui@0.6.0/lib/umd/index.js"></script>
<script src="https://unpkg.com/@univerjs/sheets-numfmt@0.6.0/lib/umd/index.js"></script>
<script src="https://unpkg.com/@univerjs/sheets-numfmt-ui@0.6.0/lib/umd/index.js"></script>

最佳实践建议

1. 版本锁定：建议明确指定所有依赖的具体版本号，避免自动获取最新版本可能带来的兼容性问题。

2. 简化集成：考虑使用 UniverJS 提供的预设(presets)方式集成，这种方式封装了底层复杂性，更适合大多数场景。

3. 样式加载：确保所有必要的 CSS 文件都已正确加载，样式缺失也会导致渲染异常。

4. 错误监控：实现前端错误监控机制，及时发现和解决运行时问题。

总结

UniverJS 作为一个功能丰富的电子表格解决方案，在提供强大功能的同时也带来了集成的复杂性。通过本文提供的解决方案，开发者可以顺利解决 Sheets 不渲染的问题。随着项目的不断发展，建议开发者关注官方文档的更新，及时调整集成方式，以获得最佳的使用体验和稳定性。