第42章 Code-First自增型编号插入异常解决方案

1 异常

    在通过Code-First模式生成自增型编号表时，在默认况下通过SQL命令插入数据是不能包含编号值的,如果包含编号值，则会出现异常：“当 IDENTITY_INSERT 设置为 OFF 时，不能为表 'Address' 中的标识列插入显式值。”。

    有时确实需要在Code-First模式生成自增型编号表中，SQL命令插入数据需要包含编号值的数据的，那么就需要定义下面的约束规则，来对上述异常进行解决

2 解决方案如下：

 builder.HasKey(address => address.Id);

            //在Code-First模式下自增型编号字段，在默认况下通过SQL命令插入数据是不能包含编号值的，如果想要包含编号值:

            //  EFCore必须使用“builder.Property(address => address.Id).ValueGeneratedNever()”；

            //  EF必须使用“builder.Property(address => address.Id).HasDatabaseGeneratedOption(DatabaseGeneratedOption.None)”

            //如果不包含上述定义，在通过SQL命令插入包含编号值的数据时会出现“当 IDENTITY_INSERT 设置为 OFF 时，不能为表 'Address' 中的标识列插入显式值。”异常。

            //注意：

            //  如果在Code-First模式下的编号字段被定义上述约束规则，那么该编号字段将不是自增型的，即在使用实体实例插入时必须为其设定1个唯一的编号值。

            builder.Property(address => address.Id).ValueGeneratedNever();

3 重构Data.Mapping.Users.RoleBuilder

//Nuget

//Nuget--Microsoft.EntityFrameworkCore.SqlServer

using Microsoft.EntityFrameworkCore;

using Microsoft.EntityFrameworkCore.Metadata.Builders;

//项目

using Core.Domain.Users;

namespace Data.Mapping.Users

{

    /// <summary>

    /// 【角色生成器--类】

    /// <remarks>

    /// 摘要：

    ///     该类通过对“EntityFrameworkCore”中间件“IEntityTypeConfiguration<TEntity/>”泛型接口的“Configure”方法的定义，以实现把角色实体类及其属性成员相关约束规则及其级联关系定义，映射到角色表及其的相应字段上。

    /// </remarks>

    /// </summary>

    public class RoleBuilder : IEntityTypeConfiguration<Role>

    {

        #region 方法--IEntityTypeConfiguration<>

        ///<param name="builder">实体类型生成器实例，用于把当前程序中指定实体和属性所定义的约束规则，映射到数据库指定表及其字段上。</param>

        /// <summary>

        /// 【配置】

        /// <remarks>

        /// 摘要：

        ///     该方法通过对“EntityFrameworkCore”中间件“IEntityTypeConfiguration<TEntity/>”泛型接口的“Configure”方法的定义，以实现把角色实体类及其属性成员相关约束规则及其级联关系定义，映射到角色表及其的相应字段上。

        /// </remarks>

        /// </summary>

        public void Configure(EntityTypeBuilder<Role> builder)

        {

            //由于“EntityTypeBuilder<Role>”的参数已经泛型实例化，因此builder后不能再定义为：“builder.Entity<Role>().HasKey(role => role.Id);”。

            //角色表及其字段约束规则，映射定义。

            builder.HasKey(role => role.Id);

            //在Code-First模式下自增型编号字段，在默认况下通过SQL命令插入数据是不能包含编号值的，如果想要包含编号值:

            //  EFCore必须使用“builder.Property(role => role.Id).ValueGeneratedNever()”；

            //  EF必须使用“builder.Property(role => role.Id).HasDatabaseGeneratedOption(DatabaseGeneratedOption.None)”

            //注意：

            //  如果在Code-First模式下的编号字段被定义上述约束规则，那么该编号字段将不是自增型的，即在使用实体实例插入时必须为其设定1个唯一的编号值。

            builder.Property(role => role.Id).ValueGeneratedNever();

            builder.Property(role => role.Name).IsRequired().HasMaxLength(255);

        }

        #endregion

    }

}

4 重构Data.Mapping.Security.PermissionBuilder

//Nuget

//Nuget--Microsoft.EntityFrameworkCore.SqlServer

using Microsoft.EntityFrameworkCore;

using Microsoft.EntityFrameworkCore.Metadata.Builders;

//项目

using Core.Domain.Security;

namespace Data.Mapping.Security

{

    /// <summary>

    /// 【权限生成器--类】

    /// <remarks>

    /// </remarks>

    /// </summary>

    public class PermissionBuilder : IEntityTypeConfiguration<Permission>

    {

        #region 方法--IEntityTypeConfiguration<>

        ///<param name="builder">实体类型生成器实例，用于把当前程序中指定实体和属性所定义的约束规则，映射到数据库指定表及其字段上。</param>

