为什么要用?

由于mysql自带的like并不是很优秀，而且有可能要根据一定的”分词” 去匹配，所以才需要使用 elastic search。

安装扩展

  1. composer require --prefer-dist yiisoft/yii2-elasticsearch -vvv

配置

  1. <?php
  2. // ......
  3. 'components' => [
  4.     'elasticsearch' => [
  5.       'class' => 'yii\elasticsearch\Connection',
  6.       'nodes' => [
  7.         [
  8.           'http_address' => '127.0.0.1:9200'
  9.         ]
  10.         // configure more hosts if you have a cluster
  11.       ],
  12.       // set autodetectCluster to false if you don't want to auto detect nodes
  13.       // 'autodetectCluster' => false,
  14.       'dslVersion' => 7 // default is 5
  15.     ],
  16. ]

模拟场景

现在有一个文章表，需要做一个搜索功能，搜索的内容可能包含在博客标题和博客内容中。

博客sql

  1. CREATE TABLE `post` (
  2.   `id` int(11) NOT NULL AUTO_INCREMENT,
  3.   `title` varchar(100) NOT NULL COMMENT '文章标题',
  4.   `content` text COMMENT '文章内容',
  5.   `view_num` int(11) NOT NULL COMMENT '预览数',
  6.   `thumb` varchar(255) NOT NULL COMMENT '缩略图',
  7.   `add_time` int(11) NOT NULL COMMENT '添加时间',
  8.   PRIMARY KEY (`id`)
  9. ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4

文章model

此 model 管理 数据库中的数据

在文章增删改查的时候对应操作elastic search的增删改查，可以使得mysql数据实时同步给elastic search，未全字段都交给 elastic search 管理，所以 es model 仅定义部分内容。

  1. <?php
  2. namespace app\models;
  4. use yii\behaviors\TimestampBehavior;
  6. /**
  7.  * This is the model class for table "{{%post}}".
  8.  *
  9.  * @property int $id
  10.  * @property string $title 文章标题
  11.  * @property string $content 文章内容
  12.  * @property int $view_num 预览数
  13.  * @property string $thumb 缩略图
  14.  * @property int $add_time 添加时间
  15.  */
  16. class Post extends \yii\db\ActiveRecord
  17. {
  19.     public function behaviors ()
  20.     {
  21.         return [
  22.             [
  23.                 'class' => TimestampBehavior::class,
  24.                 'createdAtAttribute' => 'add_time',
  25.                 'updatedAtAttribute' => false
  26.             ]
  28.         ];
  29.     }
  31.     // 添加或者修改索引
  32.     public function afterSave ($insert, $changedAttributes)
  33.     {
  34.         // 需要加入索引的内容
  35.         // 新增数据
  36.         if($insert)
  37.         {
  38.             // 将新增数据写入到 elastic search
  39.             $esPost = new EsPost();
  40.             $esPost->_id = $this->id;
  41.             $esPost->title = $this->title;
  42.             $esPost->content = $this->content;
  43.             $esPost->insert();
  44.         }
  45.         else
  46.         {
  47.             // 更新数据
  48.             $changeFields = array_keys($changedAttributes);
  49.             $fields = [
  50.                 'title',
  51.                 'content',
  52.                 'add_time'
  53.             ];
  54.             // 是否修改了es需要的字段内容
  55.             $interFields = array_intersect($changeFields, $fields);
  56.             if(! empty($interFields))
  57.             {
  58.                 $esPost = EsPost::findOne($this->id);
  59.                 if(! empty($esPost))
  60.                 {
  61.                     $attrs = [];
  62.                     foreach($interFields as $field)
  63.                     {
  64.                         // 此方法修改最佳，比之 ->setAttributes 或者 ->attributes
  65.                         $esPost->{$field} = $this->{$field};
  66.                     }
  67.                     $esPost->update(false);
  68.                 }
  69.             }
  70.         }
  71.     }
  73.     // 删除数据
  74.     public function afterDelete ()
  75.     {
  76.         $esPost = EsPost::findOne($this->id);
  77.         if(! empty($esPost))
  78.         {
  79.             $esPost->delete();
  80.         }
  81.     }
  83.     /**
  84.      * @inheritdoc
  85.      */
  86.     public static function tableName ()
  87.     {
  88.         return '{{%post}}';
  89.     }
  91.     /**
  92.      * @inheritdoc
  93.      */
  94.     public function rules ()
  95.     {
  96.         return [
  97.             [
  98.                 [
  99.                     'title',
  100.           'content',
  101.                     'thumb'
  102.                 ],
  103.                 'required'
  104.             ],
  105.             [
  106.                 [
  107.                     'content'
  108.                 ],
  109.                 'string'
  110.             ],
  111.             [
  112.                 [
  113.                     'title'
  114.                 ],
  115.                 'string',
  116.                 'max' => 100
  117.             ],
  118.             [
  119.                 [
  120.                     'thumb'
  121.                 ],
  122.                 'string',
  123.                 'max' => 255
  124.             ]
  125.         ];
  126.     }
  128.     /**
  129.      * @inheritdoc
  130.      */
  131.     public function attributeLabels ()
  132.     {
  133.         return [
  134.             'title' => '文章标题',
  135.             'content' => '文章内容',
  136.             'thumb' => '缩略图'
  137.         ];
  138.     }
  139. }

es的对应model

此model管理elastic search的内容

  1. <?php
  2. namespace app\models;
  4. use yii\elasticsearch\ActiveRecord;
  6. /**
  7.  * elastic search 文章
  8.  *
  9.  * @author vogin
  10.  * @property string title
  11.  * @property string content
  12.  * @property integer add_time
  13.  */
  14. class EsPost extends ActiveRecord
  15. {
  17.     public static function index ()
  18.     {
  19.         // 名字不能以 _或者 - 或者 + 开始
  20.         return 'e_post';
  21.     }
  23.     public function attributes ()
  24.     {
  25.         return [
  26.             'title',
  27.             'content',
  28.             'add_time'
  29.         ];
  30.     }
  32.     public static function mapping ()
  33.     {
  34.         return [
  35.             // Field types: https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping.html#field-datatypes
  36.             'properties' => [
  37.                 'title' => [
  38.                     'type' => 'text'
  39.                 ],
  40.                 // text类型在存储数据的时候会默认进行分词，并生成索引。而keyword存储数据的时候，不会分词建立索引，显然，这样划分数据更加节省内存。
  41.                 'content' => [
  42.                     'type' => 'text'
  43.                 ],
  44.                 'add_time' => [
  45.                     'type' => 'integer'
  46.                 ]
  47.             ]
  48.         ];
  49.     }
  51.     /**
  52.      * Set (update) mappings for this model
  53.      */
  54.     public static function updateMapping ()
  55.     {
  56.         $db = static::getDb();
  57.         $command = $db->createCommand();
  58.         $command->setMapping(static::index(), static::type(), static::mapping());
  59.     }
  61.     /**
  62.      * Create this model's index
  63.      */
  64.     public static function createIndex ()
  65.     {
  66.         $db = static::getDb();
  67.         $command = $db->createCommand();
  68.         $command->createIndex(static::index(), [
  69.             // 'aliases' => [ /* ... */ ],
  70.             'mappings' => static::mapping()
  71.             // 'settings' => [ /* ... */ ],
  72.         ]);
  73.     }
  75.     /**
  76.      * Delete this model's index
  77.      */
  78.     public static function deleteIndex ()
  79.     {
  80.         $db = static::getDb();
  81.         $command = $db->createCommand();
  82.         $command->deleteIndex(static::index(), static::type());
  83.     }
  85.     public static function title ($title)
  86.     {
  87.         return [
  88.             'match' => [
  89.                 'title' => $title
  90.             ]
  91.         ];
  92.     }
  94.     public static function content ($content)
  95.     {
  96.         return [
  97.             'match' => [
  98.                 'content' => $content
  99.             ]
  100.         ];
  101.     }
  102. }

基本使用

  1. <?php
  2. class PostController extends Controller{
  3.     public function actionAdd(){
  4.         // 增加数据，会触发 Post 中 afterSave钩子函数，进行数据增加
  5.         $post = new Post();
  6.         $post->title = '今天天气挺好的';
  7.         $post->content = '今天看到日出东方，天朗气清，捕捉一屋晨风，看来是个赶海的日子';
  8.         $post->thumb = 'http://www.aaa.com/a.jpg';
  9.         $post->insert();
  11.         // 修改数据，会触发 Post 中 afterSave钩子函数，进行数据修改
  12.     $post = Post::findOne(5);
  13.         $post->title = '修改了标题5';
  14.         $post->update(false);
  16.     // 删除数据，会触发 Post 中 afterDelete 钩子函数，进行数据删除
  17.     $post = Post::findOne(5);
  18.         $post->delete();
  20.     // 查找es数据
  21.     EsPost::findOne(6);
  22.     // 分页
  23.     $query = EsPost::find();
  24.         $provider = new \yii\elasticsearch\ActiveDataProvider([
  25.             'query' => $query,
  26.             'pagination' => [
  27.                 'pageSize' => 10
  28.             ]
  29.         ]);
  31.         $models = $provider->getModels();
  32.         var_dump($models);
  34.     // 类mysql like %%
  35.     $posts = EsPost::find()->query([
  36.             // match相当于like查询
  37.             'match' => [
  38.                 'title' => '今天天气挺好'
  39.             ]
  40.         ])->all();
  42.     // 类似mysql = 
  43.     // 【注】：精准查找中，term => 内容是中文可能不好使 
  44.     $posts = EsPost::find()->query([
  45.             'term' => 'zhangsan'
  46.         ])->all();
  47.     }
  48. }