当前位置：首页 > 行业动态 > 正文

c webapi构建

构建C WebAPI涉及使用C语言和相关库来创建Web服务，处理HTTP请求和响应，实现业务逻辑并提供数据接口。

C# Web API 构建全攻略

在当今数字化时代，Web API 已成为连接不同应用程序和服务的关键桥梁，使用 C# 构建 Web API 能够高效地创建功能强大、可扩展且安全的后端服务，以下将详细介绍如何使用 C# 构建 Web API，包括环境搭建、项目创建、模型创建、控制器编写、路由配置以及异常处理等方面。

一、环境搭建

1、安装 Visual Studio：从官方网站下载并安装 Visual Studio，建议选择最新的社区版或专业版，它提供了强大的开发工具和丰富的功能，支持多种编程语言和框架，包括 C# 和 .NET。

2、安装 .NET Core SDK：.NET Core 是 .NET 平台的跨平台版本，用于开发和运行 .NET 应用程序，可以从微软官网下载安装最新版本的 .NET Core SDK，确保能够在命令行中使用dotnet 命令来创建和管理项目。

二、项目创建

1、创建新项目：打开 Visual Studio，选择“创建新项目”，在项目模板中选择“ASP.NET Core Web API”项目模板，然后点击“下一步”。

2、配置项目：在弹出的窗口中，填写项目名称、解决方案名称、项目位置等信息，选择合适的目标框架（如 .NET 6.0 或更高版本），然后点击“创建”。

3、项目结构：创建完成后，Visual Studio 会自动生成一个基本的 Web API 项目结构，包括Controllers、Models、appsettings.json 等文件夹和文件。

三、模型创建

1、定义实体类：在Models 文件夹中创建一个新的 C# 类，例如Product.cs，用于表示数据库中的表结构或业务对象，使用数据注解来定义属性的数据类型、约束条件等，

using System.ComponentModel.DataAnnotations;
namespace YourNamespace.Models
{
    public class Product
    {
        [Key]
        public int Id { get; set; }
        [Required]
        [MaxLength(100)]
        public string Name { get; set; }
        [Range(0, double.PositiveInfinity)]
        public decimal Price { get; set; }
    }
}

这里使用了[Key] 注解来标识主键，[Required] 注解表示该字段不能为空，[MaxLength] 注解限制了字符串的最大长度，[Range] 注解则限定了数值的取值范围。

2、创建上下文类：在Models 文件夹中创建一个继承自DbContext 的类，例如ApplicationDbContext.cs，用于与数据库进行交互，在类中定义一个DbSet 属性，对应数据库中的表，

using Microsoft.EntityFrameworkCore;
using YourNamespace.Models;
namespace YourNamespace.Data
{
    public class ApplicationDbContext : DbContext
    {
        public DbSet<Product> Products { get; set; }
        protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
        {
            optionsBuilder.UseSqlServer("Your_Connection_String_Here");
        }
    }
}

这里的OnConfiguring 方法用于配置数据库连接字符串，需要根据实际情况修改为真实的数据库连接信息。

四、控制器编写

1、创建控制器类：在Controllers 文件夹中创建一个新的控制器类，例如ProductsController.cs，继承自ControllerBase，使用[Route] 注解来定义控制器的基础路由，

using Microsoft.AspNetCore.Mvc;
using YourNamespace.Models;
using YourNamespace.Data;
namespace YourNamespace.Controllers
{
    [Route("api/[controller]")]
    [ApiController]
    public class ProductsController : ControllerBase
    {
        private readonly ApplicationDbContext _context;
        public ProductsController(ApplicationDbContext context)
        {
            _context = context;
        }
        // 后续添加 CRUD 操作的方法
    }
}

这里的[ApiController] 注解会自动应用一些常见的 API 行为，如返回 JSON 格式的数据等。

c webapi构建

2、实现 CRUD 操作：在控制器类中添加获取所有产品、获取单个产品、创建产品、更新产品和删除产品的方法，并使用相应的 HTTP 动词（GET、POST、PUT、DELETE）和路由模板，

