ApplicationSettingsBase ConfigurationErrorsException多个程序集

时间:2016-12-19 10:46:55

标签: c# .net wpf .net-assembly applicationsettingsbase

更新问题(正确指出问题)

我正在使用lib,它实现了一个派生自ApplicationSettingsBase

的类
namespace MyLib {
    public sealed class GlobalLibSettings : ApplicationSettingsBase
    {
        [UserScopedSetting, DefaultSettingValue("true")]
        public bool SimpleProperty{
            get { return (bool) this["SimpleProperty"]; }
            set {
                this["SimpleProperty"] = value;
                Save();
            }
        }
    }
}

现在我在另一个项目中使用这个lib。这些项目还包含至少一个派生自ApplicationSettingsBase

的类
namespace MyProject {
    public sealed class ProjectSettings : ApplicationSettingsBase
    {
        [UserScopedSetting, DefaultSettingValue("true")]
        public bool AnotherProperty{
            get { return (bool) this["AnotherProperty"]; }
            set {
                this["AnotherProperty"] = value;
                Save();
            }
        }
    }
}

现在,这两个类派生自ApplicationSettingsBase,将其属性存储到同一个user.config文件中。应用程序和lib使用多个任务,如果两个任务同时执行(例如)属性setter,则会出现以下异常。这两个任务都试图同时执行写操作......

System.Configuration.ConfigurationErrorsException occurred
  BareMessage=Beim Laden einer Konfigurationsdatei ist ein Fehler aufgetreten.: Der Prozess kann nicht auf die Datei "... _xneb3g43uoxqiagk4ge5e4hea1vxlina\1.0.4.862\user.config" zugreifen, da sie von einem anderen Prozess verwendet wird.
  Filename=..._xneb3g43uoxqiagk4ge5e4hea1vxlina\1.0.4.862\user.config
  HResult=-2146232062
  Line=0
  Message=Beim Laden einer Konfigurationsdatei ist ein Fehler aufgetreten.: Der Prozess kann nicht auf die Datei "..._xneb3g43uoxqiagk4ge5e4hea1vxlina\1.0.4.862\user.config" zugreifen, da sie von einem anderen Prozess verwendet wird. (..._xneb3g43uoxqiagk4ge5e4hea1vxlina\1.0.4.862\user.config)
  Source=System.Configuration
  StackTrace:
       bei System.Configuration.ConfigurationSchemaErrors.ThrowIfErrors(Boolean ignoreLocal)
  InnerException: 
       HResult=-2147024864
       Message=Der Prozess kann nicht auf die Datei "_xneb3g43uoxqiagk4ge5e4hea1vxlina\1.0.4.862\user.config" zugreifen, da sie von einem anderen Prozess verwendet wird.
       Source=mscorlib
       StackTrace:
            bei System.IO.__Error.WinIOError(Int32 errorCode, String maybeFullPath)
            bei System.IO.FileStream.Init(String path, FileMode mode, FileAccess access, Int32 rights, Boolean useRights, FileShare share, Int32 bufferSize, FileOptions options, SECURITY_ATTRIBUTES secAttrs, String msgPath, Boolean bFromProxy, Boolean useLongPath, Boolean checkHost)
            bei System.IO.FileStream..ctor(String path, FileMode mode, FileAccess access, FileShare share)
            bei System.Configuration.Internal.InternalConfigHost.StaticOpenStreamForRead(String streamName)
            bei System.Configuration.Internal.InternalConfigHost.System.Configuration.Internal.IInternalConfigHost.OpenStreamForRead(String streamName, Boolean assertPermissions)
            bei System.Configuration.Internal.InternalConfigHost.System.Configuration.Internal.IInternalConfigHost.OpenStreamForRead(String streamName)
            bei System.Configuration.ClientConfigurationHost.OpenStreamForRead(String streamName)
            bei System.Configuration.BaseConfigurationRecord.RefreshFactoryRecord(String configKey)

我可以通过以下方案重现它:

var settings1 = new GlobalLibSettings ();
var settings2 = new ProjectSettings ();
Task.Factory.StartNew(()=>{
    while(true) settings1.SimpleProperty = !settings1.SimpleProperty;
});
Task.Factory.StartNew(()=>{
    while(true) settings2.AnotherProperty = !settings2.AnotherProperty;
});

现在我正在寻找一种实现来保护对user.config文件的访问。

解决方案:

我找到了一个有效的解决方案。 CustomApplicationSettingsBase锁定并发任务。

public sealed class GlobalLibSettings : CustomApplicationSettingsBase

public sealed class ProjectSettings : CustomApplicationSettingsBase

namespace MyLib {
    public static class LockProvider
    {
        public static object AppSettingsLock { get; } = new object();
    }

    public class CustomApplicationSettingsBase : ApplicationSettingsBase
    {
        public override object this[string propertyName] {
            get {
                lock (LockProvider.AppSettingsLock) {
                    return base[propertyName];
                }
            }
            set {
                lock (LockProvider.AppSettingsLock) {
                    base[propertyName] = value;
                }
            }
        }
        public override void Save() {
            lock (LockProvider.AppSettingsLock) {
                base.Save();
            }
        }
        public override void Upgrade() {
            lock (LockProvider.AppSettingsLock) {
                base.Upgrade();
            }
        }
    }
}

感谢您的帮助!

3 个答案:

答案 0 :(得分:4)

有一个很多不喜欢System.Configuration,但它并没有弄错这个细节。您可以在Reference Source中看到的内容,文件打开时使用:

 return new FileStream(streamName, FileMode.Open, FileAccess.Read, FileShare.Read);

