C#并行场景下UserCredential刷新令牌出现文件占用错误的问题咨询

问题原因 #

报错的核心是Google官方提供的默认FileDataStore没有实现并发读写控制，并行请求场景下多个线程同时触发令牌刷新操作时，会同时尝试写入同一份令牌缓存文件，触发系统层面的文件占用锁冲突。

解决方案 #

你不需要完全自行实现整套凭据管理逻辑，按优先级选以下方案即可：

1. 全局复用UserCredential实例（推荐，改动最小） #

不要每次请求都调用GetCredentialByJSONAsync创建新的凭据实例，将初始化好的UserCredential做成应用全局单例复用即可。Google的UserCredential内部已经实现了令牌刷新的线程安全逻辑，只会有一个线程执行刷新操作，不会出现并发写文件的问题。
单例实现参考：

// 全局静态实例
private static UserCredential _globalCredential;
private static readonly object _initLock = new object();

private async Task<UserCredential> GetSingletonCredentialAsync(FileInfo clientSecrets)
{
    if (_globalCredential == null)
    {
        lock (_initLock)
        {
            if (_globalCredential == null)
            {
                using (var stream = new FileStream(clientSecrets.FullName, FileMode.Open, FileAccess.Read))
                {
                    var secrets = GoogleClientSecrets.Load(stream).Secrets;
                    var credentialsDS = new FileDataStore(_credentials, true);
                    _globalCredential = await GoogleWebAuthorizationBroker.AuthorizeAsync(
                        secrets,
                        _scopes,
                        "user",
                        CancellationToken.None,
                        credentialsDS);
                }
            }
        }
    }
    return _globalCredential;
}

2. 替换线程安全的IDataStore实现 #

如果业务场景需要创建多个凭据实例，你可以自行实现Google.Apis.Util.Store.IDataStore接口，在读写存储的时候加锁控制并发，替换掉默认的FileDataStore即可，原有凭据管理逻辑不需要改动。
线程安全FileDataStore实现参考：

public class ThreadSafeFileDataStore : IDataStore
{
    private readonly FileDataStore _innerStore;
    private readonly object _lockObj = new object();

    public ThreadSafeFileDataStore(string folder, bool fullPath = false)
    {
        _innerStore = new FileDataStore(folder, fullPath);
    }

    public Task StoreAsync<T>(string key, T value)
    {
        lock (_lockObj)
        {
            return _innerStore.StoreAsync(key, value);
        }
    }

    public Task<T> GetAsync<T>(string key)
    {
        lock (_lockObj)
        {
            return _innerStore.GetAsync<T>(key);
        }
    }

    public Task DeleteAsync<T>(string key)
    {
        lock (_lockObj)
        {
            return _innerStore.DeleteAsync<T>(key);
        }
    }

    public Task ClearAsync()
    {
        lock (_lockObj)
        {
            return _innerStore.ClearAsync();
        }
    }
}

初始化凭据的时候把new FileDataStore(_credentials, true)换成new ThreadSafeFileDataStore(_credentials, true)即可。

3. 适配Web场景替换存储介质 #

FileDataStore本身更适合桌面客户端场景，Web应用场景你可以直接实现IDataStore接口，把令牌存在数据库、分布式缓存等介质中，从根源上避免文件IO冲突，也更适配Web应用的分布式部署需求。

内容的提问来源于stack exchange，提问作者ryan86pika