基于EDMX的EF6旧项目能否简化带metadata的连接字符串？

项目背景 #

我正在维护一个有10余年历史的C# API项目，已升级至.NET Framework 4.8和EF6，但仍沿用旧版EF连接字符串。

DbContext代码实现 #

public partial APIEntities : DbContext
{
    public APIEntities()
            : base("name=APIEntitiesConnection")
    {
    }
    
    protected override void OnModelCreating(DbModelBuilder modelBuilder)
    {
        throw new UnintentionalCodeFirstException();
    }
    
    public virtual DbSet<Object1> List1 { get; set; }
    public virtual DbSet<Object2> List2 { get; set; }
    public virtual DbSet<Object3> List3 { get; set; }
    //etc...
}

配置文件中的连接字符串 #

<add name="APIEntitiesConnection" 
     connectionString="metadata=res://*/DB_Api.csdl|res://*/DB_Api.ssdl|res://*/DB_Api.msl;
                       provider=System.Data.SqlClient;
                       provider connection string=&quot;data source=ServerName;
                       initial catalog=DB_Api;persist security info=True;
                       user id=userName;password=password; 
                       MultipleActiveResultSets=True;App=EntityFramework&quot;" 
     providerName="System.Data.EntityClient" />

疑问与尝试 #

1. 这个连接字符串为何如此冗长？嵌套的子连接字符串、metadata、provider这些参数是否必需？
2. 尝试改用普通SQL连接字符串：

"Server=ServerName;Database=DataBaseName;User Id=userId;Password=password;MultipleActiveResultSets=true;"

但触发了UnintentionalCodeFirstException错误，提示必须使用Entity Framework连接字符串。
3. 项目没有Startup文件，能否简化这个连接字符串？是否需要重构.edmx文件？

解答 #

连接字符串格式的原因 #

你当前使用的是EF Database First/Model First模式（基于EDMX文件）的标准连接字符串，各参数作用不可替代：

• metadata：指定EF依赖的模型元数据文件（CSDL=概念模型、SSDL=存储模型、MSL=映射文件），这些是EDMX编译后嵌入程序集的资源，EF必须通过它找到模型与数据库的映射关系。
• provider：指定数据驱动类型（这里是SQL Server的System.Data.SqlClient），告诉EF用哪个组件连接数据库。
• provider connection string：嵌套的是底层SQL Server的核心连接参数，包含数据库地址、认证信息等。

普通连接字符串报错的原因 #

你的APIEntities类在OnModelCreating中抛出UnintentionalCodeFirstException，这是EDMX模式的典型写法——用来阻止EF误触发Code First初始化逻辑。当传入普通SQL连接字符串时，EF默认会尝试启动Code First流程，这个异常直接中断了该流程，因此报错。

能否简化连接字符串？ #

可以做部分简化，但EDMX模式依赖的双层结构和metadata无法省略：

1. 简化metadata路径：如果项目只有一个EDMX文件，可用res://*/代替具体文件名，EF会自动扫描程序集内的所有元数据资源：

<add name="APIEntitiesConnection" 
     connectionString="metadata=res://*/;
                       provider=System.Data.SqlClient;
                       provider connection string=&quot;data source=ServerName;initial catalog=DB_Api;user id=userName;password=password;MultipleActiveResultSets=True&quot;" 
     providerName="System.Data.EntityClient" />

2. 移除非必需参数：比如persist security info=True（不需要保留连接后的密码可去掉）、App=EntityFramework（仅标识连接来源，无功能影响）。

是否需要重构EDMX文件？ #

如果想彻底改用简洁的普通连接字符串，需要将项目从EDMX模式迁移到Code First模式：

1. 删除EDMX文件及其自动生成的实体类、DbContext代码。
2. 手动编写实体类，用数据注解或Fluent API配置数据库映射关系。
3. 修改APIEntities类，移除OnModelCreating中的异常抛出，构造函数直接传入普通SQL连接字符串：

public partial APIEntities : DbContext
{
    public APIEntities()
            : base("Server=ServerName;Database=DataBaseName;User Id=userId;Password=password;MultipleActiveResultSets=true;")
    {
    }
    
    protected override void OnModelCreating(DbModelBuilder modelBuilder)
    {
        // 这里配置Fluent API映射，或留空（如果用数据注解）
    }
    
    public virtual DbSet<Object1> List1 { get; set; }
    public virtual DbSet<Object2> List2 { get; set; }
    public virtual DbSet<Object3> List3 { get; set; }
    //etc...
}

这个重构的工作量取决于实体类数量，但长期来看，Code First模式的连接字符串更简洁，维护成本更低。

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