CakePHP 5.x中如何同时使用路由选项与嵌套资源回调？

在CakePHP 5中配置嵌套REST路由时，同时使用路由选项（自定义ID正则）和子资源回调会导致嵌套资源无法正确解析父资源ID，进而返回"cart": null的异常结果。

问题代码示例 #

$builder->resources(
    'Carts', 
    [
        'id' => '[a-f0-9]{32}.*',
    ],
    function (RouteBuilder $builder) {
        $builder->resources('CartsItems', [
            'id' => '[a-f0-9]{32}.*',
        ]);
    }
);

测试情况 #

1. 单个Cart资源访问（正常） #

GET http://{{host}}/api/carts/52de3c0b144e4ac9d2dae5ded023574b.json
返回结果：

{
    "cart": {
        "id": 4,
        "rid": "52de3c0b144e4ac9d2dae5ded023574b",
        "oid": "a4e3a4445311c9269e3648b7fc814f0e",
        "str_store_id": 2,
        "main": false
    }
}

2. 嵌套CartsItems列表访问（异常） #

GET http://{{host}}/api/carts/52de3c0b144e4ac9d2dae5ded023574b/carts-items.json
返回结果：

{
    "cart": null
}

3. 单个嵌套CartsItem访问（异常） #

GET http://{{host}}/api/carts/52de3c0b144e4ac9d2dae5ded023574b/carts-items/e7df9f1531ce7d4f3518defffd66cf1a.json
返回结果：

{
    "cart": null
}

解决方案 #

1. 确保控制器正确接收父资源ID参数 #

CakePHP生成嵌套路由时，会将父资源ID以{parent}_id的参数名传递给子资源控制器。以本次场景为例，CartsItemsController的动作需接收$cart_id参数：

// src/Controller/CartsItemsController.php
class CartsItemsController extends AppController
{
    // 列表接口
    public function index($cart_id)
    {
        $cart = $this->CartsItems->Carts->get($cart_id, [
            'contain' => ['CartsItems']
        ]);
        $this->set(compact('cart'));
        $this->viewBuilder()->setOption('serialize', ['cart']);
    }

    // 单个资源接口
    public function view($cart_id, $id)
    {
        $cartItem = $this->CartsItems->get($id, [
            'contain' => ['Carts']
        ]);
        $cart = $cartItem->cart;
        $this->set(compact('cart', 'cartItem'));
        $this->viewBuilder()->setOption('serialize', ['cart', 'cartItem']);
    }
}

2. 调试路由参数传递（排查用） #

若控制器接收参数后仍异常，可添加调试代码确认父ID是否正确传递：

// 在CartsItemsController的动作中添加
debug($this->request->getParam('cart_id'));

3. 自定义路由参数名（可选） #

若默认参数名不符合需求，可手动指定父资源参数名并关联子路由：

$builder->resources(
    'Carts', 
    [
        'id' => '[a-f0-9]{32}.*',
        'param' => 'cart_rid' // 自定义父资源参数名
    ],
    function (RouteBuilder $builder) {
        $builder->resources('CartsItems', [
            'id' => '[a-f0-9]{32}.*',
            'parentParam' => 'cart_rid' // 子路由关联自定义父参数名
        ]);
    }
);

此时控制器方法需对应改为接收$cart_rid参数。

核心说明 #

嵌套路由的问题核心是父资源ID的参数传递，自定义ID正则不会干扰这一逻辑——只要父路由的ID规则匹配成功，参数就会被正确传递给子路由对应的控制器方法。

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