如此简单的读取访问和使用FileShare.Read允许其他人也从文件中读取。因此,任何线程都可能触发此代码,您无法获得文件共享异常。

因此,您尝试的解决方案无法解决问题。使用提供的信息找到另一种解释将很困难。在一个隐藏得很好的文件上很难产生共享冲突。唯一可信的解释是另一个线程正在同时写入文件。换句话说,执行Save()方法。

你必须非常不走运。但这在技术上是可行的。使用Debug> Windows>线程调试器窗口以查看其他线程正在做什么,您应该在其中一个堆栈跟踪中看到Save()方法调用。唯一的另一个可能的怪癖是环境,不安全的反恶意软件可以在扫描文件时任意使文件无法访问。

最后但并非最不重要的是,你完成这项工作并不是很明显。只有解决方案的EXE项目才能使用.config文件。获取DLL使用设置需要很多非显而易见的hanky-panky。我们不知道您做了什么,请务必使用这些详细信息更新您的问题。真的最好不要这样做。

答案 1 :(得分:1)

问题可能在于您有多个GlobalAppSettings实例同时使用的事实。这意味着可能有多个线程试图读取/写入同一个文件,这导致了重复。

带锁的解决方案不起作用,因为_locker对象不在GlobalAppSettings的不同实例之间共享。

我看到以下解决方案。首先,您可以在第二次编辑中执行某些操作,即使用静态对象同步对设置的访问。但是,我更喜欢第二种解决方案。尝试将CustomApplicationSettingsBase实现为单身人士。或者甚至更好地使用依赖注入来注入需要它的CustomApplicationSettingsBase实例,并告诉DI容器CustomApplicationSettingsBase应该是单例。

答案 2 :(得分:0)

这是一个允许程序的多个副本同时运行的解决方案,例如,它在多线程支持之上添加了多进程支持。最后保存的程序将“获胜”。如果在程序 1 保存后程序 2 保存了相同的设置。程序 1 不会收到有关新值的通知。

根据您使用的这些设置,这可能不是问题。例如,如果您要保存最大化的窗口状态,或类似的小事,此解决方案效果很好。

如果您希望新保存的值重新加载到第二个实例中,您可以在每个 getter 函数中手动调用 Settings.Default.Reload() 以确保每次访问时都重新加载它。这显然会增加相当多的开销,因此只有在您确实需要时才这样做。

如果当前有异常,我什么都不做,但您也可以添加一些错误处理。

这使用了一个命名的 eventWaitHandle。通过使用命名事件句柄,它将允许您执行多进程锁定。通过将其设置为 AutoReset,它会在程序崩溃/退出等情况下自动解锁,使用起来非常安全。

锁名称是 .config 文件的名称。如果您使用的是共享的 .config 文件,那么您应该将锁的名称更新为一个常量值,而不是使用执行路径。

我还在 LockConfigSettings() 函数中包含了一个超时,这样它就不会无限锁定,但最终还是会尝试导致崩溃(如果它确实仍然被锁定)或者它会继续。

public class ConfigSettings : IConfigSettings
{
    private readonly EventWaitHandle _configSettingsLock = new EventWaitHandle(true, EventResetMode.AutoReset, MakeStringPathSafe(Path.Combine(Path.GetDirectoryName(Assembly.GetEntryAssembly().Location), "program.exe.config")));


    public string SettingOne
    {
        set
        {
            LockConfigSettings();
            try 
            { 
                Properties.Settings.Default.SettingOne = value; 
                Properties.Settings.Default.Save();
            } 
            catch { }
            finally { ReleaseSettingsLock(); }
        }
        get
        {
            LockConfigSettings();
            try 
            { 
                return Properties.Settings.Default.SettingOne; 
            } 
            catch 
            { 
                return null; 
            }
            finally 
            { 
                ReleaseSettingsLock(); 
            }
                
        }
    }
    
    public string SettingTwo
    {
        set
        {
            LockConfigSettings();
            try 
            { 
                Properties.Settings.Default.SettingTwo = value; 
                Properties.Settings.Default.Save();
            } 
            catch { }
            finally { ReleaseSettingsLock(); }
        }
        get
        {
            LockConfigSettings();
            try 
            { 
                return Properties.Settings.Default.SettingTwo; 
            } 
            catch 
            { 
                return null; 
            }
            finally 
            { 
                ReleaseSettingsLock(); 
            }
                
        }
    }
    
    private void LockConfigSettings()
    {
        //In case we are debugging we make it infinite as the event handle will still count when the debugger is paused
        if (Debugger.IsAttached)
        {
            if (!_configSettingsLock.WaitOne())
                throw new InvalidOperationException($"Failed to lock program.exe.config due to timeout. Please try closing all instances of program.exe via task manager.");
        }
        else
        {
            //After 15 seconds stop waiting. This will ensure you get a crash or something other than an infinite wait.
            //This should only occur if the other application holding the lock has been paused in a debugger etc.
            if (!_configSettingsLock.WaitOne(15000))
                throw new InvalidOperationException($"Failed to lock program.exe.config due to timeout. Please try closing all instances of program.exe via task manager.");
        }
    }
    
    private void ReleaseSettingsLock()
    {
        try
        {
            _configSettingsLock.Set();
        }
        catch (Exception e)
        {
            throw new Exception($"Failed to release program.exe.config lock due to error");
        }
    }

    public static string MakeStringPathSafe(string path)
    {
        if (path == null) return path;

        path = path.Replace("//", "_");
        path = path.Replace("/", "_");
        path = path.Replace("\\", "_");
        path = path.Replace(@"\", "_");
        path = path.Replace(@"\\", "_");
        path = path.Replace(":", "-");
        path = path.Replace(" ", "-");
        return path;
    }

}