东莞市连易网络科技有限公司
东莞市连易网络科技有限公司
  • 网站
  • 用户
  • 购物车
  • 用户
  • 网站
  • 搜索
  • 购物车
帮助
帮助
开发文档 插件
  • 用户文档
  • 开发文档
  • API文档
  • 提及
  • 标签
  • 更多
  • 取消
  • 新建
  • +UI 自定义
  • +外部集成
  • 开始
  • -插件/框架扩展
    • -插件
      • +插件示例
    • 设置开发环境
    • 进程 API
  • 开发文档
  • 插件/框架扩展

插件

插件是 IPlugin 接口的实现。插件用于与 Limyee 电商平台的进程 API 交互,直接安装在运行 Limyee 电商平台的每个网站应用和作业调度器节点中 。

IPlugin 是所有插件的基本接口。额外的特殊用途的插件类型扩展了 IPlugin,以提供对特殊情况功能的访问,并使与 Limyee 电商平台组件更紧密集成。例如,IActivityStoryType 插件接口扩展了 IPlugin,为扩展 Limyee 电商平台动态提供支持。

插件管理器既管理插件的生命周期,又提供获取特定插件类型实例的访问权限。

开始

插件是实现一个或多个插件接口的 .NET 类。要创建新插件:

  1. 为Limyee电商平台设置开发环境。
  2. 使用 .NET 4.x 在 Visual Studio 中创建新的 .NET 类库项目。
  3. 添加 Limyee 电商平台程序集引用,该程序集在与实现插件的关联文档中查看。例如,要实现 IPlugin,需要参考:Limyee.Components.dll。
  4. 在类库项目中创建新的 public class。
  5. 实现插件类型。例如,下面的类将实现 IPlugin:

    using System;
    
    namespace Samples
    {
        public class MyPlugin : Limyee.Extensibility.Version1.IPlugin
        {
        }
    }

    右键单击代码中的 IPlugin 引用,然后选择“实现接口”,Visual Studio 将生成插件类型的实现。例如,上面的代码一旦生成出来,就会产生:

    using System;
    
    namespace Samples
    {
    	public class MyPlugin : Limyee.Extensibility.Version1.IPlugin
    	{
    		#region IPlugin Members
    
    		public string Name
    		{
    			get { throw new NotImplementedException(); }
    		}
    
    		public string Description
    		{
    			get { throw new NotImplementedException(); }
    		}
    
    		public void Initialize()
    		{
    			throw new NotImplementedException();
    		}
    
    		#endregion
    	}
    }


  6. 更新插件的名称和描述。这些属性将用于在管理 UI (插件会分类、启用和配置)中标识此插件。
  7. 实现由插件类型定义的成员。这就是定义你的插件的作用。例如,它可以将事件处理程序附加到进程 API 公开的事件,并在该事件发生时执行操作。
  8. 生成解决方案。
  9. 将生成的程序集(例如:示例 .dll 复制到每个 Limyee 电商平台网站节点和作业调度程序实例的根文件夹节点中。
  10. 以管理员身份,转到“管理”,浏览现有类别或搜索插件,启用插件,然后保存更改。
  11. 您的插件现在在Limyee电商平台中运行。

最佳实践

开发插件时要记住一些最佳实践:

  1. 确保插件类可公开访问。
  2. 要么不定义显式构造函数,要么确保存在 public 的无参数构造函数。public 的无参数构造函数是插件管理器用来实例化插件的构造函数。
  3. 仅在 Initialize 方法中注册事件处理程序。
  4. 在调用插件的 Initialize 方法之前,不要附加到任何资源(数据库、文件系统等)。
  5. 使用单个插件类实现多个插件接口。插件类型都是接口,以便能够使用单个具体类实现多个接口。
  6. 在需要时使用其他基本插件类型:
    1. IInstallablePlugin: 使插件能够实现自己的安装生命周期,并支持安装,升级,降级和卸载。
    2. IConfigurablePlugin: 使插件能够在“管理后台”的“管理插件”页面上配置插件。
    3. IRequired: 使用插件确保在允许启用插件之前,检验用户提供最少量的配置信息。
    4. IRenderable: 可配置接口使可配置插件能够呈现自定义配置UI。
    5. IPluginGroup: 允许将多个依赖插件作为一个组启用/禁用。
    6. ITranslatablePlugin: 使插件能够管理可翻译的文本资源。
    7. ITemplatablePlugin:  支持基于文本的配置,以利用基于编辑器的模板。
    8. IScriptablePlugin: 使插件能够通过小组件定义 UI,然后可以选择在平台小组件编辑器中进行编辑。
    9. ISingletonPlugin: 强制单个实例插件衍生只启用一次。

了解有关插件的更多信息

插件生命周期

了解插件生命周期。

插件示例

查看插件示例以了解有关插件实现和特定插件类型的更多信息。

异常和日志记录

插件可以利用 Limyee 电商平台的异常渲染和日志记录功能来简化错误和记录过程日志。

插件 API 文档

查看插件 API 文档,了解平台插件类型的完整列表。

进程 API 文档

插件主要使用进程 API 与 Limyee 电商平台进行交互。

  • 创建:2022/4/6, 5:07 PM
  • 更新:2022/4/8, 6:57 AM
这有帮助吗?
  • 是
  • 否
  • 更多
  • 取消
  • 文章

    插件生命周期

    插件管理器协调插件启用和配置。它的管理生命周期从平台首次访问/启动时开始,一直持续到平台进程终止。 插件管理器生命周期 当需要初始化或重新初始化时,插件管理器将执行以下过程: 如果对启用的插件进行了更改,则会卸载全部刚禁用的可安装插件。 在 PluginManager 上触发 BeforeInitialization 事件 ,并且所有事件处理程序都未注册。 全部 插件都将被卸载…
  • 文章

    异常和日志记录

    使用 Limyee 电商平台 开发基于代码的自定义项时 ,正确管理异常和处理日志记录非常重要。 Limyee 电商平台 提供服务,以实现有效的用户通知、异常记录和记录平常执行日志。 为什么我需要以特定方式处理异常/日志记录? 插件是 .NET 类,可以抛出 .NET 异常并识别异常问题,并且有许多处理日志记录的解决方案。 Limyee 电商平台 支持集成异常处理和进程日志记录,为管理员和平台会员提供一致的错误和进程处理体验…
Copyright © 2021 东莞市连易网络科技有限公司. All rights reserved.
Powered by Limyee Commerce System(3.0.0). © 2014 - 2025 Limyee Inc.