FreeMarker Mapper常见用法

目    录

Rhapsody中FreeMarker过滤器的常见语法... 1

1.        FreeMarker简介... 3

2.        引擎中的FreeMarker过滤器.. 3

3.        常见语法示例... 5

1）       获取消息属性值... 5

2）       获取全球唯一ID  UUID. 5

3）       获取XML消息消息中指定节点.. 5

4）       循环的用法... 6

5）       获取当前时间并格式化.. 8

6）       IF判断语法及LIST进阶用法.. 8

 

 

 

1. FreeMarker简介

FreeMarker是一款模板引擎： 即一种基于模板和要改变的数据，并用来生成输出文本（HTML网页、电子邮件、配置文件、源代码等）的通用工具。它不是面向最终用户的，而是一个Java类库，是一款程序员可以嵌入他们所开发产品的组件。FreeMarker是免费的，基于Apache许可证2.0版本发布。其模板编写为FreeMarker Template Language（FTL），属于简单、专用的语言。需要准备数据在真实编程语言中来显示，比如数据库查询和业务运算之后模板显示已经准备好的数据。在模板中，主要用于如何展现数据，而在模板之外注意于要展示什么数据。

1. 引擎中的FreeMarker过滤器

Rhapsody中的FreeMarker过滤器可以将输入的消息，通过引擎内置的FreeMarker模板组件将输入的消息转换为指定的消息格式。

我们常常配合Database Message Extraction过滤器，通过SQL查询语句把关键信息放置以XML格式在消息体中，然后使用FreeMarker Mapper将消息转换为特定的消息格式。使用FreeMarker Mapper可以极大的提升开发效率，直接将示例消息放置在FreeMarker中，然后将需要动态变化的值使用特定语法提取关键值，即可获得我们需要的消息格式；同时也可以减少使用JavaScript拼接消息的繁杂的工作量以及消息拼接错误的概率。

在Rhapsody6.5及以上版本，优化了FreeMarker Mapper异常提示机制，可以准确提示错误行数及错误原因。

FreeMarker Mapper的属性说明：

1. Maximum Concurrency：并发数，即过滤器最大允许并发的消息数量，缺省值为0，表示不限制并发数量，通常我们应该结合实际业务情况将其设置为2-4。并发数量越大，代表对引擎内存开销越大。
2. Input Message Type：输入消息类型，缺省值为：EDI，当设置为EDI类型时，允许我们配置模板时使用内置JavaScript对象inputEDI；XML，输入消息类型必须为XML类型，并且允许我们配置模板时使用内置JavaScript对象inputEDI或inputXML。
3. EDI Message Definition：EDI消息格式的消息定义（s3d），当输入消息类型设置为EDI时，该选项可填。
4. Missing Fields Mode：缺失节点处理模式，当输入消息类型设置为EDI时，该选项可填。缺省值为Return null values for missing fields，即返回错误并将消息放置到错误队列。Convert missing fields to empty strings即表示用空字符来处理空的节点。
5. Output Character Encoding：输出消息字符集，指定输出消息体的字符集。如果没有设置本参数但是模板中又定义了，那么就会按模板中的字符集输出消息，如果模板中也未定义，那么就按输入消息的字符集输出。
6. Automatically Trim Whitespace：是否自动处理文本前后多余的空白字符。缺省值为true。
7. Escape Characters Mode：转义字符模式，可以针对不同的消息格式设置字符的转义，如果文本中出现该消息格式的关键字符时，则自动替换为转义字符。分别有三个选项：None（缺省值，不进行转义）、XML、HL7。下表列举了XML消息中转义的字符。

原文	转义后
&	&
"	"
'	'
<	&lt;
>	&gt;
\T\	&amp;
\X0D\	&#xD;
\X0A\	&#xA;

表1 XML消息格式转义字符列表

1. Segment Delimiter Auto-Correct：段分隔符自动更正，当消息格式为HL7时可以使用，缺省值为true。
2. FreeMarker Mapping Template：消息模板定义，即定义我们的消息模板，点击该选项后会弹出FreeMarker模板编辑器。如下图所示

 

