当前位置 博文首页 > 卖代码的小当家：【繁星Code】如何在EF将实体注释写入数据库中
最近在项目中需要把各个字段的释义写到数据库中，该项目已经上线很长时间了，数据库中的字段没有上千也有上百个，要是一个项目一个项目打开然后再去找对应字段查看什么意思，估计要到明年过年了。由于项目中使用EntityFramework，本身这个项目只有手动设置字段注释的功能，Coder平时写代码的时候都懒得写注释，更别提能在配置数据库的时候将注释配置进去，所以如何在EF中自动将实体注释写入数据库，减轻Coder的压力（ru he tou lan）尤为重要。gitee地址：https://gitee.com/lbqman/Blog20210206.git 。下面进入正题。
/// <summary>Configures a comment to be applied to the column</summary>
/// <typeparam name="TProperty"> The type of the property being configured. </typeparam>
/// <param name="propertyBuilder"> The builder for the property being configured. </param>
/// <param name="comment"> The comment for the column. </param>
/// <returns> The same builder instance so that multiple calls can be chained. </returns>
public static PropertyBuilder<TProperty> HasComment<TProperty>(
[NotNull] this PropertyBuilder<TProperty> propertyBuilder,
[CanBeNull] string comment)
{
return (PropertyBuilder<TProperty>) propertyBuilder.HasComment(comment);
}
public virtual PropertyBuilder<TProperty> Property<TProperty>(
[NotNull] Expression<Func<TEntity, TProperty>> propertyExpression);
public static PropertyBuilder<TProperty> SummaryProperty<TEntity, TProperty>(
this EntityTypeBuilder<TEntity> entityTypeBuilder,
Expression<Func<TEntity, TProperty>> propertyExpression)
where TEntity : class
public static MemberInfo GetMember<T, TProperty>(this Expression<Func<T, TProperty>> expression)
{
MemberExpression memberExp;
if (expression.Body is UnaryExpression unaryExpression)
memberExp = unaryExpression.Operand as MemberExpression;
else
memberExp = expression.Body as MemberExpression;
return memberExp?.Member;
}
/// <summary>
/// xml注释获取器
/// </summary>
internal static class SummaryXmlCacheProvider
{
#region TClass
/// <summary>
/// 根据类型初始化该类所在程序集的xml
/// </summary>
/// <typeparam name="TClass"></typeparam>
internal static void InitSummaryXml<TClass>()
{
var assembly = Assembly.GetAssembly(typeof(TClass));
SerializeXmlFromAssembly(assembly);
}
/// <summary>
/// 根据类型获取该类所在程序集的xml
/// </summary>
/// <typeparam name="TClass"></typeparam>
/// <returns></returns>
internal static Dictionary<string, string> GetSummaryXml<TClass>()
{
var assembly = Assembly.GetAssembly(typeof(TClass));
return SummaryCache[assembly];
}
/// <summary>
/// 获取该类在xml的key
/// </summary>
/// <typeparam name="TClass"></typeparam>
/// <returns></returns>
internal static string GetClassTypeKey<TClass>()
{
return TableSummaryRuleProvider.TypeSummaryKey(typeof(TClass).FullName);
}
#endregion
#region TProperty
/// <summary>
/// 根据类型以及字段初始化该类所在程序集的xml
/// </summary>
/// <typeparam name="TClass"></typeparam>
/// <typeparam name="TProperty"></typeparam>
/// <param name="propertyExpression"></param>
internal static void InitSummaryXml<TClass, TProperty>(Expression<Func<TClass, TProperty>> propertyExpression)
{
var propertyAssembly = GetPropertyAssembly(propertyExpression);
SerializeXmlFromAssembly(propertyAssembly);
}
/// <summary>
/// 根据类型以及字段获取该类所在程序集的xml
/// </summary>
/// <typeparam name="TClass"></typeparam>
/// <typeparam name="TProperty"></typeparam>
/// <param name="propertyExpression"></param>
/// <returns></returns>
internal static Dictionary<string, string> GetSummaryXml<TClass, TProperty>(
Expression<Func<TClass, TProperty>> propertyExpression)
{
var propertyAssembly = GetPropertyAssembly(propertyExpression);
return SummaryCache[propertyAssembly];
