openinterop/oop-renderer

oop-renderer

镜像概述

oop-renderer是Open Interop生态系统中的渲染服务，负责消费已完成认证且填充了tempr的消息，将tempr模板渲染为可被端点直接使用的内容。默认使用Mustache渲染引擎，同时支持JavaScript自定义渲染逻辑。

核心功能

1. 模板渲染：处理tempr的template字段，支持Mustache和JavaScript两种引擎；
2. JavaScript扩展：通过JS脚本实现动态逻辑（如生成随机数、获取请求体数据），支持console.log调试和DiscardTransmission()丢弃传输；
3. 上下文访问：模板可访问消息、设备、tempr等上下文数据（如请求路径、设备ID、模板配置）；
4. 错误处理：将JSON解码错误等信息发布到指定队列，确保系统稳定性。

使用场景

1. Open Interop生态中，将标准化tempr模板转换为HTTP等端点的可执行请求；
2. 通过JavaScript自定义消息处理逻辑（如动态生成请求体、过滤无效传输）；
3. 调试tempr模板时利用console.log输出关键信息。

配置说明

需通过环境变量配置以下参数：

• OOP_AMQP_ADDRESS：AMQP消息服务地址；
• OOP_EXCHANGE_NAME：Open Interop消息交换器名称；
• OOP_ERROR_EXCHANGE_NAME：错误消息交换器名称；
• OOP_JSON_ERROR_Q：JSON解码错误消息队列；
• OOP_RENDERER_INPUT_Q：服务消费的输入队列；
• OOP_ENDPOINTS_EXCHANGE_NAME：端点消息交换器名称；
• OOP_ENDPOINT_Q：端点队列基础名称（与端点类型拼接生成最终队列名）；
• OOP_CORE_RESPONSE_Q：核心响应消息队列。

Docker部署示例

bash
docker run -d \
  --name oop-renderer \
  -e OOP_AMQP_ADDRESS=amqp://rabbitmq:5672 \
  -e OOP_EXCHANGE_NAME=oop_main_exchange \
  -e OOP_ERROR_EXCHANGE_NAME=oop_error_exchange \
  -e OOP_JSON_ERROR_Q=oop_json_errors \
  -e OOP_RENDERER_INPUT_Q=oop_renderer_input \
  -e OOP_ENDPOINTS_EXCHANGE_NAME=oop_endpoints_exchange \
  -e OOP_ENDPOINT_Q=oop.endpoints \
  -e OOP_CORE_RESPONSE_Q=oop_core_response \
  openinterop/oop-renderer

测试

运行yarn test执行测试并生成覆盖率报告。

贡献

欢迎社区贡献，需遵守https://github.com/open-interop/oop-guidelines/blob/master/CONTRIBUTING.md%E5%92%8Chttps://github.com/open-interop/oop-guidelines/blob/master/CODE_OF_CONDUCT.md%E3%80%82

许可证

版权所有 (C) 2020 The Software for Health Foundation Limited <[***]>
本程序为自由软件，遵循GNU Affero通用公共许可证（版本3或更高版本）发布，详见https://www.gnu.org/licenses/%E3%80%82