EFCore2.0@Xamarin.Forms
2018-05-03

   由于忙于Xamarin的书的创作很久没有和大家见面了,回到博客我会陆续更新一些最新的Xamarin技术,还有最近一直在努力的人工智能相关知识。话说csdn的博客改版了。总觉得变化是好事情啊。
      这篇博客,我想和大家说说EFCore,在.NET社区,EntityFramework对持久化有很深远的影响,特别是O/RM节省了一堆的数据库访问代码。到了.NET Core的年代,EF也升级到EntityFrameworkCore. 微软视EFCore为一个跨平台,轻量级,可扩展的数据库操作技术。当然我更喜欢用Dapper, 但EFCore对于移动化的数据操作场景是非常合适的。这也是我今天的重点。
      
      这里得提提移动端数据持久化,在移动端有很多方式,如CoreData, SQLite,还有第三方的大名鼎鼎的Realm(虽然很cool,但我总觉得有点复杂,因人而异了)。在Xamarin中用EFCore是有先天优势的,特别是在支持.NET Standard项目中。如果你的项目采用SQLite作为你数据持久化的一部分,EFCore会是你的最佳搭档。如果你希望的是其他持久化方案,那个人还是说一句不太合适。
     如果你想为原有的项目添加EFCore方案,你需要把你的PCL迁移到.NET Standard上,如果是新项目就直接选用.NET Standard上算了。这里吐槽下Visual Studio团队,Windows下已经有Xamarin的.NET Standard模版(左图),但macOS下是没有的(右图)。(Build快到了,你就能不能给我一个统一的呢?还有别告诉我在Beta,大家需要的是Stable)如果你希望在macOS下创建.NET Standard的Xamarin项目,建议你去装一个Prism模版,或者在Windows下创建好扔过去,还有自己创建.NET Standard Library替换PCL。
          
     创建好后,在.NET Standard下添加Nuget库Microsoft.EntityFrameworkCore.Sqlite。添加成功后剩下的事就是做Model和DbContext.
CourseInfo.cs

    public class CourseInfo

    {

        [Key]

        public int courseID { get; set; }

        public string courseName { get; set; }


        public List<CourseSession> sessionList { get; set; }

    }

CourseSession.cs

    public class CourseSession

    {

        [Key]

        public int sessionID { get; set; }


        public string sessionName { get; set; }


        public int courseID { get; set; }


        public CourseInfo course { get; set; }

    }

