如何使用.NET8 創(chuàng)建使用MySQL數(shù)據(jù)庫的webapi項目
使用 visual studio創(chuàng)建webapi項目
需要安裝的包
從上到下依次為:
- Microsoft.EntityFrameworkCore
- Microsoft.EntityFrameworkCore.Tools
- Mysql.EntityFrameworkCore
- Pomelo.EntityFrameworkCore.MySql
- Swashbuckle.AspNetCore
新建控制器
控制器的命名必須以name+Controlles的格式命名
using Microsoft.AspNetCore.Mvc;
?
// 簡單示例
namespace test_vs_api.Controllers
{
[Route("/[controller]/[action]")] // 路由為類名加方法名
[ApiController] // api控制器
public class TestController : Controller
{
[HttpGet("/[action]")] // 方法及路徑 使用方法名做路徑 如果以上使用了action 此處可以省略
public string GetMessage()
{
return "123";
}
}
}添加數(shù)據(jù)庫連接字符串
在appsettings.json文件里,添加數(shù)據(jù)庫連接字符串
"ConnectionStrings": {
"MySQLConnection": "server=localhost;port=3306;uid=root;pwd=123456;database=yourdatabaase"
},server就是主機ip 本地就是localhost,uid是mysql數(shù)據(jù)庫的用戶名,pwd是mysql數(shù)據(jù)庫的密碼,database是數(shù)據(jù)庫名稱
注冊數(shù)據(jù)庫上下文
在Program.cs中
// 注冊數(shù)據(jù)庫上下文
builder.Services.AddDbContext<DataContext>(options =>
{
options.UseMySQL(builder.Configuration.GetConnectionString("DefaultConnection")!);
});創(chuàng)建數(shù)據(jù)庫上下文
首先在根目錄創(chuàng)建Data文件夾,從中創(chuàng)建DataContext.cs
using Microsoft.EntityFrameworkCore;
using test_vs_api.Entities;
?
namespace test_vs_api.Data
{
public class DataContext : DbContext
{
public DataContext(DbContextOptions<DataContext> options) : base(options)
{
?
}
?
public DbSet<數(shù)據(jù)庫表名> 表名{ get; set; }
}
}關于遷移數(shù)據(jù)庫
打開visual studio的程序包管理器控制臺
在 Visual Studio 中,當您使用 Entity Framework (EF) 作為您的對象關系映射器 (ORM) 時,Package Manager Console 通常用于運行 EF 的命令。dir 命令在大多數(shù)命令行環(huán)境(包括 PowerShell 和命令提示符)中用于列出目錄中的文件和子目錄。但在 EF 的上下文中,您提到的 Add-Migration 和 Update-Database 是特定的 EF 命令。
以下是這些命令的簡要說明:
Add-Migration:
用途:此命令用于創(chuàng)建一個新的遷移。遷移是 EF 用來更改數(shù)據(jù)庫架構的一種方式。每當您更改了您的數(shù)據(jù)模型(例如,添加了一個新的類、更改了一個類的屬性等),您就需要創(chuàng)建一個遷移來反映這些更改到數(shù)據(jù)庫中。
語法:Add-Migration MigrationName
示例:Add-Migration Initial 會創(chuàng)建一個名為 "Initial" 的新遷移。
說明:運行此命令后,EF 會檢查您的數(shù)據(jù)模型與當前數(shù)據(jù)庫架構之間的差異,并為您生成一個遷移類。這個類包含了一個 Up 方法和一個 Down 方法。Up 方法用于應用更改,而 Down 方法用于撤銷這些更改。
Update-Database:
用途:此命令用于應用所有未應用的遷移到您的數(shù)據(jù)庫。
語法:Update-Database
說明:當您運行此命令時,EF 會檢查已定義的遷移(通常在您的項目中的 Migrations 文件夾中)和數(shù)據(jù)庫中已應用的遷移。然后,它會應用所有尚未在數(shù)據(jù)庫中應用的遷移。
簡而言之,Add-Migration 用于創(chuàng)建新的遷移來反映數(shù)據(jù)模型的更改,而 Update-Database 則用于將這些更改應用到數(shù)據(jù)庫中。這兩個命令在開發(fā)過程中經(jīng)常使用,尤其是在數(shù)據(jù)庫架構經(jīng)常更改的情況下。
在控制器中引入數(shù)據(jù)庫上下文
// 引用數(shù)據(jù)庫上下文
private readonly DataContext _context;
public StaffController(DataContext context)
{
_context = context;
}關于 IActionResult 返回類型
public async Task<IActionResult> GetAllStaff()
{
var staffList = new List<Staff>
{
new Staff
{
id = 1,
name = "張三",
department = "研發(fā)部",
sex = "男",
CreateTime = "2024-2-4 16:45:50"
}
};
?
return Ok(staffList);
}IActionResult 是一個接口,它表示一個操作的結果。在 ASP.NET Core 中, IActionResult 接口是所有操作結果類型的基類。 IActionResult 接口定義了幾個方法,這些方法可以用來返回不同的操作結果。例如, Ok 方法返回一個 200 OK 狀態(tài)碼, BadRequest 方法返回一個 400 Bad Request 狀態(tài)碼, NotFound 方法返回一個 404 Not Found 狀態(tài)碼。
只有使用IActionResult類型才會return ,Ok() 和 NotFound()方法,來表示200或404
除此之外的ActionResult類型
public async Task<ActionResult<List<Staff>>> GetAllStaff()
{
var staffList = new List<Staff>
{
new Staff
{
id = 1,
name = "張三",
department = "研發(fā)部",
sex = "男",
CreateTime = "2024-2-4 16:45:50"
}
};
?
return Ok(staffList);
}與上一個代碼段相比,這個代碼段的返回值類型從 IActionResult 改為了 ActionResult<List<Staff>> 。這意味著該方法將返回一個包含 List<Staff> 對象的 ActionResult 對象。
ActionResult 對象是一個泛型類型,它可以包含任何類型的對象。在該代碼段中, ActionResult 對象包含了一個 List<Staff> 對象。
當然我自己最直觀的感受就是他有了示例數(shù)據(jù)和下面的一個模式展示
GET請求獲取全部數(shù)據(jù)
[HttpGet] // 方法及路徑
public async Task<ActionResult<List<Staff>>> GetAllStaff()
{
var staffList = await _context.Staff.ToListAsync();
?
return Ok(staffList);
}GET請求根據(jù)id獲取單個數(shù)據(jù)
不需要分頁時
[HttpGet("{id}")] // 如果需要傳參則需要添加該參數(shù),表示參數(shù)為必需
public async Task<ActionResult<List<Staff>>> GetStaff(int id)
{
var staff = await _context.Staff.FindAsync(id); // 找到id相同的數(shù)據(jù)
?
if(staff is null)
return NotFound("找不到該員工。");
?
return Ok(staff);
}需要分頁時
// 分頁所需的數(shù)據(jù) 如果有多個接口需要使用,可以新建模型類以公用
public class PaginatedResult<T>
{
public required List<T> Data { get; set; }
public int TotalCount { get; set; }
public int TotalPages { get; set; }
public int CurrentPage { get; set; }
public int PageSize { get; set; }
}
?
[HttpGet] // 方法及路徑
public async Task<ActionResult<List<Staff>>> GetAllStaff(int page = 1, int size = 10)
{
?
// 驗證頁碼和每頁大小是否合法
if (page < 1) page = 1;
if (size < 1) size = 10;
?
// 計算總記錄數(shù)和總頁數(shù)
var totalCount = await _context.Staff.CountAsync();
var totalPages = (int)Math.Ceiling(totalCount / (double)size);
?
// 使用Skip和Take方法進行分頁查詢
var staffList = await _context.Staff
.OrderBy(s => s.id) // 假設我們按ID排序,你可以根據(jù)需要修改排序條件
.Skip((page - 1) * size)
.Take(size)
.ToListAsync();
?
if (page > totalPages)
return BadRequest("沒有更多數(shù)據(jù)!");
?
// 創(chuàng)建分頁結果對象
var paginatedResult = new PaginatedResult<Staff>
{
Data = staffList,
TotalCount = totalCount,
TotalPages = totalPages,
CurrentPage = page,
PageSize = size
};
?
return Ok(paginatedResult);
}創(chuàng)建post添加請求時的參數(shù) (類 名)
當我們需要進行添加操作時,我們需要傳遞添加所需的所有參數(shù)。這時我們可以使用創(chuàng)建控制器時提前創(chuàng)建的數(shù)據(jù)模型類。
通常在自行創(chuàng)建的Entities或Models文件夾中。
[HttpPost] // 如果需要傳參則需要添加該參數(shù),表示參數(shù)為必需
public async Task<IActionResult> AddStaff(Staff staff)
{
?
if (ModelState.IsValid)
{
staff.CreateTime = DateTime.Now.ToLocalTime(); // 將UTC時間格式轉(zhuǎn)換為本地時間格式
_context.Staff.Add(staff); // 通過數(shù)據(jù)庫上下文添加數(shù)據(jù)模型類的構造函數(shù)
await _context.SaveChangesAsync(); // 異步等待(async await)保存新數(shù)據(jù)值數(shù)據(jù)庫
?
// 返回成功消息
return Content("添加成功!", "text/plain");
}
else
{
// 如果模型狀態(tài)無效,返回錯誤消息
return BadRequest("無效的請求數(shù)據(jù)。");
}
}Put請求更新數(shù)據(jù)
[HttpPut]
public async Task<IActionResult> UpdateStaff(Staff UpdateStaff)
{
if (ModelState.IsValid)
{
var staff_form = await _context.Staff.FindAsync(UpdateStaff.id); // 找到id相同的數(shù)據(jù)
?
if (staff_form is null)
return NotFound("找不到該員工。");
?
// 依次更改數(shù)據(jù)字段
staff_form.name = UpdateStaff.name;
staff_form.department = UpdateStaff.department;
staff_form.sex = UpdateStaff.sex;
?
await _context.SaveChangesAsync();
?
return Ok("修改成功!");
}
else
{
// 如果模型狀態(tài)無效,返回錯誤消息
return BadRequest("無效的請求數(shù)據(jù)。");
}
}Delete刪除數(shù)據(jù)
[HttpDelete]
public async Task<IActionResult> DelStaff(int id)
{
var staff = await _context.Staff.FindAsync(id); // 找到id相同的數(shù)據(jù)
?
if (staff is null)
return NotFound("找不到該員工。");
?
_context.Staff.Remove(staff);
?
await _context.SaveChangesAsync();
?
return Ok("刪除成功!");
}關于創(chuàng)建時間
由于.NET8 webapi中默認使用UTC的時間格式,而北京時間使用的是UTC+8的時間格式。所以api中返回的時間會比國內(nèi)本地時間晚八個小時,我們需要對時間格式進行轉(zhuǎn)換。
使用DateTime.Now.ToLocalTime();將UTC時間轉(zhuǎn)換為本地時間,不知道為什么在數(shù)據(jù)模型類中不管用。所以我在添加功能的api中手動進行轉(zhuǎn)換,雖然swagger文檔顯示的仍是UTC時間,但數(shù)據(jù)庫中已然轉(zhuǎn)換成功。
修改時間格式,將文件放到Entities文件夾中
// 解決時間格式 ISO 8601 帶T的問題
builder.Services.AddControllers().AddJsonOptions(configure =>
{
configure.JsonSerializerOptions.Converters.Add(new DatetimeJsonConverter()); // 使用一個新類更改ISO 8601時間格式
});關于跨域問題
Cross-Origin Resource Sharing 跨源資源共享 (CORS):
- 是一種 W3C 標準,允許服務器放寬同源策略。
- 不是安全功能,CORS 放松了安全限制。 允許 CORS 并不會使 API 更安全。 有關詳細信息,請參閱 CORS 的工作原理。
- 允許服務器顯式允許某些跨源請求,同時拒絕其他請求。
- 比早期技術(如 JSONP)更安全、更靈活。
—— 摘自微軟ASP.NET Core 8.0 文檔
文心一言給出的解決方案
您遇到的錯誤是由于跨域資源共享(CORS)策略導致的。CORS是一種安全機制,它限制了從一個源(域、協(xié)議和端口)加載的網(wǎng)頁如何與另一個源的資源進行交互。當您嘗試使用Ajax從一個源(例如本地文件系統(tǒng)或localhost:某個端口)向另一個源(在本例中是https://localhost:7033)發(fā)送請求時,瀏覽器會檢查響應頭中是否包含Access-Control-Allow-Origin字段,以確定是否允許這種跨域請求。
var builder = WebApplication.CreateBuilder(args);
// 添加CORS服務
builder.Services.AddCors(options =>
{
options.AddPolicy("MyCorsPolicy", builder =>
{
builder.WithOrigins("http://localhost:你的前端端口號",
// ...其他源
)
.AllowAnyHeader()
.AllowAnyMethod();
});
});
var app = builder.Build();
// 使用CORS中間件
app.UseCors("MyCorsPolicy");
// 其他中間件和終端配置...
app.Run();使用正則表達式校驗
using System.ComponentModel.DataAnnotations;
?
namespace test_vs_api.Entities
{
public class User
{
public int id { get; set; }
public required string UserName { get; set; }
public required string Password { get; set; }
?
[RegularExpression(@"^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$", ErrorMessage = "請輸入有效的郵箱地址。")] // 像這樣
public required string Email { get; set; }
public required string NickName { get; set; }
public required DateTime CreateTime { get; set; }
}
}部署在IIs
首先需要安裝.NET-hosting文件,根據(jù)使用.NET版本進行安裝。打開IIS,安裝模塊。
添加網(wǎng)站,訪問api路徑即可
部署在linux服務器
VS發(fā)布時部署模式選擇獨立,目標運行時選擇linux對應的版本,數(shù)據(jù)庫與EF遷移記得勾選

如果部署模式選擇框架依賴,那么服務器就要安裝dotnet
隨后將發(fā)布后的項目上傳至服務器任意目錄中,打開終端輸入命令行./your_api
在linux運行api
dotnet your_api.dll // 使用dotnet運行 ./your_api // 獨立運行 nohup dotnet yourapi.dll & // 在后臺持續(xù)運行
接口拒絕訪問時
在appsettings.json文件中添加以下代碼
// 如果在訪問接口時,遇到了http請求被重定向到https的問題,可以刪掉https的配置
"Kestrel": {
"Endpoints": {
"Http": {
"Url": "http://*:5000"
},
"Https": {
"Url": "https://*:5001"
}
}
}到此這篇關于使用.NET8 創(chuàng)建使用MySQL數(shù)據(jù)庫的webapi項目的文章就介紹到這了,更多相關.NET8 webapi項目內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家!
相關文章
asp.net 抓取網(wǎng)頁源碼三種實現(xiàn)方法
asp.net 抓取網(wǎng)頁源碼三種實現(xiàn)方法,需要的朋友可以參考一下2013-06-06
Asp.net FileUpload上傳文件夾并檢測所有子文件的實現(xiàn)代碼
這篇文章主要介紹了Asp.net FileUpload上傳文件夾并檢測所有子文件的實現(xiàn)代碼,需要的朋友可以參考下2017-05-05
Ubuntu16.04系統(tǒng)搭建.Net Core開發(fā)環(huán)境
本文詳細講解了Ubuntu系統(tǒng)搭建.Net Core開發(fā)環(huán)境的方法,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧2022-02-02
Repeater綁定dictionary數(shù)據(jù)源代碼及報錯解決
為大家講解下Repeater綁定dictionary數(shù)據(jù)源以及報錯處理的方法,感興趣的朋友可以參考下哈,希望對你有所幫助2013-04-04
編寫的vs2005水晶報表程序在vs2008下正常使用的一些實現(xiàn)方法
以前用vs2005編寫的WEB程序,現(xiàn)在使用vs2008時總是出現(xiàn)水晶報表的錯誤,不能使用。經(jīng)過本人實踐,總結一下錯誤原因。2009-09-09
ASP.NET與MySQL數(shù)據(jù)庫簡明圖示入門教程
ASP.NET與MySQL數(shù)據(jù)庫簡明圖示入門教程...2006-09-09

