手把手搭建基于.NET 8.0的Web API项目

曂沅仴駦  金牌会员 | 2024-6-21 12:58:40 | 显示全部楼层 | 阅读模式
打印 上一主题 下一主题
楼主

主题 542|帖子 542|积分 1626

1.配景

工作以后，大部门时间都是在做基于业务的CRUD工作，软件产物或者项目的框架基本都早就搭建好了，步伐员只需要在框架内去填格子打代码就行了。于是，我抽了时间来搭建个简单的三层架构模式的web api项目，技能点大概如下：三层架构+EFCore+.Net 8.0 Web Api+AutoMap+IOC容器。本文是我搭建项目的一个过程，比较简单和粗糙，但是完备，得当学习和练手。
2.操作

2.1 项目的架构图

其实图1是我最开始的设计布局，但是设计风格有提到：模块间应该依赖抽象，而不是详细的实现。所以我将布局改造为了图2，针对业务逻辑层和数据访问层开了一个抽象接口层。

2.2 新增项目

按照如下操作，创建项目：SimpleWebApi




2.3 新增类库

按照下图新增类库：SimpleWebApi.Migration、SimpleWebApi.Business.Service、SimpleWebApi.Business.Service.Interface
注意：SimpleWebApi.Migration是数据库访问
SimpleWebApi.Business.Service、SimpleWebApi.Business.Service.Interface是做业务逻辑



2.4 支持EFCore

找到类库：SimpleWebApi.Migration，并给这个项目，添加如下nuget包：Microsoft.EntityFrameworkCore、Microsoft.EntityFrameworkCore.SqlServer、Microsoft.EntityFrameworkCore.Tools、Microsoft.EntityFrameworkCore.Design

按照如下所示：添加Model和DBContext

Commodity的代码如下：
  1. using System;
  2. using System.Collections.Generic;
  4. namespace SimpleWebApi.Migration.Models;
  6. public partial class Commodity
  7. {
  8.     public int Id { get; set; }
  10.     public long? ProductId { get; set; }
  12.     public int? CategoryId { get; set; }
  14.     public string? Title { get; set; }
  16.     public decimal? Price { get; set; }
  18.     public string? Url { get; set; }
  20.     public string? ImageUrl { get; set; }
  21. }
复制代码
CompanyInfo的代码如下：
  1. using System;
  2. using System.Collections.Generic;
  4. namespace SimpleWebApi.Migration.Models;
  6. public partial class CompanyInfo
  7. {
  8.     public int CompanyId { get; set; }
  10.     public string? Name { get; set; }
  12.     public DateTime? CreateTime { get; set; }
  14.     public int CreatorId { get; set; }
  16.     public int? LastModifierId { get; set; }
  18.     public DateTime? LastModifyTime { get; set; }
  20.     public virtual ICollection<SysUser> SysUsers { get; set; } = new List<SysUser>();
  21. }
复制代码
SysUser的代码如下：
  1. using System;
  2. using System.Collections.Generic;
  4. namespace SimpleWebApi.Migration.Models;
  6. public partial class SysUser
  7. {
  8.     public int Id { get; set; }
  10.     public string? Name { get; set; }
  12.     public string? Password { get; set; }
  14.     public int Status { get; set; }
  16.     public string? Phone { get; set; }
  18.     public string? Mobile { get; set; }
  20.     public string? Address { get; set; }
  22.     public string? Email { get; set; }
  24.     public long? Qq { get; set; }
  26.     public string? WeChat { get; set; }
  28.     public int? Sex { get; set; }
  30.     public DateTime? LastLoginTime { get; set; }
  32.     public DateTime? CreateTime { get; set; }
  34.     public int? CreateId { get; set; }
  36.     public DateTime? LastModifyTime { get; set; }
  38.     public int? LastModifyId { get; set; }
  40.     public int? CompanyId { get; set; }
  42.     public virtual CompanyInfo? Company { get; set; }
  43. }
