# 共同編集

- Human documentation: [https://docs.univer.ai/ja-JP/guides/bases/features/collaboration](https://docs.univer.ai/ja-JP/guides/bases/features/collaboration)

- Agent Markdown: [https://docs.univer.ai/ja-JP/guides/bases/features/collaboration.md](https://docs.univer.ai/ja-JP/guides/bases/features/collaboration.md)

- Requested language: `ja-JP`

- Content language: `ja-JP`

- Documentation version: `1.2.0`

- Source: [bases/features/collaboration.ja-JP.mdx](https://github.com/dream-num/documentation/blob/dev/content/guides/bases/features/collaboration.ja-JP.mdx)

---

#### Package metadata

```json
{
  "preset": [],
  "plugins": [
    {
      "client": "@univerjs-pro/collaboration"
    },
    {
      "client": "@univerjs-pro/collaboration-client",
      "facade": "@univerjs-pro/collaboration-client/facade",
      "locale": "@univerjs-pro/collaboration-client/locale/ja-JP"
    },
    {
      "client": "@univerjs-pro/collaboration-client-ui",
      "facade": "@univerjs-pro/collaboration-client-ui/facade",
      "locale": "@univerjs-pro/collaboration-client-ui/locale/ja-JP",
      "style": "@univerjs-pro/collaboration-client-ui/lib/index.css"
    }
  ],
  "license": true,
  "server": true
}
```

ユーザーが同じ Base を開き、テーブル、フィールド、レコード、ビューを共同で編集できます。異なるビューで作業しながら、同じドキュメントを変更できます。

## 統合手順

1. [共同編集の統合](https://docs.univer.ai/ja-JP/server/collaboration/browser-integration.md)に従ってサンプルを実行し、ログイン、権限、データベースストレージを接続します。
2. 既存の Bases エディターに Collaboration Client の設定を追加します。ブラウザー側の設定は [共同編集クイックスタート](https://docs.univer.ai/ja-JP/server/collaboration/quick-start.md)を参照してください。ただし、サンプルの Sheets データをコピーするのではなく、Bases ドキュメントを作成して保存します。
3. アプリケーションのバックエンドで Base を作成し、その ID をブラウザーに返します。

## サーバー上の Base を開く

文書を読み込む前に現在のユーザーを設定してください。詳細は[共同編集の統合](https://docs.univer.ai/ja-JP/server/collaboration/browser-integration.md)を参照してください。

```ts
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')
```

再度開く場合や共有する場合は、この ID を再利用します。サーバーからの読み込みを、`createBase()` による新しいローカルの空ドキュメントの作成に置き換えないでください。

[同期状態、再送、競合の復旧](https://docs.univer.ai/ja-JP/server/collaboration/browser-integration.md#sync-status)を使い、保存状況の表示と再読み込み前の未確認編集の保護を実装できます。

## 共同編集ドキュメントの組み込み URL 読み込みの削除

> [!WARNING: 注意]
> **1.2.0** 以降、Univer は共同編集ドキュメントの組み込み URL 読み込み処理を削除しました。URL の `unit` と `type` パラメーターを自動的に読み取って、共同編集ドキュメントを読み込むことはなくなりました。

アプリケーションがこの動作に依存している場合は、カスタムプラグインで復元できます。

### カスタムプラグインの組み込み

以下の 4 つのファイルを、次のディレクトリ構成でプロジェクトにコピーしてください。

```text
custom-url-load/
├── plugin.ts
├── controllers/
│   └── data-loader.controller.ts
└── services/
    ├── url.service.ts
    └── web-url.service.ts
```

エディターと共同編集プラグインの初期化後、現在のユーザーを設定してから `CustomUrlLoadPlugin` を登録します。

```ts
import { UserManagerService } from '@univerjs/core'
import { CustomUrlLoadPlugin } from './custom-url-load/plugin'

univer.__getInjector().get(UserManagerService).setCurrentUser({ userID, name, avatar })

univer.registerPlugin(CustomUrlLoadPlugin)
```

登録後はプラグインがドキュメントを読み込むため、同じドキュメントに対して `loadBaseAsync()` を呼び出す必要はありません。すでに Facade で読み込んでいる場合は、前のセクションの方法を引き続き使用し、アプリケーションの要件に合わせて URL を処理できます。

### プラグインの全コード

#### plugin.ts

```ts
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))
  }
}
```

#### controllers/data-loader.controller.ts

```ts
import { DataLoaderService } from '@univerjs-pro/collaboration-client'
import { ILogService, Inject, RxDisposable } from '@univerjs/core'
import { IURLService } from '../services/url.service'

/**
 * 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)
      })
  }
}
```

#### services/url.service.ts

```ts
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')
```

#### services/web-url.service.ts

```ts
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())
    }
  }
}
```

## 同期と保存の確認

独立した 2 つのブラウザーセッションで同じ ID を開きます。一方でレコードを追加するかフィールドを変更し、もう一方に届くことを確認します。ページの再読み込みとサーバーの再起動後も編集内容が保持されることを確認してください。

閲覧者や権限のないユーザーのアクセスはサーバー側で認可してください。[ローカルの読み取り専用設定](https://docs.univer.ai/ja-JP/guides/bases/features/core/permissions.md)はエディターの動作だけを制御します。ファイル変換、コメント、履歴にはそれぞれ対応するバックエンド機能が必要です。[インポート・エクスポート](https://docs.univer.ai/ja-JP/guides/bases/features/import-export.md)、[コメント](https://docs.univer.ai/ja-JP/guides/bases/features/thread-comment.md)、[履歴](https://docs.univer.ai/ja-JP/guides/bases/features/edit-history.md)を参照してください。