CourseDbContext.cs

    public class CourseDbContext : DbContext

    {

        public DbSet<CourseInfo> Courses { get; set; }

        public DbSet<CourseSession> Sessions { get; set; }


        private string DatabasePath { get; set; }


        public CourseDbContext()

        {


        }


        public CourseDbContext(string databasePath)

        {

            DatabasePath = databasePath;

        }


        protected override void OnModelCreating(ModelBuilder modelBuilder)

        {

            modelBuilder.Entity<CourseSession>()

                        .HasOne(p => p.course)

                        .WithMany(b => b.sessionList)

                        .HasForeignKey("courseID");

        }

        protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)

        {

            optionsBuilder.UseSqlite($"Filename={DatabasePath}");

        }

    }

     这里让我解释一下,上面很简单就是创建两个表一个是课程CourseInfo,一个是课程内容CourseSession,我做了一个1:n的关联,数据源就是CourseDbContext. 

      在MainPage.cs要做的事就是把数据库初始化好,和初始化一些数据。

               try

                {

                    using (var db = new CourseDbContext(path))

                    {

                        //db.Database.OpenConnection();

                        await db.Database.MigrateAsync();

                        CourseInfo info1 = new CourseInfo() { courseID = 1000, courseName = "Xamarin in action" };

                        CourseInfo info2 = new CourseInfo() { courseID = 1001, courseName = "Azure" };


                        List<CourseInfo> courseList = new List<CourseInfo>() { info1, info2 };


                        if (await db.Courses.CountAsync() < 2)

                        {

                            await db.Courses.AddRangeAsync(courseList);

                            await db.SaveChangesAsync();

                        }


                        CourseSession session1 = new CourseSession() { sessionID = 1, sessionName = "1. What's Xamarin", courseID = 1000 };

                        CourseSession session2 = new CourseSession() { sessionID = 2, sessionName = "1. What's azure", courseID = 1001 };

                        CourseSession session3 = new CourseSession() { sessionID = 3, sessionName = "2. Xamarin Installation", courseID = 1000 };



                        List<CourseSession> sessionList = new List<CourseSession>() { session1, session2,session3 };



                        if (await db.Sessions.CountAsync() < 3)

                        {

                            await db.Sessions.AddRangeAsync(sessionList);

                            await db.SaveChangesAsync();

                        }


                        var list = await db.Sessions.ToListAsync();


                    var session = list.Where(item => item.courseID == 1000);

                    ObservableCollection<SessionView> viewList = new ObservableCollection<SessionView>();


                    foreach (var item in session)

                    {

                        viewList.Add(new SessionView { SessionName = item.sessionName });

                    }

                    SessionListView.ItemsSource = viewList;

                    }

                }

                catch (Exception ex)

                {

                    var temp = ex.ToString();

                }

     这样通过EFCore的代码就完成了,但别忘记在iOS/Android/UWP对SQLite进行初始化,否则你是不能使用SQLite的。方法如下,在每个平台上添加SQLitePCL,

       iOS在AppDelegate.cs的FinishedLauching方法上添加

 SQLitePCL.raw.SetProvider(new SQLitePCL.SQLite3Provider_sqlite3());
   Android在MainActivity.cs上增加

        [DllImport("libsqlite.so")]

        internal static extern int sqlite3_shutdown();


        [DllImport("libsqlite.so")]

        internal static extern int sqlite3_initialize();

      

 并在OnCreate方法上添加

        sqlite3_shutdown();

        SQLitePCL.raw.SetProvider(new SQLitePCL.SQLite3Provider_e_sqlite3());

        sqlite3_initialize();

 UWP呢?哈哈在Surface Phone出生前,我不会再去考虑了(希望真的有)
       这个时候应该可以编译了吧?如果直接运行会出现以下错误:
       Microsoft.Data.Sqlite.SqliteException (0x80004005): SQLite Error 1:
       原因是项目缺少了Migrations对数据库结构进行初始化。你需要做一个Migration, 个人建议你创建一个.NET Core Console Application去完成。这样省事,又方便。创建好一个.NET Core Console Application后先添加Microsoft.EntityFrameworkCore.Design和Microsoft.EntityFrameworkCore.Sqlite, 之后去修改.csproj, 增加ef命令支持

  <DotNetCliToolReference Include="Microsoft.EntityFrameworkCore.Tools.DotNet" Version="2.0.2" />

       保存好后把之前创建的CourseInfo,CourseSession,CourseDbContext添加进来,restore和rebuild后,去命令行做 

 如果成功就可以生成一个Migrations文件夹,把这个文件夹拷贝进Xamarin.Forms .NET Standard的项目中。再重新运行就可以成功了。
           
      EFCore + Xamarin.Forms就大功告成了,但我这里得提一个坑,在编译Android项目时,不知道为啥就是不能部署到机器里面,我找了又找,需要做在Android的csproj上设置以下,添加如下:

<PackageReference Include="System.Runtime.CompilerServices.Unsafe" Version="4.3.0" />

<PropertyGroup>

  <NoWarn>$(NoWarn);NU1605</NoWarn>

</PropertyGroup>

应该是Xamarin.Android对.NET Standard兼容未做得太好,但通过这个方法可以避免相关错误。当然这个不影响部署发布了,错误我已经反馈给微软那边了,希望在新的版本中尽快修正。
      完整代码https://github.com/lokinfey/EFCore-Xamarin.Forms 
      EFCore是.NET Core下非常重要的一部分,对于移动端数据持久化也有非常重要的意义,我更寄望有更多的功能可以实现,或者如第三方的Realm能尽快对EFCore进行支持。


原文: