asp.net使用WebAPI和EF框架结合实现数据的基本操作

我来详细讲解“ASP.NET使用WebAPI和EF框架结合实现数据的基本操作”的完整攻略。

1. 简介

ASP.NET是基于.NET Framework的一个Web应用程序开发框架，EF（Entity Framework）是.NET中用于数据访问的ORM框架，WebAPI是.NET框架中的一个轻量级的HTTP服务，它可以用来创建RESTful风格的Web服务。

本攻略通过结合使用WebAPI和EF框架，实现了数据的基本操作，包括数据的增、删、改、查。

2. 环境准备

在开始本攻略之前，需要先完成以下环境准备工作：

• 安装Visual Studio，用于编写和调试代码。
• 安装.NET Framework和ASP.NET，用于运行Web应用程序。
• 在Visual Studio中安装EF框架，可以通过NuGet包管理器安装。

3. 创建WebAPI项目

在Visual Studio中创建一个WebAPI项目，可以选择空项目或者Web API模板。这里选择Web API模板，在创建项目时，需要选择HTTP应用程序作为项目类型，然后选择Web API模板。

4. 配置EF框架

在WebAPI项目中，可以使用EF框架来访问数据库。需要在Web.config文件中配置EF框架连接字符串和数据提供程序。以下是一个示例配置：

<connectionStrings>
  <add name="DefaultConnection" connectionString="Data Source=(LocalDb)\v11.0;Initial Catalog=TestDB;Integrated Security=SSPI;" providerName="System.Data.SqlClient" />
</connectionStrings>

<entityFramework>
  <defaultConnectionFactory type="System.Data.Entity.Infrastructure.SqlConnectionFactory, EntityFramework" />
  <providers>
    <provider invariantName="System.Data.SqlClient" type="System.Data.Entity.SqlServer.SqlProviderServices, EntityFramework.SqlServer" />
  </providers>
</entityFramework>

这里的DefaultConnection是数据源的名称，TestDB是要连接的数据库名称，Integrated Security=SSPI表示使用SSPI身份验证来登录数据库，providerName是要使用的数据提供程序。

5. 创建数据库模型

在使用EF框架之前，需要先创建一个数据库模型。可以使用EF框架的代码优先（Code First）方式来创建数据库模型。

以下是一个示例的数据库模型：

public class TodoItem
{
    public int Id { get; set; }
    public string Name { get; set; }
    public bool IsComplete { get; set; }
}

这个模型表示一个TodoItem，包括Id、Name和IsComplete三个属性。

6. 创建数据访问上下文

要使用EF框架访问数据库，需要创建一个数据访问上下文（DbContext）。以下是一个示例的数据访问上下文：

public class TodoContext : DbContext
{
    public TodoContext() : base("DefaultConnection")
    {
    }

    public DbSet<TodoItem> TodoItems { get; set; }
}

这个数据访问上下文表示一个TodoContext，继承自EF框架的DbContext类。在构造函数中，指定了连接字符串的名称DefaultConnection。

7. 创建WebAPI控制器

使用WebAPI框架来创建控制器，用于对数据进行增、删、改、查的操作。以下是一个示例控制器：

public class TodoItemsController : ApiController
{
    private TodoContext db = new TodoContext();

    // GET: api/TodoItems
    public IQueryable<TodoItem> GetTodoItems()
    {
        return db.TodoItems;
    }

    // GET: api/TodoItems/5
    [ResponseType(typeof(TodoItem))]
    public IHttpActionResult GetTodoItem(int id)
    {
        TodoItem todoItem = db.TodoItems.Find(id);
        if (todoItem == null)
        {
            return NotFound();
        }

        return Ok(todoItem);
    }

    // PUT: api/TodoItems/5
    [ResponseType(typeof(void))]
    public IHttpActionResult PutTodoItem(int id, TodoItem todoItem)
    {
        if (!ModelState.IsValid)
        {
            return BadRequest(ModelState);
        }

        if (id != todoItem.Id)
        {
            return BadRequest();
        }

        db.Entry(todoItem).State = EntityState.Modified;

        try
        {
            db.SaveChanges();
        }
        catch (DbUpdateConcurrencyException)
        {
            if (!TodoItemExists(id))
            {
                return NotFound();
            }
            else
            {
                throw;
            }
        }

        return StatusCode(HttpStatusCode.NoContent);
    }

