ABP框架系列之九：(Abp-Session-会话)

Introduction

ASP.NET Boilerplate provides IAbpSession interface to obtain current user and tenant without using ASP.NET's Session. IAbpSession is also fully integrated and used by other structures in ASP.NET Boilerplate (setting system and authorization system for instance).

ASP.NET样板提供iabpsession接口获取当前用户和租户不使用ASP。NET的会话。iabpsession也完全集成的ASP.NET样板其他结构（设置系统和授权系统为例）。

Injecting Session（会话注入）

IAbpSession is generally property injected to needed classes unless it's not possible to work without session informations. If we use property injection, we can use NullAbpSession.Instance as default value as shown below:

iabpsession一般属性注入所需的类除非没有会话信息的工作是不可能的。如果我们使用属性注入，我们可以用nullabpsession。例如默认值，如下图所示：

public class MyClass : ITransientDependency
{
    public IAbpSession AbpSession { get; set; }

    public MyClass()
    {
        AbpSession = NullAbpSession.Instance;
    }

    public void MyMethod()
    {
        var currentUserId = AbpSession.UserId;
        //...
    }
}

Since authentication/authorization is an application layer task, it's adviced to use IAbpSession in application layer and upper layers (we don't use it in domain layer normally). ApplicationService, AbpController,AbpApiController and some other base classes has AbpSession already injected. So, you can directly use AbpSession property in an application service method for instance.

因为认证/授权是一个应用层的任务，这是建议使用iabpsession在应用层和上层（我们不使用它在域层通常）。applicationservice，abpcontroller abpapicontroller and some other基础类，有abpsession已经注入。所以，你可以直接使用abpsession property 在应用服务的方法的实例中。

Session Properties（会话属性）

AbpSession defines a few key properties:

• UserId: Id of the current user or null if there is no current user. It can not be null if the calling code is authorized.
• 如果没有当前用户，则当前用户ID或NULL。如果调用代码被授权，它不能为空。
• TenantId: Id of the current tenant or null if there is no current tenant (in case of user has not logged in or he is a host user).
• 如果没有当前租户（在用户未登录或他是主机用户的情况下），则当前租户的ID或NULL。
• ImpersonatorUserId: Id of the impersonator user if current session is impersonated by another user. It's null if this is not an impersonated login.
• 身份证模拟用户如果当前会话是由模拟另一个用户。如果这不是一个模拟登录它的空。
• ImpersonatorTenantId: Id of the impersonator user's tenant, if current session is impersonated by another user. It's null if this is not an impersonated login.
• 身份证模拟用户的租户，如果当前会话是由模拟另一个用户。如果这不是一个模拟登录它的空。
• MultiTenancySide: It may be Host or Tenant.
• 可能是主机或租户。

UserId and TenantId is nullable. There is also non-nullable GetUserId() and GetTenantId() methods. If you're sure there is a current user, you can call GetUserId(). If current user is null, this method throws exception. GetTenantId() is also similar.

Impersonator properties are not common as other properties and generally used for audit logging purposes.

UserId 和TenantId可以是空。也有非空getuserid()和gettenantid()方法。
如果你确信有一个当前用户，你可以调用getuserid()。
如果当前用户为null，则此方法引发异常。gettenantid()也类似。

模拟的属性是不常见的其他属性，一般用于日志审计的目的。

ClaimsAbpSession

ClaimsAbpSession is the default implementation of IAbpSession interface. It gets session properties (except MultiTenancySide, it's calculated) from claims of current user's princical. For a cookie based form authentication, it gets from cookies. Thus, it' well integrated to ASP.NET's authentication mechanism.

claimsabpsession是iabpsession接口的默认实现。它获取会话属性（除multitenancyside，它计算）从当前的主要用户。对于基于cookie的表单身份验证，它来自cookie。因此，它很好地集成到ASP.NET的身份验证机制中。

Overriding Current Session Values（重写当前会话值）

In some specific cases, you may need to change/override session values for a limited scope. In such cases, you can use IAbpSession.Use method as shown below:

在某些特定的情况下，您可能需要更改/覆盖有限范围的会话值。在这种情况下，你可以使用iabpsession。使用方法如下图所示：

public class MyService
{
    private readonly IAbpSession _session;

    public MyService(IAbpSession session)
    {
        _session = session;
    }

    public void Test()
    {
        using (_session.Use(42, null))
        {
            var tenantId = _session.TenantId; //42
            var userId = _session.UserId; //null
        }
    }
}

Use method returns an IDisposable and it must be disposed. Once the return value is disposed, Session values are automatically restored the to previous values.

使用方法返回一个IDisposable，必须设置。一旦返回值被处理，会话值将自动恢复到以前的值。

Warning!

Always use it in a using block as shown above. Otherwise, you may get unexpected session values. You can have nested Use blocks and they will work as you expect.

始终在使用块中使用它，如上所示。否则，您可能会获得意外的会话值。可以使用嵌套的块，它们将按照您的预期工作。

User Identifier（用户标示符）

You can use .ToUserIdentifier() extension method to create a UserIdentifier object from IAbpSession. Since UserIdentifier is used in most API, this will simplify to create a UserIdentifier object for the current user.

你可以使用。touseridentifier()扩展方法来创建一个对象从iabpsession useridentifier。因为useridentifier用的最多的就是API，这将简化创建当前用户useridentifier对象。