复制代码
AdvancedCustomerDbContext的代码如下：
  1. using System;
  2. using System.Collections.Generic;
  3. using Microsoft.EntityFrameworkCore;
  4. using SimpleWebApi.Migration.Models;
  6. namespace SimpleWebApi.Migration
  7. {
  9.     public class AdvancedCustomerDbContext : DbContext
  10.     {
  11.         public AdvancedCustomerDbContext()
  12.         {
  13.         }
  15.         public AdvancedCustomerDbContext(DbContextOptions<AdvancedCustomerDbContext> options)
  16.             : base(options)
  17.         {
  18.         }
  20.         public virtual DbSet<Commodity> Commodities { get; set; }
  22.         public virtual DbSet<CompanyInfo> CompanyInfos { get; set; }
  24.         public virtual DbSet<SysUser> SysUsers { get; set; }
  26.         protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
  27. #warning To protect potentially sensitive information in your connection string, you should move it out of source code. You can avoid scaffolding the connection string by using the Name= syntax to read it from configuration - see https://go.microsoft.com/fwlink/?linkid=2131148. For more guidance on storing connection strings, see https://go.microsoft.com/fwlink/?LinkId=723263.
  28.             => optionsBuilder.UseSqlServer("Data Source=127.0.0.1;Initial Catalog=AdvancedCustomerDB_Init;Persist Security Info=True;User ID=sa;Password=****;Encrypt=False;TrustServerCertificate=true");
  30.         protected override void OnModelCreating(ModelBuilder modelBuilder)
  31.         {
  32.             modelBuilder.Entity<Commodity>(entity =>
  33.             {
  34.                 entity.ToTable("Commodity");
  36.                 entity.Property(e => e.ImageUrl)
  37.                     .HasMaxLength(1000)
  38.                     .IsUnicode(false);
  39.                 entity.Property(e => e.Price).HasColumnType("decimal(18, 2)");
  40.                 entity.Property(e => e.Title)
  41.                     .HasMaxLength(500)
  42.                     .IsUnicode(false);
  43.                 entity.Property(e => e.Url)
  44.                     .HasMaxLength(1000)
  45.                     .IsUnicode(false);
  46.             });
  48.             modelBuilder.Entity<CompanyInfo>(entity =>
  49.             {
  50.                 entity.HasKey(e => e.CompanyId).HasName("PK_Company");
  52.                 entity.ToTable("CompanyInfo");
  54.                 entity.Property(e => e.CreateTime).HasColumnType("datetime");
  55.                 entity.Property(e => e.LastModifyTime).HasColumnType("datetime");
  56.                 entity.Property(e => e.Name)
  57.                     .HasMaxLength(50)
  58.                     .IsUnicode(false);
  59.             });
  61.             modelBuilder.Entity<SysUser>(entity =>
  62.             {
  63.                 entity.ToTable("SysUser");
  65.                 entity.Property(e => e.Address)
  66.                     .HasMaxLength(500)
  67.                     .IsUnicode(false);
  68.                 entity.Property(e => e.CreateTime).HasColumnType("datetime");
  69.                 entity.Property(e => e.Email)
  70.                     .HasMaxLength(50)
  71.                     .IsUnicode(false);
  72.                 entity.Property(e => e.LastLoginTime).HasColumnType("datetime");
  73.                 entity.Property(e => e.LastModifyTime).HasColumnType("datetime");
  74.                 entity.Property(e => e.Mobile)
  75.                     .HasMaxLength(12)
  76.                     .IsUnicode(false);
  77.                 entity.Property(e => e.Name)
  78.                     .HasMaxLength(50)
  79.                     .IsUnicode(false);
  80.                 entity.Property(e => e.Password)
  81.                     .HasMaxLength(50)
  82.                     .IsUnicode(false);
  83.                 entity.Property(e => e.Phone)
  84.                     .HasMaxLength(12)
  85.                     .IsUnicode(false);
  86.                 entity.Property(e => e.Qq).HasColumnName("QQ");
  87.                 entity.Property(e => e.WeChat)
  88.                     .HasMaxLength(50)
  89.                     .IsUnicode(false);
  91.                 entity.HasOne(d => d.Company).WithMany(p => p.SysUsers)
  92.                     .HasForeignKey(d => d.CompanyId)
  93.                     .OnDelete(DeleteBehavior.Cascade)
  94.                     .HasConstraintName("FK_SysUser_CompanyInfo");
  95.             });
  97.             OnModelCreatingPartial(modelBuilder);
  98.         }
  100.         public void OnModelCreatingPartial(ModelBuilder modelBuilder)
  101.         {
  103.         }
  104.     }
  105. }
