C#中GraphQL的搭建与实践完整指南

using HotChocolate; // 核心命名空间
using HotChocolate.AspNetCore; // Web集成
using HotChocolate.Data; // 数据查询扩展
using Microsoft.EntityFrameworkCore; // 若结合EF Core

var builder = WebApplication.CreateBuilder(args);

// 1. 注册EF Core（若需操作数据库）
builder.Services.AddDbContext(opt => 
    opt.UseSqlServer(builder.Configuration.GetConnectionString("DefaultConnection")));

// 2. 注册GraphQL服务，配置Schema、查询/突变类型
builder.Services
    .AddGraphQLServer() // 注册GraphQL服务器
    .AddQueryType() // 注册查询类型（获取数据）
    .AddMutationType() // 注册突变类型（新增/修改/删除数据）
    .AddProjections() // 支持字段投影（按需取数核心）
    .AddFiltering() // 支持查询过滤
    .AddSorting(); // 支持查询排序

var app = builder.Build();

// 3. 启用GraphQL中间件，配置访问路径（默认/graphql）
app.UseGraphQL();
// 4. 启用GraphQL Playground（调试工具，生产环境关闭）
app.UseGraphQLPlayground();

app.Run();

// 实体类（示例：商品实体）
public class Product
{
    public int Id { get; set; }
    public string Name { get; set; }
    public decimal Price { get; set; }
    public string Description { get; set; }
    public int CategoryId { get; set; }
    // 关联导航属性
    public Category Category { get; set; }
}

public class Category
{
    public int Id { get; set; }
    public string Name { get; set; }
    public List Products { get; set; } = new();
}

// 数据库上下文
public class AppDbContext : DbContext
{
    public AppDbContext(DbContextOptions options) : base(options) { }
    public DbSet Products { get; set; }
    public DbSet Categories { get; set; }
}

/// 

/// 查询类型（获取数据，只读操作）
/// 

public class Query
{
    /// 

    /// 查询所有商品（支持过滤、排序、投影）
    /// 

    [UseProjection] // 启用投影（按需取数）
    [UseFiltering] // 启用过滤（如按价格、名称筛选）
    [UseSorting] // 启用排序（如按价格升序/降序）
    public IQueryable GetProducts([Service] AppDbContext dbContext)
    {
        return dbContext.Products.Include(p => p.Category); // 关联查询
    }

    /// 

    /// 根据ID查询单个商品
    /// 

    public async Task GetProductById(int id, [Service] AppDbContext dbContext)
    {
        return await dbContext.Products.Include(p => p.Category).FirstOrDefaultAsync(p => p.Id == id);
    }
}

/// 

/// 突变类型（新增/修改/删除数据，写操作）
/// 

public class Mutation
{
    /// 

    /// 新增商品
    /// 

    public async Task CreateProduct(ProductInput input, [Service] AppDbContext dbContext)
    {
        var product = new Product
        {
            Name = input.Name,
            Price = input.Price,
            Description = input.Description,
            CategoryId = input.CategoryId
        };
        dbContext.Products.Add(product);
        await dbContext.SaveChangesAsync();
        return product;
    }

    /// 

    /// 修改商品
    /// 

    public async Task UpdateProduct(int id, ProductInput input, [Service] AppDbContext dbContext)
    {
        var product = await dbContext.Products.FindAsync(id);
        if (product == null) throw new Exception("商品不存在");
        
        product.Name = input.Name;
        product.Price = input.Price;
        product.Description = input.Description;
        product.CategoryId = input.CategoryId;
        
        await dbContext.SaveChangesAsync();
        return product;
    }

    /// 

    /// 输入类型（用于接收客户端提交的参数，类型安全）
    /// 

    public class ProductInput
    {
        public string Name { get; set; }
        public decimal Price { get; set; }
        public string Description { get; set; }
        public int CategoryId { get; set; }
    }
}

# 1. 查询单个商品（仅获取ID、名称、价格，无需Description和Category）
query GetProductById {
  productById(id: 1) {
    id
    name
    price
  }
}

# 2. 查询所有商品（过滤价格>100，按价格降序，获取商品信息及所属分类）
query GetProducts {
  products(where: { price: { gt: 100 } }, order: { price: DESC }) {
    id
    name
    price
    category {
      id
      name
    }
  }
}

# 3. 新增商品（突变操作）
mutation CreateProduct {
  createProduct(input: {
    name: "测试商品"
    price: 199.99
    description: "测试描述"
    categoryId: 1
  }) {
    id
    name
  }
}