升级.NET后WPF项目LocalDb连接|DataDirectory|路径失效如何解决

问题根因 #

.NET Framework默认会自动初始化应用程序域的DataDirectory属性，SQL Server连接驱动可以自动解析|DataDirectory|占位符为对应路径。而.NET 5属于.NET Core生态，没有默认设置该属性，导致占位符无法被识别，抛出Invalid value for key 'attachdbfilename'错误。 #

解决方案 #

步骤1：程序启动时手动配置DataDirectory #

在WPF应用的启动入口（通常是App.xaml.cs的OnStartup方法）添加代码，手动给DataDirectory赋值，确保这段代码在第一次访问数据库之前执行：

using System.IO;
using System.Windows;

namespace LedgerCommander
{
    public partial class App : Application
    {
        protected override void OnStartup(StartupEventArgs e)
        {
            base.OnStartup(e);
            // 方案A：将DataDirectory设置为程序运行目录（和你测试正常的绝对路径根目录一致）
            string runDir = AppContext.BaseDirectory;
            AppDomain.CurrentDomain.SetData("DataDirectory", runDir);

            /* 方案B：如果要将数据库文件存到用户文档目录避免权限问题，用如下代码
            string docDir = Environment.GetFolderPath(Environment.SpecialFolder.MyDocuments);
            string appDbDir = Path.Combine(docDir, "LedgerCommander", "Data");
            // 自动创建目录避免路径不存在报错
            Directory.CreateDirectory(appDbDir);
            AppDomain.CurrentDomain.SetData("DataDirectory", appDbDir);
            */
        }
    }
}

步骤2：保留原有连接字符串逻辑 #

你的连接字符串构建代码不需要做任何修改，继续使用|DataDirectory|占位符即可：

var sqlConnectionStringBuilder = new SqlConnectionStringBuilder
{
    DataSource = @"(LocalDB)\MSSQLLocalDB",
    AttachDBFilename = $"|DataDirectory|\\Lc Db {userName}.mdf",
    IntegratedSecurity = true
};

注意事项 #

• 确保DataDirectory指向的路径对当前运行用户开放读写权限，否则会出现数据库文件访问错误
• 如果你需要和.NET Framework版本的程序共用数据库文件，要保证DataDirectory的赋值和.NET Framework默认的路径规则一致
• 如果你是打包发布的应用，不要将DataDirectory设置到程序安装目录（通常是C盘Program Files下），该目录默认没有写入权限，建议设置到ApplicationData或者MyDocuments等用户可写目录

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