获取所有产品：使用[HttpGet] 注解，返回所有产品的列表。

获取单个产品：使用[HttpGet("{id}")] 注解，根据产品 ID 获取单个产品的信息。

创建产品：使用[HttpPost] 注解，接收客户端发送的产品数据并添加到数据库中。

更新产品：使用[HttpPut("{id}")] 注解，根据产品 ID 更新产品的信息。

删除产品：使用[HttpDelete("{id}")] 注解，根据产品 ID 删除产品。

以下是一个简单的示例代码：

[HttpGet]
public async Task<ActionResult<IEnumerable<Product>>> GetProducts()
{
    return await _context.Products.ToListAsync();
}
[HttpGet("{id}")]
public async Task<ActionResult<Product>> GetProduct(int id)
{
    var product = await _context.Products.FindAsync(id);
    if (product == null)
    {
        return NotFound();
    }
    return product;
}
[HttpPost]
public async Task<ActionResult<Product>> CreateProduct(Product product)
{
    _context.Products.Add(product);
    await _context.SaveChangesAsync();
    return CreatedAtAction(nameof(GetProduct), new { id = product.Id }, product);
}
[HttpPut("{id}")]
public async Task<IActionResult> UpdateProduct(int id, Product product)
{
    if (id != product.Id)
    {
        return BadRequest();
    }
    _context.Entry(product).State = EntityState.Modified;
    await _context.SaveChangesAsync();
    return NoContent();
}
[HttpDelete("{id}")]
public async Task<IActionResult> DeleteProduct(int id)
{
    var product = await _context.Products.FindAsync(id);
    if (product == null)
    {
        return NotFound();
    }
    _context.Products.Remove(product);
    await _context.SaveChangesAsync();
    return NoContent();
}

五、路由配置

1、默认路由配置：在Startup.cs 文件中的Configure 方法中配置默认路由，通常使用app.UseEndpoints(...) 方法来设置路由，

app.UseEndpoints(endpoints =>
{
    endpoints.MapControllers();
});

这将自动发现项目中的所有控制器，并根据控制器中定义的路由模板进行路由匹配。

2、自定义路由配置：如果需要更灵活的路由配置，可以在Startup.cs 文件中的ConfigureServices 方法中使用services.AddControllersWithViews(...) 方法来配置路由选项，

services.AddControllersWithViews(options =>
{
    options.Conventions.Add(new RouteTokenTransformerConvention(new SlugifyParameterTransformer()));
});

这里的SlugifyParameterTransformer 是一个自定义的路由参数转换器，可以将 URL 中的参数转换为小写并用连字符连接的形式，以便更好地与数据库中的记录匹配。

c webapi构建

六、异常处理

1、全局异常处理：在Startup.cs 文件中的Configure 方法中使用app.UseExceptionHandler(...) 方法来配置全局异常处理器，

app.UseExceptionHandler("/Home/Error");

这将捕获应用程序中的所有未处理异常，并将请求重定向到指定的错误处理页面或控制器方法。

2、自定义异常处理：可以创建一个自定义的异常处理中间件或过滤器，在控制器方法中使用[ExceptionFilter] 注解来应用该过滤器，

public class CustomExceptionFilter : IExceptionFilter
{
    public void OnException(ExceptionContext context)
    {
        // 自定义异常处理逻辑，例如记录日志、返回友好的错误信息等
        context.Result = new JsonResult(new { message = "An error occurred" }) { StatusCode = StatusCodes.Status500InternalServerError };
    }
}

然后在控制器类上添加[ServiceFilter(typeof(CustomExceptionFilter))] 注解来应用该过滤器。

七、身份验证与授权（可选）

1、JWT 认证：可以使用 JWT（JSON Web Token）来实现用户身份验证和授权，需要在项目中安装相关的 JWT 库，例如Microsoft.AspNetCore.Authentication.JwtBearer，在Startup.cs 文件中配置 JWT 认证中间件，

