如何在ASP.NET Core 6 Web API项目中集成Elasticsearch？

一、兼容性说明 #

完全可以。Elasticsearch官方提供了专门的.NET客户端库，和ASP.NET Core 6的兼容性极佳，能无缝集成到你的Web API项目中，实现全文搜索、数据存储与分析等需求。

二、具体实现步骤 #

1. 安装官方Elasticsearch .NET客户端 #

推荐使用最新版的官方客户端Elastic.Clients.Elasticsearch（替代旧版NEST），通过NuGet安装：

Install-Package Elastic.Clients.Elasticsearch

或者用.NET CLI命令：

dotnet add package Elastic.Clients.Elasticsearch

2. 配置Elasticsearch连接 #

在appsettings.json中添加Elasticsearch的连接配置：

"Elasticsearch": {
  "Uri": "http://localhost:9200",
  "Username": "elastic", // 若开启了身份验证，填写你的用户名
  "Password": "your-password" // 对应密码
}

然后在Program.cs中注册Elasticsearch客户端服务，注入到依赖容器：

var elasticSettings = new ElasticsearchClientSettings(new Uri(builder.Configuration["Elasticsearch:Uri"]!))
    .Authentication(new BasicAuthentication(
        builder.Configuration["Elasticsearch:Username"]!,
        builder.Configuration["Elasticsearch:Password"]!));

builder.Services.AddSingleton<IElasticsearchClient>(new ElasticsearchClient(elasticSettings));

3. 定义实体与索引映射 #

先创建和Elasticsearch文档对应的实体类，比如商品实体：

public class Product
{
    public int Id { get; set; }
    public string Name { get; set; } = string.Empty;
    public decimal Price { get; set; }
    public DateTime CreatedAt { get; set; }
}

接着编写索引创建方法，指定字段映射规则（确保Elasticsearch存储类型和实体字段匹配）：

public async Task CreateProductIndex(IElasticsearchClient client)
{
    var response = await client.Indices.CreateAsync("products", c => c
        .Map<Product>(m => m
            .Properties(p => p
                .Number(n => n.Name(f => f.Id))
                .Text(t => t.Name(f => f.Name))
                .Number(n => n.Name(f => f.Price).Type(NumberType.Double))
                .Date(d => d.Name(f => f.CreatedAt))
            )
        )
    );

    if (!response.IsSuccess())
    {
        // 这里可以添加日志记录或异常处理逻辑
        throw new Exception($"创建索引失败: {response.DebugInformation}");
    }
}

在项目启动时执行索引创建（放在Program.cs中）：

var app = builder.Build();

using (var scope = app.Services.CreateScope())
{
    var elasticClient = scope.ServiceProvider.GetRequiredService<IElasticsearchClient>();
    await CreateProductIndex(elasticClient);
}

4. 实现CRUD操作 #

新增文档

public async Task<bool> AddProduct(IElasticsearchClient client, Product product)
{
    var response = await client.IndexAsync(product, i => i.Index("products"));
    return response.IsSuccess();
}

按ID查询文档

public async Task<Product?> GetProductById(IElasticsearchClient client, int productId)
{
    var response = await client.GetAsync<Product>(productId, g => g.Index("products"));
    return response.IsSuccess() ? response.Source : null;
}

全文搜索

public async Task<List<Product>> SearchProducts(IElasticsearchClient client, string keyword)
{
    var response = await client.SearchAsync<Product>(s => s
        .Index("products")
        .Query(q => q
            .Match(m => m
                .Field(f => f.Name)
                .Query(keyword)
            )
        )
    );

    return response.Documents.ToList();
}

更新文档

public async Task<bool> UpdateProduct(IElasticsearchClient client, Product product)
{
    var response = await client.UpdateAsync<Product, Product>(product.Id, u => u
        .Index("products")
        .Doc(product)
    );
    return response.IsSuccess();
}

删除文档

public async Task<bool> DeleteProduct(IElasticsearchClient client, int productId)
{
    var response = await client.DeleteAsync<Product>(productId, d => d.Index("products"));
    return response.IsSuccess();
}

5. 在API控制器中调用 #

注入IElasticsearchClient，将操作封装为API接口：

[ApiController]
[Route("api/products")]
public class ProductsController : ControllerBase
{
    private readonly IElasticsearchClient _elasticClient;

    public ProductsController(IElasticsearchClient elasticClient)
    {
        _elasticClient = elasticClient;
    }

    [HttpPost]
    public async Task<IActionResult> Add([FromBody] Product product)
    {
        var success = await AddProduct(_elasticClient, product);
        return success ? Ok("添加成功") : BadRequest("添加失败");
    }

    [HttpGet("{id:int}")]
    public async Task<IActionResult> GetById(int id)
    {
        var product = await GetProductById(_elasticClient, id);
        return product != null ? Ok(product) : NotFound();
    }

    // 其他接口（搜索、更新、删除）同理实现
}

三、注意事项 #

• 确保本地或服务器上的Elasticsearch服务正在运行，连接地址、账号密码配置正确。
• 索引映射需和实体字段类型匹配，避免出现数据存储错误。
• 生产环境建议添加日志记录、重试机制，处理Elasticsearch连接异常。
• 批量操作时使用BulkAsync接口，提升处理大量数据的性能。

内容的提问来源于stack exchange，提问作者Reza1991