# C#/.NET 后端开发模式 ## 依赖注入 ### 服务注册 // Program.cs 或 Startup.cs var builder = WebApplication.CreateBuilder(args); // 瞬态：每次都有新实例 builder.Services.AddTransient(); // 范围：每个 HTTP 请求一个实例 builder.Services.AddScoped(); builder.Services.AddScoped(); // Singleton：应用程序生命周期的一个实例 builder.Services.AddSingleton(); // 有工厂 builder.Services.AddScoped(provider => { var config =provider.GetRequiredService(); 返回新的 DbContext(config.GetConnectionString("默认")); }); ### 构造函数注入公共类 OrderService : IOrderService { 私有只读 IOrderRepository _orderRepository; 私有只读 IProductService _productService; 私有只读 IEmailService _emailService；私有只读 ILogger _logger; 公共秩序服务（ IOrderRepository orderRepository, IProductService 产品服务， IEmailService 电子邮件服务， ILogger 记录器） { _orderRepository = orderRepository; _产品服务=产品服务； _emailService = 电子邮件服务； _logger=记录器； } 公共异步任务 CreateOrderAsync（CreateOrderRequest 请求，CancellationToken ct） { _logger.LogInformation("正在为客户{CustomerId}创建订单", request.CustomerId); // 实现 } } ### 接口隔离 // 重点接口公共接口 IProductReader { 任务<产品？> GetByIdAsync(Guid id, CancellationToken ct); 任务> GetAllAsync(CancellationToken ct); 任务> SearchAsync(字符串查询, CancellationToken ct); } 公共接口 IProductWriter { 任务<产品> CreateAsync(CreateProductRequest 请求, CancellationToken ct); 任务 UpdateAsync(Guid id, UpdateProductRequest 请求, CancellationToken ct); 任务DeleteAsync(Guid id, CancellationToken ct); } // 组合接口以方便使用公共接口 IProductService : IProductReader, IProductWriter { } ## 服务层架构 ### 服务接口公共接口IProductService { 任务<产品？> GetByIdAsync(Guid id, CancellationToken ct = 默认); 任务> GetPagedAsync(int page, int pageSize, CancellationToken ct = default); 任务<产品> CreateAsync(CreateProductRequest 请求, CancellationToken ct = 默认); 任务 UpdateAsync(Guid id, UpdateProductRequest 请求, CancellationToken ct = 默认); 任务DeleteAsync(Guid id, CancellationToken ct = 默认); } ### 服务实施公共类 ProductService ：IProductService { 私有只读 IProductRepository _repository; 私有只读 IValidator _createValidator; 私有只读 ILogger _logger; 公共产品服务（ IProductRepository 存储库， IValidator createValidator, ILogger 记录器） { _repository=存储库； _createValidator = 创建验证器； _logger=记录器； } 公共异步任务 <产品？> GetByIdAsync（Guid id，CancellationToken ct = 默认） { 返回等待_repository.GetByIdAsync(id, ct); } 公共异步任务> GetPagedAsync( 国际页面， int 页面大小, CancellationToken ct = 默认） { var Skip = (页 - 1) * 页大小; var items = wait _repository.GetPagedAsync(skip, pageSize, ct); var 总=等待_repository.CountAsync(ct); 返回新的 PagedResult<产品> { 物品=物品，页=页，页面大小=页面大小，总数 = 总计， TotalPages = (int)Math.Ceiling(总计 / (double)pageSize) }; } 公共异步任务<产品> CreateAsync( 创建产品请求请求， CancellationToken ct = 默认） { var validationResult = wait _createValidator.ValidateAsync(request, ct); if (!validationResult.IsValid) { 抛出新的 ValidationException(validationResult.Errors); } var 产品 = 新产品 { Id = Guid.NewGuid(), 名称 = 请求.名称, 描述 = 请求.描述, 价格 = 请求.价格, 创建时间 = DateTime.UtcNow }; 等待 _repository.AddAsync(产品, ct); _logger.LogInformation("已创建产品 {ProductId}: {ProductName}", 产品.Id、产品.名称); 退回产品； } 公共异步任务 UpdateAsync( 引导 ID，更新产品请求请求， CancellationToken ct = 默认） { var 产品 = wait _repository.GetByIdAsync(id, ct) ?? throw new NotFoundException($"未找到产品 {id}"); 产品.名称 = 请求.名称 ??产品.名称；产品.描述 = 请求.描述 ??产品描述; 产品.价格 = 请求.价格 ??产品.价格; 产品.UpdatedAt = DateTime.UtcNow; 等待 _repository.UpdateAsync(产品, ct); } 公共异步任务DeleteAsync（Guid id，CancellationToken ct =默认） { var存在=等待_repository.ExistsAsync(id, ct); 如果（！存在） { throw new NotFoundException($"未找到产品 {id}"); } 等待 _repository.DeleteAsync(id, ct); _logger.LogInformation("已删除产品{ProductId}", id); } } ## 存储库模式 ### 存储库接口公共接口 IRepository 其中 T ：类 { 任务 GetByIdAsync(Guid id, CancellationToken ct = 默认); 任务> GetAllAsync(CancellationToken ct = default); 任务> GetPagedAsync(int skip, int take, CancellationToken ct = default); 任务 CountAsync(CancellationToken ct = 默认); 任务 ExistsAsync(Guid id, CancellationToken ct = 默认); 任务 AddAsync(T 实体, CancellationToken ct = 默认); 任务 UpdateAsync(T 实体, CancellationToken ct = 默认); 任务DeleteAsync(Guid id, CancellationToken ct = 默认); } 公共接口 IProductRepository : IRepository<产品> { 任务> GetByCategoryAsync(字符串类别, CancellationToken ct = 默认); 任务> SearchAsync(字符串查询, CancellationToken ct = 默认); } ### 存储库实施公共类 ProductRepository ：IProductRepository { 私有只读AppDbContext _context；公共 ProductRepository（AppDbContext 上下文） { _context = 上下文； } 公共异步任务 <产品？> GetByIdAsync（Guid id，CancellationToken ct = 默认） { 返回等待_context.Products .AsNoTracking() .FirstOrDefaultAsync(p => p.Id == id, ct); } 公共异步任务> GetPagedAsync( 整数跳过， INT采取， CancellationToken ct = 默认） { 返回等待_context.Products .AsNoTracking() .OrderByDescending(p => p.CreatedAt) .跳过(跳过) .采取（采取） .ToListAsync(ct); } 公共异步任务> SearchAsync( 字符串查询， CancellationToken ct = 默认） { 返回等待_context.Products .AsNoTracking() .Where(p => p.Name.Contains(query) || p.Description.Contains(query)) .OrderBy(p => p.Name) .取(100) .ToListAsync(ct); } 公共异步任务 AddAsync（产品实体，CancellationToken ct = 默认） { 等待 _context.Products.AddAsync(entity, ct); 等待 _context.SaveChangesAsync(ct); } 公共异步任务 UpdateAsync（产品实体，CancellationToken ct = 默认） { _context.Products.Update(实体); 等待 _context.SaveChangesAsync(ct); } 公共异步任务DeleteAsync（Guid id，CancellationToken ct =默认） { var实体 =等待_context.Products.FindAsync(new object[] { id }, ct); if（实体！= null） { _context.Products.Remove(实体); 等待 _context.SaveChangesAsync(ct); } } } ## 控制器模式 ### API 控制器 [API控制器] [路线(“api/[控制器]”)] 公共类ProductsController：ControllerBase { 私有只读 IProductService _productService; 私有只读 ILogger _logger; 公共产品控制器（ IProductService 产品服务， ILogger 记录器） { _产品服务=产品服务； _logger=记录器； } [http获取] [ProducesResponseType(typeof(PagedResult), StatusCodes.Status200OK)] 公共异步任务 GetAll( [FromQuery] int 页 = 1, [FromQuery] int pageSize = 10, CancellationToken ct = 默认） { var result = wait _productService.GetPagedAsync(page, pageSize, ct); 返回确定（结果）； } [HttpGet("{id:guid}")] [ProducesResponseType(typeof(ProductDto), StatusCodes.Status200OK)] [产生响应类型（StatusCodes.Status404NotFound）] 公共异步任务 GetById(Guid id, CancellationToken ct) { var 产品 = wait _productService.GetByIdAsync(id, ct); 如果（产品==空） { 返回未找到（）； } 返回确定（产品）； } [http邮报] [ProducesResponseType(typeof(ProductDto), StatusCodes.Status201Created)] [ProducesResponseType(typeof(ValidationProblemDetails), StatusCodes.Status400BadRequest)] 公共异步任务 Create( [FromBody] CreateProductRequest 请求，取消令牌 ct) { var 产品 = wait _productService.CreateAsync(request, ct); 返回 CreateAtAction( 名称(GetById), 新的 { id = 产品.Id }, 产品）； } [HttpPut("{id:guid}")] [产生响应类型（StatusCodes.Status204NoContent）] [产生响应类型（StatusCodes.Status404NotFound）] 公共异步任务更新（引导 ID， [FromBody] UpdateProductRequest 请求，取消令牌 ct) { 等待 _productService.UpdateAsync(id, 请求, ct); 返回无内容（）； } [HttpDelete("{id:guid}")] [产生响应类型（StatusCodes.Status204NoContent）] [产生响应类型（StatusCodes.Status404NotFound）] 公共异步任务删除（Guid id，CancellationToken ct） { 等待 _productService.DeleteAsync(id, ct); 返回无内容（）； } } ### MVC 控制器公共类ProductsController：控制器 { 私有只读 IProductService _productService; 私有只读 ICategoryService _categoryService；公共产品控制器（ IProductService 产品服务， ICategory服务类别Service) { _产品服务=产品服务； _categoryService = 类别服务; } [http获取] 公共异步任务索引（int page = 1，CancellationToken ct = 默认） { var products = wait _productService.GetPagedAsync(page, 12, ct); 返回视图（产品）； } [http获取] 公共异步任务详细信息（Guid id，CancellationToken ct） { var 产品 = wait _productService.GetByIdAsync(id, ct); 如果（产品==空） { 返回未找到（）； } 返回视图（产品）； } [http获取] 公共异步任务创建（CancellationToken ct） { ViewBag.Categories =等待_categoryService.GetAllAsync(ct); 返回视图（新的CreateProductRequest（））； } [http邮报] [验证防伪令牌] 公共异步任务 Create( 创建产品请求请求，取消令牌 ct) { if (!ModelState.IsValid) { ViewBag.Categories =等待_categoryService.GetAllAsync(ct); 返回视图（请求）； } var 产品 = wait _productService.CreateAsync(request, ct); TempData["SuccessMessage"] = "产品创建成功。"; return RedirectToAction(nameof(详细信息), new { id = 产品.Id }); } } ## 异步/等待最佳实践 ### 始终异步 // 不好：阻塞异步代码公共产品 GetProduct(Guid id) { 返回 _repository.GetByIdAsync(id).Result; // 死锁风险！ } // 好：一直异步公共异步任务<产品？> GetProductAsync（Guid id，CancellationToken ct） { 返回等待_repository.GetByIdAsync(id, ct); } ### CancellationToken 传播公共异步任务<订单> ProcessOrderAsync( 创建订单请求请求， CancellationToken ct = 默认） { // 将取消令牌传递给所有异步操作 var customer = wait _customerService.GetByIdAsync(request.CustomerId, ct); var products = wait _productService.GetByIdsAsync(request.ProductIds, ct); var order = new Order { /* ... */ }; 等待 _orderRepository.AddAsync(order, ct); // 即使请求被取消，后台工作也应该继续 _ = _emailService.SendOrderConfirmationAsync(order.Id, CancellationToken.None); 退货订单； } ### 并行操作公共异步任务 GetDashboardAsync(CancellationToken ct) { // 并行运行独立查询 var orderTask = _orderService.GetRecentAsync(10, ct); var productsTask = _productService.GetTopSellingAsync(5, ct); var statsTask = _analyticsService.GetSummaryAsync(ct); 等待任务.WhenAll(ordersTask, productsTask, statsTask); 返回新的仪表板数据 { 最近的订单 = 等待订单任务， TopProducts = 等待 productsTask, 统计 = 等待 statsTask }; } ### 配置等待 // 在库代码中，使用ConfigureAwait(false)来避免上下文捕获公共异步任务 FetchDataAsync(string url, CancellationToken ct) { 使用 var client = new HttpClient(); var response = wait client.GetAsync(url, ct).ConfigureAwait(false); 返回等待response.Content.ReadAsStringAsync(ct).ConfigureAwait(false); } // 在 ASP.NET Core 控制器/服务中，一般不需要 // 框架正确处理同步上下文 ## LINQ 模式 ### 查询语法与方法语法 // 方法语法（大多数情况下首选） var activeProducts = 产品 .Where(p => p.IsActive) .OrderBy(p => p.Name) .Select(p => new ProductDto(p.Id, p.Name, p.Price)) .ToList(); // 查询语法（对于复杂连接有用） var 订单详情 = 从订单中的订单按订单将客户加入客户中。CustomerId 等于 customer.Id 将产品加入订单中的产品中。ProductId 等于 Product.Id 其中 order.Date >= startDate orderby order.日期降序选择新的 OrderDetailDto { 订单Id = 订单.Id, 客户名称 = 客户.名称, 产品名称 = 产品.名称, 总计 = 订单.数量 * 产品.价格 }; ### 常见的 LINQ 操作 // 过滤 var active = products.Where(p => p.IsActive); var 昂贵 = products.Where(p => p.Price > 100); // 投影 var 名称 = products.Select(p => p.Name); var dtos = products.Select(p => new ProductDto(p)); // 聚合 var TotalValue = products.Sum(p => p.Price * p.Stock); var AveragePrice = products.Average(p => p.Price); var maxPrice = products.Max(p => p.Price); var count = products.Count(p => p.IsActive); // 分组 var byCategory = 产品 .GroupBy(p => p.Category) .Select(g => 新 { 类别 = g.Key, 产品 = g.ToList(), 计数 = g.Count() }); // 第一个/单个 var first = products.FirstOrDefault(p => p.Id == id); var single = products.SingleOrDefault(p => p.Sku == sku); // 任意/全部 var hasActive = products.Any(p => p.IsActive); var allActive = products.All(p => p.IsActive); ### EF Core 特定 // 包含相关数据 var orderWithItems = wait _context.Orders .include(o => o.Customer) .include(o => o.Items) .ThenInclude(i => i.Product) .ToListAsync(ct); // 显式加载等待 _context.Entry(订单) .Collection(o => o.Items) .LoadAsync(ct); // 投影（更高效） var orderSummaries =等待_context.Orders .Select(o => 新的 OrderSummaryDto { Id = o.Id，客户名称 = o.客户.名称, 总计 = o.Items.Sum(i => i.Quantity * i.UnitPrice), ItemCount = o.Items.Count }) .ToListAsync(ct); ## 配置模式 ### 选项模式 // 配置类公共类电子邮件设置 { 公共常量字符串SectionName =“电子邮件”; 公共字符串 SmtpHost { 获取；放; } = 字符串.Empty; 公共 int SmtpPort { 获取；放; } = 587; 公共字符串FromAddress { 获取；放; } = 字符串.Empty; 公共字符串FromName { get;放; } = 字符串.Empty; 公共 bool UseSsl { 获取；放; } = 真； } // 注册 builder.Services.Configure( builder.Configuration.GetSection(EmailSettings.SectionName)); // 与 IOptions 一起使用公共类电子邮件服务：IEmailService { 私人只读EmailSettings _settings；公共电子邮件服务（IOptions 选项） { _settings = 选项.Value; } } // 与 IOptionsSnapshot 一起使用（更改时重新加载）公共类电子邮件服务：IEmailService { 私有只读 IOptionsSnapshot _options; 公共电子邮件服务（IOptionsSnapshot 选项） { _选项=选项； } 公共无效发送（） { var 设置 = _options.Value; // 获取当前值 } } ### 验证公共类 EmailSettingsValidation ： IValidateOptions { public ValidateOptionsResult Validate（字符串？名称，EmailSettings选项） { var 失败 = new List(); if (string.IsNullOrWhiteSpace(options.SmtpHost)) { failure.Add("需要 SmtpHost"); } if (string.IsNullOrWhiteSpace(options.FromAddress)) { failure.Add("FromAddress 为必填项"); } 返回失败次数。计数 > 0 ？ ValidateOptionsResult.Fail（失败） : ValidateOptionsResult.Success; } } // 注册 builder.Services.AddSingleton, EmailSettingsValidation>(); ## 日志记录 ### 结构化日志记录公共类 OrderService : IOrderService { 私有只读 ILogger _logger; 公共异步任务 CreateOrderAsync（CreateOrderRequest 请求，CancellationToken ct） { // 使用命名参数进行结构化日志记录 _logger.日志信息( “正在为客户 {CustomerId} 创建包含 {ItemCount} 件商品的订单”, 请求.客户ID, 请求.项目.计数); 尝试 { var order = wait ProcessOrderAsync(request, ct); _logger.日志信息( "订单{OrderId}创建成功。总计：{Total:C}", 订单.Id, 订单.总计); 退货订单； } catch（异常前） { _logger.LogError（例如， “无法为客户 {CustomerId} 创建订单”，请求.CustomerId); 扔; } } } ### 日志级别 // Trace - 非常详细，通常仅在开发中 _logger.LogTrace("正在输入方法{MethodName}", nameof(ProcessOrder)); // 调试-调试信息 _logger.LogDebug("正在处理数量为{Quantity}的商品{ItemId}", item.Id, item.Quantity); // 信息 - 一般流程 _logger.LogInformation("订单 {OrderId} 已发货至 {Address}", order.Id, order.ShippingAddress); // 警告 - 出现意外情况，但不是错误 _logger.LogWarning("订单 {OrderId} 付款重试 {Attempt}", attempts, orderId); // 错误 - 发生错误，但应用程序可以继续 _logger.LogError(例如，“无法发送订单 {OrderId} 的电子邮件”，orderId); // 严重 - 应用程序失败 _logger.LogCritical(例如，“数据库连接失败”); ### 范围公共异步任务 ProcessOrderAsync（订单顺序，CancellationToken ct） { 使用 (_logger.BeginScope(new Dictionary { ["订单Id"] = 订单.Id, ["客户 ID"] = 订单.客户 ID }）） { _logger.LogInformation("处理订单"); // 此范围内的所有日志都将包含 OrderId 和 CustomerId 等待 ProcessPaymentAsync(订单, ct); 等待 ProcessShippingAsync(订单, ct); } } ## 异常处理 ### 自定义异常公共类NotFoundException：异常 { 公共字符串资源类型{获取; } 公共字符串ResourceId { 获取; } 公共NotFoundException（字符串资源类型，字符串资源Id） : base($"未找到 ID 为“{resourceId}”的{resourceType}”) { 资源类型=资源类型；资源ID = 资源ID; } } 公共类 ValidationException ：异常 { 公共 IReadOnlyList 错误 { get; } 公共 ValidationException（IEnumerable 错误） : base("发生一个或多个验证错误") { 错误=errors.ToList(); } } 公共类 BusinessRuleException ：异常 { 公共字符串代码{获取; } public BusinessRuleException（字符串代码，字符串消息）：基础（消息） { 代码=代码； } } ### 全局异常处理程序公共类 GlobalExceptionHandler : IExceptionHandler { 私有只读 ILogger _logger; 公共 GlobalExceptionHandler(ILogger 记录器) { _logger=记录器； } 公共异步 ValueTask TryHandleAsync( HttpContext httpContext, 异常异常，取消令牌 ct) { _logger.LogError(exception, "发生未处理的异常"); var (statusCode, response) = 异常开关 { NotFoundException 前 => ( StatusCodes.Status404NotFound，新问题详情 { 状态 = 404， Title = "未找到资源", 详细信息=例如消息 }), 验证异常前 => ( StatusCodes.Status400BadRequest，新的验证问题详细信息 { 状态 = 400， Title = "验证失败", 错误 = ex.Errors.ToDictionary( e => e.PropertyName, e => new[] { e.Message }) }), _ => ( StatusCodes.Status500InternalServerError，新问题详情 { 状态 = 500， Title = "发生错误", 详细信息=“发生意外错误。请稍后再试。” }) }; httpContext.Response.StatusCode = statusCode; 等待 httpContext.Response.WriteAsJsonAsync(response, ct); 返回真； } } ## 工作单元模式公共接口 IUnitOfWork : IDisposable { IProductRepository 产品 { 获取； } IOrderRepository 订单 { get; } ICustomerRepository 客户 { 获取； } 任务 SaveChangesAsync(CancellationToken ct = 默认); 任务 BeginTransactionAsync(CancellationToken ct = 默认); 任务 CommitTransactionAsync(CancellationToken ct = 默认); 任务 RollbackTransactionAsync(CancellationToken ct = 默认); } 公共类 UnitOfWork ：IUnitOfWork { 私有只读AppDbContext _context；私有IDbContextTransaction？ _交易; 公共 IProductRepository 产品 { 获取； } 公共 IOrderRepository 订单 { 获取； } 公共 ICustomerRepository 客户 { 获取； } 公共工作单元（AppDbContext上下文） { _context = 上下文；产品 = new ProductRepository(context); 订单 = new OrderRepository(context); 客户=新的CustomerRepository（上下文）； } 公共异步任务 SaveChangesAsync（CancellationToken ct = 默认值） { 返回等待_context.SaveChangesAsync(ct); } 公共异步任务 BeginTransactionAsync（CancellationToken ct = 默认） { _transaction =等待_context.Database.BeginTransactionAsync(ct); } 公共异步任务 CommitTransactionAsync（CancellationToken ct = 默认） { if (_transaction!= null) { 等待_transaction.CommitAsync(ct); 等待_transaction.DisposeAsync(); _交易=空； } } 公共异步任务 RollbackTransactionAsync（CancellationToken ct = 默认） { if (_transaction!= null) { 等待_transaction.RollbackAsync(ct); 等待_transaction.DisposeAsync(); _交易=空； } } 公共无效处置（） { _transaction?.Dispose(); _context.Dispose(); } }

后端Csharp

包含技能