如何构建自定义 SharePoint 应用程序和扩展

通过值得信赖的 SharePoint 开发服务公司提升您的业务。我们的专家提供量身定制的解决方案，以实现无缝协作和生产力。

Microsoft 最近在 Ignite Conference 上公布了 SharePoint Framework X 的多项改进和承诺，并承诺其将随着时间的推移不断发展。现在可在 SharePoint 2016 Feature Pack 2 中本地使用，但并非所有在线可用的功能都可以在本地使用，例如当前仅在 SharePoint 实施 Online 中工作的扩展。现代 UI 尚不支持本地 SharePoint 服务，但这可能会随着 SharePoint 2019 的支持而改变 – 此功能最终也可能会出现在经典网站上。

当 SharePoint 框架扩展已提供大量扩展时，投资 JSLink 等技术并不明智。SharePoint On-Premises 尚未提供其所需的所有功能，例如租户级部署改进。虽然本地部署将来可能会成为自己的产品，但就目前而言，它应该作为一个子集 – 无论您在本地创建什么，也应该在 SharePoint Online 中工作，而不需要任何特殊修改。

同样，某些功能也将回归到离岸本地 SharePoint 开发服务中。Microsoft 最近发布了 SharePoint 框架扩展，引起了轰动——这是他们最令人兴奋的更新之一。SPFx 现在不仅仅满足 Web 部件的需求，从而进一步扩展了其适用性，创造了令人兴奋的未来开发故事。

什么是 SPFx 扩展？

SharePoint 框架扩展提供了一种自定义和增强 SharePoint 体验的绝佳方法。虽然 Web 部件自定义可能是核心，但您可以修改列表的呈现方式并在 SharePoint 内的特定点添加操作或内容。

Microsoft 提供了满足业务需求和轨道所需的所有功能，以便火车在了解周围环境的同时保持在正确的轨道上。是的，SPFx 可以允许完全控制 SharePoint 页面；但是，Microsoft 澄清了可接受和不可接受的用例。虽然骑着它穿越未知的领域似乎很有趣，但你应该始终保持在它的轨道上。

目前扩展分为三类：

• 应用程序定制器允许您将脚本或 HTML 元素直接添加到网页上，并在这些占位符中呈现自定义逻辑。

• 字段定制器允许您更改列表的外观。“进步”是指区域可能看起来更有吸引力，因为条形图代表进度，而不仅仅是数字；使用字段定制器，您可以使该数字显示为进度条。

• 命令集允许用户添加新操作，同时提供客户端行为代码。

让我们单独检查每个元素。

应用程序定制器

这些可自定义的控件允许您添加脚本或访问流行的 HTML 元素（包括占位符）以实现自定义开发渲染逻辑。作为经验丰富的 SharePoint 开发人员，您可能还记得“委派控件”。Microsoft 允许通过这种方式以批准的方式自定义页眉或页脚等元素。

这个功能可能很宝贵；您可以检查网站 URL 并向用户提供免责声明。或者嵌入功能以允许他们更改站点的外观，同时保留您的所有 SPFx 自定义设置。另一个显着的好处是：如果在租户范围内部署 SPFx 解决方案，则根本不会使用 feature.xml – 这意味着租户范围内的自定义解决方案将不支持依赖于特定列表或内容类型的解决方案。解决方案可能包括安装一个在部署或卸载解决方案时运行代码的挂钩。有两种方法可以避免此问题：

• 应在要激活该功能的站点上使用 PnP PowerShell。

• 应用程序定制器允许一次性脚本执行，从而启用站点、Web 和列表范围内的功能；

现在让我们看看如何创建一个。您的体验将通过向导进行引导，您将：

• 选择“仅限 SharePoint Online”

• 当要求选择适用于所有租户的解决方案时，选择“N”。

• 选择“扩展”对于组件的类型。

• 选择“应用程序定制器”。

打开您的项目后，在 src 扩展目录中搜索您的定制器 — 应该只有一个，并且其名称应与创建解决方案时输入的内容相匹配 — manifest.json 应包含有关此文件的信息，其中包含 SharePoint 可以识别的唯一标识符开发服务公司会认识到；立即记下它，因为稍后您将再次需要它。

应用程序定制器只是一个继承自 BaseApplicationCustomizer 的类，并且可以像 Web 部件一样进行强类型化。然而请注意，定制只能在“OnInit”期间发生。而不是它的构造函数，因为这允许访问它的状态。

请注意，我们已使用回车符对 URL 进行了分解，以便您更轻松地阅读；但是，由于它仍然是一个 URL，因此仍应写在一行上，并且与 manifest.json 对应的 GUID 应保持不变。

此免责声明增强了它的功能，允许调试脚本在页面内运行，为用户和开发人员提供了一种快速测试和注入代码的方法。这种方法可确保双方免受从 Internet 下载的意外内容的影响，同时为开发人员提供测试代码插入和注入的有效方法。