复制代码
2.5 业务逻辑抽象层

找到项目“SimpleWebApi.Business.Service.Interface”，新增项目引用-SimpleWebApi.Migration，如下图：


按照下图添加以下接口：

IBaseService的代码如下：
  1. using System;
  2. using System.Collections.Generic;
  3. using System.Linq;
  4. using System.Linq.Expressions;
  5. using System.Text;
  6. using System.Threading.Tasks;
  8. namespace SimpleWebApi.Business.Service.Interface
  9. {
  10.     public interface IBaseService
  11.     {
  13.         public IQueryable<T> Query<T>(Expression<Func<T,bool>> funcWhere) where T : class;
  14.     }
  15. }
复制代码
ICommodityService的代码如下：
  1. using SimpleWebApi.Migration.Models;
  2. using System;
  3. using System.Collections.Generic;
  4. using System.Linq;
  5. using System.Text;
  6. using System.Threading.Tasks;
  8. namespace SimpleWebApi.Business.Service.Interface
  9. {
  10.     public interface ICommodityService:IBaseService
  11.     {
  13.         public bool AddCommodity(Commodity commodity);
  15.         public IQueryable<Commodity> GetCommodity(int Id);
  17.      
  19.     }
  20. }
复制代码
ICompanyInfoService的代码如下：
  1. using SimpleWebApi.Migration.Models;
  2. using System;
  3. using System.Collections.Generic;
  4. using System.Linq;
  5. using System.Text;
  6. using System.Threading.Tasks;
  8. namespace SimpleWebApi.Business.Service.Interface
  9. {
  10.     public interface ICompanyInfoService:IBaseService
  11.     {
  12.         CompanyInfo GetCompany(int companyID);  
  13.     }
  14. }
复制代码
ISysUserService的代码如下：
  1. using System;
  2. using System.Collections.Generic;
  3. using System.Linq;
  4. using System.Text;
  5. using System.Threading.Tasks;
  7. namespace SimpleWebApi.Business.Service.Interface
  8. {
  9.     public interface ISysUserService:IBaseService
  10.     {
  11.     }
  12. }
复制代码
2.6 业务逻辑层
找到项目“SimpleWebApi.Business.Service”，新增项目引用如下：SimpleWebApi.Business.Service.Interface和 SimpleWebApi.Migration

按照下图添加以下类：

BaseService的代码如下：
  1. using Microsoft.EntityFrameworkCore;
  2. using SimpleWebApi.Business.Service.Interface;
  3. using System;
  4. using System.Collections.Generic;
  5. using System.Linq;
  6. using System.Linq.Expressions;
  7. using System.Text;
  8. using System.Threading.Tasks;
  10. namespace SimpleWebApi.Business.Service
  11. {
  12.     public class BaseService:IBaseService
  13.     {
  14.         protected DbContext Context;
  15.         public BaseService(DbContext context)
  16.         {
  17.             Console.WriteLine($"{this.GetType().Name}被构造了......");
  18.             this.Context= context;   
  19.         }
  20.         public IQueryable<T> Query<T>(Expression<Func<T, bool>> funcWhere) where T : class
  21.         {
  22.             return this.Context.Set<T>().Where<T>(funcWhere);   
  23.         }
  24.   
  25.     }
  26. }
复制代码

