模块实战：Model、ResourceModel、Collection

一、理解 Model、ResourceModel 和 Collection 在 Magento 2 中的作用

在 Magento 2 架构中，Model 是数据的主要载体，它代表了业务逻辑中的实体。ResourceModel 则负责与数据库进行交互，执行数据的读取、写入、更新和删除等操作。而 Collection 是用于管理一组相关 Model 实例的工具。

例如，在一个电商系统中，有商品（Product）这个实体。Product Model 包含了商品的属性信息，如名称、价格、描述等。Product ResourceModel 负责将这些商品数据存储到数据库中或者从数据库中读取出来。Product Collection 可以用来获取多个商品的集合，例如获取特定分类下的所有商品。

二、创建简单的 Model

以下是一个创建简单 Product Model 的示例：

收起

php

复制

<?php

namespace Vendor\Module\Model;

use Magento\Framework\Model\AbstractModel;

class Product extends AbstractModel
{
    protected function _construct()
    {
        $this->_init('Vendor\Module\Model\ResourceModel\Product');
    }
}

在这个示例中，我们的 Product Model 继承自 AbstractModel，并在构造函数中初始化了对应的 ResourceModel。

三、构建 ResourceModel

接下来构建 Product ResourceModel：

收起

php

复制

<?php

namespace Vendor\Module\Model\ResourceModel;

use Magento\Framework\Model\ResourceModel\Db\AbstractDb;

class Product extends AbstractDb
{
    protected function _construct()
    {
        $this->_init('vendor_product_table', 'product_id');
    }
}

这里我们指定了关联的数据库表（vendor_product_table）和主键（product_id）。

四、利用 Collection 管理 Model 集合

创建 Product Collection 示例：

收起

php

复制

<?php

namespace Vendor\Module\Model\ResourceModel\Product;

use Magento\Framework\Model\ResourceModel\Db\Collection\AbstractCollection;

class Collection extends AbstractCollection
{
    protected function _construct()
    {
        $this->_init('Vendor\Module\Model\Product', 'Vendor\Module\Model\ResourceModel\Product');
    }
}

五、执行数据读取操作

在控制器中使用 Collection 来获取数据：

收起

php

复制

<?php

namespace Vendor\Module\Controller\Index;

use Magento\Framework\App\Action\Action;
use Magento\Framework\App\Action\Context;
use Vendor\Module\Model\ResourceModel\Product\CollectionFactory;

class Index extends Action
{
    protected $productCollectionFactory;

    public function __construct(
        Context $context,
        CollectionFactory $productCollectionFactory
    ) {
        $this->productCollectionFactory = $productCollectionFactory;
        parent::__construct($context);
    }

    public function execute()
    {
        $collection = $this->productCollectionFactory->create();
        foreach ($collection as $product) {
            echo $product->getName(). '<br>';
        }
    }
}

六、数据写入与更新

通过 Model 和 ResourceModel 进行数据写入：

收起

php

复制

$product = $this->productFactory->create();
$product->setName('New Product');
$product->setPrice(100);
$this->productResourceModel->save($product);

// 更新数据
$product->setPrice(120);
$this->productResourceModel->save($product);

七、复杂查询与过滤

在 Collection 中进行复杂查询和过滤：

收起

php

复制

$collection = $this->productCollectionFactory->create();
$collection->addFieldToFilter('price', ['gt' => 50]);
$collection->addOrder('price', 'DESC');

在这个示例中，我们过滤出价格大于 50 的产品，并按照价格降序排列。

八、关联表查询

假设我们的商品表与类别表有外键关联，我们可以在 Collection 中进行关联查询：

收起

php

复制

$collection = $this->productCollectionFactory->create();
$collection->getSelect()
    ->joinLeft(
        ['category' => 'category_table'],
        'main_table.category_id = category.category_id',
        ['category_name']
    );

九、总结与观点

在 Magento 2 系统中，Model、ResourceModel 和 Collection 协同工作，为数据管理提供了强大而灵活的机制。Model 提供了数据的抽象表示，ResourceModel 负责与数据库交互，Collection 则方便地管理一组 Model 实例。

在开发过程中，合理利用这些组件可以高效地处理数据相关的业务逻辑。从简单的数据读取到复杂的关联查询和数据更新，都可以通过它们来实现。同时，遵循 Magento 2 的最佳实践可以确保代码的可维护性和性能。