Sulu后台列表视图默认排序设置方法

实现步骤： #

1. 打开自定义实体的REST控制器，找到处理列表请求的方法（通常是cgetAction）
2. 根据查询方式选择对应的默认排序实现：

方式一：使用Sulu DoctrineListBuilder（推荐）

如果控制器依赖DoctrineListBuilderFactory和RestHelper，按以下代码修改：

use Sulu\Component\Rest\ListBuilder\ListBuilderInterface;

// ...

public function cgetAction(Request $request): Response
{
    $listBuilder = $this->doctrineListBuilderFactory->create(YourEntity::class);
    
    // 仅当前端未传排序参数时，设置默认排序规则
    if (!$request->get('sortBy')) {
        $listBuilder->addOrderBy('name', ListBuilderInterface::ORDER_ASC);
    }
    
    // 应用前端传入的排序、过滤、分页参数
    $this->restHelper->initializeListBuilder($listBuilder, $request);
    
    $paginator = $listBuilder->execute();
    
    // 构建返回的集合数据（保持原代码逻辑）
    $representation = new CollectionRepresentation(
        $paginator,
        'your_entities',
        RouteCollectionBuilder::REST_LIST_KEY,
        $request->query->all(),
        $paginator->getCurrentPage(),
        $paginator->getLimit(),
        $paginator->getTotal()
    );
    
    return $this->handleView($this->view($representation));
}

方式二：直接使用Doctrine查询构建器

如果手动创建查询构建器，修改如下：

use Doctrine\ORM\QueryBuilder;

// ...

public function cgetAction(Request $request): Response
{
    $queryBuilder = $this->entityManager->getRepository(YourEntity::class)->createQueryBuilder('e');
    
    // 获取前端排序参数，无参数时使用默认值
    $sortBy = $request->get('sortBy', 'name');
    $sortOrder = $request->get('sortOrder', 'asc');
    
    // 添加排序规则
    $queryBuilder->orderBy('e.' . $sortBy, $sortOrder);
    
    // 处理分页逻辑（示例）
    $paginator = $this->paginatorFactory->create($queryBuilder);
    $this->paginatorFactory->setCurrentPage($paginator, $request->get('page', 1));
    $this->paginatorFactory->setLimit($paginator, $request->get('limit', 10));
    
    // 构建返回结果（保持原代码逻辑）
    $representation = new CollectionRepresentation(
        $paginator,
        'your_entities',
        RouteCollectionBuilder::REST_LIST_KEY,
        $request->query->all(),
        $paginator->getCurrentPage(),
        $paginator->getLimit(),
        $paginator->getTotal()
    );
    
    return $this->handleView($this->view($representation));
}

说明： #

• 两种实现都会优先使用前端传入的sortBy和sortOrder参数，仅在用户未手动排序时，默认按name字段升序排列
• 需替换代码中的YourEntity为实际实体类名，your_entities为对应资源名称

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