目录
前言
在以前的文章中,我们介绍了使用AutoFilterer.Generators
创建高级查询服务。
但是,AutoFilterer.Generators
只能提供简单的范围筛选:
今天,我们介绍如何使用Dynamic LINQ轻松实现更强大的高级查询服务。
Demo
创建ASP.NET Core Web API项目,引用Nuget包System.Linq.Dynamic.Core
。
并在WeatherForecastController.cs头部添加:
using System.Linq.Dynamic.Core;
1.定义查询参数
创建DynamicLinqDto
,用于传递返回字段、查询条件、排序方式、分页方式等:
public class DynamicLinqDto
{
public string Fields { get; set; }
public string Filter { get; set; }
public string OrderBy { get; set; }
public int? PageNo { get; set; }
public int? PageSize { get; set; }
}
2.实现查询方法
修改默认的Get方法如下:
[HttpGet]
[ProducesDefaultResponseType(typeof(WeatherForecast))]
public IEnumerable<dynamic> Get([FromQuery] DynamicLinqDto dto)
{
var rng = new Random();
IQueryable query = Enumerable.Range(1, 5).Select(index => new WeatherForecast
{
Date = DateTime.Now.AddDays(index),
TemperatureC = rng.Next(-20, 55),
Summary = Summaries[rng.Next(Summaries.Length)]
})
.AsQueryable();
return query.ToDynamicArray(dto);
}
由于Get方法的返回类型是IEnumerable,因此需要使用ProducesDefaultResponseTypeAttribute
指定实际返回的类型,以便Swagger页面能显示正确:
3.实现扩展方法
上面最关键的代码是ToDynamicArray
方法。
实际上,这是我们封装的扩展方法,对于任意IQueryable
对象,实现高级查询:
public static class DynamicLinqExtentions
{
public static dynamic[] ToDynamicArray(this IQueryable query, DynamicLinqDto dto)
{
if (!string.IsNullOrWhiteSpace(dto.Fields))
{
query = query.Select($@"new({dto.Fields})");
}
if (!string.IsNullOrWhiteSpace(dto.Filter))
{
query = query.Where(dto.Filter);
}
if (!string.IsNullOrWhiteSpace(dto.OrderBy))
{
query = query.OrderBy(dto.OrderBy);
}
var pageNo = dto.PageNo ?? 1;
var pageSize = dto.PageSize ?? 10;
query = query.Page(pageNo, pageSize);
return query.ToDynamicArray();
}
}
4.效果
运行程序,传入指定的参数并执行:
可以看到,现在,“高级查询”服务已经完成了:
结论
可以看到Dynamic LINQ使实现起来相当容易。详细参数说明请参看官方文档:https://dynamic-linq.net/