12.Magento 2 索引和重建索引

Magento 2 开发目录

本文讨论如何创建一个索引器(Indexer)重建索引(Reindex)。Magento 2 索引中最主要的是索引器。为了代码演示我们继续使用 HelloWorld 模块。

Magento 系统使用索引来变换数据如产品、分类等进而提高店铺的性能。当数据变化时,变换的数据也必须同步更新或重建索引。Magento 使用非常精致的架构在很多数据表中存储大量的店铺数据(包括产品、价格、用户、店铺等数据)。为了优化店铺性能,Magento 使用索引器把累积的数据存储到特定数据表。

比如,你将一个产品的价格从¥8.99改到¥6.99,这时要让前台页面正常显示 Magento 就必须重建价格索引。

如果不使用索引,Magneto就必须实时计算每一个产品的价格——要计算的有客户购物车产品规则、批量价、折扣价、阶梯价等。这样产品的价格计算会花费很长时间,长时间的等待造成的结果可能就是消费者放弃购物。

创建自定义索引器步骤:

  • 1 添加索引器配置文件
  • 2 添加 Mview 配置文件
  • 3 定义索引器类
  • 4 运行测试

添加索引器配置文件

文件: app/code/Aqrun/HelloWorld/etc/indexer.xml

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Indexer/etc/indexer.xsd">
    <indexer id="aqrun_helloworld_indexer" 
        view_id="aqrun_helloworld_indexer"
        class="Aqrun\HelloWorld\Model\Indexer\Test"
        >
        <title translate="true">Aqrun HelloWorld Indexer</title>
        <description translate="true">你好世界自定义索引器</description>
    </indexer>
</config>

上面代码中我们使用 indexer 节点定义了一个新的索引器:

  • id 属性是索引器的唯一标识。可以在命令行使用这个ID来检查状态、模式或重建对应的索引
  • view_id 是视图元素的ID,视图元素会在 mview 配置文件中进行定义
  • class 属性指定我们要处理索引方法的类名

简单的索引还有两个子节点:

  • title 节点是显示在索引器列表中的文字
  • description 节点索引器列表中的说明文字

添加 Mview 配置文件

mview.xml 文件是用于跟踪指定的实体在数据库中的变化,并运行指定的方法处理这些变化

文件: app/code/Aqrun/HelloWorld/etc/mview.xml

<?xml version="1.0" encoding="UTF-8"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:noNamespaceSchemaLocation="urn:magento:framework:Mview/etc/mview.xsd">
    <view id="aqrun_helloworld_indexer"
          class="Aqrun\HelloWorld\Model\Indexer\Test"
          group="indexer" >
        <subscriptions>
            <table name="catalog_product_entity" entity_column="entity_id"/>
        </subscription>
    </view>
</config>

代码中定义了有ID属性的 view 节点,ID属性关联索引器,class 属性指定了实现有 execute() 方法的类。这个方法会在订阅的数据表有更新时执行。

定义数据表需要用到表名和表的字段,这些参数也会传给 execute() 方法。本例我们指定的表是 catalog_product_entity。因此无论何时不管是一个还是多个产品被保存,都会执行 Aqrun\HelloWorld\Model\Indexer\Test 类的 execute() 方法。

定义索引器类

根据上面的 indexer.xml 和 mview.xml 配置文件,定义索引器为: Aqrun\HelloWorld\Model\Indexer\Test

文件: app/code/Aqrun/HelloWrold/Model/Indexer/Test.php

<?php
namespace Aqrun\HelloWorld\Model\Indexer;

class Test implements \Magento\Framework\Indexer\ActionInterface,
    \Magento\Framework\Mview\ActionInterface
{
    /**
     * 被 mview 调用,允许在 "Update on schedule" 模式下处理索引
     * @param int[] $ids
     */
    public function execute($ids){
        //code
    }

    /**
     * 会处理所有的数据并重建索引
     * 在使用命令行重建索引时会执行
     */
    public function executeFull(){
        //code
    }

    /**
     * 作用于一组实体的变化(如批量操作)
     * @param array $ids
     */
    public function executeList(array $ids){
        //code
    }

    /**
     * 作用于单个实体
     * @param int $id
     */
    public function executeRow($id){
        // code
    }
}

你可以在索引器类方法中添加代码向索引器表更新数据

接下来,清空缓存并到后台菜单 system > Index Management 查看代码结果

12-custom-indexer.png

重建索引使用命令:

php bin/magento indexer:redinex
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,457评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,837评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,696评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,183评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,057评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,105评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,520评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,211评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,482评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,574评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,353评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,213评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,576评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,897评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,174评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,489评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,683评论 2 335

推荐阅读更多精彩内容