    // POST: api/TodoItems
    [ResponseType(typeof(TodoItem))]
    public IHttpActionResult PostTodoItem(TodoItem todoItem)
    {
        if (!ModelState.IsValid)
        {
            return BadRequest(ModelState);
        }

        db.TodoItems.Add(todoItem);
        db.SaveChanges();

        return CreatedAtRoute("DefaultApi", new { id = todoItem.Id }, todoItem);
    }

    // DELETE: api/TodoItems/5
    [ResponseType(typeof(TodoItem))]
    public IHttpActionResult DeleteTodoItem(int id)
    {
        TodoItem todoItem = db.TodoItems.Find(id);
        if (todoItem == null)
        {
            return NotFound();
        }

        db.TodoItems.Remove(todoItem);
        db.SaveChanges();

        return Ok(todoItem);
    }

    private bool TodoItemExists(int id)
    {
        return db.TodoItems.Count(e => e.Id == id) > 0;
    }

    protected override void Dispose(bool disposing)
    {
        if (disposing)
        {
            db.Dispose();
        }
        base.Dispose(disposing);
    }
}

这个控制器包含了Get、Put、Post和Delete四个方法，分别对应了数据的查询、修改、添加和删除操作。控制器中的每个方法都有对应的HTTP请求类型（GET、PUT、POST、DELETE）。

8. 使用Postman测试API

在控制器创建完成后，可以使用Postman来测试API。以下是一个示例操作：

• 发送一个GET请求，获取所有的TodoItems：

GET http://localhost:12345/api/TodoItems

• 发送一个GET请求，获取指定Id的TodoItem：

GET http://localhost:12345/api/TodoItems/1

• 发送一个POST请求，添加一个新的TodoItem：

```
POST http://localhost:12345/api/TodoItems
Content-Type: application/json

{
"Name": "Learn ASP.NET",
"IsComplete": false
}
```

• 发送一个PUT请求，修改指定Id的TodoItem：

```
PUT http://localhost:12345/api/TodoItems/1
Content-Type: application/json

{
"Id": 1,
"Name": "Learn ASP.NET Core",
"IsComplete": false
}
```

• 发送一个DELETE请求，删除指定Id的TodoItem：

DELETE http://localhost:12345/api/TodoItems/1

9. 示例说明

除了以上详细的说明外，这里再给出两条示例说明。假设我们有一个学生信息管理的API，包括学生的姓名、年龄和性别。以下是两个操作示例：

示例一

我们想要统计年龄小于25岁的学生人数。可以在控制器中添加如下方法：

// GET: api/Students/count
public IHttpActionResult GetStudentCount()
{
    var count = db.Students.Where(s => s.Age < 25).Count();
    return Ok(count);
}

在Postman中发送如下请求：

GET http://localhost:12345/api/Students/count

返回结果中会显示年龄小于25岁的学生人数。

示例二

我们想要修改学生的性别。可以在控制器中添加如下方法：

// PUT: api/Students/5/gender/male
[ResponseType(typeof(void))]
[HttpPut]
[Route("api/Students/{id}/gender/{gender}")]
public IHttpActionResult ChangeGender(int id, string gender)
{
    Student student = db.Students.Find(id);
    if (student == null)
    {
        return NotFound();
    }

    student.Gender = gender;
    db.Entry(student).State = EntityState.Modified;

    try
    {
        db.SaveChanges();
    }
    catch (DbUpdateConcurrencyException)
    {
        if (!StudentExists(id))
        {
            return NotFound();
        }
        else
        {
            throw;
        }
    }

    return StatusCode(HttpStatusCode.NoContent);
}

在Postman中发送如下请求：

PUT http://localhost:12345/api/Students/1/gender/male

表示将Id为1的学生的性别修改为male。

总结

本攻略详细讲解了如何使用WebAPI和EF框架结合实现数据的基本操作，在步骤5中给出了一个示例的数据模型，在步骤6中给出了一个示例的数据访问上下文，在步骤7中给出了一个示例的API控制器，步骤8中给出了Postman测试API的示例，而步骤9中则给出了两个具体的操作示例，希望对读者有所帮助。