{"id":4288,"date":"2024-12-17T11:02:22","date_gmt":"2024-12-17T11:02:22","guid":{"rendered":"https:\/\/www.rcvtechnologies.com\/blog\/?p=4288"},"modified":"2024-12-17T11:07:06","modified_gmt":"2024-12-17T11:07:06","slug":"why-use-repository-pattern-in-laravel","status":"publish","type":"post","link":"https:\/\/www.rcvtechnologies.com\/blog\/why-use-repository-pattern-in-laravel\/","title":{"rendered":"Why use Repository Pattern in Laravel"},"content":{"rendered":"

Detailed Use Case: E-Commerce Platform with Complex Data Requirements<\/b><\/p>\n

Scenario: Multi-Vendor Marketplace System<\/b><\/p>\n

Initial Context<\/b><\/p>\n

Imagine an e-commerce platform with the following complex requirements:<\/span><\/p>\n

– Multiple data sources (internal database, external vendor APIs)<\/span><\/p>\n

– Complex querying across different models<\/span><\/p>\n

– Need for extensive caching<\/span><\/p>\n

– Requirement for advanced filtering and search<\/span><\/p>\n

– Performance optimization<\/span><\/p>\n

– Decoupled architecture for scalability<\/span><\/p>\n

 <\/p>\n

Practical Implementation<\/b><\/p>\n

    \n
  1. Product Repository with Multiple Data Sources<\/b><\/li>\n<\/ol>\n
    \n\t\t\t
    \n
    \n
    \n
    <\/div>\n
    <\/div>\n
    <\/div>\n <\/div>\n
    \n \n Copy Code<\/span>\n Copied<\/span>\n Use a different Browser<\/span><\/a>\n <\/div>\n <\/div>\n 
    <\/p>\n
    namespace App\\Repositories;\r\n\r\nuse App\\Models\\Product;\r\n\r\nuse App\\Interfaces\\ProductRepositoryInterface;\r\n\r\nuse Illuminate\\Support\\Facades\\Cache;\r\n\r\nuse App\\Services\\ExternalVendorService;\r\n\r\n\r\n\r\n\r\nclass ProductRepository implements ProductRepositoryInterface\r\n\r\n{\r\n\r\n\u00a0\u00a0\u00a0\u00a0protected $model;\r\n\r\n\u00a0\u00a0\u00a0\u00a0protected $externalVendorService;\r\n\r\n\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0public function __construct(Product $product, ExternalVendorService $externalVendorService)\r\n\r\n\u00a0\u00a0\u00a0\u00a0{\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0$this->model = $product;\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0$this->externalVendorService = $externalVendorService;\r\n\r\n\u00a0\u00a0\u00a0\u00a0}\r\n\r\n\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0\/\/ Complex method demonstrating multiple concerns\r\n\r\n\u00a0\u00a0\u00a0\u00a0public function getFilteredProducts(array $filters)\r\n\r\n\u00a0\u00a0\u00a0\u00a0{\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\/\/ Caching strategy\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0$cacheKey = $this->generateCacheKey($filters);\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0return Cache::remember($cacheKey, now()->addHours(2), function () use ($filters) {\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0$query = $this->model->newQuery();\r\n\r\n\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\/\/ Dynamic filtering with multiple conditions\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0$query->when($filters['category'] ?? null, function ($q, $category) {\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0return $q->where('category_id', $category);\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0})\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0->when($filters['price_min'] ?? null, function ($q, $minPrice) {\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0return $q->where('price', '>=', $minPrice);\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0})\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0->when($filters['price_max'] ?? null, function ($q, $maxPrice) {\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0return $q->where('price', '<=', $maxPrice);\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0})\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0->when($filters['vendor'] ?? null, function ($q, $vendor) {\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0return $q->where('vendor_id', $vendor);\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0});\r\n\r\n\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\/\/ Complex join with vendor information\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0$query->with(['vendor', 'reviews'])\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0->withCount('reviews')\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0->orderBy('rating', 'desc');\r\n\r\n\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\/\/ Paginate with custom per page\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0return $query->paginate($filters['per_page'] ?? 15);\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0});\r\n\r\n\u00a0\u00a0\u00a0\u00a0}\r\n\r\n\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0\/\/ Method to fetch products from external vendor\r\n\r\n\u00a0\u00a0\u00a0\u00a0public function getExternalVendorProducts($vendorId)\r\n\r\n\u00a0\u00a0\u00a0\u00a0{\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\/\/ Fetch products from external API\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0$externalProducts = $this->externalVendorService->getProducts($vendorId);\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\/\/ Transform and normalize external data\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0return $this->transformExternalProducts($externalProducts);\r\n\r\n\u00a0\u00a0\u00a0\u00a0}\r\n\r\n\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0\/\/ Advanced search method\r\n\r\n\u00a0\u00a0\u00a0\u00a0public function searchProducts($searchTerm, array $options = [])\r\n\r\n\u00a0\u00a0\u00a0\u00a0{\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0return $this->model->search($searchTerm)\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0->when($options['category'] ?? null, function ($query, $category) {\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0return $query->where('category_id', $category);\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0})\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0->when($options['vendor'] ?? null, function ($query, $vendor) {\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0return $query->where('vendor_id', $vendor);\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0})\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0->paginate($options['per_page'] ?? 15);\r\n\r\n\u00a0\u00a0\u00a0\u00a0}\r\n\r\n\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0\/\/ Complex aggregation method\r\n\r\n\u00a0\u00a0\u00a0\u00a0public function getVendorProductPerformance($vendorId)\r\n\r\n\u00a0\u00a0\u00a0\u00a0{\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0return $this->model->where('vendor_id', $vendorId)\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0->select([\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0DB::raw('AVG(rating) as average_rating'),\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0DB::raw('COUNT(*) as total_products'),\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0DB::raw('SUM(total_sales) as cumulative_sales')\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0])\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0->first();\r\n\r\n\u00a0\u00a0\u00a0\u00a0}\r\n\r\n\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0\/\/ Private helper method for cache key generation\r\n\r\n\u00a0\u00a0\u00a0\u00a0private function generateCacheKey(array $filters)\r\n\r\n\u00a0\u00a0\u00a0\u00a0{\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0return 'products:' . md5(json_encode($filters));\r\n\r\n\u00a0\u00a0\u00a0\u00a0}\r\n\r\n}<\/pre>\n
    <\/code><\/pre>\n\t\t\t<\/div>\n        <\/div>\n
    Why Repository Pattern is Necessary Here<\/b><\/p>\n
      \n
    1.  Separation of Concerns<\/b><\/li>\n<\/ol>\n
      \u00a0\u00a0\u00a0– Isolates complex database logic from controllers<\/span><\/p>\n
      \u00a0\u00a0\u00a0– Centralizes query logic in one place<\/span><\/p>\n
      \u00a0\u00a0\u00a0– Makes code more maintainable and readable<\/span><\/p>\n
        \n
      1.  Flexibility in Data Sources<\/b><\/li>\n<\/ol>\n
        \u00a0\u00a0\u00a0– Can easily switch between local database and external APIs<\/span><\/p>\n
        \u00a0\u00a0\u00a0– Provides a consistent interface for data retrieval<\/span><\/p>\n
        \u00a0\u00a0\u00a0– Allows seamless integration of multiple data sources<\/span><\/p>\n
          \n
        1.  Caching Strategy<\/b><\/li>\n<\/ol>\n
          \u00a0\u00a0\u00a0– Implements sophisticated caching mechanism<\/span><\/p>\n
          \u00a0\u00a0\u00a0– Reduces database load<\/span><\/p>\n
          \u00a0\u00a0\u00a0– Improves application performance<\/span><\/p>\n
            \n
          1.  Complex Filtering and Search<\/b><\/li>\n<\/ol>\n
            \u00a0\u00a0\u00a0– Provides advanced filtering capabilities<\/span><\/p>\n
            \u00a0\u00a0\u00a0– Supports dynamic query building<\/span><\/p>\n
            \u00a0\u00a0\u00a0– Enables complex search across multiple criteria<\/span><\/p>\n
             <\/p>\n
              \n
            1.  Testability<\/b><\/li>\n<\/ol>\n
              \u00a0 
              \n\t\t\t
              \n                
              \n                    
              \n                        
              <\/div>\n                        
              <\/div>\n                        
              <\/div>\n                    <\/div>\n                    
              \n                        \n                        Copy Code<\/span>\n                        Copied<\/span>\n                        Use a different Browser<\/span><\/a>\n                    <\/div>\n                <\/div>\n                
              <\/span><\/p>\n
              \/\/ Easy to mock for unit testing\r\n\r\n\u00a0\u00a0\u00a0public function testProductRetrieval()\r\n\r\n\u00a0\u00a0\u00a0{\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0$mockRepo = Mockery::mock(ProductRepository::class);\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0$mockRepo->shouldReceive('getFilteredProducts')\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0->once()\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0->andReturn(collect([]));\r\n\r\n\r\n\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\/\/ Test controller or service logic\r\n\r\n\u00a0\u00a0\u00a0}<\/pre>\n
              <\/code><\/pre>\n\t\t\t<\/div>\n        <\/div><\/span><\/p>\n
               <\/p>\n
              Additional Benefits in This Scenario<\/b><\/p>\n
              – Performance Optimization<\/b><\/p>\n
              \u00a0\u00a0– Centralized query optimization<\/span><\/p>\n
              \u00a0\u00a0– Consistent caching strategy<\/span><\/p>\n
              \u00a0\u00a0– Reduced database hits<\/span><\/p>\n
              – Scalability<\/b><\/p>\n
              \u00a0\u00a0– Easy to modify data retrieval logic<\/span><\/p>\n
              \u00a0\u00a0– Supports future extensions<\/span><\/p>\n
              \u00a0\u00a0– Decoupled from direct Eloquent usage<\/span><\/p>\n
              When This Approach Shines<\/b><\/p>\n
              \ud83d\udc49 Large, complex applications<\/span><\/p>\n
              \ud83d\udc49 Multiple data sources<\/span><\/p>\n
              \ud83d\udc49 Advanced querying requirements<\/span><\/p>\n
              \ud83d\udc49 Performance-critical systems<\/span><\/p>\n
              \ud83d\udc49 Microservices architectures<\/span><\/p>\n
              Potential Drawbacks (Mitigated)<\/b><\/p>\n
                \n
              1. Complexity<\/b>: Managed through clean, well-structured implementation<\/span><\/li>\n
              2. Performance Overhead<\/b>: Minimized through efficient caching<\/span><\/li>\n
              3. Abstraction<\/b>: Provides tangible benefits in complex scenarios<\/span><\/li>\n<\/ol>\n
                 <\/p>\n
                Key Takeaway<\/b><\/p>\n
                The Repository pattern is not about blind abstraction but strategic decoupling. In scenarios with complex data interactions, it provides significant architectural advantages that outweigh its minor performance implications.<\/span><\/p>\n
                 <\/p>\n","protected":false},"excerpt":{"rendered":"
                Detailed Use Case: E-Commerce Platform with Complex Data Requirements Scenario: Multi-Vendor Marketplace System Initial Context Imagine an e-commerce platform with the following complex requirements: – Multiple data sources (internal database, external vendor APIs) – Complex querying across different models – Need for extensive caching – Requirement for advanced filtering and search – Performance optimization – […]<\/p>\n","protected":false},"author":17,"featured_media":4292,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"_uf_show_specific_survey":0,"_uf_disable_surveys":false,"footnotes":""},"categories":[332],"tags":[],"class_list":["post-4288","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-laravel"],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/www.rcvtechnologies.com\/blog\/wp-json\/wp\/v2\/posts\/4288","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.rcvtechnologies.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.rcvtechnologies.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.rcvtechnologies.com\/blog\/wp-json\/wp\/v2\/users\/17"}],"replies":[{"embeddable":true,"href":"https:\/\/www.rcvtechnologies.com\/blog\/wp-json\/wp\/v2\/comments?post=4288"}],"version-history":[{"count":4,"href":"https:\/\/www.rcvtechnologies.com\/blog\/wp-json\/wp\/v2\/posts\/4288\/revisions"}],"predecessor-version":[{"id":4293,"href":"https:\/\/www.rcvtechnologies.com\/blog\/wp-json\/wp\/v2\/posts\/4288\/revisions\/4293"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/www.rcvtechnologies.com\/blog\/wp-json\/wp\/v2\/media\/4292"}],"wp:attachment":[{"href":"https:\/\/www.rcvtechnologies.com\/blog\/wp-json\/wp\/v2\/media?parent=4288"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.rcvtechnologies.com\/blog\/wp-json\/wp\/v2\/categories?post=4288"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.rcvtechnologies.com\/blog\/wp-json\/wp\/v2\/tags?post=4288"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}