CommodityService的代码如下：
  1. using Microsoft.EntityFrameworkCore;
  2. using SimpleWebApi.Business.Service.Interface;
  3. using SimpleWebApi.Migration.Models;
  4. using System;
  5. using System.Collections.Generic;
  6. using System.Linq;
  7. using System.Text;
  8. using System.Threading.Tasks;
  10. namespace SimpleWebApi.Business.Service
  11. {
  12.     public class CommodityService : BaseService, ICommodityService
  13.     {
  14.         public CommodityService(DbContext context):base(context)
  15.         {
  16.                
  17.         }
  19.         public bool AddCommodity(Commodity commodity)
  20.         {
  21.             this.Context.Set<Commodity>().Add(commodity);
  22.             int num= this.Context.SaveChanges();
  23.             return num > 0;
  24.         }
  26.         public IQueryable<Commodity> GetCommodity(int Id)
  27.         {
  28.             var list= this.Context.Set<Commodity>().Where(a => a.Id == Id);
  29.             return list;
  30.         }
  31.     }
  32. }
复制代码

CompanyInfoService的代码如下：
  1. using Microsoft.EntityFrameworkCore;
  2. using SimpleWebApi.Business.Service.Interface;
  3. using SimpleWebApi.Migration.Models;
  4. using System;
  5. using System.Collections.Generic;
  6. using System.Linq;
  7. using System.Text;
  8. using System.Threading.Tasks;
  10. namespace SimpleWebApi.Business.Service
  11. {
  12.     public class CompanyInfoService:BaseService, ICompanyInfoService
  13.     {
  14.         public CompanyInfoService(DbContext context):base(context)
  15.         {
  16.                
  17.         }
  19.         public CompanyInfo GetCompany(int companyID)
  20.         {
  21.             var company = this.Context.Set<CompanyInfo>().Where(a=>a.CompanyId==companyID).FirstOrDefault();
  22.             return company;
  23.         }
  24.     }
  25. }
复制代码

SysUserService的代码如下：
  1. using Microsoft.EntityFrameworkCore;
  2. using SimpleWebApi.Business.Service.Interface;
  3. using System;
  4. using System.Collections.Generic;
  5. using System.Linq;
  6. using System.Text;
  7. using System.Threading.Tasks;
  9. namespace SimpleWebApi.Business.Service
  10. {
  11.     public class SysUserService:BaseService, ISysUserService
  12.     {
  13.         public SysUserService(DbContext context) : base(context)
  14.         {
  15.                
  16.         }
  17.     }
  18. }
复制代码
2.6 UI

找到项目“SimpleWebApi”，并新增项目引用：
SimpleWebApi.Business.Service、SimpleWebApi.Business.Service.Interface、SimpleWebApi.Migration

按照如下，新增nuget包引用：AutoMapper、AutoMapper.Extensions.Microsoft.DependencyInjection


新增文件夹DTO和Map,并新增类文件和AutoMapper的规则文件

CommodityDTO的代码如下：
  1. using System;
  2. using System.Collections.Generic;
  4. namespace SimpleWebApi;
  6. public class CommodityDTO
  7. {
  8.     public int CommodityId { get; set; }
  10.     public long? ProductId { get; set; }
  12.     public int? CategoryId { get; set; }
  14.     public string? Title { get; set; }
  16.     public decimal? Price { get; set; }
  18.     public string? Url { get; set; }
  20.     public string? ImageUrl { get; set; }
  21. }
复制代码
CompanyInfoDTO的代码如下：
  1. using SimpleWebApi.Migration.Models;
  2. using System;
  3. using System.Collections.Generic;
  5. namespace SimpleWebApi;
  7. public class CompanyInfoDTO
  8. {
  9.     public int CompanyId { get; set; }
  11.     public string? Name { get; set; }
  13.     public DateTime? CreateTime { get; set; }
  15.     public int CreatorId { get; set; }
  17.     public int? LastModifierId { get; set; }
  19.     public DateTime? LastModifyTime { get; set; }
  21.     public virtual ICollection<SysUser> SysUsers { get; set; } = new List<SysUser>();
  22. }
