Elastic学习之旅 (11) .NET 6应用集成ES - 上 - 码农

2024-04-20码农

大家好，我是Edison。

写在开头

有了前面10篇的基础，我们大概清楚了ES的基本概念和使用（主要是查询），这也是我们作为Developer应该了解的范畴，而至于更深入的聚合分析、运维管理就不在本系列的范畴中。有童鞋说，讲讲如何在.NET应用中集成和使用ES吧，额，这个其实网上也有很多教程了。不过你既然提了，那还是得安排上。

在.NET应用中集成ES一般涉及两个方面：

（1）将ES当存储用，类似于MongoDB，做文档的增删查改，这一类操作偏CRUD。

（2）对ES中的数据做查询分析，聚合统计、分组等等，这一类操作偏查询分析。

针对这两类操作，我们今天先来搞定CRUD！

准备工作

创建一个Web API应用程序，这里我选择的是.NET 6版本。

项目结构如下图所示：

其中，我们对Elastic的集成主要放在了Infrastructure目录中，里面存放了我们定义的Repository进而帮助我们在Controller中使用其提供的持久化能力。

在appsetting中我们定义了如下配置指明Elastic的相关信息（URL地址和默认索引）：

{ ......"Elastic": {"ServerUrl": "http://edt-elastic:9200","DefaultIndex": "app-logs" }}

定义模型

我们这里定义一个Model，假设叫AppLog，来模拟日志文档的CRUD到ES：

public classAppLog : ElasticModelBase{publicstring LogLevel { get; set; } = "Info";publicstring Message { get; set; } = string.Empty;public DateTimeOffset CreatedAt { get; set; } = DateTimeOffset.Now;publicAppLog() {this.Id = Guid.NewGuid().ToString(); }publicAppLog(string id) {this.Id = id; }}public classElasticModelBase{publicvirtualstring Id { get; set; }}

定义ElasticProxy

我们知道，.NET应用要操作Elastic得使用Elastic的.NET客户端，因此按照国际惯例我们对其进行一个小封装，以便于可以在Repository中使用。

对于ES 7.x版本的集群，推荐使用NEST这个客户端包（目前已停止更新）：

dotnetaddpackageNEST

对于ES 8.x及以上版本的集群，则推荐使用Elastic.Clients.Elasticsearch：

dotnet add package Elastic.Clients.Elasticsearch

这里因为我自己搭的实验ES集群环境是7.x版本，所以我使用的实NEST，不过操作都是类似的。

在Infrastructure目录下，定义一个ElasticProxy用于获取Elastic的.NET客户端：

publicinterfaceIElasticProxy{IElasticClient GetClient(string indexName = null);}public classElasticProxy : IElasticProxy{privatereadonlystring ElasticServerUrl;privatereadonlystring DefaultIndexName;publicElasticProxy(IConfiguration configuration) { ElasticServerUrl = configuration["Elastic:ServerUrl"] ?? thrownew ArgumentNullException(); DefaultIndexName = configuration["Elastic:DefaultIndex"] ?? thrownew ArgumentNullException(); }public IElasticClient GetClient(string indexName = null) {var settings = new ConnectionSettings(new Uri(ElasticServerUrl)) .DefaultIndex(indexName ?? DefaultIndexName);returnnew ElasticClient(settings); }}

定义ElasticRepository基类

为了方便后续定义具体的Repository，我们这里先定义一个ElasticRepository的基类，帮我们把CRUD操作做一个基础的实现。

public interface IElasticRepositoryBase<T> where T : ElasticModelBase{Task AddAsync(T item);Task UpdateAsync(T item);Task DeleteAsync(string id); Task<Tuple<int, IList<T>>> QueryAsync(int page, int limit);}public abstract classElasticRepositoryBase<T> : IElasticRepositoryBase<T> where T : ElasticModelBase{private readonly IElasticProxy _elasticProxy;publicElasticRepositoryBase(IElasticProxy elasticProxy){ _elasticProxy = elasticProxy; }protected abstract string IndexName { get; }protected IElasticClient Client => _elasticProxy.GetClient(IndexName);publicvirtual async Task AddAsync(T item){ await this.Client.IndexAsync(item, x => x.Index(this.IndexName)); }publicvirtual async Task DeleteAsync(string id){ await this.Client.DeleteAsync<T>(id, x => x.Index(this.IndexName)); }publicvirtual async Task UpdateAsync(T item){ await this.Client.UpdateAsync<T>(item.Id, x => x.Index(this.IndexName).Doc(item)); }publicvirtual async Task<Tuple<int, IList<T>>> QueryAsync(int page, int limit) { var query = await this.Client.SearchAsync<T>(x => x.Index(this.IndexName) .From((page -1) * limit) .Size(limit));returnnew Tuple<int, IList<T>>(Convert.ToInt32(query.Total), query.Documents.ToList()); }}

有了上面的基类，我们再去实现具体的Repository就方便的多啦。

实现AppLogRepository

下面我们可以很方便的实现一个AppLogRepository啦，是不是很方便！

public classAppLogRepository : ElasticRepositoryBase<AppLog>, IAppLogRepository{public AppLogRepository(IElasticProxy elasticProxy) : base(elasticProxy) { }protectedoverride string IndexName => "app-logs";}

定义依赖注入

下面我们把要用到的ElasticProxy和Repository注入到ServiceCollection中，后面Controller就可以用了！这里我们在Infrastructure中实现一个扩展方法，便于在Program.cs中使用。

publicstatic classInfraServiceExtensions{publicstaticvoidAddApplicationInfrastructure(this IServiceCollection services) { services.AddSingleton<IElasticProxy, ElasticProxy>(); services.AddSingleton<IProductRepository, ProductRepository>(); services.AddSingleton<IAppLogRepository, AppLogRepository>(); }}

然后在Program.cs中使用这个扩展方法：

......// Add infra services / repositoriesbuilder.Services.AddApplicationInfrastructure();

实现AppLogController

下面我们就可以快速实现一个Controller来调用Repository实现ES的CRUD操作啦：

[ApiController][Route("[controller]")]public classAppLogController : ControllerBase{privatereadonly IAppLogRepository _appLogRepository;publicAppLogController(IAppLogRepository appLogRepository) { _appLogRepository = appLogRepository; } [HttpGet]publicasync Task<IActionResult> QueryAsync(int page = 1, int limit = 10) {var result = await _appLogRepository.QueryAsync(page, limit);return Ok(new { total = result.Item1, items = result.Item2 }); } [HttpPost]publicasync Task<IActionResult> AddAsync([FromBody] AppLog log) {await _appLogRepository.AddAsync(log);return Ok("Success"); } [HttpPut]publicasync Task<IActionResult> UpdateAsync([FromBody] AppLog log) {await _appLogRepository.UpdateAsync(log);return Ok("Success"); } [HttpDelete]publicasync Task<IActionResult> DeleteAsync([Required] string id) {await _appLogRepository.DeleteAsync(id);return Ok("Success"); }}