path mxusearch

antsfree/mxusearch

this is mxu fulltext search application.

基于讯搜服务封装的全文检索服务(for laravel)

服务说明

全文检索服务是基于开源项目xunsearch封装的全文搜索引擎，服务仍在完善。, _(*1)

服务安装配置

1. 通过composer 安装搜索服务, 输入如下命令安装最新版本., _(*2)

composer require antsfree/mxusearch dev-master
OR
composer require antsfree/mxusearch '^0.1'

2. 在 config/app.php 的服务数组 providers 中添加以下服务., _(*3)

Antsfree\Mxusearch\MxusearchProvider::class

3. 在 config/app.php 的门面数组 aliases 中添加以下门面., _(*4)

'Mxusearch' => Antsfree\Mxusearch\Mxusearch::class,

4. 执行如下命令, 配置mxusearch.php配置文件；, _(*5)

php artisan vendor:publish --provider="Antsfree\Mxusearch\MxusearchProvider"

5. 分布式安装，各自laravel项目需要配置以下env参数：, _(*6)

注意：以上配置全都有默认值，其中索引、搜索的host在分布式部署上需要注意区分。统一指向讯搜服务所在服务器。, _(*7)

6. 执行console命令，生成ini文件, _(*8)

php artisan search:reset-ini

基本服务方法设定

Artisan命令服务

提供 artisan 的命令实现 :, _(*9)

ini配置

1、 ini配置文件：mxu-backend/config/mxusearch.ini ;, _(*10)

2、 服务器配置, _(*11)

project.name = {{MXUSEARCH_PROJECT}}// 项目名称
project.default_charset = {{MXUSEARCH_CHARSET}}// 字符编码
server.index = {{MXUSEARCH_INDEX_HOST}}:{{MXUSEARCH_INDEX_PORT}}// 索引服务端配置(Host&端口)
server.search = {{MXUSEARCH_SEARCH_HOST}}:{{MXUSEARCH_SEARCH_PORT}}// 搜索服务端配置(Host&端口)

3、索引字段配置, _(*12)

[id]
type = id
tokenizer = full

[column_id]
tokenizer = full
index = self

......
......

方法说明

multiSearch（多条件查询）

方法示例, _(*13)

/**
 * 多条件查询功能
 *
 * @param        $keyword
 * @param string $field
 * @param array  $other_field_value
 * @param array  $range
 * @param int    $limit
 * @param int    $page
 * @param array  $sorts
 *
 * @return array
 */
public function multiSearch($keyword, $field = '', array $other_field_value = [], array $range = [], $limit = 0, $page = 1, array $sorts = []);

请求参数, _(*14)

请求示例, _(*15)

$key = '我是关键词';
$field = 'title';
// 多条件
$other_field_value = [
    'site_id'   => 1,
    'column_id' => 2,
    'type'      => 'article',
    // ...
];
$range = [
    [
        'field' => 'publish_time',
        'from'  => '2017-10-18 12:07:26',
        'to'    => '2017-10-23 17:07:26',
    ],
    // ...
];
// 分页控制
$limit = 10;
$page = 1;
// 排序条件(true 为正序, false 为倒序)
$sorts = [
    'field_1' => true, // 根据 field_1 正序排序
    'field_2' => false // 根据 field_2 倒序排序
];

// 调用服务
Mxusearch::multiSearch($key, $field, $other_field, $range, $limit, $page, $sorts);

索引管理注意事项：

1. 索引更新：多条同时更新存在时间误差，具体时长和需要创建的索引数量有关系，具体在2~4分钟能实现索引的更新；
2. 索引创建：多条同时新增存在时间误差，具体时长和需要创建的索引数量有关系，具体在2~4分钟能实现索引的创建；
3. 当前只支持单库存储；
4. ini配置默认存于laravel config目录中；

TODO List

1. 增加热词删除服务;
2. 重构或者优化高级搜索服务,支持搜索条件/类型可扩展;

讯搜服务官方SDK参考

讯搜 SDK 指南, _(*16)