        /// <summary>

        /// 【配置】

        /// <remarks>

        /// 摘要：

        ///     该方法通过对“EntityFrameworkCore”中间件“IEntityTypeConfiguration<TEntity/>”泛型接口的“Configure”方法的定义，以实现把权限实体类及其属性成员相关约束规则及其级联关系定义，映射到权限表及其的相应字段上。

        /// </remarks>

        /// </summary>

        public void Configure(EntityTypeBuilder<Permission> builder)

        {

            //由于“EntityTypeBuilder<Permission>”的参数已经泛型实例化，因此builder后不能再定义为：“builder.Entity<Permission>().HasKey(permission => permission.Id);”。

            //权限表及其字段约束规则，映射定义。

            builder.HasKey(permission => permission.Id);

            //在Code-First模式下自增型编号字段，在默认况下通过SQL命令插入数据是不能包含编号值的，如果想要包含编号值:

            //  EFCore必须使用“builder.Property(permission => permission.Id).ValueGeneratedNever()”；

            //  EF必须使用“builder.Property(permission => permission.Id).HasDatabaseGeneratedOption(DatabaseGeneratedOption.None)”

            //如果不包含上述定义，在通过SQL命令插入包含编号值的数据时会出现“当 IDENTITY_INSERT 设置为 OFF 时，不能为表 'Permission' 中的标识列插入显式值。”异常。

            //注意：

            //  如果在Code-First模式下的编号字段被定义上述约束规则，那么该编号字段将不是自增型的，即在使用实体实例插入时必须为其设定1个唯一的编号值。

            builder.Property(permission => permission.Id).ValueGeneratedNever();

            builder.Property(permission => permission.Name).IsRequired().HasMaxLength(255);

            builder.Property(permission => permission.Category).IsRequired().HasMaxLength(500);

        }

        #endregion

    }

}

5 重构Data.Mapping.Common.AddressBuilder

//Nuget

//Nuget--Microsoft.EntityFrameworkCore.SqlServer

using Microsoft.EntityFrameworkCore;

using Microsoft.EntityFrameworkCore.Metadata.Builders;

//项目

using Core.Domain.Common;

namespace Data.Mapping.Common

{

    /// <summary>

    /// 【地址生成器--类】

    /// <remarks>

    /// 摘要：

    ///     该类通过对“EntityFrameworkCore”中间件“IEntityTypeConfiguration<TEntity/>”泛型接口的“Configure”方法的定义，以实现把地址实体类及其属性成员相关约束规则及其级联关系定义，映射到地址表及其的相应字段上。

    /// </remarks>

    /// </summary>

    public class AddressBuilder : IEntityTypeConfiguration<Address>

    {

        #region 方法--IEntityTypeConfiguration<>

        ///<param name="builder">实体类型生成器实例，用于把当前程序中指定实体和属性所定义的约束规则，映射到数据库指定表及其字段上。</param>

        /// <summary>

        /// 【配置】

        /// <remarks>

        /// 摘要：

        ///     该方法通过对“EntityFrameworkCore”中间件“IEntityTypeConfiguration<TEntity/>”泛型接口的“Configure”方法的定义，以实现把地址实体类及其属性成员相关约束规则及其级联关系定义，映射到地址表及其的相应字段上。

        /// </remarks>

        /// </summary>

        public void Configure(EntityTypeBuilder<Address> builder)

        {

            //由于“EntityTypeBuilder<Address>”的参数已经泛型实例化，因此builder后不能再定义为：“builder.Entity<Address>().HasKey(address => address.Id);”。

            //权限表及其字段约束规则，映射定义。

            builder.HasKey(address => address.Id);

            //在Code-First模式下自增型编号字段，在默认况下通过SQL命令插入数据是不能包含编号值的，如果想要包含编号值:

            //  EFCore必须使用“builder.Property(address => address.Id).ValueGeneratedNever()”；

            //  EF必须使用“builder.Property(address => address.Id).HasDatabaseGeneratedOption(DatabaseGeneratedOption.None)”

            //如果不包含上述定义，在通过SQL命令插入包含编号值的数据时会出现“当 IDENTITY_INSERT 设置为 OFF 时，不能为表 'Address' 中的标识列插入显式值。”异常。

            //注意：

            //  如果在Code-First模式下的编号字段被定义上述约束规则，那么该编号字段将不是自增型的，即在使用实体实例插入时必须为其设定1个唯一的编号值。

            builder.Property(address => address.Id).ValueGeneratedNever();

            builder.Property(address => address.Name).IsRequired().HasMaxLength(255);

        }

        #endregion

    }

}

对以上功能更为具体实现和注释见：230211_036shopDemo(Code-First自增型编号插入异常解决方案)。