复制代码
AuotoMapConfig的代码如下：
  1. using AutoMapper;
  2. using SimpleWebApi.Migration.Models;
  4. namespace SimpleWebApi
  5. {
  6.     public class AuotoMapConfig:Profile
  7.     {
  8.         public AuotoMapConfig()
  9.         {
  10.             CreateMap<Commodity, CommodityDTO>().ForMember(c=>c.CommodityId, s=>s.MapFrom(c=>c.Id))
  11.                 .ForMember(c=>c.ProductId,s=>s.MapFrom(c=>c.ProductId))
  12.                 .ForMember(c=>c.CategoryId,s=>s.MapFrom(c=>c.CategoryId))
  13.                 .ForMember(c=>c.Title,s=>s.MapFrom(c=>c.Title))
  14.                 .ForMember(c=>c.Price,s=>s.MapFrom(c=>c.Price))
  15.                 .ForMember(c=>c.Url,s=>s.MapFrom(c=>c.Url))
  16.                 .ForMember(c=>c.ImageUrl,s=>s.MapFrom(c=>c.ImageUrl));
  18.             CreateMap<CompanyInfo, CompanyInfoDTO>();
  20.         }
  22.     }
  23. }
复制代码
为了添加对象映射，DBContext，对象注入等，打开Program文件，按照如下添加


上图的红色代码如下：
  1.   //查询数据库真实数据的业务逻辑层服务注册
  2.   builder.Services.AddTransient<ICommodityService, CommodityService>();
  3.   builder.Services.AddTransient<ICompanyInfoService, CompanyInfoService>();
  5.   //添加DbContext
  6.   //builder.Services.AddDbContext<AdvancedCustomerDbContext>();
  7.   builder.Services.AddTransient<DbContext, AdvancedCustomerDbContext>();
  9.   //支持AutoMapper
  10.   builder.Services.AddAutoMapper(options =>
  11.   {
  12.       options.AddProfile<AuotoMapConfig>();
  14.   });
复制代码
选中“Controllers”文件夹新增控制器 ApiController

ApiController代码如下：
  1. using AutoMapper;
  2. using Microsoft.AspNetCore.Mvc;
  3. using SimpleWebApi.Business.Service.Interface;
  4. using SimpleWebApi.Migration.Models;
  5. using System.Linq.Expressions;
  7. namespace SimpleWebApi.Controllers
  8. {
  9.     [ApiController]
  10.     [Route("api/[controller]/[action]")]
  11.     public class ApiController : ControllerBase
  12.     {
  13.         private readonly ILogger<ApiController> _logger;
  15.         private ICommodityService _comService;
  16.         private ICompanyInfoService _companyService;
  18.         private IMapper _mapper;
  20.         public ApiController(ILogger<ApiController> logger, ICommodityService comService, ICompanyInfoService companyService, IMapper mapper)
  21.         {
  22.             _logger = logger;
  23.             _comService = comService;
  24.             _companyService = companyService;
  25.             _mapper = mapper;
  26.         }
  28.         [HttpGet]
  29.         public IEnumerable<CommodityDTO> GetCommodity(int Id)
  30.         {
  31.             Expression<Func<Commodity, bool>> funcWhere = null;
  32.             funcWhere = a => a.Id == Id;
  33.             var commodityList = _comService.Query(funcWhere);
  34.             List<CommodityDTO> list = new List<CommodityDTO>();
  35.             _mapper.Map<IQueryable<Commodity>, List<CommodityDTO>>(commodityList, list);
  37.             return list;
  39.         }
  41.         [HttpGet]
  42.         public CompanyInfoDTO GetCompanyInfo(int companyId)
  43.         {
  44.             var company = _companyService.GetCompany(companyId);
  45.             CompanyInfoDTO dto = new CompanyInfoDTO();
  46.             _mapper.Map<CompanyInfo, CompanyInfoDTO>(company, dto);
  48.             return dto;
  50.         }
  51.     }
  52. }
复制代码
 这里有个小坑，打开SimpleWebApi.csproj，按照下图设置，可以办理题目
  1. <InvariantGlobalization>false</InvariantGlobalization>
复制代码