图1 FreeMarker模板编辑器界面

1. 常见语法示例

1. 获取消息属性值

${input.getProperty("消息属性名称")}

 

1. 获取全球唯一ID  UUID

${UUID.generate()}

 

1. 获取XML消息消息中指定节点

${inputXML.节点名.节点名.节点名}

 

如获取下面的XML中的开嘱时间  ${inputXML.message.就诊.开嘱时间}

<message>     <就诊>        <开嘱时间>20191010120212</开嘱时间>        <开嘱医生>李四</开嘱医生>        <医嘱ID>5621478</医嘱ID>        <项目名称>血常规</项目名称>        <项目编码>00023</项目编码>     </就诊> </message>

1. 循环的用法

XML或JSON中可能出现需要循环的节点，LIST中的内容，会根据LIST定义的节点出现次数而循环

<#list inputXML.节点名.节点名as 别名> ${别名.节点名} </#list>

如下面的输入消息

<message>     <就诊>        <开嘱时间>20191010120212</开嘱时间>        <开嘱医生>李四</开嘱医生>        <医嘱ID>5621478</医嘱ID>        <项目名称>血常规</项目名称>        <项目编码>00023</项目编码>     </就诊>     <就诊>        <开嘱时间>20191010120312</开嘱时间>         <开嘱医生>张三</开嘱医生>        <医嘱ID>5621476</医嘱ID>        <项目名称>生化</项目名称>        <项目编码>00021</项目编码>     </就诊> </message>

 

需要得到如下的结果

<Request>     <MessageID>26b60f3d-0bcf-4792-ba89-99f1436d2af1</MessageID>     <OrderLIST>        <ITEM>            <OrderId>5621478</OrderId>            <OrderName>血常规</OrderName>        </ITEM>        <ITEM>            <OrderId>5621476</OrderId>            <OrderName>生化</OrderName>        </ITEM>     </OrderLIST> </Request>

 

则可以这样设置模板

<Request>     <MessageID>${UUID.generate()}</MessageID>     <OrderLIST>     <#list inputXML.message.就诊 as 就诊列表>        <ITEM>            <OrderId>${就诊列表.医嘱ID}</OrderId>            <OrderName>${就诊列表.项目名称}</OrderName>        </ITEM>     </#list>     </OrderLIST> </Request>

 

1. 获取当前时间并格式化

${.now?string('yyyyMMddhhmmss')}

 

1. IF判断语法及LIST进阶用法

在拼接json消息时，list的每个要素之间都需要逗号分隔，而最后一个不需要逗号，list的别名后面_has_next 用于判断list是否还有下一条记录，如果有则判断成立，显示逗号，如果没有则判断不成立，不显示逗号。

 IF条件判断，下面的示例判断list的索引是否为偶数

     <#if 别名_index % 2 == 0>

       xxxxA

<#else>

      xxxxB

</#if>

 List的其他用法：

  别名_index：获取列表的索引值，从0开始

  别名_has_next：列表是否还有下一条记录，返回true/false

  别名?size:列表中的元素个数

 LIST的排序

 <#list inputXML.节点名?sort_by("需要排序的节点名") as 别名> 

     ... 

</#list>  

 

<#if list别名_has_next> , </#if>

如果需要将4）中的示例消息转换为如下的JSON格式

 

{   "Request": {     "MessageID": "26b60f3d-0bcf-4792-ba89-99f1436d2af1",     "OrderLIST": {       "ITEM": [         {           "OrderId": "5621478",           "OrderName": "血常规"         },         {           "OrderId": "5621476",           "OrderName": "生化"         }       ]     }   } }

则需要这样设置模板

{   "Request": {     "MessageID": "${UUID.generate()}",     "OrderLIST": {       "ITEM": [ <#list inputXML.message.就诊 as 就诊列表>         {           "OrderId": "5621478",           "OrderName": "血常规"         } <#if list就诊列表_has_next> , </#if> </#list>       ]     }   } }