플러그인 시스템

플러그인을 사용하여 뷰어 확장

Doconut의 핵심은 간결하게 유지됩니다; 선택적 기능은 플러그인 형태로 제공되며 — 뷰어나 서비스를 제공하는 별도의 NuGet 패키지이며 라이선스로 활성화됩니다. 이 페이지에서는 등록 모델, 런타임에서 라이선스 게이팅이 어떻게 동작하는지, 그리고 자체 뷰어를 어떻게 연결하는지 설명합니다.

플러그인 등록

각 플러그인 패키지는 하나의 플러그인 클래스를 노출합니다. 시작 시 한 번 등록합니다:

csharp
builder.Services.AddDoconut(options =>
{
    options.AddPlugin<Doconut.Plugins.Converter.ConverterPlugin>();
    options.AddPlugin<Doconut.Plugins.Dicom.DicomPlugin>();
});

AddPlugin<TPlugin>()는 플러그인을 인스턴스화하고 DoconutOptions에 보관된 플러그인 레지스트리에 대해 Register 콜백을 호출합니다. 플러그인이 제공하는 모든 것은 플러그인의 필수 기능으로 태그됩니다. AddDoconut()은 등록된 플러그인을 즉시 검증합니다: 라이선스가 없거나, 레거시 TRIAL 파일이 있거나, 해당 기능이 없는 유료 라이선스는 InvalidOperationException으로 시작이 실패합니다. Temporary/Demo 등록은 만료 후에도 유지되지만, 런타임 기능은 만료일 이후에 회수됩니다.

계약

플러그인은 의도적으로 작은 인터페이스를 구현합니다:

text
public interface IDoconutPlugin
{
    string Name { get; }                          // e.g. "Doconut DICOM Viewer"
    LicenseCapability RequiredCapability { get; } // the license gate
    void Register(IDoconutPluginBuilder builder); // contribute viewers/services
}

Register 내부에서, 빌더는 두 종류의 기여를 받습니다:

  • builder.RegisterViewer(".dcm", () => new DicomViewer()) — 파일 확장자를 위한 뷰어,
  • builder.RegisterService<TContract>(() => …) — 파이프라인의 다른 부분에서 조회할 수 있는 형식화된 서비스.

기능 및 게이팅

기능은 라이선스 단위입니다. Converter와 Dicom은 선택적 플러그인으로 제공되며; Search와 Annotation은 동일한 방식으로 게이팅되는 기본 기능입니다. 기본 뷰어는 기능이 아닙니다 — 전제 조건이며 라이선스 서비스의 IsViewerLicensed로 노출됩니다.

시작 시 검증은 일반적으로 라이선스가 없는 플러그인이 요청 파이프라인에 들어가는 것을 방지합니다. 뷰어 팩토리는 또한 두 가지 방어적인 런타임 규칙을 적용하는데, 이는 시작 후 권한이 변경될 경우 중요합니다:

  • 플러그인이 기본 뷰어를 대체함 (플러그인이 기본 레지스트리도 처리하는 확장자를 주장하는 경우): 기능이 라이선스된 경우 플러그인 뷰어가 우선합니다; 그렇지 않으면 Doconut이 조용히 기본 뷰어로 되돌아갑니다. 사용자는 여전히 문서를 볼 수 있지만 플러그인 기능은 제공되지 않습니다.
  • 플러그인 전용 포맷 (예: .dcm — DICOM에는 기본 뷰어가 없음): 기능이 없으면 열기 호출이 강제로 실패합니다:
text
LicenseException: This document type requires the 'Dicom' plugin license.

활성화된 Temporary 라이선스는 모든 기능을 부여합니다 (깨끗하고 워터마크가 없는 기본 뷰잉). 이는 실서비스 전환 시 흔히 발생하는 놀라움의 원인입니다: 기능 중 하나가 누락된 구매 라이선스로 동일한 플러그인을 등록하면 AddDoconut()이 시작 시 실패합니다. 배포 전에 IsCapabilityGranted(...)를 플랜과 비교하십시오. 반대로 라이선스가 전혀 없으면, 아무 것도 부여되지 않습니다 — 라이선스가 없다는 것은 Temporary 라이선스가 아니라는 의미입니다.

같은 게이팅이 클라이언트 측에도 나타납니다: Viewer.ReferenceScripts()와 ReferenceCss()는 라이선스가 활성화된 경우에만 라이선스-게이팅된 기능(검색, 주석, …)에 대한 스크립트/스타일 번들을 출력하므로 위젯 UI가 서버가 실제로 수행하는 작업과 일치합니다.

기능 및 플러그인 맵

제품 UI는 “플러그인”을 광범위한 기능 라벨로 사용하지만, 서버 등록은 다릅니다:

기능활성화 방법필요 기능기여 내용
Annotation뷰어에 내장; 주석 리소스 포함Annotation브라우저 저작, 세션 지속성, 그리고 내장된 내보내기
Search검색 가능한 포맷 뷰어에 내장; 검색 리소스를 포함하고 필요 시 추출 활성화Search네이티브 텍스트 인덱스, 하이라이트, 결과 탐색
ConverterDoconut.NET8.Converter 설치 및 ConverterPlugin 등록ConverterC# 변환 서비스 및 선택적 웹 위젯
DICOMDoconut.NET8.Dicom 설치 및 DicomPlugin 등록Dicom.dcm 및 .ima에 대한 의료 이미지 뷰잉

출시된 플러그인 패키지

플러그인패키지필요 기능기여 내용
ConverterDoconut.NET8.ConverterConverter문서 변환 기능
DICOMDoconut.NET8.DicomDicom의료 이미지 뷰잉 (.dcm — 플러그인 전용 포맷)

각각은 플러그인 아래 전용 페이지가 있으며, 구성 및 사용법을 제공합니다.

사용자 정의 뷰어 — 자체 포맷 핸들러

플러그인 패키지를 작성하지 않고도 Program.cs에서 직접 뷰어를 파이프라인에 연결할 수 있습니다:

text
builder.Services.AddDoconut(options =>
{
    options.RegisterViewer(
        ".myext",
        () => new MyCustomViewer(),               // implements IFormatViewer
        () => new ImageConfig { ImageResolution = 150 }); // optional default config
});

사용자 정의 뷰어는 모든 것—기본 및 플러그인—보다 우선하며 라이선스 게이팅되지 않습니다(사용자 코드이기 때문). 팩토리는 기본 구성을 제공하지 않을 경우 ImageConfig로 대체합니다.

주요 내용

  • 플러그인은 명시적으로 등록되며 AddDoconut() 중에 LicenseCapability가 검증됩니다 — 누락되었거나 일시적이 아닌 권한이 부족하면 즉시 실패합니다.
  • 오버라이드 스타일 플러그인은 우아하게 감소하고; 플러그인 전용 포맷은 LicenseException으로 실패합니다.
  • 활성화된 Temporary 라이선스는 모든 것을 해제하고; 프로덕션 라이선스는 구매한 항목만 해제합니다. 배포 전 IDoconutLicenseService로 확인하십시오.

이 페이지가 도움이 되었나요?