Strapi V5单类型中如何选择一级组件指定字段？

问题概述 #

存在一个名为landing的Strapi单类型，其中包含自定义组件metadata。尝试仅获取该组件的title字段，以及关联icon媒体的url字段时，触发500内部服务器错误。

可正常获取完整数据的查询 #

使用以下请求可以拿到完整响应：

http://localhost:1337/api/landing?locale=fr&populate[0]=metadata&populate[1]=metadata.icon

完整响应示例：

{    
    "data": {        
        "id": 2,        
        "documentId": "w4z673xnhj4l65f5n52516js",        
        "createdAt": "2024-10-30T16:59:38.097Z",        
        "updatedAt": "2024-10-30T16:59:38.097Z",        
        "publishedAt": "2024-10-30T16:59:38.108Z",        
        "locale": "fr",        
        "metadata": {            
            "id": 2,            
            "title": "test",            
            "description": "test description",            
            "icon": {                
                "id": 63,                
                "documentId": "d4eozd44w0atb4snvx3z6u39",                
                "name": "iconWorld.png",                
                "alternativeText": null,                
                "caption": null,                
                "width": 64,                
                "height": 64,                
                "formats": null,                
                "hash": "icon_World_52392aee13",                
                "ext": ".png",                
                "mime": "image/png",                
                "size": 2.32,                
                "url": "/uploads/icon_World_52392aee13.png",                
                "previewUrl": null,                
                "provider": "local",                
                "provider_metadata": null,                
                "createdAt": "2024-10-13T09:30:23.800Z",                
                "updatedAt": "2024-10-30T16:59:34.798Z",                
                "publishedAt": "2024-10-13T09:30:23.800Z"            
            }        
        }    
    },    
    "meta": {}
}

触发错误的查询及日志 #

尝试筛选字段的请求：

http://localhost:1337/api/landing?locale=fr&populate[metadata][populate][icon][fields][0]=url&populate[metadata][fields][0]=title

错误响应：

{    
    "data": null,    
    "error": {        
        "status": 500,        
        "name": "InternalServerError",        
        "message": "Internal Server Error"    
    }
}

控制台错误日志：

[2024-10-30 18:36:04.952] error: select distinct `t1`.`order`, `t0`.`id`, `t0`.`documentId`, `t0`.`title`, `t1`.`entity_id` as `__strapientity_id` from `components_common_metadata` as `t0` left join `landings_cmps` as `t1` on `t0`.`id` = `t1`.`cmp_id` and `t1`.`field` = 'metadata' where (`t1`.`entity_id` in (2)) order by `t1`.`order` asc - no such column: t0.documentId
SqliteError: select distinct `t1`.`order`, `t0`.`id`, `t0`.`documentId`, `t0`.`title`, `t1`.`entity_id` as `__strapientity_id` from `components_common_metadata` as `t0` left join `landings_cmps` as `t1` on `t0`.`id` = `t1`.`cmp_id` and `t1`.`field` = 'metadata' where (`t1`.`entity_id` in (2)) order by `t1`.`order` asc - no such column: t0.documentId
    at Database.prepare (C:\repo\aircastnews\aircastnews-front\aircastnews-strappy\node_modules\better-sqlite3\lib\methods\wrappers.js:5:21)
    at Client_BetterSQLite3._query (C:\repo\aircastnews\aircastnews-front\aircastnews-strappy\node_modules\knex\lib\dialects\better-sqlite3\index.js:35:34)
    at executeQuery (C:\repo\aircastnews\aircastnews-front\aircastnews-strappy\node_modules\knex\lib\execution\internal\query-executioner.js:37:17)
    at Client_BetterSQLite3.query (C:\repo\aircastnews\aircastnews-front\aircastnews-strappy\node_modules\knex\lib\client.js:154:12)
    at C:\repo\aircastnews\aircastnews-front\aircastnews-strappy\node_modules\knex\lib\execution\transaction.js:371:24
    at new Promise (<anonymous>)
    at trxClient.query (C:\repo\aircastnews\aircastnews-front\aircastnews-strappy\node_modules\knex\lib\execution\transaction.js:366:12)
    at Runner.query (C:\repo\aircastnews\aircastnews-front\aircastnews-strappy\node_modules\knex\lib\execution\runner.js:141:36)
    at ensureConnectionCallback (C:\repo\aircastnews\aircastnews-front\aircastnews-strappy\node_modules\knex\lib\execution\internal\ensure-connection-callback.js:13:17)
    at Runner.ensureConnection (C:\repo\aircastnews\aircastnews-front\aircastnews-strappy\node_modules\knex\lib\execution\runner.js:318:20)
[2024-10-30 18:36:04.954] http: GET /api/landing?locale=fr&populate[metadata][populate][icon][fields][0]=url&populate[metadata][fields][0]=title (16 ms) 500

期望的响应格式 #

{    
    "data": {        
        "id": 2,        
        "documentId": "w4z673xnhj4l65f5n52516js",        
        "createdAt": "2024-10-30T16:59:38.097Z",        
        "updatedAt": "2024-10-30T16:59:38.097Z",        
        "publishedAt": "2024-10-30T16:59:38.108Z",        
        "locale": "fr",        
        "metadata": {            
            "id": 2,            
            "title": "test",            
            "icon": {                
                "id": 63,                
                "documentId": "d4eozd44w0atb4snvx3z6u39",                
                "url": "/uploads/icon_World_52392aee13.png"            
            }        
        }    
    },    
    "meta": {}
}

问题原因与解决方法 #

原因分析 #

从错误日志可见，Strapi生成的SQL语句试图查询组件表components_common_metadata中的documentId字段，但该字段仅存在于单类型的主表中，组件表本身没有这个字段，导致SQL执行失败。

解决方法 #

方法1：显式指定组件的有效字段

修改查询参数，明确列出组件和媒体需要返回的所有有效字段，避免Strapi自动注入不存在的字段：

http://localhost:1337/api/landing?locale=fr&populate[metadata][fields][0]=id&populate[metadata][fields][1]=title&populate[metadata][populate][icon][fields][0]=id&populate[metadata][populate][icon][fields][1]=documentId&populate[metadata][populate][icon][fields][2]=url

方法2：使用逗号分隔的字段列表语法

如果Strapi版本支持，可简化字段参数的写法：

http://localhost:1337/api/landing?locale=fr&populate[metadata][fields]=id,title&populate[metadata][populate][icon][fields]=id,documentId,url

方法3：升级Strapi版本

该问题可能是Strapi的已知bug，升级到最新稳定版本大概率能修复组件字段查询时错误注入documentId的问题。

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