QueryFilter: फ़िल्टरिंग मॉडल की अवधारणा

मैं URL- अनुरोध द्वारा फ़िल्टरिंग के आयोजन की अवधारणा को आपके ध्यान में लाना चाहता हूं। उदाहरण के लिए, मैं PHP भाषा और लारवेल फ्रेमवर्क का उपयोग करूंगा।

संकल्पना

फ़िल्टर के साथ काम करने के लिए एक सार्वभौमिक QueryFilter वर्ग बनाने का विचार है।

GET /posts?title=source&status=active 

इस उदाहरण का उपयोग करते हुए, हम निम्नलिखित मानदंडों द्वारा पदों (पोस्ट मॉडल) को फ़िल्टर करेंगे:

• शीर्षक क्षेत्र में "स्रोत" शब्द की उपस्थिति;
• मूल्य "प्रकाशित" स्थिति क्षेत्र में;

आवेदन उदाहरण

पोस्ट मॉडल

 <?php namespace App; use Illuminate\Database\Eloquent\Model; class Post extends Model { /** * The attributes that are mass assignable. * * @var array */ protected $fillable = [ 'name', 'id', 'title', 'slug', 'status', 'type', 'published_at', 'updated_at', ]; } 

एक मार्ग जोड़ें:

 Route::get('/posts', 'PostController@index'); 

JSON प्रारूप में आउटपुट के लिए एक संसाधन \ Post फ़ाइल बनाएँ:

 namespace App\Http\Resources; use Illuminate\Http\Resources\Json\JsonResource; class Post extends JsonResource { /** * Transform the resource into an array. * * @param \Illuminate\Http\Request $request * @return array */ public function toArray($request) { return [ 'id' => $this->ID, 'title' => $this->post_title, 'slug' => $this->post_name, 'status' => $this->post_status, 'type' => $this->post_type, 'published_at' => $this->post_date, 'updated_at' => $this->post_modified, ]; } } 

और नियंत्रक एक ही कार्रवाई के साथ:

 namespace App\Http\Controllers; use App\Http\Resources\Post as PostResource; use App\Post; class PostController extends Controller { /** * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection */ public function index() { $posts = Post::limit(10)->get(); return PostResource::collection($posts); } } 

मानक फ़िल्टरिंग निम्नलिखित कोड द्वारा आयोजित किया जाता है:

 /** * @param Request $request * @return \Illuminate\Http\Resources\Json\AnonymousResourceCollection */ public function index(Request $request) { $query = Post::limit(10); if ($request->filled('status')) { $query->where('post_status', $request->get('status')); } if ($request->filled('title')) { $title = $request->get('title'); $query->where('post_title', 'like', "%$title%"); } $posts = $query->get(); return PostResource::collection($posts); } 

इस दृष्टिकोण के साथ, हमें नियंत्रक की वृद्धि का सामना करना पड़ता है, जो अवांछनीय है।

QueryFilter को लागू करना

इस तरह की अवधारणा का अर्थ प्रत्येक इकाई के लिए एक अलग वर्ग का उपयोग करना है जो फ़िल्टरिंग के लिए प्रत्येक क्षेत्र के तरीकों का मानचित्रण करता है।

अनुरोध द्वारा फ़िल्टर करें:

 GET /posts?title=source&status=publish 

फ़िल्टरिंग के लिए, हमारे पास पोस्टफ़िल्टर क्लास और शीर्षक () और स्थिति () विधियाँ होंगी । PostFilter अमूर्त वर्ग QueryFiler का विस्तार करेगा जो पारित मापदंडों के साथ वर्ग विधियों के मिलान के लिए जिम्मेदार है।

विधि लागू ()

QueryFIlter वर्ग में एक लागू () विधि है, जो फ़िल्टर फ़िल्टर को लागू करने के लिए ज़िम्मेदार है जो PostFilter बच्चे वर्ग में हैं।

 namespace App\Http\Filters; use Illuminate\Database\Eloquent\Builder; use Illuminate\Http\Request; abstract class QueryFilter { /** * @var Request */ protected $request; /** * @var Builder */ protected $builder; /** * @param Request $request */ public function __construct(Request $request) { $this->request = $request; } /** * @param Builder $builder */ public function apply(Builder $builder) { $this->builder = $builder; foreach ($this->fields() as $field => $value) { $method = camel_case($field); if (method_exists($this, $method)) { call_user_func_array([$this, $method], (array)$value); } } } /** * @return array */ protected function fields(): array { return array_filter( array_map('trim', $this->request->all()) ); } } 