services.AddAuthentication(options =>
{
    options.DefaultAuthenticateScheme = JwtBearerDefaults.AuthenticationScheme;
    options.DefaultChallengeScheme = JwtBearerDefaults.ChallengeScheme;
}).AddJwtBearer(options =>
{
    options.TokenValidationParameters = new TokenValidationParameters
    {
        ValidateIssuer = true,
        ValidateAudience = true,
        ValidateLifetime = true,
        ValidateIssuerSigningKey = true,
        ValidIssuer = "YourIssuer",
        ValidAudience = "YourAudience",
        IssuerSigningKey = new SymmetricSecurityKey(Encoding.UTF8.GetBytes("Your_Secret_Key_Here"))
    };
});

这里的TokenValidationParameters 用于配置 JWT 令牌的验证规则，如签发人、受众、有效期等，在控制器方法中使用[Authorize] 注解来限制只有经过身份验证的用户才能访问某些资源，

[Authorize]
public async Task<IActionResult> GetProducts()
{
    // ...
}

2、角色授权：可以结合 JWT 认证实现基于角色的授权，需要在用户信息中添加角色字段，并在 JWT 令牌中包含角色信息，在控制器方法中使用[Authorize(Roles = "Admin, User")] 注解来限制只有具有特定角色的用户才能访问该方法，

[Authorize(Roles = "Admin")]
public async Task<IActionResult> DeleteProduct(int id)
{
    // ...
}

这里的Roles 参数指定了允许访问该方法的角色列表。

八、部署与测试

1、本地测试：在开发过程中，可以使用 Visual Studio 等开发工具自带的调试功能进行本地测试，通过启动项目并模拟客户端请求，检查应用程序是否能够正确处理各种请求和返回预期的结果，可以使用 Postman 等工具来发送 HTTP 请求并查看响应数据。

c webapi构建

2、部署到服务器：当本地测试通过后，可以将应用程序部署到生产环境中的服务器上，可以选择将应用程序发布到 Windows Server、Linux 服务器或云平台上，如 Azure、AWS、阿里云等，根据所选的服务器环境，需要进行相应的配置和部署步骤，如安装必要的运行时环境、配置 IIS 或其他 Web 服务器等，部署完成后，需要再次进行全面的测试，确保应用程序在实际生产环境中能够稳定运行。

九、性能优化（可选）

1、数据库查询优化：避免在控制器方法中直接执行复杂的数据库查询语句，可以使用延迟加载、投影和缓存等技术来优化数据库查询性能，使用Include 方法来加载相关的实体数据，使用Select 方法来指定只查询所需的字段，使用MemoryCache 或其他缓存机制来缓存频繁访问的数据。

2、异步编程：尽量使用异步编程模型来提高应用程序的并发处理能力，在控制器方法中使用async 和await 关键字来编写异步代码，避免阻塞线程，要注意正确处理异步编程中的异常情况和任务取消等问题。

3、压缩与合并静态资源：对应用程序中的 CSS、JavaScript 和图像等静态资源进行压缩和合并，减少文件大小和请求次数，从而提高页面加载速度，可以使用工具如 Webpack、Gulp 等来自动化处理静态资源的压缩与合并。

4、启用 HTTP 压缩：在服务器端启用 HTTP 压缩功能，如 Gzip 或 Brotli，对传输的数据进行压缩，减少网络带宽占用，提高数据传输速度，不同的服务器环境和 Web 服务器有不同的配置方式来实现 HTTP 压缩。

FAQs：

1、问：如何处理数据库连接字符串的安全性？

答：不要将数据库连接字符串硬编码在源代码中，可以使用配置文件或环境变量来存储连接字符串，并在应用程序启动时读取这些配置信息，这样可以方便地在不同的环境中切换数据库连接，并且可以通过加密配置文件或环境变量来提高安全性，还可以使用安全的秘密管理服务来存储敏感的配置信息。

2、问：如何防止 SQL 注入攻击？

答：在使用 Entity Framework 等 ORM 框架时，要正确使用参数化查询，避免直接拼接 SQL 语句，对于用户输入的数据，要进行严格的验证和过滤，确保数据的合法性和安全性，要及时更新数据库系统和应用框架的安全补丁，以防止已知的破绽被利用。

c语言Web API构建

相关文章