ABP框架 - 模块系统

模块系统介绍

ABP提供了基础设施功能来构建模块,并通过组合这些模块来创建应用。一个模块可以依赖于另一个模块。一般来讲,一个程序集被认为和定义成一个模块。如果你的应用包含多个程序集,那么你可以为每一个程序集都定义一个模块。

模块定义

ABP中的一个模块是由继承于AbpModule(AbpModule定义在ABP package中)的一个类来定义的。比如我们开发了一个博客模块,可以被不同的应用程序使用,那么一个最简单的博客模块定义如下:

public class MyBlogApplicationModule : AbpModule
{
    public override void Initialize()
    {
        IocManager.RegisterAssemblyByConvention(Assembly.GetExecutingAssembly());
    }
}

定义模块的类有一个职责就是通过依赖注入来注册模块中的类型,如上代码所示:

IocManager.RegisterAssemblyByConvention(Assembly.GetExecutingAssembly());

当然,除此之外,它还可以配置应用程序,实现新的功能等等

模块的生命周期

当应用程序启动和关闭时,ABP会调用模块中的一组特定方法PreInitialize、Initialize、PostInitialize、Shutdown。你可以重写这些方法来执行特定任务。

ABP是根据模块之间的依赖顺序来执行模块的这些方法的。例如模块A依赖于模块B,那么模块B就会在模块A之前做初始化。当应用程序启动时,模块A和模块B中这些方法的执行顺序如下:PreInitialize-B-->PreInitialize-A-->Initialize-B-->Initialize-A-->PostInitialize-B-->PostInitialize-A

当应用程序关闭时,过程与启动类似,只是执行顺序与启动时是相反的。

PreInitialize

当启动时,会首先调用PreInitialize方法,它在模块初始化之前执行,所以通常会将框架和模块的配置定义在这里。同时,一些在依赖注入之前执行的代码也会写在这里。例如你定义一个传统的类,那么你需要在这里调用 IocManager.AddConventionalRegisterer 方法来注册它。

Initialize

在Initialize方法中,会通过依赖注入注册模块中定义的类型,一般使用IocManager.RegisterAssemblyByConvention 方法来来注册,当然也可自定义类型注册。

PostInitialize

在启动过程中,这是最后一个被调用的方法。在这里可以安全的解析一个依赖。

Shutdown

在应用关闭时,会调用此方法。

模块依赖

一个模块可以依赖于另一个模块,你需要使用DependsOn特性来显示的定义模块间的依赖关系,如下所示:

[DependsOn(typeof(MyBlogCoreModule))]
public class MyBlogApplicationModule : AbpModule
{
    public override void Initialize()
    {
        IocManager.RegisterAssemblyByConvention(Assembly.GetExecutingAssembly());
    }
}

在这里,我们定义MyBlogApplicationModule模块依赖于MyBlogCoreModule模块,并且MyBlogCoreModule模块要在MyBlogApplicationModule模块之前进行初始化。

ABP在启动模块中,自动的解析模块之间的依赖关系并初始化模块。启动模块是最后一个被初始化的模块。

插件模块

ABP可以在启动模块中检测、加载模块集,也可以动态的加载模块,这些动态加载的模块就称之为插件模块。

在动态加载模块时,要指定插件模块的源,在AbpBootstrapper类中定义了一个属性PlugInSources, 就是用来指定插件模块的源。任何一个实现了IPlugInSource接口的类都可以用来定义插件模块的源。

在ABP中提供了一个默认实现PlugInFolderSource, 用于从指定的文件夹中获取插件模块。

ASP.NET CORE

在ABP ASP.NET Core模块的Startup类中,ABP为AddAbp扩展方法定义了添加插件模块源的选项:

services.AddAbp<MyStartupModule>(options =>
{
    options.PlugInSources.Add(new FolderPlugInSource(@"C:\MyPlugIns"));
});

也可以使用AddFolder扩展方法

services.AddAbp<MyStartupModule>(options =>
{
    options.PlugInSources.AddFolder(@"C:\MyPlugIns");
});

ASP.NET MVC, Web API

如果是ASP.NET MVC应用程序,我们可以重写global.asax中的Application_Start方法来添加插件模块的源:

public class MvcApplication : AbpWebApplication<MyStartupModule>
{
    protected override void Application_Start(object sender, EventArgs e)
    {
        AbpBootstrapper.PlugInSources.AddFolder(@"C:\MyPlugIns");
        //...
        base.Application_Start(sender, e);
    }
}

插件模块中的Controllers

如果你在插件模块中定义了MVC / Web API Controllers, ASP.NET将不能检测到这些Controllers, 要解决这个问题,你需要修改global.asax代码文件如下:

using System.Web;
using Abp.PlugIns;
using Abp.Web;
using MyDemoApp.Web;

[assembly: PreApplicationStartMethod(typeof(PreStarter), "Start")]

namespace MyDemoApp.Web
{
    public class MvcApplication : AbpWebApplication<MyStartupModule>
    {
    }

    public static class PreStarter
    {
        public static void Start()
        {
            //...
            MvcApplication.AbpBootstrapper.PlugInSources.AddFolder(@"C:\MyPlugIns\");
            MvcApplication.AbpBootstrapper.PlugInSources.AddToBuildManager();
        }
    }
}

附加程序集

在ABP中定义了两个接口IAssemblyFinder和ITypeFinder,这两个接口是ABP用来检测应用中的程序中的程序集和类型的。ABP为这两个接口提供了默认实现,在默认实现中,仅仅从上述模块(通过启动模块定义的模块依赖解析出的模块,以及插件模块)中来查找程序集和类型。如果想添加其他程序集,可以重写GetAdditionalAssemblies方法。

模块中的自定义方法

在模块中可以定义自定义方法,模块中的自定义方法可以被其他依赖的模块调用。假设MyModule2模块依赖MyModule1模块,并且想在PreInitialize方法中调用MyModule1模块的自定义方法,如下代码所示:

public class MyModule1 : AbpModule
{
    public override void Initialize()
    {
        IocManager.RegisterAssemblyByConvention(Assembly.GetExecutingAssembly());
    }

    public void MyModuleMethod1()
    {
        //this is a custom method of this module
    }
}

[DependsOn(typeof(MyModule1))]
public class MyModule2 : AbpModule
{
    private readonly MyModule1 _myModule1;

    public MyModule2(MyModule1 myModule1)
    {
        _myModule1 = myModule1;
    }

    public override void PreInitialize()
    {
        _myModule1.MyModuleMethod1(); //Call MyModule1‘s method
    }

