Azure Cosmos DB (二) SQL API 操作

一，引言

　　还记得国庆期间，我们学习了一下关于Azure Cosmos DB 的一些基础知识以及Azure Cosmos DB 的几种支持数据库类型。今天就开始分享一些实战操作，如何通过Azure Portal 创建 Cosmos DB，以及在实际项目中如何通过代码操作数据库。

　　今天要演示的是 Core(SQL) 核心，SQL API 是具有丰富的SQL查询功能的无架构 JSON 数据库引擎，它是以 json 形式的文档数据库。同时微软提供了对应的 EF 的操作包 ----- Microsoft.EntityFrameworkCore.Cosmos，使得我们很轻松的使用原有EF操作数据库的模式进行操作 Cosmos DB。

注意这里使用的  Microsoft.EntityFrameworkCore.Cosmos 仅适用于 Azure Cosmos DB 的 SQL API

--------------------我是分割线--------------------

1，Azure Cosmos DB (一) 入门介绍

2，Azure Cosmos DB (二) SQL API 操作

二，正文

1， 创建Azure Cosmos DB 

在Azure portal 中点击 “+ 创建资源”，在搜索框中输入 “Azure Cosmos DB” 进行搜索

点击 “Create” ，进行开始创建

Resource Group："Web_Test_DB_RG"

Account Name："cnbateblogwebcosmosdb"

API 选择：Core（SQL）

Capacity mode 选择默认 ：“Provisioned throughtput”（预配的吞吐量）

其他都选择默认。点击 “Review + create” 进行创建前的预校验。

使用Azure Cosmos DB 免费层时，将在账户中免费获得 400 RU/秒和 5GB 的存储。每个订阅最多可对一个账户启用免费层。预计每个账户每月有24美元的折扣。

可以看到验证提示 “Validation Sucess”，点击 ”Create“ 进行创建

等待几分钟后，我们可以在 "Web_Test_DB_RG" 中找到刚刚创建好的叫 ”cnbateblogwebcosmosdb“ 的 Cosmos DB 了

点击进去，找到 Data Explorer ，点击 ”New Database“ 新建数据库

或者点击 ”New Container“ 旁边的小箭头，进行下拉选择创建新的数据库。

Database id：”CNBATEBLOGWEB“

点击 “OK” ，进行创建

可以看到 “CNBATEBLOGWEB” 的 Database 已创建好了。

2，项目添加对Cosmos DB 的依赖包

2.1，安装 “Microsoft.EntityFrameworkCore”，“Microsoft.EntityFrameworkCore.Cosmos”

使用程序包管理控制台进行安装

Install-Package Microsoft.EntityFrameworkCore -Version 3.1.8

Install-Package Microsoft.EntityFrameworkCore.Cosmos -Version 3.1.8

2.2，要创建所需的容器并插入种子数据

配置环境，此时需要cosmosDB 的 Endpoint，Key，DatabaseName

图中对应的 URL=》Endpoint，PRIMARK KEY=》Key，

上面步骤中创建的叫 “CNBATEBLOGWEB” 的我们需要的DatabaseName

整理好刚才需要的三个参数，添加到项目的配置文件中 也就是 appsettings.json 文件中

创建UserModel 实体，UserContext，重写 OnConfiguring 方法，调用UseCosmos 方法

重写 “OnModelCreating” 创建数据数据映射关系

”ConfigrueServices“ 中添加对 “UserContext” 的依赖注入

生产种子数据，先将已有的数据库进行删除操作，再进行添加操作以及生成种子数据

 完整代码

public class UserContext : DbContext
    {
        public UserContext(DbContextOptions<UserContext> options) : base(options)
        {

        }

        public DbSet<UserModel> Users { get; set; }

        /// <summary>
        /// 重写连接数据库
        /// </summary>
        /// <param name="optionsBuilder"></param>
        protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
        {
            // 从 appsetting.json 中获取配置信息
            var config = new ConfigurationBuilder()
                .SetBasePath(Directory.GetCurrentDirectory())
                .AddJsonFile("appsettings.json")
                .Build();

            // 定义要使用的数据库
            optionsBuilder.UseCosmos(Appsettings.app("CosmosDB", "Endpoint"), Appsettings.app("CosmosDB", "Key"), Appsettings.app("CosmosDB", "DataBase"));
        }

        protected override void OnModelCreating(ModelBuilder modelBuilder)
        {
            //针对于HasData限制（即使主键是由数据库生成的自动增长），也需要指定主键 

            //调用EnsureCreated方法只针对与添加数据有效，但是数据库如果有数据的话，
            //也就是对数据更改将无效
            Console.WriteLine("**********UserModel表开始初始化数据**********");
            #region 数据库数据映射
            modelBuilder.Entity<UserModel>().HasData(
                   //new Blog{Id=1,Name="DDD领域驱动模型"},
                   new UserModel { Id = 1, Name = "EntityFramework Core 3.1.1" },
                  new UserModel { Id = 2, Name = "EntityFramework Core 3.1.6" });

            #endregion


        }

    }

