Collaboration SDK 개요
Univer Collaboration SDK가 해결하는 문제, 모듈 구성, 확장 지점과 애플리케이션이 담당하는 제품 기능을 알아봅니다.
Univer Collaboration SDK는 Univer 문서 모델을 위한 서버 측 협업 SDK입니다. 작업 변환(OT1), 리비전2, 스냅샷, 실시간 동기화, 영속성을 제공하여 여러 Univer 클라이언트가 서버를 기준으로 하는 동일한 Unit을 편집하도록 합니다.
개발자는 이를 자신의 Node.js 애플리케이션에 내장하고 Middleware로 신원 확인과 권한 부여를 연결하며, Middleware나 Events로 로깅 및 다른 애플리케이션 로직을 확장합니다. Database Adapter는 협업 데이터를 애플리케이션 데이터베이스에 연결합니다.
완성된 문서 제품은 아닙니다
Collaboration SDK는 협업의 핵심을 제공합니다. 사용자, 역할, 계층, 공유, 파일 공간, 업무 흐름은 제공하지 않습니다. 이러한 제품 기능과 데이터 모델은 애플리케이션이 담당합니다.
해결하는 문제
Web SDK는 브라우저에서 Sheet, Doc, Slide, Board, Base 콘텐츠를 표시하고 편집합니다. 여러 사용자가 편집하려면 콘텐츠를 로드하고, 동시 변경을 확정하고, 리비전을 갱신하며, 연결이 끊긴 클라이언트를 일관된 상태로 복구하는 서버가 필요합니다.
다음 애플리케이션에 적합합니다.
- Univer로 편집기를 구축했고 실시간 다중 사용자 편집이 필요한 경우
- 협업 데이터를 직접 호스팅하고 데이터베이스를 선택하려는 경우
- 기존 신원 확인, 권한 부여, 테넌트 규칙을 협업 작업에 연결해야 하는 경우
- 핵심 협업에 History, Thread Comment, Worktree 기능을 추가하려는 경우
전체 협업 서비스
| 모듈 | 주요 역할 |
|---|---|
| Collaboration Client | Unit 로드, 변경 집합 제출, 브라우저 협업 상태 유지 |
| Node Transport | HTTP/WebSocket 트래픽 수신 및 애플리케이션 진입 미들웨어 실행 |
UniverCollabEndpoint | 클라이언트 프로토콜, Session, Room, Presence, ACK, 브로드캐스트 구현 |
UniverCollabService | Unit 수명 주기 관리, OT 실행, 연속 리비전 확정 |
| Database Adapter | 스냅샷, 변경 집합, 리비전, 제출 멱등성 상태를 원자적으로 저장 |
SDK가 제공하는 기능
핵심 기능은 다음과 같습니다.
- Sheet, Doc, Slide, Board, Base Unit 생성, 로드, 삭제, 복구
- 스냅샷, 변경 집합, 리비전, OT, 제출 멱등성
- HTTP 콘텐츠 로드와 WebSocket Session, Room, Presence, ACK, 브로드캐스트
- Transport, Endpoint, Service 경계의 Middleware
- Unit 생성, 변경 집합 커밋, 삭제, 복구에 대한 프로세스 내부 Events
- Memory, SQLite 및 사용자 정의 Database Adapter 계약
핵심 경로가 동작하면 버전 기록, 스레드 댓글, Worktree 초안, 서버 측 Office 파일 변환을 추가할 수 있습니다. 이러한 기능은 자체 Service, Middleware, Events 또는 Database Adapter를 갖습니다.
애플리케이션이 담당하는 기능
| Collaboration SDK | 애플리케이션 |
|---|---|
| Unit 협업 상태 | 사용자, 테넌트, 계층, 공유 관계 |
| OT, 리비전, 스냅샷 | 로그인, Session, 신원 매핑 |
| 협업 Session, Room, Presence | 역할, ACL, 제품 정책 |
| 협업 Database Adapter | 파일, 객체 스토리지, 제품 데이터베이스 |
| Middleware와 Event 확장 지점 | 로깅, 감사, 지표, 외부 통합 |
| 클라이언트 프로토콜 Endpoint | 업무 API 및 문서 생성 등의 흐름 |
세 가지 일반 확장 지점
| 확장 지점 | 해결하는 문제 |
|---|---|
| Middleware | 작업 중 Context 검사·보강, 요청 거부, 처리 과정 기록 |
| Event | 확정된 상태 변경을 관찰하여 프로세스 내부 파생 상태 또는 비핵심 후속 작업 처리 |
| Database Adapter | 스토리지 선택 및 원자성, CAS, 멱등성 계약 구현 |
신원 확인과 권한 부여는 Middleware로 통합합니다. 작업 전 검증과 제한에는 Middleware를, 상태 확정 후 변경 기록과 후속 작업에는 Events를 사용합니다. 둘 다 로깅, 요청 추적, 지표, 파생 상태 업데이트를 지원할 수 있습니다. 실행 경계는 Middleware와 Events를 참고하세요.
시작하기
- 빠른 시작을 실행하여 두 브라우저에서 전체 경로를 확인합니다.
- 모듈 경계와 관계를 읽고 각 패키지의 목적을 이해합니다.
- 통합하려는 작업에 맞춰 Middleware와 Events, 신원 확인과 권한 부여, 데이터베이스 어댑터를 읽습니다.
- History, 댓글, Worktree, 파일 변환은 협업 확장 모듈을 참고하세요.
Footnotes
이 가이드는 어떠셨나요?