    public override void Initialize()
    {
        IocManager.RegisterAssemblyByConvention(Assembly.GetExecutingAssembly());
    }
}

在这里,我们通过构造函数注入将MyModule1模块注入到MyModule2模块,这样我们就可以在MyModule2模块总调用MyModule1的方法了,但是前提条件是MyModule2模块依赖MyModule1模块。

模块配置

ABP中建议使用启动配置(startup configuration)来配置模块

模块生存期

定义模块的类会被自动注册为单例

原文地址:https://www.cnblogs.com/lcyhjx/p/8978010.html

时间: 2024-10-02 22:56:51

ABP框架 - 模块系统的相关文章

ABP vNext模块系统初试 - 创建留言板模块

上次翻译的ABP vNext介绍发布后,引起了很多ABP好爱者的关注. 那么就趁热打铁,体验一下新ABP. 新的ABP中我最感兴趣的是它的模板系统,所以这次就利用模块系统做了留言板的例子,分享给大家. 留言板模块 我们的留言板模块功能很简单,就是提供用户留言的功能(废话),为了简单起见,功能都非常简陋: 通过菜单进入留言板 显示留言一览,显示的项目有:标题,作者和时间 任意用户可创建留言,修改或删除自己的留言 管理员可修改或删除任何留言 留言只有标题和正文,均为纯文本(不支持富文本). 使用AB

基于DDD的现代ASP.NET开发框架--ABP系列之4、ABP模块系统

点这里进入ABP系列文章总目录 基于DDD的现代ASP.NET开发框架--ABP系列之4.ABP模块系统 ABP是“ASP.NET Boilerplate Project (ASP.NET样板项目)”的简称. ABP的官方网站:http://www.aspnetboilerplate.com ABP在Github上的开源项目:https://github.com/aspnetboilerplate 本文由东莞-天道提供翻译 ABP模块系统简介 ABP框架提供了创建和组装模块的基础,一个模块能够依

ABP模块系统

ABP模块系统 基于DDD的现代ASP.NET开发框架--ABP系列之4.ABP模块系统 ABP是“ASP.NET Boilerplate Project (ASP.NET样板项目)”的简称. ABP的官方网站:http://www.aspnetboilerplate.com ABP在Github上的开源项目:https://github.com/aspnetboilerplate 本文由东莞-天道提供翻译 ABP模块系统简介 ABP框架提供了创建和组装模块的基础,一个模块能够依赖于另一个模块.

&lt;&lt;ABP文档 - 框架&gt;&gt; 1.3 模块系统

文档目录 本节内容: 简介 模块定义 生命周期方法 PreInitialize(预初始化) Initialize(初始化) PostInitialize(提交初始化) Shutdown(关闭) 模块依赖 插件模块 Asp.net Core Asp.net Mvc,Web Api 插件中的控制器 附加程序集 自定义模块方法 模块配置 模块生命期 简介 ABP为创建模块及组织它们提供基础框架.一个模块可依赖于另一个模块.通常地,一个程序集做为一个模块.如果你的应用是多个程序集,建议为每个程序集定义一

【ABP框架系列学习】模块系统(4)

0.引言 ABP提供了构建模块和通过组合模块以创建应用程序的基础设施.一个模块可以依赖于另外一个模块.通常,程序集可以认为是模块.如果创建多个程序集的应用程序,建议为每个程序集创建模块定义. 当前,模块系统主要集中在服务器,而不是客户端. 1.模块定义 模块是从ABP包中的AbpModule派生的类定义的.比如说开发一个可以用于不同应用程序的博客模块(Blog Module).最简单的模块定义如下 : public class MyBlogApplicationModule : AbpModul

如何用ABP框架快速完成项目(11) - ABP只要加人即可马上加快项目进展- 全栈篇(2) - 不推荐模块组件化, 推荐微服务

一个人写代码不需要担心会和别人的代码冲突, 不需要做代码合并, 不需要担心自己的代码被覆盖. 但是多个人一起写代码就需要担心这些问题. 解决这些问题的方法很多, 比如用AzureDevOps(TFS)来进行代码管理和版本控制等等. 其中有两个办法就是, 业务模块组件化和微服务. 首先ABP是支持业务模块组件化的, 然而我并不推荐在ABP使用业务模块组件化, 因为: ABP更新太快了, 每2周更新一个版本. 除了ABP更新快, 其他技术\框架\工具也更新很快. 正如我在<如何用ABP框架快速完成项

&lt;&lt;ABP框架&gt;&gt; 功能管理

文档目录 本节内容: 简介 关于 IFeatureValueStore 功能类型 Boolean 功能 Value 功能 定义功能 基本功能属性 其它功能属性 功能层次 检查功能 使用RequiresFeature特性 RequiresFeature特性注意事项 使用 IFeatureChecker IsEnabled GetValue 客户端 isEnabled getValue 功能管理器 对版本的一个提示 简介 大部分SaaS(多租户)应用有不同功能的版本(包),因此你可以提供不同价格和功

&lt;&lt;ABP框架&gt;&gt; 依赖注入

文档目录 本节内容: 什么时依赖注入 传统方式的问题 解决方案 构造器注入模式 属性注入模式 依赖注入框架 ABP 依赖注入基础 注册依赖 约定注入 辅助接口 自定义/直接 注册 使用IocManager 使用Castle Windsor API 解析 构造器和属性注入 IIocResolver 和 IIocManager 另外 IShouldInitialize 接口 Asp.net Mvc 和 Asp.net Web Api 集成 Asp.net Core 集成 最后提醒 什么是依赖注入 如

ABP框架个人开发实战(1)_环境搭建

前言 之前关注ABP框架有一阵子了,一直没有潜下心来实际研究一下.最近想自己建站,以后有自己的功能开发项目,可以在自己的站点上开发,并一步步的完善,所以找个比较好用的框架迫在眉睫,选来选去,决定用ABP框架.用群里的大大门的话来说,掌握了ABP,基本就可以飞天了~ 先简单介绍下吧(以下部分资料来自群里资料,如有侵权,请告知): ABP是“ASP.NET Boilerplate Project (ASP.NET样板项目)”的简称. ASP.NET Boilerplate是一个用最佳实践和流行技术开