PHPackages                             seffeng/laravel-xunsearch - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Search & Filtering](/categories/search)
4. /
5. seffeng/laravel-xunsearch

ActiveLibrary[Search & Filtering](/categories/search)

seffeng/laravel-xunsearch
=========================

PHP laravel extension xunsearch

v0.1.5(2y ago)21.3kMITPHPPHP >=7.1.3

Since Sep 4Pushed 2y ago1 watchersCompare

[ Source](https://github.com/seffeng/laravel-xunsearch)[ Packagist](https://packagist.org/packages/seffeng/laravel-xunsearch)[ Docs](https://github.com/seffeng/laravel-xunsearch)[ RSS](/packages/seffeng-laravel-xunsearch/feed)WikiDiscussions master Synced 3w ago

READMEChangelog (6)Dependencies (1)Versions (7)Used By (0)

Laravel Xunsearch
-----------------

[](#laravel-xunsearch)

### 安装

[](#安装)

```
$ composer require seffeng/laravel-xunsearch
```

##### Laravel

[](#laravel)

```
# 1、生成配置文件
$ php artisan vendor:publish --tag="xunsearch"

# 2、修改配置文件 /config/xunsearch.php 或 /.env，建议通过修改 .env 实现配置，
```

##### Lumen

[](#lumen)

```
# 1、将以下代码段添加到 /bootstrap/app.php 文件中的 Providers 部分
$app->register(Seffeng\LaravelXunsearch\XunsearchServiceProvider::class);

# 2、复制扩展包内 config/xunsearch.php 到项目 config 目录，修改项目字段， 在 .env 文件中添加配置
```

### 目录说明

[](#目录说明)

```
├───config
│       xunsearch.php
├───src
│   │   Xunsearch.php
│   │   XunsearchServiceProvider.php
|   ├───Exceptions
|   |       XunsearchException.php
│   └───Facades
│           Xunsearch.php

```

### 示例

[](#示例)

```
/**
 * 参考 tests/XunsearchTest.php
 */
use PHPUnit\Framework\TestCase;
use Seffeng\LaravelXunsearch\Facades\Xunsearch;

class XunsearchTest extends TestCase
{
    /**
     *
     * @author zxf
     * @date    2020年4月17日
     * @throws \Exception
     */
    public function testSearch()
    {
        try {
            // 添加文档
            $data = ['id' => 1, 'name' => '李白']; // 或二维数组 [['id' => 1, 'name' => '李白'], ['id' => 2, 'name' => '杜甫']]
            Xunsearch::addIndex($data);
            // 或非默认项目库
            // 注意：使用 setDatabase($db) 后，再使用 Xunsearch::{$method} 也为新设置的$db
            Xunsearch::setDatabase('author')->addIndex($data);

            // 修改文档
            $data = ['id' => 1, 'name' => '李白，字太白'];
            Xunsearch::updateIndex($data);

            // 删除文档
            Xunsearch::delIndex([1, 2]);

            // 清空文档
            Xunsearch::cleanIndex();

            // 平滑重建索引
            Xunsearch::beginRebuild();
            Xunsearch::addIndex($data);
            Xunsearch::endRebuild();

            // 搜索
            // Xunsearch::setFuzzy(true|false);  // 是否模糊搜索
            // Xunsearch::setLimit(int 10);  // 每页数量
            // Xunsearch::setOffset(int 0); // 偏移量，与 setPage 不同时使用
            // Xunsearch::setPage(int 1);   // 当前页，改变偏移量，与 setOffset 不同时使用
            $result = Xunsearch::search('李白');
            /**
            Array
            (
                [time] => 0.003633975982666             // 搜索时长[s]
                [data] => Array                         // 结果
                    (
                        [0] => XSDocument Object
                            (
                                [_data:XSDocument:private] => Array
                                    (
                                        [id] => 1
                                        [name] => 李白，字太白
                                        [255] =>
                                    )

                                [_terms:XSDocument:private] =>
                                [_texts:XSDocument:private] =>
                                [_charset:XSDocument:private] => UTF-8
                                [_meta:XSDocument:private] => Array
                                    (
                                        [docid] => 1
                                        [rank] => 1
                                        [ccount] => 0
                                        [percent] => 100
                                        [weight] => 0.40546509623528
                                    )

                            )

                    )

                [page] => Array
                    (
                        [totalCount] => 1               // 结果数量
                        [pageCount] => 1                // 总页数
                        [currentPage] => 1              // 当前页
                        [perPage] => 10                 // 每页数量
                    )

            )
            */
        } catch (\Exception $e) {
            throw $e;
        }
    }
}

```

项目依赖
----

[](#项目依赖)

依赖仓库地址备注hightman/xunsearch无### 备注

[](#备注)

1、测试脚本 tests/XunsearchTest.php 仅作为示例供参考。

2、xunsearch [安装](https://hub.docker.com/r/seffeng/xunsearch)。

```
# docker 安装
$ docker pull seffeng/xunsearch

# 启动
$ docker run -d seffeng/xunsearch
```

3、xunsearch [官方介绍](http://xunsearch.com/doc/php/guide/start.installation)。

###  Health Score

24

—

LowBetter than 31% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity17

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity44

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~249 days

Recently: every ~312 days

Total

6

Last Release

874d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/30b3d8cc986a1ad37a55169b11812fea1cae31430dd8dbe1b3436dc58cc885bd?d=identicon)[seffeng](/maintainers/seffeng)

---

Top Contributors

[![seffeng](https://avatars.githubusercontent.com/u/3509779?v=4)](https://github.com/seffeng "seffeng (14 commits)")

---

Tags

phplaravelseffengxunsearch

### Embed Badge

![Health badge](/badges/seffeng-laravel-xunsearch/health.svg)

```
[![Health](https://phpackages.com/badges/seffeng-laravel-xunsearch/health.svg)](https://phpackages.com/packages/seffeng-laravel-xunsearch)
```

###  Alternatives

[babenkoivan/elastic-scout-driver

Elasticsearch driver for Laravel Scout

2774.0M6](/packages/babenkoivan-elastic-scout-driver)[omaressaouaf/query-builder-criteria

Define reusable query criteria for filtering, sorting, search, field selection, and includes in Laravel Eloquent models

285.3k](/packages/omaressaouaf-query-builder-criteria)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)