ASP.NET Boilerplate：通用WEB应用框架与项目模板简介

需积分: 10 155 浏览量更新于2024-07-18 收藏 1.94MB PDF 举报

身份认证购VIP最低享 7 折!

领优惠券(最高得80元）

资源详情

资源推荐

在ABP中，有很多种不同的方法来注册你的类到依赖注入系统。大部分时间，常规方法就足够了。

常规注册(Conventional registrations)

按照约定，ABP自动注册所有 Repositories， Domain Services， Application Services， MVC 控制器和Web API控制器。例

如，你可能有一个IPersonAppService 接口和实现类PersonAppService：

publicinterfaceIPersonAppService:IApplicationService

{

//...

}

publicclassPersonAppService:IPersonAppService

{

//...

}

ABP会自动注册它，因为它实现IApplicationService接口﴾它只是一个空的接口﴿。它会被注册为transient ﴾每次使用都创建实例﴿。

当你注入﴾使用构造函数注入﴿IPersonAppService接口成一个类，PersonAppService对象会被自动创建并传递给构造函数。

注意：命名约定在这里非常重要。例如你可以将名字PersonAppService改为 MyPersonAppService或另一个包

含“PersonAppService”后缀的名称，由于IPersonAppService包含这个后缀。但是你可以不遵循PeopleService命名你的服务

类。如果你这样做，它将不会为IPersonAppService自动注册﴾它需要自注册（self‐registration）到DI框架，而不是接口﴿，

所以，如果你想要你应该手动注册它。

ABP按照约定注册程序集。所以，你应该告诉ABP按照约定注册你的程序集。这很容易:

IocManager.RegisterAssemblyByConvention(Assembly.GetExecutingAssembly());

Assembly.GetExecutingAssembly﴾﴿得到一个对包括此代码的程序集的引用。你可以通过RegisterAssemblyByConvention方法注

册其他程序集。这同在你的模块初始化（AbpModule.Initialize﴾﴿）时完成。请查看ABP的模块系统获得更多信息。

你可以通过实现 IConventionalRegisterer 接口和调用 IocManager.AddConventionalRegisterer 方法编写自己的约定注册类。

你应该将它添加到模块的pre‐initialize方法中。

帮助接口(Helper interfaces)

你可以注册一个特定的类，不遵循传统的约定制度规则。ABP提供了 ITransientDependency和ISingletonDependency 接口的

快速实现方法。例如：

publicinterfaceIPersonManager

{

//...

}

publicclassMyPersonManager:IPersonManager,ISingletonDependency

{

//...

}

以这种方式，你可以很容易地注册MyPersonManager为transient。当需要注入IPersonManager时，MyPersonManager会被使

用。注意，依赖被声明为单例。因此，创建的MyPersonManager同一个对象被传递给所有需要的类。只是在第一次使用时创

建，那么应用程序的整生命周期使用的是同一实例。

自定义/直接注册(Custom/Direct registration)

如果之前描述的方法还是不足以应对你的情况，你可以使用 IocManager或者Castle Windsor 来注册你自己的类。

使用IocManager

你可以使用 IocManager 来注册依赖关系﴾这通常是在模块的PreInitialize方法中实现﴿：

IocManager.Register<IMyService,MyService>(DependencyLifeStyle.Transient);

使用Castle Windsor API

你也可以使用 IIocManager.IocContainer 属性来访问Windsor容器并且注册依赖关系。如下所示：

IocManager.IocContainer.Register(Classes.FromThisAssembly().BasedOn<IMySpecialInterface>().LifestylePerThread().WithServiceSelf

更多信息，请阅读Windsor文档。

这里没有删除之前实现IWindsorInstaller接口的翻译，因为我感觉这个非常有用。

也可以实现IWindsorInstaller接口进行注册。你可以在应用程序中创建一个实现IWindsorInstaller接口的类：

publicclassMyInstaller:IWindsorInstaller

{

publicvoidInstall(IWindsorContainercontainer,IConfigurationStorestore)

{

container.Register(Classes.FromThisAssembly().BasedOn<IMySpecialInterface>().LifestylePerThread().WithServiceSelf());

}

}

Abp自动发现和执行这个类。最后，你可以通过使用IIocManager.IocContainer属性得到WindsorContainer。

解析（Resolving）

注册通知IOC﴾控制反转﴿容器关于你的类，它们的依赖项和生命周期。在你的应用程序需要使用IOC容器创建对象时，ASP.NET

提供了一些方法解决依赖关系。

构造函数 & 属性注入(Constructor & Property Injection)

作为最佳实践，应该使用构造函数和属性注入去获取类的依赖。例子：

publicclassPersonAppService

{

publicILoggerLogger{get;set;}

privateIPersonRepository_personRepository;

publicPersonAppService(IPersonRepositorypersonRepository)

{

_personRepository=personRepository;

Logger=NullLogger.Instance;

}

publicvoidCreatePerson(stringname,intage)

{

Logger.Debug("Insertinganewpersontodatabasewithname="+name);

varperson=newPerson{Name=name,Age=age};

_personRepository.Insert(person);

Logger.Debug("Successfullyinserted!");

}

}

IPersonRepository从构造函数注入，ILogger实例从公共属性注入。这样，你的代码不会体现依赖注入系统。这是使用DI系统最

适当的方式。

IIocResolver，IIocManager以及IScopedIocResolver接口

有时可能需要直接创建所需的依赖项，而不是构造函数和属性注入。（应该尽可能避免这种情况）。Abp提供一些服务使得这

样的注入很容易实现。例子：

publicclassMySampleClass:ITransientDependency

{

privatereadonlyIIocResolver_iocResolver;

publicMySampleClass(IIocResolveriocResolver)

{

_iocResolver=iocResolver;

}

publicvoidDoIt()

{

//解析,使用并手动释放

varpersonService1=_iocResolver.Resolve<PersonAppService>();

personService1.CreatePerson(newCreatePersonInput{Name="Yunus",Surname="Emre"});

_iocResolver.Release(personService1);

//解析并使用using语法糖来释放资源

using(varpersonService2=_iocResolver.ResolveAsDisposable<PersonAppService>())

{

personService2.Object.CreatePerson(newCreatePersonInput{Name="Yunus",Surname="Emre"});

}

}

}

MySampleClass是一个应用程序的示例类。IIcResolver通过构造函数注入，然后用它来创建和释放对象。有几个解决方法的重

载可以根据需要使用。Release方法用于释放组件﴾对象﴿。如果你是手动创建一个对象，调用Release方法释放对象非常重要。否

则，你的应用程序会有内存泄漏问题。为了保证对象被释放，尽可能使用ResolveAsDisposable﴾就像上面的例子所示﴿。它会在

using代码块结束的时候自动调用Release方法。

IIocResolver﴾以及IIocManager﴿有个 CreateScope 的扩展方法﴾定义在Abp.Dependency命名空间﴿来安全的释放所有的解析后了

依赖资源。如下所示：

using(varscope=_iocResolver.CreateScope())

{

varsimpleObj1=scope.Resolve<SimpleService1>();

varsimpleObj2=scope.Resolve<SimpleService2>();

//...

}

在using语句块的最后，所有解析后的依赖资源会自动的释放。也可以使用 IScopedIocResolver 接口来实现上述操作。你能注

入该接口并解析依赖关系。当你使用的类被释放后，所有被解析的依赖资源也会被自动释放掉。但是，请小心使用它；例如：

如果该类的生命周期很长﴾如单例模式﴿，并且需要解析很多对象，那么它们会一直停留在内存中，直到该类被释放掉。

如果你想直接使用IOC容器﴾Castle Windsor﴿来处理依赖关系项，可以通过构造函数注入 IIocManager并使用它

IIocManager.IocContainer 属性。如果你是在一个静态上下文或不能注入IIocManager，还有最后一个方法，你可以使用单例对

象IocManager.Instance，你可以在任何地方获取到，它无处不在。但是，在这种情况下你的代码将变得不容易测试。

3.1.3 其他

1. IShouldInitialize 接口

有些类在第一次使用前需要初始化。IShouldInitialize有Initialize﴾﴿方法。如果你实现它，那么你的Initialize﴾﴿方法自动会被自动调

用在创建对象之后﴾在使用之前﴿。当然，为了使用这个特性，你应该注入/创建此对象。

2. ASP.NET MVC & ASP.NET Web API 集成

当然，我们必须调用依赖注入系统处理依赖关系图的根对象。在一个ASP.NET MVC应用程序，通常是一个控制器类。我们可以

使用构造函数注入模式注入控制器。当一个请求来到我们的应用程序中，控制器和所有依赖项被IOC容器递归创建。所以，谁

做了这些？这是被Abp扩展的ASP.NET MVC默认控制器工厂自动完成的。ASP.NET Web API 也是相似的。你不用关心对象的创

建和释放。

3. ASP.NET Core 集成

ASP.NET Core已经内置了依赖注入：Microsoft.Extensions.DependencyInjection。在ASP.NET Core中ABP使用

Castle.Windsor.MsDependencyInjection实现了依赖注入。所以你不需要考虑它。

4. 最后说明（Last notes）

Abp简化并自动使用依赖注入，只要你遵守规则和使用上面的结构。大多数时候这样就够了。但是如果不能满足你的需求，你

可以直接使用Castle Windsor的所有能力来执行任何任务﴾如自定义注册，注入钩子，拦截器等等﴿。

2.2 ABP公共结构 - 会话管理

2.2.1 简介

如果一个应用程序需要登录，则它必须知道当前用户执行了什么操作。因此ASP.NET在展示层提供了一套自己的SESSION会话

对象，而ABP则提供了一个可以在任何地方获取当前用户和租户的IAbpSession接口

注意：关于IAbpSession接口：需要获取会话信息则必须实现IAbpSession接口。虽然你可以用自己的方式去实现它

（IAbpSession），但是它在module‐zero项目中已经有了完整的实现。

IAbpSession也被集成且使用在ABP其他模块中，例如：设置管理，权限认证。

2.2.2 注入会话

IAbpSession通常是以属性注入的方式存在于需要它的类中，不需要获取会话信息的类中则不需要它。如果我们使用属性注入方

式，我们可以用NullAbpSession.Instance作为默认值来初始化它（IAbpSession），如下所示：

publicclassMyClass:ITransientDependency

{

publicIAbpSessionAbpSession{get;set;}

publicMyClass()

{

AbpSession=NullAbpSession.Instance;

}

publicvoidMyMethod()

{

varcurrentUserId=AbpSession.UserId;

//...

}

}

由于授权是应用层的任务，因此我们应该在应用层和应用层的上一层使用IAbpSession（我们不在领域层使用IAbpSession是很

正常的）。

ApplicationService, AbpController 和 AbpApiController 这3个基类已经注入了AbpSession属性，因此在Application Service的实

例方法中，能直接使用AbpSession属性。

2.2.3 使用会话属性

AbpSession定义的一些关键属性：

UserId：当前用户的标识ID，如果没有当前用户则为null。如果调用的代码是已授权，那么它不可能为空。

TenantId：当前租户的标识ID，如果没有当前租户则为null﴾如果用户没有登录或者他是一个Host用户﴿。

ImpersonatorUserId：模拟用户的标识ID，如果当前会话被其他用户模拟登录。如果不是一个模拟登录，那么该值为空。

ImpersonatorTenantId：模拟用户租户的标识ID，如果当前会话被其他用户模拟登录。如果不是一个模拟登录，那么该值

为空。

MultiTenancySide：可能是Host或Tenant。

UserId和TenantId是可空类型。当然也提供了不为空时获取数据的 GetUserId() 和 GetTenantId() 方法。当你确定有当前用户

时，你可以使用GetUserId﴾﴿方法。

如果当前用户为空，使用该方法则会抛出一个异常。GetTenantId﴾﴿的使用方式和GetUserId﴾﴿类似。

模拟属性不像其它通用属性一样用于审计日志。

2.2.4 User Identifier

你可以使用 ToUserIdentifier() 扩展方法从IAbpSession创建一个UserIdentifier对象。因为UserIdentifier被大多数API使用，所以

使用该方法可以很方便的为当前用户创建一个UserIdentifier。

2.3 ABP公共结构 - 缓存管理

2.3.1 简介

ABP给出了一个抽象缓存基类。并在内部使用了该抽象基类。使用 MemoryCache 来实现了该抽象基类。它能够被任何其它的

缓存类来扩展。Abp.RedisCache 包就扩展了该缓存基类。

2.3.2 ICacheMananger

ABP对外提供了一个缓存接口ICacheMananger。我们通过构造函数注入这个接口来获取缓存。示例如下：

publicclassTestAppService:ApplicationService

{

privatereadonlyICacheManager_cacheManager;

publicTestAppService(ICacheManagercacheManager)

{

_cacheManager=cacheManager;

}

publicItemGetItem(intid)

{

//取得缓存

return_cacheManager

.GetCache("MyCache")

.Get(id.ToString(),()=>GetFromDatabase(id))asItem;

}

publicItemGetFromDatabase(intid)

{

//...从数据库中检索数据

}

}

在这个示例中，我们注入了 ICacheManager接口，并且获取了一个名称为MyCache的缓存。缓存的名字是大小写敏感的，那就

是"MyCache"和"MYCACHE"取得的缓存内容是不同的。

注意：GetCache方法千万不要在你的构造函数中使用GetCache方法。如果类不是一个单例对象那么该缓存可能会被

dispose掉。

2.3.3 ICache

ICacheManager.GetCache方法返回了一个ICache对象。每一个缓存都是基于名称单例存在的。只有首次访问时才会被创建，以

后你每次用相同的名称去获取的缓存都是相同的。所以我们可以在不同的类中使用相同的名称来共享相同的缓存。

在示例代码中，我们简单的使用了ICache.Get 方法，它有两个参数：

key : 要获取的缓存项的唯一标识符

factory：如果根据给定的key获取到的缓存项为空，那么factory将会创建一个标识符为key的缓存，并且返回该缓存

ICache接口还有其它方法，例如：GetOrDefault，Set，Remove和Clear。当然也有这些方法的异步﴾async﴿版本。

2.3.4 ITypedCache

ICache 接口用key﴾字符串类型﴿来获取缓存value﴾object类型﴿。ITypedCache 为ICahe提供了一个类型安全的包装；为了使类型

安全转换﴾ICache到ITypedCache﴿，我们可以用扩展方法 AsTyped，而不需要写其它强制类型转换的代码，如下所示：

ITypedCache<int,Item>myCache=_cacheManager.GetCache("MyCache").AsTyped<int,Item>();

2.3.5 Configuration

缓存的过期时间默认是60分钟。它是变化的。如果你在60分钟内没有使用该缓存，该缓存会被自动的移除。如果你想改变所有

的缓存或者指定的缓存来的默认过期时间，你可以这样做，实现如下：

//对所有缓存的配置

Configuration.Caching.ConfigureAll(cache=>

{

cache.DefaultSlidingExpireTime=TimeSpan.FromHours(2);

});

//对指定缓存的配置

Configuration.Caching.Configure("MyCache",cache=>

{

cache.DefaultSlidingExpireTime=TimeSpan.FromHours(8);

});

剩余153页未读，继续阅读

jishufangui

粉丝: 3
资源: 4

ASP.NET Boilerplate：通用WEB应用框架与项目模板简介

.NET Core实现分表分库、读写分离的通用 Repository功能

abp 项目 demo

abp框架说明

如何优化abp 本地化

abp应用程序中Dapper与Entity Framework Core一起使用

abp vnext 和volo abp vnext 有区别吗

abp vnext 种子数据

abp uniapp

abp vnext 商业版

visual studio 搭建ABP

abp rabbitmq

如何查看我使用的abp的版本

abp多租户怎么实现

创建一个ABP框架的空解决方案

abp sqlsugar

abp tenant代码实现

abp框架使用kafka

Abp VNext前后端分离项目实践

abp-vnex eventbus如何使用？

ABP Java 连接地址

最新资源