.NET 8框架使用Web Core API项目引用SqlSugar教程

在现代软件开发中，API的设计与实现至关重要，而在.NET生态中，ASP.NET Core 是最流行的Web框架之一。SqlSugar则是一个简单易用且功能强大的ORM框架，可以帮助我们更高效地与数据库进行交互。本文将介绍如何在ASP.NET Core 8项目中集成SqlSugar，并通过一个简单的示例来演示如何使用它。

环境准备

首先，请确保你的开发环境中已经安装了以下组件：

1. .NET 8 SDK（可以通过官网下载）
2. Visual Studio 2022或其他支持.NET开发的IDE

创建ASP.NET Core Web API项目

1. 打开命令行工具（如：cmd 或 PowerShell），并运行以下命令以创建新的Web API项目：

bash dotnet new webapi -n SqlSugarApiDemo cd SqlSugarApiDemo

1. 接下来，使用以下命令安装SqlSugar：

bash dotnet add package SqlSugar

配置SqlSugar

创建一个模型类，表示数据库中的表。假设我们有一个简单的用户表：

// Models/User.cs
namespace SqlSugarApiDemo.Models
{
    public class User
    {
        public int Id { get; set; }
        public string Name { get; set; }
        public int Age { get; set; }
    }
}

接下来，我们创建一个数据库上下文类，来配置SqlSugar：

// Data/SugarDbContext.cs
using SqlSugar;

namespace SqlSugarApiDemo.Data
{
    public class SugarDbContext
    {
        private readonly SqlSugarClient _db;

        public SugarDbContext(string connectionString)
        {
            _db = new SqlSugarClient(new ConnectionConfig
            {
                ConnectionString = connectionString,
                DbType = DbType.SqlServer,  // 根据你的数据库类型修改
                IsAutoCloseConnection = true
            });

            _db.CodeFirst.InitTables<User>(); // 初始化User表
        }

        public SqlSugarClient GetDb()
        {
            return _db;
        }
    }
}

然后，在Program.cs中配置SqlSugar：

// Program.cs
using SqlSugarApiDemo.Data;

var builder = WebApplication.CreateBuilder(args);

// 读取连接字符串，假设在appsettings.json中定义
var connectionString = builder.Configuration.GetConnectionString("DefaultConnection");
builder.Services.AddSingleton(new SugarDbContext(connectionString));

var app = builder.Build();

app.MapControllers();

app.Run();

创建控制器

接下来，我们创建一个控制器来处理用户相关的API请求。

// Controllers/UserController.cs
using Microsoft.AspNetCore.Mvc;
using SqlSugar;
using SqlSugarApiDemo.Data;
using SqlSugarApiDemo.Models;

namespace SqlSugarApiDemo.Controllers
{
    [ApiController]
    [Route("[controller]")]
    public class UserController : ControllerBase
    {
        private readonly SugarDbContext _dbContext;

        public UserController(SugarDbContext dbContext)
        {
            _dbContext = dbContext;
        }

        [HttpGet]
        public IActionResult GetUsers()
        {
            var users = _dbContext.GetDb().Queryable<User>().ToList();
            return Ok(users);
        }

        [HttpPost]
        public IActionResult AddUser(User user)
        {
            var id = _dbContext.GetDb().Insertable(user).ExecuteReturnIdentity();
            return CreatedAtAction(nameof(GetUsers), new { id }, user);
        }
    }
}

配置连接字符串

在appsettings.json中添加数据库连接字符串：

{
  "ConnectionStrings": {
    "DefaultConnection": "Server=your_server;Database=your_database;User Id=your_username;Password=your_password;"
  },
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft.AspNetCore": "Warning"
    }
  },
  "AllowedHosts": "*"
}

运行项目

在Visual Studio中，选择调试或运行项目。你可以使用Postman或其他API测试工具发送GET和POST请求，以测试你的API。

测试示例

• GET 请求: GET http://localhost:5000/user，获取用户列表。
• POST 请求: POST http://localhost:5000/user，并在请求体中发送用户数据（例如 { "Name": "Alice", "Age": 30 }）以添加新用户。

总结

通过以上步骤，我们成功地创建了一个使用ASP.NET Core 8框架和SqlSugar的Web API项目。本文简单介绍了数据库的配置、模型的创建以及如何实现基本的CRUD操作。SqlSugar简化了与数据库之间的交互过程，使得开发更加高效。希望这篇教程能对你有所帮助！