ASP.NET WebAPI是一种创建 Web服务的框架，通过它可以轻松地创建RESTful API并支持传输多种数据格式。连接数据库是开发WebAPI的重要一步，下面将详细讲解ASP.NET WebAPI连接数据库的方法。

1.创建数据库

使用ASP.NET WebAPI连接数据库，首先需要创建一个数据库。可以使用SQL Server Management Studio（SSMS）等工具创建一个数据库，并在其中添加表来存储数据。下面是一个创建数据库的示例：

CREATE DATABASE WebApiDemo
USE WebApiDemo
GO

CREATE TABLE Users (
    UserId INT IDENTITY(1,1) PRIMARY KEY,
    FirstName VARCHAR(50) NOT NULL,
    LastName VARCHAR(50) NOT NULL,
    Email VARCHAR(50) NOT NULL
)

上面的示例创建了一个名为WebApiDemo的数据库，并在其中创建了一个名为Users的表，表中包含UserId、FirstName、LastName和Email列。

2.安装Entity Framework

ASP.NET WebAPI应用程序需要使用Entity Framework来管理数据库。可以通过NuGet控制台来安装Entity Framework:

Install-Package EntityFramework

3.创建数据模型

在WebAPI应用程序中，需要使用数据模型类来定义数据库表对应的实体类。创建一个名为User的数据模型类，可以使用以下代码：

public class User
{
    public int UserId { get; set; }
    public string FirstName { get; set; }
    public string LastName { get; set; }
    public string Email { get; set; }
}

4.配置数据连接

在WebAPI应用程序中配置数据库连接时，需要在Web.config文件中定义连接字符串。以下是一个连接到本地SQL Server Express实例的示例：

<connectionStrings>
  <add name="WebApiDemoContext" connectionString="Data Source=.\SQLEXPRESS;Initial Catalog=WebApiDemo;Integrated Security=True;" providerName="System.Data.SqlClient" />
</connectionStrings>

5.创建数据上下文

数据上下文表示应用程序和数据库之间的连接，是管理数据库的关键。创建名为WebApiDemoContext的数据上下文，可以使用以下代码：

public class WebApiDemoContext : DbContext
{
    public WebApiDemoContext() : base("WebApiDemoContext")
    {
    }

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

6.创建数据访问服务

创建数据访问服务来与WebAPI控制器交互。以下是一个使用数据上下文从数据库中获取用户数据的示例：

public class UserService
{
    private WebApiDemoContext db;

    public UserService()
    {
        db = new WebApiDemoContext();
    }

    public List<User> GetAllUsers()
    {
        return db.Users.ToList();
    }

    public User GetUserById(int userId)
    {
        return db.Users.Find(userId);
    }

    public void AddUser(User user)
    {
        db.Users.Add(user);
        db.SaveChanges();
    }

    public void UpdateUser(User user)
    {
        db.Entry(user).State = EntityState.Modified;
        db.SaveChanges();
    }

    public void DeleteUser(int userId)
    {
        User user = db.Users.Find(userId);
        db.Users.Remove(user);
        db.SaveChanges();
    }
}

7.创建WebAPI控制器

使用上面创建的数据访问服务在WebAPI控制器中实现对用户数据的操作。这是一个包含五个动作的控制器，可用于获取、添加、更新和删除用户：

public class UsersController : ApiController
{
    private UserService userService;

    public UsersController()
    {
        userService = new UserService();
    }

    // GET api/users
    public IEnumerable<User> Get()
    {
        return userService.GetAllUsers();
    }

    // GET api/users/5
    public User Get(int id)
    {
        return userService.GetUserById(id);
    }

    // POST api/users
    public void Post([FromBody]User user)
    {
        userService.AddUser(user);
    }

    // PUT api/users/5
    public void Put(int id, [FromBody]User user)
    {
        userService.UpdateUser(user);
    }

    // DELETE api/users/5
    public void Delete(int id)
    {
        userService.DeleteUser(id);
    }
}

示例1

以下是一个使用上述步骤创建的WebAPI控制器的Postman示例：

要添加一个新用户，请使用以下HTTP POST请求：http://localhost:port/api/users，请求主体是一个包含用户信息的JSON对象：

{
  "FirstName": "John",
  "LastName": "Doe",
  "Email": "john.doe@example.com"
}

示例2

以下是一个使用上述步骤创建的WebAPI控制器的C#客户端示例：

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;

namespace WebApiDemoClient
{
    class Program
    {
        static void Main(string[] args)
        {
            // HTTP GET
            GetUsers();

            // HTTP POST
            CreateUser(new User { FirstName = "Alice", LastName = "Jones", Email = "alice.jones@example.com" });

            // HTTP PUT
            UpdateUser(new User { UserId = 1, FirstName = "Bob", LastName = "Smith", Email = "bob.smith@example.com" });

            // HTTP DELETE
            DeleteUser(2);
        }

        static async void GetUsers()
        {
            using (HttpClient client = new HttpClient())
            {
                client.BaseAddress = new Uri("http://localhost:port");
                client.DefaultRequestHeaders.Accept.Clear();
                client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));

                HttpResponseMessage response = await client.GetAsync("api/users");
                if (response.IsSuccessStatusCode)
                {
                    List<User> users = await response.Content.ReadAsAsync<List<User>>();
                    foreach (User user in users)
                    {
                        Console.WriteLine($"{user.FirstName} {user.LastName} ({user.Email})");
                    }
                }
            }
        }

        static async void CreateUser(User user)
        {
            using (HttpClient client = new HttpClient())
            {
                client.BaseAddress = new Uri("http://localhost:port");
                client.DefaultRequestHeaders.Accept.Clear();
                client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));

                HttpResponseMessage response = await client.PostAsJsonAsync("api/users", user);
                response.EnsureSuccessStatusCode();
            }
        }

        static async void UpdateUser(User user)
        {
            using (HttpClient client = new HttpClient())
            {
                client.BaseAddress = new Uri("http://localhost:port");
                client.DefaultRequestHeaders.Accept.Clear();
                client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));

                HttpResponseMessage response = await client.PutAsJsonAsync($"api/users/{user.UserId}", user);
                response.EnsureSuccessStatusCode();
            }
        }

        static async void DeleteUser(int userId)
        {
            using (HttpClient client = new HttpClient())
            {
                client.BaseAddress = new Uri("http://localhost:port");
                client.DefaultRequestHeaders.Accept.Clear();
                client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));

                HttpResponseMessage response = await client.DeleteAsync($"api/users/{userId}");
                response.EnsureSuccessStatusCode();
            }
        }
    }
}

本站文章如无特殊说明，均为本站原创，如若转载，请注明出处：ASP.NET WebAPI连接数据库的方法 - Python技术站

ASP.NET WebAPI连接数据库的方法