异步 WCF 结束方法中的错误 Thread.CurrentPrincipal

Question

我有一个 WCF 服务，它的 Thread.CurrentPrincipal 设置在 ServiceConfiguration.ClaimsAuthorizationManager 中。

当我像这样异步实现服务时：

    public IAsyncResult BeginMethod1(AsyncCallback callback, object state)
    {
        // Audit log call (uses Thread.CurrentPrincipal)

        var task = Task<int>.Factory.StartNew(this.WorkerFunction, state);

        return task.ContinueWith(res => callback(task));
    }

    public string EndMethod1(IAsyncResult ar)
    {
        // Audit log result (uses Thread.CurrentPrincipal)

        return ar.AsyncState as string;
    }

    private int WorkerFunction(object state)
    {
        // perform work
    }

我发现 Thread.CurrentPrincipal 在 Begin-method 和 WorkerFunction 中设置为正确的 ClaimsPrincipal，但在 End-method 中设置为 GenericPrincipal。

我知道我可以为服务启用 ASP.NET 兼容性并使用 HttpContext.Current.User，它在所有方法中都具有正确的主体，但我不想这样做。

有没有办法在不打开 ASP.NET 兼容性的情况下强制 Thread.CurrentPrincipal 使用正确的 ClaimsPrincipal？

Answer 1

从summary of WCF extension points 开始，您会看到专为解决您的问题而设计的那个。它被称为CallContextInitializer。看看这个article which gives CallContextInitializer sample code。

如果您进行 ICallContextInitializer 扩展，您将获得对 BeginXXX 线程上下文和 EndXXX 线程上下文的控制权。您是说 ClaimsAuthorizationManager 在您的 BeginXXX(...) 方法中正确建立了用户主体。在这种情况下，您然后为自己创建一个自定义 ICallContextInitializer，它分配或记录 CurrentPrincipal，具体取决于它是处理您的 BeginXXX() 还是 EndXXX()。比如：

public object BeforeInvoke(System.ServiceModel.InstanceContext instanceContext, System.ServiceModel.IClientChannel channel, System.ServiceModel.Channels.Message request){
    object principal = null;
    if (request.Properties.TryGetValue("userPrincipal", out principal))
    {
        //If we got here, it means we're about to call the EndXXX(...) method.
        Thread.CurrentPrincipal = (IPrincipal)principal;
    }
    else
    {
        //If we got here, it means we're about to call the BeginXXX(...) method.
        request.Properties["userPrincipal"] = Thread.CurrentPrincipal;            
    }
    ...
 }

为了进一步澄清，请考虑两种情况。假设您同时实现了 ICallContextInitializer 和 IParameterInspector。假设这些挂钩预计将与同步 WCF 服务和异步 WCF 服务一起执行（这是您的特殊情况）。

以下是事件的顺序和对正在发生的事情的解释：

同步案例

ICallContextInitializer.BeforeInvoke();
IParemeterInspector.BeforeCall();
//...service executes...
IParameterInspector.AfterCall();
ICallContextInitializer.AfterInvoke();

上面的代码没什么奇怪的。但是现在看看下面异步服务操作会发生什么......

异步案例

ICallContextInitializer.BeforeInvoke();  //TryGetValue() fails, so this records the UserPrincipal.
IParameterInspector.BeforeCall();
//...Your BeginXXX() routine now executes...
ICallContextInitializer.AfterInvoke();

//...Now your Task async code executes (or finishes executing)...

ICallContextInitializercut.BeforeInvoke();  //TryGetValue succeeds, so this assigns the UserPrincipal.
//...Your EndXXX() routine now executes...
IParameterInspector.AfterCall();
ICallContextInitializer.AfterInvoke();

如您所见，CallContextInitializer 确保您有机会在 EndXXX() 例程运行之前初始化诸如 CurrentPrincipal 之类的值。因此，EndXXX() 例程确实在与 BeginXXX() 例程不同的线程上执行并不重要。是的，System.ServiceModel.Channels.Message 对象在 Begin/End 方法之间存储您的用户主体，即使线程发生更改，WCF 也会保留并正确传输。

总体而言，这种方法允许您的 EndXXX(IAsyncresult) 使用正确的 IPrincipal 执行，而无需在 EndXXX() 例程中显式地重新建立 CurrentPrincipal。与任何 WCF 行为一样，您可以决定这是否适用于单个操作、合同上的所有操作或端点上的所有操作。

Answer 2

并不是我的问题的真正答案，而是实现 WCF 服务（在 .NET 4.5 中）的另一种方法，它不会出现与 Thread.CurrentPrincipal 相同的问题。

    public async Task<string> Method1()
    {
        // Audit log call (uses Thread.CurrentPrincipal)

        try
        {
            return await Task.Factory.StartNew(() => this.WorkerFunction());
        }
        finally 
        {
            // Audit log result (uses Thread.CurrentPrincipal)
        }
    }

    private string WorkerFunction()
    {
        // perform work
        return string.Empty;
    }

Answer 3

对此的有效方法是创建一个扩展：

public class SLOperationContext : IExtension<OperationContext>
{
    private readonly IDictionary<string, object> items;

    private static ReaderWriterLockSlim _instanceLock = new ReaderWriterLockSlim();

    private SLOperationContext()
    {
        items = new Dictionary<string, object>();
    }

    public IDictionary<string, object> Items
    {
        get { return items; }
    }

    public static SLOperationContext Current
    {
        get
        {
            SLOperationContext context = OperationContext.Current.Extensions.Find<SLOperationContext>();
            if (context == null)
            {
                _instanceLock.EnterWriteLock();
                context = new SLOperationContext();
                OperationContext.Current.Extensions.Add(context);
                _instanceLock.ExitWriteLock();
            }
            return context;
        }
    }

    public void Attach(OperationContext owner) { }
    public void Detach(OperationContext owner) { }
}

现在这个扩展被用作你想要在线程切换之间持久化的对象的容器，因为 OperationContext.Current 将保持不变。

现在您可以在 BeginMethod1 中使用它来保存当前用户：

SLOperationContext.Current.Items["Principal"] = OperationContext.Current.ClaimsPrincipal;

然后在 EndMethod1 中你可以通过输入获取用户：

ClaimsPrincipal principal = SLOperationContext.Current.Items["Principal"];

编辑（另一种方法）：

public IAsyncResult BeginMethod1(AsyncCallback callback, object state)
{
    var task = Task.Factory.StartNew(this.WorkerFunction, state);

    var ec = ExecutionContext.Capture();

    return task.ContinueWith(res =>
        ExecutionContext.Run(ec, (_) => callback(task), null));
}