Conversion from iBatis 2 to MyBatis 3:

This page provides some information that is useful when migrating a project from iBatis 2 to MyBatis 3. It is probably not 100% complete.

Conversion Tool

There is a tool available in the downloads section that will help you to convert your iBATIS 2.x sqlmap files into MyBatis 3.x xml mapper files.

Get it from http://mybatis.googlecode.com/files/ibatis2mybatis.zip

The tool is designed around an xslt transformation and some text replacements packaged in an ant task and tries to deliver a good starting point before the more complex work begins.

New DTDs

New sqlMapConfig.xml DTD:

New sqlMap (*.map.xml) DTD:

Configuration

• Root configuration tag  is now 

Settings

Within the root configuration tag:

 x="y" foo="bar"/>

is now:

     name="x" value="y"/>
     name="foo" value="bar"/>

and

 useStatementNamespaces="true"/>

can be removed, since the use of namespaces has become mandatory.

 must be moved out of the  element to 

    
    ...
    

   
        ... />
   

 and 

 type="JDBC" commitRequired="false">
     type="your.package.CustomDataSourceFactory" />

is now:

 default="env">
     id="env">
         type="JDBC">
             name="commitRequired" value="false"/>
        
         type="your.package.CustomDataSourceFactory" />
    

 resource=... />
 resource=... />
 resource=... />

is now:

     resource=... />

Mapping

• The root element  is now 
• The attribute parameterClass should be changed to parameterType
• The attribute resultClass should be changed to resultType
• The attribute class should be changed to type
• the columnIndex attribute does not exist anymore for the  tag
• The groupBy attribute has been eliminated. Here is an example of groupBy from a 2.x sqlMap:

 id="productRM" class="product" groupBy="id">
     property="id" column="product_id"/>
     property="name" column="product_name"/>
     property="category" column="product_category"/>
     property="subProducts" resultMap="Products.subProductsRM"/>

New:

 id="productRM" type="product" >
     property="id" column="product "/>
     property="name " column="product_name "/>
     property="category " column="product_category "/>
     property="subProducts" resultMap="Products.subProductsRM"/>

Nested resultMaps

These should now be specified using the  tag.

 ...>
     property="client" resultMap="Client.clientRM"/>
    ...

is now:

 ...>
     property="client" resultMap="Client.clientRM"/>
    ...

Although this tag is deprecated, it can be used as in iBatis 2. However for versions up to 3.0.3 there is a bug when using type="map" and not specifying javaType for a parameter. This will result in

There is no getter for property named '...' in 'interface java.util.Map'    

This should be solved in MyBatis 3.0.4. For versions 3.0.3 and earlier the workaround is to explicitly specify javaType.

Inline parameters

#value#

is now:

#{value}

jdbcType changes

jdbcType="ORACLECURSOR"

is now:

jdbcType="CURSOR"

and

jdbcType="NUMBER"

is now:

jdbcType="NUMERIC"

Stored procedures

• the  tag doesn't exist anymore. Use ,  or .

 id="getValues" parameterMap="getValuesPM">
    { ? = call pkgExample.getValues(p_id => ?) }

is now:

 id="getValues" parameterMap="getValuesPM" statementType="CALLABLE">
    { ? = call pkgExample.getValues(p_id => ?)}

If you're calling an insert procedure that returns a value, you can use  instead of , but make sure to specifyuseCache="false" and flushCache="true". You'll also have to force a commit.

• for stored procedures that return a cursor, there is a bug (see  issue 30 ) when using nested result maps (i.e. the output parameter's resultMap contains an  tag with the resultMap attribute). As long as the issue is not fixed, you have to specify the resultMap of the output parameter on the statement itself as well, or the nested resultMap will not be populated.

Caching

 id="myCache" type="LRU">
     hours="24"/>
     name="size" value="100" />

is now:

 flushInterval="86400000" eviction="LRU"/>

Note: you can omit eviction="LRU" since it is the default.

• the  tag is replaced by the flushCache attribute for the statements and the cache will be used by all select statements by default.

Dynamic SQL

The most common dynamic SQL in my project is isNotNull. Here is an example replacement regex:

Pattern:

.*?property=\"(.*?)\">

Replacement:

 test="$1 != null">

Also common is the use of isEqual, you can replace this by a similar  tag.

Java code

SqlMapClient

• This class doesn't exist anymore. Use SqlSessionFactory instead (see User Guide).

Custom type handler

• Replace interface TypeHandlerCallback with TypeHandler. It has slightly different but similar methods.

Custom data source factory

Old interface:

com.ibatis.sqlmap.engine.datasource.DataSourceFactory

New interface:

org.apache.ibatis.datasource.DataSourceFactory

Replace method

public void initialize(Map properties)

with

public void setProperties(Properties props)