Liferay自定义远程服务未在/api/jsonws中显示问题求助

针对你遇到的情况，按以下步骤逐一排查：

1. 确认Service Builder构建流程完整 #

• 必须执行gradlew buildService生成远程服务相关代码：这一步会自动在*ServiceImpl类中添加@JSONWebService注解，同时生成*ServiceSoap等远程服务支撑类
• 检查构建产物：查看模块build/libs下的JAR包，确认里面包含META-INF/jsonws/目录，该目录下应有对应服务的元数据JSON文件
• 核对service.xml：确保每个<entity>节点的remote-service="true"配置无拼写错误，且构建时未被忽略

2. 检查Spring组件注册配置 #

• 服务实现类（*ServiceImpl）必须添加Spring注解：比如@Component或@Service，确保被Spring上下文扫描并注册
• 查看启动日志：搜索你的服务类名，确认是否有类似Registered bean with name 'xxxServiceImpl'的日志，证明Spring已加载该服务
• 若用Spring Boot风格配置：检查@ComponentScan是否覆盖了服务所在的包路径，避免漏扫

3. 修正模块的Bnd配置 #

• 编辑bnd.bnd文件，添加Liferay-JSON-WS: true头信息：显式告知Liferay该模块提供JSON-WS服务
• 确认Export-Package配置：必须包含服务接口所在的包（如com.yourcompany.service），否则JSON-WS框架无法访问服务定义

4. 验证Docker环境的部署细节 #

• 检查容器内模块状态：进入Docker容器，确认你的模块JAR已在osgi/modules目录下，且模块在Liferay控制面板的「模块管理器」中显示为「已激活」
• 查看容器日志：检查/opt/liferay/logs/liferay.log，搜索JSONWebService关键词，确认是否有服务注册失败的异常信息
• 权限验证：访问/api/jsonws时使用管理员账号，普通用户可能看不到全部服务上下文

5. 处理版本兼容性问题 #

• 你的Workspace用的是DXP-7.4-GA1，但运行环境是2023.Q4.2（对应GA1之后的更新版本），可能存在API差异：
  • 将Liferay Workspace升级到与运行环境匹配的版本（如7.4.13.u42），重新构建模块后再部署
  • 检查Service Builder生成的代码中是否有已废弃的API，替换为运行环境支持的版本

快速测试技巧 #

• 直接访问具体服务端点：比如/api/jsonws/your-service-context/your-entity/get-all-your-entity，若能正常返回数据，说明服务已注册，只是列表展示有问题
• 重启容器后观察日志：如果看到Registering JSON web services for com.yourcompany.service.impl.XxxServiceImpl，说明服务已被JSON-WS框架识别

内容的提问来源于stack exchange，提问作者Eboua Osée