public class UserModel
    {
        public int Id { get; set; }

        public string Name { get; set; }

        public int Age { get; set; }

        public string Address { get; set; }

        public string Remark { get; set; }
    }

   /// <summary>
    /// appsettings.json操作类
    /// </summary>
    public class Appsettings
    {
        static IConfiguration Configuration { get; set; }
        static string contentPath { get; set; }

        public Appsettings(string contentPath)
        {
            string Path = "appsettings.json";


            //如果你把配置文件 是 根据环境变量来分开了，可以这样写
            //string Path = $"appsettings.{Environment.GetEnvironmentVariable("ASPNETCORE_ENVIRONMENT")}.json";

            //var contentPath = env.ContentRootPath;
            Configuration = new ConfigurationBuilder()
               .SetBasePath(contentPath)
               .Add(new JsonConfigurationSource { Path = Path, Optional = false, ReloadOnChange = true })//这样的话，可以直接读目录里的json文件，而不是 bin 文件夹下的，所以不用修改复制属性
               .Build();
        }

        /// <summary>
        /// 封装要操作的字符
        /// </summary>
        /// <param name="sections"></param>
        /// <returns></returns>
        public static string app(params string[] sections)
        {
            try
            {
                var val = string.Empty;
                for (int i = 0; i < sections.Length; i++)
                {
                    val += sections[i] + ":";
                }

                return Configuration[val.TrimEnd(':')];
            }
            catch (Exception)
            {
                return "";
            }
        }
    }

    public class Program
    {
        public static void Main(string[] args)
        {
            var host = CreateHostBuilder(args).Build();
            // 创建可用于解析作用域服务的新 Microsoft.Extensions.DependencyInjection.IServiceScope。
            using (var scope = host.Services.CreateScope())
            {
                var services = scope.ServiceProvider;
                var loggerFactory = services.GetRequiredService<ILoggerFactory>();
                var env = services.GetRequiredService<IWebHostEnvironment>();
                if (env.IsDevelopment())
                {
                    try
                    {
                        // 从 system.IServicec提供程序获取 T 类型的服务。
                        var context = services.GetRequiredService<UserContext>();
                        
                        context.Database.EnsureDeleted();
                        Console.WriteLine("**********开始初始化数据**********");
                        context.Database.EnsureCreated();

                    }
                    catch (Exception e)
                    {
                        var logger = loggerFactory.CreateLogger<Program>();
                        logger.LogError(e, "Error occured seeding the Database.");
                    }
                }
            }

            // 运行 web 应用程序并阻止调用线程, 直到主机关闭。
            // 创建完 WebHost 之后，便调用它的 Run 方法，而 Run 方法会去调用 WebHost 的 StartAsync 方法
            // 将Initialize方法创建的Application管道传入以供处理消息
            // 执行HostedServiceExecutor.StartAsync方法

            host.Run();
        }

        public static IHostBuilder CreateHostBuilder(string[] args) =>
            Host.CreateDefaultBuilder(args)
                .ConfigureWebHostDefaults(webBuilder =>
                {
                    webBuilder
                    .UseUrls("http://*:9001")
                    .UseStartup<Startup>();
                });
    }

public class Startup
    {
        public Startup(IConfiguration configuration, IWebHostEnvironment env)
        {
            Env = env;
            Configuration = configuration;
        }

        public IConfiguration Configuration { get; }

        public IWebHostEnvironment Env { get; }

        // This method gets called by the runtime. Use this method to add services to the container.
        public void ConfigureServices(IServiceCollection services)
        {
            services.AddSingleton(new Appsettings(Env.ContentRootPath));

            services.AddDbContext<UserContext>(options => options.UseCosmos(Appsettings.app("CosmosDB", "Endpoint"), Appsettings.app("CosmosDB", "Key"), Appsettings.app("CosmosDB", "DataBase")));

            services.AddControllersWithViews();
        }

        // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
        public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }
            else
            {
                app.UseExceptionHandler("/Home/Error");
            }
            app.UseStaticFiles();

            app.UseRouting();

            app.UseAuthorization();

            app.UseEndpoints(endpoints =>
            {
                endpoints.MapControllerRoute(
                    name: "default",
                    pattern: "{controller=Home}/{action=Index}/{id?}");
            });
        }
    }

 3，运行项目，查看测试结果

我们可以看到UserModel 表已初始化数据完成

 我们转到Azure Portal 上查看 "CNBATEBLOGWEB" 数据库下多了叫 “UserContext” 的 Container 这里的可以理解成存放表的容器

同时，我们可以看到 ”UserContext“ 下的 Item 多了两条 Usermodel 数据，我们分别进行查看，可以看到这两条数据就是刚刚生成的种子数据

ok，今天的分享就到此，撒花是