Code Fisrt 更新注释到mysql数据库

背景：

从java项目翻到.net core 项目，将java的实体转换成.net 的实体，然后使用 ef tool 直接更新到数据库

命令如下：

Enable-Migrations -EnableAutomaticMigrations

Add-Migration InitialCreate

Update-Database -Verbose

 

更新的时候会遇到几个问题

1. 外键关系：

因为我的项目中使用Guid做关联，所有就没有使用外键，如果要做外键关联可以参考这篇文章

https://www.cnblogs.com/xishuai/p/ef-dbcontext-savechanges-foreignkey-value.html

 

2.注释无法更新到数据库

如果一个个注释都手动添加到数据库，几十张表，会不会很蛋疼：

然后看网上给出的思路，根据生成的xml 获取注释，更新到数据库

如果大家有什么工具，希望大家分享下 -，-，

 

下面简单介绍下思路：

 

 

两个项目

1：DbContext项目，就是model-first中对应数据库实体的项目，一般都是单独放在一个项目中

2：控制台程序，您也可以做成web，或者窗体，这边我为了省事做了控制台程序

（不知道为什么，博客园提示无法上传图片，下次补齐图片，先用文字描述。。。）

 

控制台程序添加对DbContext项目的引用，

右击DbContext项目，在生成中的 勾选 输出 “xml 文档文件（X）” bin\Debug\netcoreapp2.1\***.xml ，这个xml文件包含了项目中实体的注释

 

你大概可以看到xml文件中的内容大概是如下

  <member name="T:TmcService.Core.Model.TestTable">
            <summary>
            用于测试
            </summary>
  </member>
   <member name="P:TmcService.Core.Model.TmcSuppliers.SupplierCode">
            <summary>
            主键
            </summary>
   </member>
   <member name="P:TmcService.Core.Model.TmcSuppliers.Name">
            <summary>
            名称
            </summary>
   </member>

可以看到表明 的xml节点   T:TmcService.Core.Model.TestTable

和字段的xml节点 　　　　P:TmcService.Core.Model.TmcSuppliers.Name

好了基础工作做完我们就开始下一步

1.读取xml文件，获取每一个节点，将结果集存到list中，

 

2.使用反射获取程序集和表的对应关系存到字典中，

代码如下，数据库操作是用的Dapper，应为数据库mysql所以用了 Pomelo.EntityFrameworkCore.MySql 在nuget都可以直接安装

代码中部分命名空间做了处理

namespace TmcService.GenertageAnnotationToDb
{
    class Program
    {
        private static MySqlConnection con = new MySqlConnection("连接字符串");

        static void Main(string[] args)
        {
            Console.WriteLine($"如果出现两个命名空间包含相同的字符串的情况下：\n" +
                $"类名：Cofig  命名空间：TmcService.Core.Model \n" +
                $"类名：CofigDetail  命名空间：TmcService.Core.Model \n" +
                $"这种情况下会发生异常，可以手动将拼接的字段生成sql脚本手动更新  \n");
            Console.WriteLine("按任意键更新数据库注释...\n");
            Console.ReadKey();
            try
            {
                Console.WriteLine("注释更新中...");
                UpdateAnnonation();
                Console.WriteLine("更新成功按任意键退出...");
            }
            catch (Exception ex)
            {
                Console.WriteLine("更新失败 \n");
                Console.WriteLine(ex.ToString());
            }
            Console.ReadKey();
        }

        /// <summary>
        /// 获取数据类名和对应的数据库表名，返回一个dic
        /// </summary>
        /// <returns></returns>
        private static Dictionary<string, string> GetAllCalssMapperDbName()
        {
            Dictionary<string, string> keyValuePairs = new Dictionary<string, string>();

            //引用model，DbContext的dll
            string dllName = AppDomain.CurrentDomain.BaseDirectory + @"***";
            Assembly assembly = Assembly.LoadFrom(dllName);

            //获取数据库映射到数据库的实体类（根据情况自行处理）
            var typies = assembly.GetTypes().Where(o => o.FullName.Contains("***") && !o.FullName.Contains("***")).ToList();

            //创建对象的实例，获取对象的属性，获取对象在数据库对应的表，
            typies.ForEach(o =>
            {
                Object obj = Activator.CreateInstance(o);
                var attribute = o.GetCustomAttributes(typeof(TableAttribute), false).FirstOrDefault();
                if (attribute != null)
                {
                    keyValuePairs.Add(o.FullName, ((TableAttribute)attribute).Name);
                }
            });
            return keyValuePairs;
        }

        /// <summary>
        /// 根据根据dic 匹配类和表关系，将字段标注更新到数据库
        /// </summary>
        private static List<AnnonationModel> GerAnnonationFromXmlDoc()
        {
            var keyValuePairs = GetAllCalssMapperDbName();

            XmlDocument xmlDoc = new XmlDocument();
            xmlDoc.Load("dbcontext.xml");
            var list = xmlDoc.SelectSingleNode("doc").SelectSingleNode("members");
            var annonationList = new List<AnnonationModel>();
            foreach (var item in list)
            {
                AnnonationModel annonationmodel = new AnnonationModel();
                var member = (XmlNode)item;
                var annotation = member.SelectSingleNode("summary");
                string summary = string.Empty;
                var attr = member.Attributes["name"];
                var attrVal = string.Empty;
                if (attr != null)
                {
                    attrVal = member.Attributes["name"].Value;
                }
                if (annotation != null)
                {
                    summary = (annotation).InnerText;
                }
                annonationmodel.Annonation = summary;
                annonationmodel.ClassName = attrVal;
                annonationList.Add(annonationmodel);
            }
            return annonationList;
        }

        /// <summary>
        /// 更新
        /// </summary>
        private static void UpdateAnnonation()
        {
            //更新数据库字段注释
            var keyValuePairs = GetAllCalssMapperDbName();
            var annonationList = GerAnnonationFromXmlDoc();

            string sqls = string.Empty;

            foreach (var item in keyValuePairs)
            {
                var className = item.Key;
                var tableName = item.Value;

                //获取注释的所有属性
                var fields = annonationList.Where(o => o.ClassName.Contains(className)).ToList();

                StringBuilder sb = new StringBuilder();

                foreach (var o in fields)
                {
                    if (!o.ClassName.Contains("T:"))
                    {
                        string[] str = o.ClassName.Split(".");
                        var len = str.Length;
                        var attrName = str[len - 1];
                        //mql数据库关键字处理
                        if (attrName == "Name" || attrName == "Status")
                        {
                            attrName = "`" + attrName + "`";
                        }
                        string sql = $" alter table {tableName} modify column {attrName} int comment'{o.Annonation}'; \n";
                        sb.Append(sql);
                    }
                }
                sqls += sb.ToString();
            }
            con.Execute(sqls);
        }
    }

    public class AnnonationModel
    {
        public string ClassName { get; set; }
        public string Annonation { get; set; }

    }
}