लब्बोलुआब यह है कि अनुरोध के माध्यम से पारित प्रत्येक क्षेत्र के लिए हमारे पास चाइल्ड फ़िल्टर क्लास (पोस्टफ़िल्टर क्लास) में एक अलग विधि है। यह हमें प्रत्येक फ़िल्टर फ़ील्ड के लिए तर्क को अनुकूलित करने की अनुमति देता है।

पोस्टफिल्टर क्लास

अब चलिए PostFilter क्लास बनाने की ओर बढ़ते हैं जो QueryFilter का विस्तार करती है । जैसा कि पहले उल्लेख किया गया है, इस वर्ग में प्रत्येक क्षेत्र के लिए विधियाँ होनी चाहिए जिनके द्वारा हमें फ़िल्टर करना है। हमारे मामले में, शीर्षक ($ मूल्य) और स्थिति ($ मूल्य) तरीके

 namespace App\Http\Filters; use Illuminate\Database\Eloquent\Builder; class PostFilter extends QueryFilter { /** * @param string $status */ public function status(string $status) { $this->builder->where('post_status', strtolower($status)); } /** * @param string $title */ public function title(string $title) { $words = array_filter(explode(' ', $title)); $this->builder->where(function (Builder $query) use ($words) { foreach ($words as $word) { $query->where('post_title', 'like', "%$word%"); } }); } } 

यहां मुझे प्रत्येक विधि के विस्तृत विश्लेषण के लिए कोई कारण नहीं दिखाई देता है, काफी मानक प्रश्न। मुद्दा यह है कि अब हमारे पास प्रत्येक क्षेत्र के लिए एक अलग विधि है और हम अनुरोध बनाने के लिए किसी भी तर्क का उपयोग कर सकते हैं।

दायरे बनाएँ ()

अब हमें मॉडल और क्वेरी डिज़ाइनर को बांधने की आवश्यकता है

 /** * @param Builder $builder * @param QueryFilter $filter */ public function scopeFilter(Builder $builder, QueryFilter $filter) { $filter->apply($builder); } 

खोज करने के लिए, हमें अपने मामले PostFilter में फ़िल्टर () विधि को कॉल करने और QueryFilter का एक उदाहरण पास करने की आवश्यकता है ।

 $filteredPosts = Post::filter($postFilter)->get(); 

इस प्रकार, सभी फ़िल्टरिंग लॉजिक को फ़िल्टर ($ पोस्टफ़िल्टर) विधि से कॉल करके संसाधित किया जाता है, जिससे नियंत्रक को अनावश्यक तर्क से बचाया जा सके।

पुन: उपयोग की सुविधा के लिए, आप स्कोप में स्कोपफिल्टर विधि डाल सकते हैं और इसका उपयोग प्रत्येक मॉडल के लिए कर सकते हैं जिसे फ़िल्टर करने की आवश्यकता होती है।

 namespace App\Http\Filters; use Illuminate\Database\Eloquent\Builder; trait Filterable { /** * @param Builder $builder * @param QueryFilter $filter */ public function scopeFilter(Builder $builder, QueryFilter $filter) { $filter->apply($builder); } } 

पोस्ट ऐड में:

 class Post extends CorcelPost { use Filterable; 

यह कंट्रोलर विधि में इंडेक्स () को पोस्टफिल्टर पैरामीटर के रूप में जोड़ता है और फ़िल्टर () मॉडल विधि को कॉल करता है।

 class PostController extends Controller { /** * @param PostFilter $filter * @return \Illuminate\Http\Resources\Json\ResourceCollection */ public function index(PostFilter $filter) { $posts = Post::filter($filter)->limit(10)->get(); return PostResource::collection($posts); } } 

वह सब है। हम सभी फ़िल्टरिंग लॉजिक को उपयुक्त वर्ग में ले गए, जो एकल जिम्मेदारी के सिद्धांत का पालन कर रहा है (सिद्धांतों की ठोस प्रणाली में एस)

निष्कर्ष

फिल्टर के कार्यान्वयन के लिए यह दृष्टिकोण आपको ट्रेलर पतले नियंत्रक से चिपके रहने की अनुमति देता है, और परीक्षणों के लेखन की सुविधा भी देता है।

यहाँ PHP और Laravel का उपयोग करके एक उदाहरण दिया गया है। लेकिन जैसा कि मैंने कहा, यह एक अवधारणा है और किसी भी भाषा या ढांचे के साथ काम कर सकती है।

संदर्भ

• जूनियर ग्रॉसी ब्लॉग
• किलर ब्लैस से तैयार पैकेज