Sulu：将自定义实体纳入后台全局搜索

嘿，作为Sulu新手碰到这个问题太正常了——我当初刚用Sulu的时候也踩过这个坑！你设置的searchability="yes"确实只是用来控制实体列表页的本地筛选，和后台的全局搜索是两套完全独立的机制。要让自定义实体出现在全局搜索里，得配置搜索索引和提供者，我给你一步步拆解：

首先要告诉Sulu你的实体哪些字段需要被纳入全局搜索索引。你可以在config/sulu/search/目录下创建一个XML配置文件（比如CustomEntity.xml）：

<?xml version="1.0" ?>
<search-metadata xmlns="http://schemas.sulu.io/search/metadata">
    <class name="App\Entity\CustomEntity">
        <!-- 定义要索引的字段，boost可以设置字段权重，数值越高搜索优先级越高 -->
        <property name="id" type="string" />
        <property name="title" type="string" boost="2.0" />
        <property name="description" type="text" />
        <!-- 点击搜索结果时跳转的后台路由 -->
        <route-name>app_customentity_detail</route-name>
        <!-- 可选：设置权限上下文，控制哪些用户能看到搜索结果 -->
        <security-context>sulu.app.customentities</security-context>
    </class>
</search-metadata>

这个类的作用是把你的Doctrine实体转换成Sulu搜索系统能识别的文档。在App\Search目录下创建CustomEntitySearchProvider.php：

<?php

namespace App\Search;

use App\Entity\CustomEntity;
use Doctrine\ORM\EntityManagerInterface;
use Sulu\Component\Search\Document\DocumentInterface;
use Sulu\Component\Search\Document\IndexDocument;
use Sulu\Component\Search\Metadata\MetadataInterface;
use Sulu\Component\Search\Provider\SearchProviderInterface;

class CustomEntitySearchProvider implements SearchProviderInterface
{
    private $entityManager;
    private $metadata;

    public function __construct(EntityManagerInterface $entityManager, MetadataInterface $metadata)
    {
        $this->entityManager = $entityManager;
        $this->metadata = $metadata;
    }

    // 告诉Sulu这个提供者支持你的自定义实体
    public function supportClass(string $className): bool
    {
        return $className === CustomEntity::class;
    }

    // 将实体转换为可搜索的文档
    public function createDocument($entity): DocumentInterface
    {
        $document = new IndexDocument($entity->getId(), $this->metadata->getIndexName());
        
        // 把实体字段映射到搜索文档
        $document->addField('title', $entity->getTitle());
        $document->addField('description', $entity->getDescription());
        // 这里添加你需要被搜索的其他字段
        
        // 设置路由参数，用于生成搜索结果的跳转链接
        $document->setRouteParameters(['id' => $entity->getId()]);
        
        return $document;
    }

    // 获取所有实体ID，用于全量重建索引
    public function fetchAllIds(): iterable
    {
        return $this->entityManager->createQuery('SELECT e.id FROM App\Entity\CustomEntity e')
            ->getScalarResult();
    }

    // 根据ID获取单个实体，用于增量索引更新
    public function fetchById($id)
    {
        return $this->entityManager->find(CustomEntity::class, $id);
    }
}

在config/services.yaml里把刚才的类注册成Sulu的搜索服务：

services:
    App\Search\CustomEntitySearchProvider:
        arguments:
            - '@doctrine.orm.entity_manager'
            - '@sulu_search.metadata_provider.metadata.class.App\Entity\CustomEntity'
        tags:
            - { name: sulu.search.provider }

最后一步是把现有实体数据同步到搜索索引里，运行命令行：

bin/console sulu:search:reindex

• 之后你新增/修改自定义实体时，Sulu会自动触发增量索引更新，不需要每次都手动重建
• 确保后台用户有对应实体的访问权限，不然搜索结果会被权限系统过滤掉

内容的提问来源于stack exchange，提问作者BlueM