EDI转换成XML格式设计文档

Smooks是一个用于处理XML与非XML(CSV,EDI,Java等)的Java框架与引擎。它常常被认为是一个转换框架并以此被用于好几个产品和项目中,包括JBoss
ESB。Smooks能够用于各种数据格式的转换:XML to XML,CSV to XML,EDI to
XML,XML to EDI,XML to CSV,Java to XML,Java to EDI,Java to CSV,Java
to Java,XML to Java,EDI to Java等。不久前,Smooks
1.2版本发布了,这次添加了许多有趣的新功能

EDI转换成XML格式设计文档

EDIFACT Java 编译器:EJC大大的简化了绑定EDI数据到Java object
graph,EJC类似于JAXBs
XJC。支持实体持久性框架:重利用你的实体持久性资源坚持和丰富任何格式的messages。访问一个数据库,使用它的查询语言,或CRUD方法
,来读出/写入数据库。验证:支持Data Field
level验证,使用正则表达式,或Business Rule
compliance验证,使用MVEL表达式。简易的CSV处理:使用简易的XML配置,在几分钟之内即可绑定CVS记录到java
对象,或者使用一个更简单的programmatic API。改进Programmatic API:Smooks
1.2之前的版本,programmatic配置不是Smooks的强项,但是在1.2版本中已经取得了重大的改进。许多Smooks的功能都可以通过java被利用,不需要编写XML。

EDI格式说明

EDI,全称 Electronic Data Interchange,译名:电子数据交换。
它是由国际标准化组织(ISO)推出使用的国际标准,它是指一种为商业或行政事务处理,按照一个公认的标准,形成结构化的事务处理或消息报文格式,从计算机到计算机的电子传输方法,也是计算机可识别的商业语言。例如,国际贸易中的采购订单、装箱单、提货>单等数据的交换。

使用Smooks的方式有两种,你可以使用其中之一或结合使用它们:
模式一:你可以完全投入到Smooks中,编写你自己的定制访问者逻辑事件处理器,将其用于处理一个数据源事件流中特定事件。使用这一模式,你必须熟悉核心的API。
模式二:你可以重用由Smooks发行版提供的开箱即用解决方案,其数目正在不断的增长中。在这种模式下,你只需要重用别人创建的组件即可,重新配置它们来处理你的数据源,例如,通过配置一些参数就可以由EDI数据源生成Java对象模型。

EDI格式标准

EDI电子数据交换是结构化的数据通过一定标准的报文格式从一个应用程序到另一个应用程序的电子化的交换,商业伙伴实施EDI,必须遵循一定的EDI报文标准。目前常用的标准主要有,美国标准ANSI
X.12和欧洲标准EDIFACT。

点击查看详情:

smooks说明##\

Smooks是一个用于出力XML和非XML数据(CVS,EDI,Java)的JAVA可扩展框架。
主要有以下特性:

  1. JAVA绑定:根据数据源(XML,CSV,EDI…)活得JAVA对象,亦可以实现JAVA对象到数据源的格式化。
  2. 转化:数据格式之间的转化,如XML-XML,CSV-XML,EDI-XML…..
  3. 大数据处理:能处理大型数据(GBs)-分割,转换,路由到JMS,文件,数据库等。
  4. 数据完整性填充:利用数据库等数据源填充数据。
  5. 复杂数据验证
  6. 基于ORM框架的数据存储:可以使用持久层框架(如ibatis,hibernate…)或者DAO读取或者存储数据。
  7. 可以将以上特性结合使用。

使用smooks转换EDI到XML格式示例说明##\

DEI示例文件内容如下(input-message.edi)

HDR*1*0*59.97*64.92*4.95*Wed Nov 15 13:45:28 EST 2006
CUS*user1*Harry^Fletcher*SD
ORD*1*1*364*The 40-Year-Old Virgin*29.98
ORD*2*1*299*Pulp Fiction*29.99

DEI转换XML配置文件(edi-to-xml-order-mapping.xml)

<?xml version="1.0" encoding="UTF-8"?>
<medi:edimap xmlns:medi="http://www.milyn.org/schema/edi-message-mapping-1.0.xsd">
    <medi:description name="DVD Order" version="1.0" />
    <medi:delimiters segment="" field="*" component="^" sub-component="~" />
    <medi:segments xmltag="Order">
        <medi:segment segcode="HDR" xmltag="header">
            <medi:field xmltag="order-id" />
            <medi:field xmltag="status-code" />
            <medi:field xmltag="net-amount" />
            <medi:field xmltag="total-amount" />
            <medi:field xmltag="tax" />
            <medi:field xmltag="date" />
        </medi:segment>
        <medi:segment segcode="CUS" xmltag="customer-details">
            <medi:field xmltag="username" />
            <medi:field xmltag="name">
                <medi:component xmltag="firstname" />
                <medi:component xmltag="lastname" />
            </medi:field>
            <medi:field xmltag="state" />
        </medi:segment>
        <medi:segment segcode="ORD" xmltag="order-item" maxOccurs="-1">
            <medi:field xmltag="position" />
            <medi:field xmltag="quantity" />
            <medi:field xmltag="product-id" />
            <medi:field xmltag="title" />
            <medi:field xmltag="price" />
        </medi:segment>
    </medi:segments>
