<\/p>\r\n\r\n
Today, I’m presenting to you, automatic filterin in AspNetCore Web Applications. That basicly converts Query String to LINQ without writing any of code, isn’t it amazing? Let’s follow this paper to understand that:<\/p>\r\n\r\n
<\/p>\r\n\r\n
<\/p>\r\n\r\n
Let’s understand what is the problem and what will be automated. Think about you have a Blog entity like below:<\/p>\r\n\r\n
<\/p>\r\n\r\n
\n\npublic class Blog
\n{
\n public string BlogId { get; set; }
\n public int CategoryId { get; set; }
\n public int Priority { get; set; }
\n public bool IsPublished { get; set; }
\n public DateTime PublishDate { get; set; }
\n}<\/div><\/div>\n\n<\/pre>\r\n\r\n<\/p>\r\n\r\n
And think about you have a DTO to filter Blogs:<\/p>\r\n\r\n
<\/p>\r\n\r\n
\n\npublic class BlogFilterDto
\n{
\n public int CategoryId { get; set; }
\n public int Priority { get; set; }
\n public bool? IsPublished { get; set; }
\n public DateTime PublishDate { get; set; }
\n}<\/div><\/div>\n\n<\/pre>\r\n\r\n<\/p>\r\n\r\n
Now, this dto parameters comes from QueryString and it is used to filter Blogs in Controller via classical way:<\/p>\r\n\r\n
<\/p>\r\n\r\n
\n\n[Route("api\/[controller]")]
\n [ApiController]
\n public class BlogsController : ControllerBase
\n {
\n [HttpGet]
\n public async Task<IActionResult> Get([FromQuery]BlogFilterDto filter)
\n {
\n var db = new MyDbContext();
\n
\n var query = db.Blogs;
\n if (filter.CategoryId != null)
\n query = query.Where(x => x.CategoryId == filter.CategoryId);
\n
\n if (filter.IsPublished != null)
\n query = query.Where(x => x.IsPublished == filter.IsPublished);
\n
\n if (filter.Priority != null)
\n query = query.Where(x => x.Priority == filter.Priority);
\n
\n if (filter.PublishDate != null)
\n query = query.Where(x => x.PublishDate == filter.PublishDate);
\n
\n var list = query.ToList();
\n
\n return Ok(list);
\n }
\n }<\/div><\/div>\n\n<\/pre>\r\n\r\n<\/p>\r\n\r\n
Uhh, it is too much painful and compicated codes and stuffs.<\/p>\r\n\r\n
<\/p>\r\n\r\n
Solution<\/h2>\r\n\r\n
<\/p>\r\n\r\n
There is a lot of way to solve this problem like reflection but the main point is keep conversion to dabase queries ability. That means we need to generate expressions from properties. It’s not logically right, to do this for each model. That’s why I created a library that converts properties to Expressions that can be applied on Entity Framework IQuaryable. That is AutoFilterer<\/a><\/p>\r\n\r\n
<\/p>\r\n\r\n
AutoFilterer<\/h3>\r\n\r\n
<\/p>\r\n\r\n
Firstly, add AutoFilterer<\/strong> to your project from NuGet. You can visit wiki page<\/a> to read more detailed installation and usage documentations.<\/p>\r\n\r\n
<\/p>\r\n
\r\n<\/p>\r\n\r\n
Afterall, go your DTO and inherit from FilterBase class.<\/p>\r\n\r\n
<\/p>\r\n\r\n
\n\npublic class BlogFilterDto : FilterBase<Blog>
\n{
\n public int CategoryId { get; set; }
\n public int Priority { get; set; }
\n public bool? IsPublished { get; set; }
\n public DateTime PublishDate { get; set; }
\n}<\/div><\/div>\n\n<\/pre>\r\n\r\n<\/p>\r\n\r\n
And, go back to your controller and remove all the stuffs and just use ApplyFilterTo() <\/strong>method to generate expression and apply to DbSet. That’s it. It’s amazing, everything works easily with a clean controller code or repository code or whatever you say…<\/p>\r\n\r\n
<\/p>\r\n\r\n
<\/p>\r\n\r\n
\n\n[Route("api\/[controller]")]
\n [ApiController]
\n public class BlogsController : ControllerBase
\n {
\n \/\/ api\/Blogs
\n \/\/ api\/Blogs?categoryId=8
\n \/\/ api\/Blogs?categoryId=8&isPublished=False
\n \/\/ api\/Blogs?priority=2
\n
\n [HttpGet]
\n public async Task<IActionResult> Get([FromQuery]BlogFilterDto filter)
\n {
\n var db = new MyDbContext();
\n
\n var list = filter.ApplyFilterTo(db.Blogs).ToList();
\n
\n return Ok(list);
\n }
\n }<\/div><\/div>\n\n<\/pre>\r\n\r\n<\/p>\r\n\r\n
\u00a0Advanced configurations are made in your DTO with attributes. That keeps your code clean and readable with an amazing way! You can use this library in any platform, it’s for only Web API. You can use it in MVC projects with returning `View()` instead of `Ok()`<\/p>\r\n\r\n<\/p>\r\n\r\n
Advaned Options<\/h3>\r\n\r\n
<\/p>\r\n\r\n
For more feature, like Pagination, Range filtering, string search, you can find instructions from GitHub Page<\/a><\/p>\r\n\r\n
<\/p>\r\n\r\n
<\/p>\r\n\r\n
<\/p>\r\n\r\n
Bu i\u015flemi otomatize etmenin pek \u00e7ok yolu var. Fakat istedi\u011fimiz yol Expression \u00fcretmek ve do\u011frudan Entity Framework \u00fczerinden DB sorgusuna d\u00f6n\u00fc\u015febilmesini sa\u011flamak. Bunu her bir model i\u00e7in ayr\u0131 ayr\u0131 yapmak yerine, Generic bir \u015fekilde yapan bir k\u00fct\u00fcphane geli\u015ftirdim: AutoFilterer<\/a><\/p>\r\n\r\n
AutoFilterer<\/h3>\r\n\r\n
<\/p>\r\n\r\n
Projemize AutoFilterer<\/strong> k\u00fct\u00fcphanesini NuGet Package<\/strong> olarak ekliyoruz. Daha detayl\u0131 kurulum ve kullan\u0131m talimatlar\u0131 i\u00e7in GitHub’daki wiki sayfas\u0131<\/a>n\u0131 ziyaret edebilirsiniz.<\/p>\r\n
\r\n<\/p>\r\n\r\n
Daha sonra DTO class’\u0131na gidip FilterBase objesinden miras almas\u0131n\u0131 sa\u011flay\u0131n<\/p>\r\n\r\n
<\/p>\r\n\r\n
\n\npublic class BlogFilterDto : FilterBase<Blog>
\n{
\n public int CategoryId { get; set; }
\n public int Priority { get; set; }
\n public bool? IsPublished { get; set; }
\n public DateTime PublishDate { get; set; }
\n}<\/div><\/div>\n\n<\/pre>\r\n\r\n<\/p>\r\n\r\n
Ve sonunda Controller’a d\u00f6n\u00fcp b\u00fct\u00fcn o uzun hardcode edilmi\u015f k\u0131sm\u0131 temizleyip ApplyFilterTo()<\/strong> methodunu \u00e7a\u011f\u0131rabiliriz. Bu otomatik olarak Expression olu\u015fturup, DbSet’teki IQuaryable koleksiyona uygulam\u0131\u015f olacak. Daha sonras\u0131nda ile tek yapmam\u0131z gereken bu sorguyu \u00e7al\u0131\u015ft\u0131rmak.<\/p>\r\n\r\n
<\/p>\r\n\r\n
<\/p>\r\n\r\n
\n\n[Route("api\/[controller]")]
\n [ApiController]
\n public class BlogsController : ControllerBase
\n {
\n \/\/ api\/Blogs
\n \/\/ api\/Blogs?categoryId=8
\n \/\/ api\/Blogs?categoryId=8&isPublished=False
\n \/\/ api\/Blogs?priority=2
\n
\n [HttpGet]
\n public async Task<IActionResult> Get([FromQuery]BlogFilterDto filter)
\n {
\n var db = new MyDbContext();
\n
\n var list = filter.ApplyFilterTo(db.Blogs).ToList();
\n
\n return Ok(list);
\n }
\n }<\/div><\/div>\n\n<\/pre>\r\n\r\n<\/p>\r\n\r\n
B\u00f6ylelikle \u00e7ok daha temiz bir kod elde etmi\u015f olduk. Advanced d\u00fczey ayarlamalar\u0131 da DTO \u00fczerinden attribute’ler ile yapm\u0131\u015f olaca\u011f\u0131m\u0131zdan, filtreleme sorgular\u0131yla ilgili herhangi bir \u015fey kodun d\u00fczenini ve okunabilirli\u011fini bozmam\u0131\u015f olacak. Sadece Web API projelerinde de\u011fil, MVC projelerinde de kullan\u0131labilir. `Ok()` yerine `View()` return edip, view k\u0131sm\u0131nda filtrelenmi\u015f listeyi kullanabilirsiniz.\u00a0<\/p>\r\n\r\n
<\/p>\r\n\r\n
\u0130leri D\u00fczey Ayarlamalar<\/h3>\r\n\r\n
<\/p>\r\n\r\n
Sayfalama, aral\u0131k filtreleme, string i\u00e7erisinde arama gibi \u00f6zellikler i\u00e7in GitHub sayfas\u0131<\/a>ndaki talimatlar\u0131 takip edebilirsiniz.<\/p>\r\n\r\n
<\/p>\r\n\r\n
<\/p>\r\n\r\n
Summary<\/h2>\r\n\r\n
<\/p>\r\n\r\n
Today, I’m presenting to you, automatic filterin in AspNetCore Web Applications. That basicly converts Query String to LINQ without writing any of code, isn’t it amazing? Let’s follow this paper to understand that:<\/p>\r\n\r\n
<\/p>\r\n\r\n
Problem<\/h2>\r\n\r\n
<\/p>\r\n\r\n
Let’s understand what is the problem and what will be automated. Think about you have a Blog entity like below:<\/p>\r\n\r\n
<\/p>\r\n\r\n
\n\npublic class Blog
\n{
\n public string BlogId { get; set; }
\n public int CategoryId { get; set; }
\n public int Priority { get; set; }
\n public bool IsPublished { get; set; }
\n public DateTime PublishDate { get; set; }
\n}<\/div><\/div>\n\n<\/pre>\r\n\r\n<\/p>\r\n\r\n
And think about you have a DTO to filter Blogs:<\/p>\r\n\r\n
<\/p>\r\n\r\n
\n\npublic class BlogFilterDto
\n{
\n public int CategoryId { get; set; }
\n public int Priority { get; set; }
\n public bool? IsPublished { get; set; }
\n public DateTime PublishDate { get; set; }
\n}<\/div><\/div>\n\n<\/pre>\r\n\r\n<\/p>\r\n\r\n
Now, this dto parameters comes from QueryString and it is used to filter Blogs in Controller via classical way:<\/p>\r\n\r\n
<\/p>\r\n\r\n
\n\n[Route("api\/[controller]")]
\n [ApiController]
\n public class BlogsController : ControllerBase
\n {
\n [HttpGet]
\n public async Task<IActionResult> Get([FromQuery]BlogFilterDto filter)
\n {
\n var db = new MyDbContext();
\n
\n var query = db.Blogs;
\n if (filter.CategoryId != null)
\n query = query.Where(x => x.CategoryId == filter.CategoryId);
\n
\n if (filter.IsPublished != null)
\n query = query.Where(x => x.IsPublished == filter.IsPublished);
\n
\n if (filter.Priority != null)
\n query = query.Where(x => x.Priority == filter.Priority);
\n
\n if (filter.PublishDate != null)
\n query = query.Where(x => x.PublishDate == filter.PublishDate);
\n
\n var list = query.ToList();
\n
\n return Ok(list);
\n }
\n }<\/div><\/div>\n\n<\/pre>\r\n\r\n<\/p>\r\n\r\n
Uhh, it is too much painful and compicated codes and stuffs.<\/p>\r\n\r\n
<\/p>\r\n\r\n
Solution<\/h2>\r\n\r\n
<\/p>\r\n\r\n
There is a lot of way to solve this problem like reflection but the main point is keep conversion to dabase queries ability. That means we need to generate expressions from properties. It’s not logically right, to do this for each model. That’s why I created a library that converts properties to Expressions that can be applied on Entity Framework IQuaryable. That is AutoFilterer<\/a><\/p>\r\n\r\n
<\/p>\r\n\r\n
AutoFilterer<\/h3>\r\n\r\n
<\/p>\r\n\r\n