这项技术会被滥用吗？它有哪些限制？Microsoft 提供了“rails”作为指导方针，而应用程序定制器允许访问页面上的预定义区域。让我们扩展一个应用程序定制器，以便它通过在 .ts 定制器文件中编辑其导入语句来支持此功能：使用之前使用的相同 URL，但包括 Top 和 Bottom 属性。

部署定制器

由于我们一直在调试模式下测试定制器，因此用户可能很容易忘记长 URL — 要成功部署应用程序定制器，您必须至少执行两个步骤：使用 SPFx 的 feature.xml 文件，您可以指示具有指定 GUID（由 ClientSideComponentId 属性指定）的特定定制器将使用通过 ClientSideComponentProperties 中的 JSON 指定的属性进行定制。

您的下一个问题可能是“是否有必要在 XML 文档中的转义 JSON 中硬编码属性。”这是。这些属性仅作为起点。它们可以为您指明提供动态值的动态 Web 服务，也可以根据上下文计算动态值。但不要相信我们的话：租户的需求是巨大的。属性提供了另一种解决方案。初始起始价值可以指向租户的需求。用户可以设置其值的属性；租户的属性甚至可以指向另一个可以在运行时更改的 Web 服务或参数。最后一步是通过 CDN 激活并上传文件。确认应用程序定制器现在默认显示在激活定制器的网站上。

但是，在部署包含所有租户扩展的 SPFx 解决方案时，应记住一个重要的注意事项：租户范围的解决方案不会激活功能 XML 文件，即使您部署了它们。使用 PnP PowerShell，您可以手动激活所需的功能来绕过此要求，然后使用具有租户范围部署的自定义程序来跨多个站点进行自定义。

现场定制员

现在，我们将把重点转向现场定制器。我们只会解决它们的关键差异，因为应用程序定制器和字段定制器的部署步骤相似。字段定制器允许您更改字段列表视图的呈现方式，从而使用户可以更灵活地查看数据。但是，请记住，渲染仅在所有字段渲染器方法完成其任务后才会发生 – 保持这些简单以获得最佳性能，或者考虑将复杂的渲染作业委托给异步操作。

字段渲染方法不仅仅是简单地自定义字段；它们还可以用于呈现主从数据或来自另一个系统的信息。轻松创建现场定制器。启动 SharePoint 开发咨询服务 Generator 可以帮助快速创建字段定制器。然后可以在应用程序定制器中找到这些生成器，以便更轻松地进行现场定制。

一旦您的应用程序搭建完成，请打开您的 FieldCustomizer 类的 .ts。它应该是一个继承 BaseFieldCustomizer 的简单类，其属性通过接口表示。所有 SPFx 工件都严格遵循此模式。

请注意，您还可以使用 onRenderCell 事件来呈现自定义 HTML 代码。使用该元素访问 DOM 元素，渲染字段并按照您的意愿渲染它。该字段定制器被明确编写为在 UX 网站上搜索名为 Percentage 的字段 – 创建一个列表并添加一个“百分比”字段。列作为其一部分，然后访问 URL 地址以启动此定制器。

命令集

命令集使您能够将自定义操作直接添加到 SharePoint 的用户体验 (UX) 中。创建新的 SharePoint 项目，选择 SharePoint Online，然后使用下面的命令集创建扩展。完成此操作后，访问您的 manifest.json 文件以选择您想要添加的命令。

按照惯例，您将在其关联的 .ts 文件中找到命令集扩展的定义。按照惯例，该类继承自 BaseListViewCommandSet，它支持您的命令集支持的属性；此外，该类中还有两个被重写的方法。当 ListView 状态改变时，该方法被调用。在这里，您可以根据需要更改其标题或隐藏 / 显示元素 – 每次列表视图更改时都会在此处调用每个命令。

调用 execute 方法时，您可以将逻辑放置在该方法中。ID 可用于定位当前活动的命令。像平常一样执行命令集扩展。验证通过此扩展启用的任何命令是否显示在列表的命令栏中（如果已激活），并检查在选择列表项时这两个命令是否都显示。

结论

SharePoint 框架引入了一种自定义 SharePoint 的创新方法。所有这些要求使得现代网站的开发变得更加简单。此外，它在本地和云中的应用意味着我们在这两种环境中拥有相同的编程模型。

SharePoint 咨询和开发服务框架尚未达到“完整性”然而。需要构建的重要特性和功能仍然至关重要；尽管如此，它正在迅速成为 SharePoint 的有效开发工具。

文章来源地址 https://www.toymoban.com/diary/system/602.html

到此这篇关于如何构建自定义 SharePoint 应用程序和扩展的文章就介绍到这了, 更多相关内容可以在右上角搜索或继续浏览下面的相关文章，希望大家以后多多支持 TOY 模板网！

原文地址:https://www.toymoban.com/diary/system/602.html

如若转载，请注明出处：如若内容造成侵权 / 违法违规 / 事实不符，请联系站长进行投诉反馈，一经查实，立即删除！