如何将Elasticsearch.Net GET请求返回的Fields序列化为对象类型
Elasticsearch.Net 存储字段自动反序列化方案
问题场景
使用Elasticsearch.Net客户端执行Get文档请求时,为规避大体积_source字段加载解析带来的额外性能开销,会设置SourceEnabled(false),仅指定需要返回的存储字段。
开启_source返回时,客户端可自动将响应内容反序列化为指定的泛型对象;但关闭_source后,响应的Fields属性类型为FieldValues(继承自IsADictionaryBase<string, LazyDocument>),默认不会自动映射为目标实体类。
发起请求的示例代码如下:
var response = await client.GetAsync<MyObject>(docId, s => s.Index(myIndex) .SourceEnabled(false) .StoredFields(new string[] { "MyStringArray1", "MyStringArray2", "MyLongValue" } ));
最原始的处理方式是逐字段手动读取赋值,可维护性差:
MyObject mine = new MyObject() { MyStringArray1 = response.Fields["MyStringArray1"].As<string[]>(), MyStringArray2 = response.Fields["MyStringArray2"].As<string[]>(), MyLongValue = response.Fields.Value<long>("MyLongValue") };
可用实现方式
直接使用内置反序列化方法
7.x及以上版本的Elasticsearch.Net客户端,FieldValues类型已内置支持直接映射为目标实体类型,不需要逐字段手动赋值,直接调用As<T>()方法即可:
MyObject mine = response.Fields.As<MyObject>();
注意事项:该方法的字段名匹配规则和客户端全局序列化配置一致,如果C#属性名和ES存储字段名存在命名策略差异(如帕斯卡命名转驼峰、自定义属性名映射),只要和_source反序列化时的配置保持一致,就能自动完成正确映射,不需要额外处理。
低版本兼容扩展
如果使用的是不支持整对象As<T>()映射的低版本客户端,可以封装一个通用扩展方法,通过反射自动完成属性匹配赋值,一次封装后可全局复用:
using System.Reflection; public static class FieldValuesExtension { public static T ToObject<T>(this FieldValues fields) where T : new() { var result = new T(); var writableProps = typeof(T).GetProperties(BindingFlags.Instance | BindingFlags.Public) .Where(prop => prop.CanWrite); foreach (var prop in writableProps) { // 可根据自身命名规则调整字段名转换逻辑,比如驼峰转换 var fieldKey = prop.Name; if (fields.ContainsKey(fieldKey)) { prop.SetValue(result, fields[fieldKey].As(prop.PropertyType)); } } return result; } }
使用时直接调用扩展方法即可:
MyObject mine = response.Fields.ToObject<MyObject>();
内容的提问来源于stack exchange,提问作者Gabe
相关产品推荐
相关产品推荐

