Collaboration
Plusieurs utilisateurs peuvent ouvrir la même base et éditer des tables, des champs, des enregistrements et des vues ensemble. Chaque utilisateur peut travailler dans une vue différente tandis que toutes les modifications s'appliquent au même document.
Étapes d’intégration
- Suivez Intégration de la collaboration pour exécuter l'exemple de collaboration, puis connectez la connexion, les permissions et le stockage de la base de données.
- Ajouter la configuration Collaboration Client à l'éditeur de bases existant. Pour le côté navigateur, suivez Début rapide de la collaboration, mais créez et stockez des documents Bases au lieu de copier les données Feuilles de l'exemple.
- Créez la base sur le moteur de l'application et retournez son ID dans le navigateur.
Ouvrir une Base du serveur
Définissez l’utilisateur courant avant de charger le document. Voir Intégration collaborative.
import '@univerjs-pro/bases/facade'import { UserManagerService } from '@univerjs/core'import '@univerjs-pro/collaboration-client/facade'univer.__getInjector().get(UserManagerService).setCurrentUser({ userID, name, avatar })const base = await univerAPI.getCollaboration().loadBaseAsync('your-base-id')if (!base) throw new Error('Base could not be loaded')Réutiliser le même ID lors de la réouverture ou du partage du document. Ne remplacez pas le chargement du serveur avec createBase() et un nouveau document local vierge.
Utilisez l'état de synchronisation, les relevés et le rétablissement des conflits pour créer des indicateurs de sauvegarde et protéger les modifications non reconnues avant un rechargement.
Suppression du chargement intégré par URL des documents collaboratifs
Remarque
À partir de la version 1.2.0, Univer n'inclut plus le chargement d'URL intégré pour les documents collaboratifs. Il ne lit plus les paramètres d'URL unit et type pour déterminer quel document charger.
Si l'application dépend de ce comportement, un plugin personnalisé peut le restaurer.
Intégrer le plugin personnalisé
Copiez les quatre fichiers ci-dessous dans le projet et conservez la structure de répertoire suivante :
custom-url-load/├── plugin.ts├── controllers/│ └── data-loader.controller.ts└── services/ ├── url.service.ts └── web-url.service.tsAprès l'initialisation de l'éditeur et des plugins de collaboration, définissez l'utilisateur actuel, puis enregistrez CustomUrlLoadPlugin.
import { UserManagerService } from '@univerjs/core'import { CustomUrlLoadPlugin } from './custom-url-load/plugin'univer.__getInjector().get(UserManagerService).setCurrentUser({ userID, name, avatar })univer.registerPlugin(CustomUrlLoadPlugin)Après l'enregistrement, le plugin charge le document, donc appeler loadBaseAsync() pour le même document n'est plus nécessaire. Si l'application charge déjà des documents à travers la Facade, conservez l'approche décrite dans la section précédente et manipulez les URLs comme l'exige l'application.
Code complet du plugin
import { UniverCollaborationClientPlugin } from '@univerjs-pro/collaboration-client'import { DependentOn, Inject, Injector, Plugin } from '@univerjs/core'import { CollaborationDataLoaderController } from './controllers/data-loader.controller'import { IURLService } from './services/url.service'import { WebURLService } from './services/web-url.service'@DependentOn(UniverCollaborationClientPlugin)export class CustomUrlLoadPlugin extends Plugin { static override pluginName = 'CUSTOM_URL_LOAD_PLUGIN' constructor( _config: undefined, @Inject(Injector) protected override readonly _injector: Injector ) { super() } override onStarting(): void { this._injector.add([IURLService, { useClass: WebURLService }]) this._injector.add([CollaborationDataLoaderController]) this.disposeWithMe(this._injector.get(IURLService)) this.disposeWithMe(this._injector.get(CollaborationDataLoaderController)) }}import { DataLoaderService } from '@univerjs-pro/collaboration-client'import { ILogService, Inject, RxDisposable } from '@univerjs/core'import { IURLService } from '../services/url.service'/** * Charge un document collaboratif à partir des paramètres de l’URL. */export class CollaborationDataLoaderController extends RxDisposable { constructor( @IURLService private readonly _urlService: IURLService, @ILogService private readonly _logService: ILogService, @Inject(DataLoaderService) private readonly _dataLoaderService: DataLoaderService ) { super() const unitId = this._urlService.getParam('unit') const type = this._urlService.getParam('type') if (!unitId || !type) { return } this._dataLoaderService.loadUnit(unitId, Number(type)) .catch((error: unknown) => { this._logService.error('[CollaborationDataLoaderController]', error) }) }}import type { IDisposable } from '@univerjs/core'import type { Observable } from 'rxjs'import { createIdentifier } from '@univerjs/core'export interface IURLService extends IDisposable { getParam: (key: string) => string | undefined setParam: (key: string, value: string, useReplace?: boolean) => void removeParam: (key: string, useReplace?: boolean) => void readonly urlChange$: Observable<void>}export const IURLService = createIdentifier<IURLService>('demo.custom-url-load.url-service')import type { IURLService } from './url.service'import { RxDisposable } from '@univerjs/core'import { fromEvent, map, shareReplay, takeUntil } from 'rxjs'export class WebURLService extends RxDisposable implements IURLService { readonly urlChange$ = fromEvent(window, 'popstate').pipe( map(() => undefined), takeUntil(this.dispose$), shareReplay({ bufferSize: 1, refCount: true }) ) getParam(key: string): string | undefined { return new URL(window.location.href).searchParams.get(key) ?? undefined } setParam(key: string, value: string, useReplace = false): void { const url = new URL(window.location.href) url.searchParams.set(key, value) this._updateUrl(url, useReplace) } removeParam(key: string, useReplace = false): void { const url = new URL(window.location.href) url.searchParams.delete(key) this._updateUrl(url, useReplace) } private _updateUrl(url: URL, useReplace: boolean): void { if (useReplace) { window.history.replaceState(window.history.state, '', url.toString()) } else { window.history.pushState(window.history.state, '', url.toString()) } }}Vérifier la synchronisation et l’enregistrement
Ouvrez le même ID dans deux sessions de navigateur indépendantes. Ajoutez un enregistrement ou modifiez un champ dans une session et confirmez que l'autre reçoit le changement. Ensuite, vérifiez que les modifications persistent après une mise à jour de page et un redémarrage du serveur.
Les visionneurs et les utilisateurs non autorisés doivent être autorisés sur le serveur. Paramètres locaux en lecture seule n'affecte que le comportement de l'éditeur. L'échange, les commentaires et l'historique nécessitent chacun leurs propres fonctionnalités de backend; voir Importation et exportation, Commentaires et Historique.
Que pensez-vous de ce guide ?