当前位置：首页 > news >正文

.NET Core 集成 SqlSugar 最简实战（开箱即用）

news 2026/3/26 21:55:10

一、前言

SqlSugar 是一款轻量、高性能的 ORM 框架，相比 EF Core 更加轻量、易用，非常适合中小型项目快速开发。本文将分享ASP.NET Core 中集成 SqlSugar 的最简配置方案，包含核心配置、Swagger 集成、跨域配置，代码可直接复制使用。

二、环境准备

.NET 6/7/8（本文以 .NET 8 为例）
SqlSugarCore 包（NuGet 安装）
SQL Server 数据库（可根据需求替换为 MySQL/PostgreSQL 等）

安装 NuGet 包

Install-Package SqlSugarCore Install-Package Swashbuckle.AspNetCore

三、核心代码实现

3.1 Program.cs 完整配置

using SqlSugar; using Microsoft.OpenApi.Models; var builder = WebApplication.CreateBuilder(args); // 添加控制器支持 builder.Services.AddControllers(); // 添加端点探索器（Swagger 必需） builder.Services.AddEndpointsApiExplorer(); // 最简 Swagger 配置（方便接口调试） builder.Services.AddSwaggerGen(); // 添加 HttpContext 访问器（可选，按需添加） builder.Services.AddHttpContextAccessor(); // 核心：SqlSugar 最简配置（无日志、无测试连接，仅基础功能） builder.Services.AddScoped<ISqlSugarClient>(s => { return new SqlSugarClient(new ConnectionConfig() { // 数据库类型（可替换为 DbType.MySql/DbType.Sqlite 等） DbType = DbType.SqlServer, // 从配置文件读取连接字符串 ConnectionString = builder.Configuration.GetConnectionString("DefaultConnection"), // 自动关闭连接（推荐开启，避免连接泄露） IsAutoCloseConnection = true }); }); // 跨域配置（解决前端调用接口跨域问题） builder.Services.AddCors(options => { options.AddPolicy("any", policy => { policy.AllowAnyMethod() // 允许所有请求方法 .AllowAnyHeader() // 允许所有请求头 .AllowCredentials() // 允许携带凭证（如 Cookie） .SetIsOriginAllowed(origin => true); // 允许所有来源 }); }); var app = builder.Build(); // 开发环境启用 Swagger if (app.Environment.IsDevelopment()) { app.UseSwagger(); app.UseSwaggerUI(); // Swagger UI 页面，默认地址：/swagger } // 强制 HTTPS（生产环境推荐，开发环境可注释） app.UseHttpsRedirection(); // 启用跨域策略 app.UseCors("any"); // 启用授权（按需使用，无权限控制可保留） app.UseAuthorization(); // 映射控制器路由 app.MapControllers(); app.Run();

3.2 配置文件（appsettings.json）

{ "Logging": { "LogLevel": { "Default": "Information", "Microsoft.AspNetCore": "Warning" } }, // 数据库连接字符串 "ConnectionStrings": { "DefaultConnection": "Server=.;User Id=sa;Password=123456;Database=Demo01;Persist Security Info=True;Trust Server Certificate=True" }, "AllowedHosts": "*" }

四、快速使用示例

4.1 创建实体类

using SqlSugar; namespace DemoProject.Entities { /// <summary> /// 用户表 /// </summary> [SugarTable("Sys_User")] // 映射数据库表名 public class SysUser { /// <summary> /// 主键（自增） /// </summary> [SugarColumn(IsPrimaryKey = true, IsIdentity = true)] public int Id { get; set; } /// <summary> /// 用户名 /// </summary> public string UserName { get; set; } /// <summary> /// 密码 /// </summary> public string Password { get; set; } } }

4.2 创建控制器（CURD 示例）

using Microsoft.AspNetCore.Mvc; using SqlSugar; using DemoProject.Entities; namespace DemoProject.Controllers { [ApiController] [Route("api/[controller]")] public class UserController : ControllerBase { private readonly ISqlSugarClient _db; // 构造函数注入 SqlSugar 客户端 public UserController(ISqlSugarClient db) { _db = db; } /// <summary> /// 获取所有用户 /// </summary> [HttpGet] public async Task<IActionResult> GetAll() { var users = await _db.Queryable<SysUser>().ToListAsync(); return Ok(users); } /// <summary> /// 添加用户 /// </summary> [HttpPost] public async Task<IActionResult> Add(SysUser user) { var result = await _db.Insertable(user).ExecuteCommandAsync(); return Ok(result > 0 ? "添加成功" : "添加失败"); } } }