JiBX 入门级使用

约定不等于承诺〃 2022-06-01 07:11 281阅读 0赞

# 简介 #

> JiBX is a tool for binding XML data to Java objects

这是官网开篇介绍，JiBX 是绑定XML结构数据到Java对象上的工具，效率是Xstream的3倍。

> 官网：[http://jibx.sourceforge.net/index.html][http_jibx.sourceforge.net_index.html]

# 使用方法 #

例子：  
Java 对象

package com.zb;
    
    public class JibxBean { 
    
        private String name;
    
        private Integer age;
    
        // 1 - 男；2 - 女
        private String sex;
    
        public String getName() {
            return name;
        }
    
        public void setName(String name) {
            this.name = name;
        }
    
        public Integer getAge() {
            return age;
        }
    
        public void setAge(Integer age) {
            this.age = age;
        }
    
        public String getSex() {
            return sex;
        }
    
        public void setSex(String sex) {
            this.sex = sex;
        }
    
    }

binding.xml 文件

<?xml version="1.0" encoding="UTF-8"?>
    <binding value-style="element">
    
        <mapping name="Root" class="com.zb.JibxBean" ordered="false">
            <value name="Name" field="name" usage="optional" />
            <value name="Age" field="age" usage="optional" />
            <value name="Sex" field="sex" usage="optional" />
        </mapping>
    
    </binding>

XML结构数据

## 一 执行绑定 ##

/zb 目录下存在 JibxBean.class 和 binding.xml 文件

### 方法一： ###

将Java对象的class类，与binding.xml文件放在同级目录下，使用jibx-bind.jar进行编译绑定。

1.  进入 class 与 binding.xml 所在目录 /zb
2.  使用命令 `java -jar /home/dennis/jibx/lib/jibx-bind.jar binding.xml` 进行编译绑定

> 官方翻译：  
> 一旦你有一个绑定规则，你需要使用 JiBX 绑定编译，来将你的 class 文件和绑定规则进行绑定。一个简单方式是，使用提供的 jibx-bind.jar 包（在 /home/dennis/jibx/lib 目录下）执行绑定。例如，如果 JiBX 安装在 /home/dennis，然后你程序的根目录中有 binding.xml 文件，你只需要执行：  
> `java -jar /home/dennis/jibx/lib/jibx-bind.jar binding.xml`

### 方法二： ###

自动运行当前目录下 class 文件和 jar 包中的类，进行绑定。  
例子：需要绑定的 class 文件在 a.jar 中，所在路径：/zb/lib/a.jar

1.  进入 class 与 binding.xml 所在目录 /zb
2.  使用命令 `java -cp .:lib/a.jar:/home/dennis/jibx/lib/jibx-bind.jar org.jibx.binding.Compile binding.xml` 进行编译绑定

> 官方翻译：  
> 当你使用此方法进行绑定时，JiBX 将会自动地包括当前目录中被加载的 class 文件。它将需要访问所有在 binding.xml 文件中被绑定的类，因为要包括被绑定类的父类，所以需要包含其他的类路径，或 jar 包到当前执行目录中，但是不幸的是，直接执行 jibx-bind.jar 进行绑定就不会生效，你需要指定编译绑定的类，即 org.jibx.binding.Compile，并且在你的当前执行目录（classpath）中要包含 jibx-bind.jar。如下所示(在一行,显示只有格式化)：  
> `java -cp .:lib/support.jar:/home/dennis/jibx/lib/jibx-bind.jar org.jibx.binding.Compile binding.xml`

## 二 XML 结构与 Java 对象转换 ##

### XML 结构转换为 Java 对象 ###

IBindingFactory bfact = BindingDirectory.getFactory(JibxBean.class);
    
    IUnmarshallingContext uctx = bfact.createUnmarshallingContext();
    Object obj = uctx.unmarshalDocument(new FileInputStream("filename.xml"), null);
    // 转成JibxBean
    JibxBean bean = (JibxBean) obj;

> uctx.unmarshalDocument()，方法第一个参数，需要是一个流，从XML结构字符串转化为流也可以

### Java 对象转换为 XML 结构 ###

JibxBean bean = new JibxBean();
    bean.setName("李四");
    bean.setAge(20);
    bean.setSex(2);
    
    StringWriter sw = new StringWriter();
    
    IBindingFactory bfact = BindingDirectory.getFactory(JibxBean.class);
    
    IMarshallingContext mctx = bfact.createMarshallingContext();
    mctx.marshalDocument(bean, "UTF-8", null, sw);
    String result = sw.toString();
    
    System.out,println(result);

输出结果：

# Eclipse 插件使用 #

## 添加 JiBX 插件下载地址 ##

JiBX 官网提供的地址为：  
`http://jibx.sourceforge.net/eclipse/`

1.  点击 Eclipse 工具栏中 Help -> Install New Software，按照下图添加 JiBX 插件  
    ![1240][]
2.  选择要安装的插件版本  
    ![1240 1][]
3.  等待下载完毕

## 使用 JiBX 插件执行绑定操作 ##

1.  选择 JiBX 转换 Java 对象所在的工程，点击右键，选择 Properties  
    按照下图设置：
    
    1.  选择 JiBX 选项
    2.  设置 binding.xml 文件所在文件夹
    3.  选择 JiBX 的版本（若安装多个，则选）  
        ![1240 2][]
2.  使 JiBX 插件生效  
    ![1240 3][]
3.  当 Java 对象编译后 class 发生变化，或 binding.xml 文件绑定关系发生变化，JiBX 插件都会自动重新执行绑定操作
    
    > 参考官网解释：  
    > A new Eclipse plugin for JiBX is now available. You can install the plugin by making use of Eclipse’s Software Updates handling, with the update site url [http://jibx.sourceforge.net/eclipse/][http_jibx.sourceforge.net_eclipse]. If you want a detailed walk-through of how to configure Eclipse to use this site, see the [Install][] page.  
    > Once you’ve installed the plugin, you can activate it for any of your Eclipse projects using the project context menu, and for each project specify a folder containing the binding definitions used by that project. The plugin will parse all XML files contained in your specified mappings folder to identify which Java classes require bindings, and will automatically run the JiBX binding compiler whenever it detects a change that might effect the bindings or bound classes. For a detailed walk-through of how to activate the plugin for a project, and details of when and how it runs the binding compiler, see the [Usage][] page.

[http_jibx.sourceforge.net_index.html]: http://jibx.sourceforge.net/index.html
[1240]: /images/20220601/ae083ff3a8844b2ea8b00738128d169e.png
[1240 1]: /images/20220601/3a162e1fb63341c8a8aa3677625dab5f.png
[1240 2]: /images/20220601/3c539fa2f56e4b79b53f7ec8a158ecde.png
[1240 3]: /images/20220601/c704af40e3c24b5a873f491170e8435b.png
[http_jibx.sourceforge.net_eclipse]: http://jibx.sourceforge.net/eclipse/
[Install]: http://jibx.sourceforge.net/eclipse/install.html
[Usage]: http://jibx.sourceforge.net/eclipse/usage.html