</medi:edimap>

转换后的格式如下

<Order>
    <header>
        <order-id>1</order-id>
        <status-code>0</status-code>
        <net-amount>59.97</net-amount>
        <total-amount>64.92</total-amount>
        <tax>4.95</tax>
        <date>Wed Nov 15 13:45:28 EST 2006</date>
    </header>
    <customer-details>
        <username>user1</username>
        <name>
            <firstname>Harry</firstname>
            <lastname>Fletcher</lastname>
        </name>
        <state>SD</state>
    </customer-details>
    <order-item>
        <position>1</position>
        <quantity>1</quantity>
        <product-id>364</product-id>
        <title>The 40-Year-Old Virgin</title>
        <price>29.98</price>
    </order-item>
    <order-item>
        <position>2</position>
        <quantity>1</quantity>
        <product-id>299</product-id>
        <title>Pulp Fiction</title>
        <price>29.99</price>
    </order-item>
</Order>

配置文件(edi-to-xml-order-mapping.xml)说明###\

<medi:delimiters segment="" field="*" component="^" sub-component="~" />  

segment:表示每组数据(一个定单,或者理解为一个bean)的分隔符。
field:表示元素分隔符(bean中的属分隔符)
component:子元素分隔符
sub-component:示例中没有用到。

<medi:segments xmltag="Order">

转换根元素为根元素

<medi:segment segcode="HDR" xmltag="header">

把HDR部分转换成元素header

<medi:field xmltag="order-id" />

通过*分隔,提取第一个,转换成元素order-id

<medi:field xmltag="status-code" />

通过*分隔,提取第二个,转换成元素status-code

其他行比较类似
其中:

<medi:field xmltag="name">
    <medi:component xmltag="firstname" />
    <medi:component xmltag="lastname" />
</medi:field>

通过*分隔符,生成name元素,因为还有两个子元素,所以使用<medi:component>,子元素使用^分隔。

使用smooks转换代码###\

Locale defaultLocale = Locale.getDefault();
Locale.setDefault(new Locale("en", "IE"));
// Instantiate Smooks with the config...
Smooks smooks = new Smooks("smooks-config.xml");
try {
    // Create an exec context - no profiles....
    ExecutionContext executionContext = smooks.createExecutionContext();
    StringResult result = new StringResult();
    // Configure the execution context to generate a report...
    executionContext.setEventListener(new HtmlReportGenerator("target/report/report.html"));
    // Filter the input message to the outputWriter, using the execution context...
    smooks.filterSource(executionContext, new StreamSource(new ByteArrayInputStream(messageIn)), result);
    Locale.setDefault(defaultLocale);
    return result.getResult();
} finally {
    smooks.close();
}

ESB转换EDI到XML流程说明

  1. 在ESB数据库中配置好EDI转XML的流程(Flow),需要配置config属性,里面就是上面的DEI转换XML配置文件的内容
  2. 配置Flow执行”edi-2-xml-component”组件。
  3. 然后edi-2-xml-component组件获取配置的config和请求参数中的edi报文,调用Edi2XMLTransformer执行转换

ESB转换EDI到XML主要类

  1. DEI2XMLComponent.java
    从context获取请求要转换的EDI报文,从settings中分别获取smooks的转换配置,调用Edi2XMLTransformer类进行转换
    @Component(“edi-2-xml-component”)
    public class EDI2XMLComponent implements CustomComponent {
    private final static Edi2XMLTransformer EDI_2_XML_TRANSFORMER =
    new Edi2XMLTransformer();

         @Override
         public Object execute(MuleMessage message,Context context,Map<String,Object> settings){
             if(!settings.containsKey("config")){
                 String errorMessage = ExceptionMessageUtils.generate(ExceptionMessages.EDI_DEFECT_CONFIG_ERROR,"EDI转XML");
                 throw new DefectSettingException(ExceptionMessages.EDI_DEFECT_CONFIG_ERROR.getExceptionCode(),errorMessage);
             }
             String config = MapUtils.getString(settings,"config");
             String payload = String.valueOf(context.getPayload());
             return EDI_2_XML_TRANSFORMER.transformer(config,payload);
         } 
     }  
    
  2. Edi2XMLTransformer.java
    使用Smooks把EDI格式转换成XML格式
    public class Edi2XMLTransformer implements Transformer {
    @Override
    public String transformer(String config,String source){
    Smooks smooks = new Smooks();
    EDIReaderConfigurator ediReaderConfigurator = new
    EDIReaderConfigurator(config);
    smooks.setReaderConfig(ediReaderConfigurator);
    ExecutionContext executionContext =
    smooks.createExecutionContext();
    StringResult result = new StringResult();
    smooks.filterSource(executionContext,new
    StringSource(source),result);
    return result.getResult();
    }
    }