向 ONLYOFFICE Workspace 添加自定义模块

介绍

如果您想为 ONLYOFFICE 创建自己的模块并将其添加到 ONLYOFFICE Workspace，现在您可以轻松实现。示例项目可在此处获取：https://github.com/ONLYOFFICE/CommunityServer/tree/master/web/studio/ASC.Web.Studio/Products/Sample

您可以修改此示例或基于此创建一个新的自定义模块。请确保所有必要的组件都位于指定的文件夹中，并按照下面的描述将某些代码行添加到指定的文件中。

工作原理

1. 从 https://github.com/ONLYOFFICE/CommunityServer 获取 ONLYOFFICE 社区版服务器
2. Sample 项目位于 Products 文件夹中：

   https://github.com/ONLYOFFICE/CommunityServer/tree/master/web/studio/ASC.Web.Studio/Products

3. ASC.Api.Sample 位于 ASC.Api 文件夹中：

   https://github.com/ONLYOFFICE/CommunityServer/tree/master/module/ASC.Api

4. 将以下代码行添加到 https://github.com/ONLYOFFICE/CommunityServer/blob/master/build/msbuild/build.proj 文件中：

   <!-- Sample --><ProjectToBuild Include="$(ASCDir)web\studio\ASC.Web.Studio\Products\Sample\ASC.Web.Sample.csproj"/>

   以及

   <ProjectToBuild Include="$(ASCDir)module\ASC.Api\ASC.Api.Sample\ASC.Api.Sample.csproj"/>

   您还可以查看其他现有项目以确定这些行应添加到何处。

   请注意！ 输入行的顺序非常重要。
5. 将 ASC.Api.Sample.SampleApi 添加到 web\studio\ASC.Web.Studio\web.autofac.config 文件中，如下所示：

   <componenttype="ASC.Api.Sample.SampleApi, ASC.Api.Sample"service="ASC.Api.Interfaces.IApiEntryPoint, ASC.Api"name="sample"/>

6. 可以在此处运行 Build.bat 文件：

   https://github.com/ONLYOFFICE/CommunityServer/blob/master/build/Build.bat

如何为 ONLYOFFICE 创建自己的模块

1. 创建一个 ASP.NET Web 应用程序 (ASC.Web.Sample) 项目，并将其放入 ...web\studio\ASC.Web.Studio\Products\Sample 文件夹。
   重要！！！ 输出 dll 文件名必须为 "ASC.Web.*.dll"。
2. 从 ...\web\studio\ASC.Web.Studio\bin\ 连接所需的引用：

   ASC.Common.dll
   ASC.Core.Common.dll
   ASC.Data.Storage.dll
   ASC.Web.Core.dll
   ASC.Web.Studio.dll

3. 在 ProductEntryPoint.cs 文件中实现 IProduct 接口。
   重要！！！ ProductID 必须是唯一的 Guid（在 VS2012 中生成为 工具 -> GUID -> 新建 GUID）
4. 将以下行添加到 AssemblyInfo.cs 文件中：

   [assembly: Product(typeof(ASC.Web.Sample.Configuration.ProductEntryPoint))]

5. 从 web\studio\ASC.Web.Studio\Masters\BaseTemplate.master 继承 Master
6. 在项目属性中设置输出路径，如下所示：

   <OutputPath>..\..\bin\</OutputPath>

   以便构建在 web\studio\ASC.Web.Studio\bin 文件夹中创建。

7. 项目可以手动构建或使用构建器构建。对于后者，将以下行添加到 build\msbuild\build.proj 文件中：

   <ProjectToBuild Include="$(ASCDir)web\studio\ASC.Web.Studio\Products\Sample\ASC.Web.Sample.csproj"/>

   并运行 build\Build.bat 文件。

8. 构建完成后，在 localhost:port 地址运行网站，转到“模块和工具”设置页面（http://localhost:port/management.aspx?type=2）并启用新的 Sample 模块。之后，它将在门户头部下拉菜单中可用，或通过直接链接访问：http://localhost:port/products/sample/default.aspx

现在，您可以按照这些说明为自己的模块创建 API。