Asp.NET Core基礎 第二篇 Core WebAPI連接Sqlserver數據庫及服務發布

 

 

第二篇  Asp.Net Core WebAPI 連接Sqlserver數據庫及WebAPI服務發布

 

      前言  Core API可以在業務與數據的模式下提供了一項安全、可靠的數據接口服務方式，我們借助於Core API可以為移動端、物聯網終端、互聯網終端等設備提供在線數據訪問服務，本文重點介紹Core API項目創建、Sqlserver數據CRUD操作、服務發布（WinDows服務器和Linux服務器），側重入門實操，大俠繞步！

      學習目標：

       1）使用Vs2019創建Core API項目；

       2）如何實現Core API連接Sqlserver數據庫，並且實現CRUD操作；

       3）搭建Swagger，實現可視化的API頁面。

       4）在Windows和Linux服務器發布Core API應用。

      前期准備工具：

      Vs2019 IDE環境、Sqlserver2008、Windows服務器、Linux服務器。

 

       一、使用Vs2019創建WebAPI項目

　　新建一個項目名稱為WebApi的工程，Core版本選擇3.1，項目類型選擇“ASP.NET Core Web API”，如下圖所示

 

 

 

 

 

 

 

 

 　　使用項目模板自動生成了一個未來5天天氣情況的Json字符串，運行后如下圖所示：

[{
    "date": "2021-11-25T15:15:48.3451682+08:00",
    "temperatureC": 3,
    "temperatureF": 37,
    "summary": "Scorching"
}, {
    "date": "2021-11-26T15:15:48.3481578+08:00",
    "temperatureC": 17,
    "temperatureF": 62,
    "summary": "Scorching"
}, {
    "date": "2021-11-27T15:15:48.3481611+08:00",
    "temperatureC": -9,
    "temperatureF": 16,
    "summary": "Bracing"
}, {
    "date": "2021-11-28T15:15:48.3481614+08:00",
    "temperatureC": 49,
    "temperatureF": 120,
    "summary": "Hot"
}, {
    "date": "2021-11-29T15:15:48.3481615+08:00",
    "temperatureC": 35,
    "temperatureF": 94,
    "summary": "Warm"
}]

　　項目中的文件和文件夾主要有：Controllers（控制器），appsettings.json（配置數據庫等連接參數），Program.cs（軟件啟動項設置），Startup.cs（注冊路由和服務）

       二、建立SqlServer數據庫CRUD操作

      　　 2.1 配置Sqlserver參數，導入Core Nuget程序包

　　      Core Web API和MVC配置類似，需要先導入NuGet包，appsettings.json文件中配置Sql數據庫連接參數，Startup.cs中配置連接服務。

　　三個NuGet包分別為：Microsoft.EntityFrameworkCore（5.0.12）、Microsoft.EntityFrameworkCore.SqlServer、Microsoft.EntityFrameworkCore.Tools、Microsoft.VisualStudio.Web.CodeGenerators.Design

 

　　右鍵點擊項目資源，選擇“管理NuGet程序包”

　　

 

 

 　　在appsetting.json文件中設置數據庫連接字符串

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  },
  "AllowedHosts": "*",
  "ConnectionStrings": {
    "MVCSqlContext": "Server=localhost;Database=InfoUser;User ID=sa;Password=sa;"
  }
}

　　在Startup.cs文件中配置連接服務，如下圖所示

        // This method gets called by the runtime. Use this method to add services to the container.
        public void ConfigureServices(IServiceCollection services)
        {
            services.AddControllersWithViews();
            //下面為加入的數據庫服務，注意MVCSqlContext修改為自己的文件名
            services.AddDbContext<InfoUserContext>(options =>
                    options.UseSqlServer(Configuration.GetConnectionString("MVCSqlContext")));



            services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_3_0);
        }

　　

　　2.2 添加Model模型類、用於CRUDSqlserver數據業務的控制器

　　      首先，在Sqlserver數據庫創建數據庫名為InfoUser的數據庫，建立一個UserData表，表結構如下：

 

 

 

　　在項目中添加一個“Models”文件夾，右鍵點擊Models添加類文件，類的名稱為UserData

 

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.ComponentModel.DataAnnotations;
using System.ComponentModel.DataAnnotations.Schema;

namespace MVC_SQL_Test.Models
{
    public partial class UserData
    {
        [Key, Column(Order = 1)]
        public int UserId { get; set; }
        public string UserName { get; set; }
        public string Password { get; set; }
    }
}

 

　　手動添加一個API 控制器，右鍵點擊Models，依次選擇“添加”->"控制器"->“EF 控制器”

 

 

 

　　

 

　　控制器自動生成后，點擊項目調試運行：https://localhost:44364/api/UserDatas/5，運行結果如下：

 

 

 

      注意：在API項目中也可以同時創建MVC 控制器和Views頁面，可參考第一篇。

 

       三、創建Swagger可視化（RESTFull）服務

      　　 第一步：需要導入Swagger NuGet包，右鍵選中項目依次點擊“NuGet包管理器”->輸入“Swashbuckle.AspNetCore”

 

 

 

　　　第二步：在Startup.cs文件中注冊Swagger服務，代碼如下圖所示：

 

using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.HttpsPolicy;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;
using Microsoft.OpenApi.Models;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.EntityFrameworkCore;
using WebApi.Data;

namespace WebApi
{
    public class Startup
    {
        public Startup(IConfiguration configuration)
        {
            Configuration = configuration;
        }

        public IConfiguration Configuration { get; }

        // This method gets called by the runtime. Use this method to add services to the container.
        public void ConfigureServices(IServiceCollection services)
        {

            services.AddControllers();
            services.AddSwaggerGen(c =>
            {
                c.SwaggerDoc("v1", new OpenApiInfo { Title = "WebApi", Version = "v1" });
            });

            services.AddDbContext<WebApiContext>(options =>
                    options.UseSqlServer(Configuration.GetConnectionString("WebApiContext")));
        }

        // 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();
                app.UseSwagger();
                app.UseSwaggerUI(c => c.SwaggerEndpoint("/swagger/v1/swagger.json", "WebApi v1"));
            }

            app.UseHttpsRedirection();

            app.UseRouting();

            app.UseAuthorization();

            app.UseEndpoints(endpoints =>
            {
                endpoints.MapControllers();
            });
        }
    }
}

 

 

      最終運行效果如下圖所示：