ps：默认该数据值是true，运行步伐后会非常，非常提示如下:
  1. System.Globalization.CultureNotFoundException
  2.   HResult=0x80070057
  3.   Message=Only the invariant culture is supported in globalization-invariant mode. See https://aka.ms/GlobalizationInvariantMode for more information. (Parameter 'name')
  4. en-us is an invalid culture identifier.
  5.   Source=System.Private.CoreLib
  6.   StackTrace:
  7.    在 System.Globalization.CultureInfo.GetCultureInfo(String name)
  8.    在 Microsoft.Data.SqlClient.SqlConnection.TryOpen(TaskCompletionSource`1 retry, SqlConnectionOverrides overrides)
  9.    在 Microsoft.Data.SqlClient.SqlConnection.Open(SqlConnectionOverrides overrides)
  10.    在 Microsoft.Data.SqlClient.SqlConnection.Open()
  11.    在 Microsoft.EntityFrameworkCore.SqlServer.Storage.Internal.SqlServerConnection.OpenDbConnection(Boolean errorsExpected)
  12.    在 Microsoft.EntityFrameworkCore.Storage.RelationalConnection.OpenInternal(Boolean errorsExpected)
  13.    在 Microsoft.EntityFrameworkCore.Storage.RelationalConnection.Open(Boolean errorsExpected)
  14.    在 Microsoft.EntityFrameworkCore.Storage.RelationalCommand.ExecuteReader(RelationalCommandParameterObject parameterObject)
  15.    在 Microsoft.EntityFrameworkCore.Query.Internal.SingleQueryingEnumerable`1.Enumerator.InitializeReader(Enumerator enumerator)
  16.    在 Microsoft.EntityFrameworkCore.Query.Internal.SingleQueryingEnumerable`1.Enumerator.<>c.<MoveNext>b__21_0(DbContext _, Enumerator enumerator)
  17.    在 Microsoft.EntityFrameworkCore.SqlServer.Storage.Internal.SqlServerExecutionStrategy.Execute[TState,TResult](TState state, Func`3 operation, Func`3 verifySucceeded)
  18.    在 Microsoft.EntityFrameworkCore.Query.Internal.SingleQueryingEnumerable`1.Enumerator.MoveNext()
  19.    在 System.Collections.Generic.List`1..ctor(IEnumerable`1 collection)
  20.    在 System.Linq.Enumerable.ToList[TSource](IEnumerable`1 source)
  21.    在 SimpleProjectDemo.Controllers.WeatherForecastController.Get2() 在 E:\Vs_Project\SimpleProjectDemo\SimpleProjectDemo\Controllers\WeatherForecastController.cs 中: 第 50 行
  22.    在 Microsoft.AspNetCore.Mvc.Infrastructure.ActionMethodExecutor.SyncObjectResultExecutor.Execute(ActionContext actionContext, IActionResultTypeMapper mapper, ObjectMethodExecutor executor, Object controller, Object[] arguments)
  23.    在 Microsoft.AspNetCore.Mvc.Infrastructure.ControllerActionInvoker.<<InvokeActionMethodAsync>g__Logged|12_1>d.MoveNext()
复制代码
2.7 运行项目

运行项目，如下图所示显示Swagger页面:

用接口api/Api/GetCommodity 来测试下

3.结论

至此，操作完成。成功的搭建了一个简单的.net 8.0的web api项目。
ps:本项目的代码都很简单，朴拙建议跟着指引来敲代码梳理思路，不过思量极端情况，我还是打包代码上传到了csdn。有需要的童鞋可以按需下载。谢谢。

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。
回复

使用道具 举报

0 个回复

倒序浏览
返回列表

快速回复

高级模式
B Color Image Link Quote Code Smilies
您需要登录后才可以回帖 登录 or 立即注册

本版积分规则

曂沅仴駦

金牌会员
这个人很懒什么都没写!

楼主热帖

标签云

挺好的 服务器
微信订阅号
微信服务号
微信客服
小程序
H5
关于我们 商务合作 网站地图
©Copyright 2022-2024 杭州祥升科技有限公司 版权所有 浙ICP备20004199号
快速回复 返回顶部 返回列表