MyBatipse : Eclipse plugin for MyBatis

MyBatis is a popular SQL Mapper framework.
And MyBatipse is an Eclipse plug-in which provids content assists and validations when editing MyBatis related files.

Features

XML Editor Enhancements

Auto-completion

• Mapper namespace : Calculated from the path.
  

• Java class/Type alias : Propose Java classes and Type Aliases (translucent icons). Camelcase match is supported. [1] [2]
  

• Java property : Propose properties of the parent java class. Nested properties are supported.
  

• Statement ID : If corresponding mapper interface exists, propose the method name as a statement ID.
  

• Reference to resultMap/select/sql : Propose ID of the referenced resultMap/select/sql. External reference is supported (blue icons).
  

• Parameter properties : #{} and ${} in select/insert/udpate/delte statements. Also works in some attributes.
  

• javaType, jdbcType, typeHandler in #{}
  

• Result elements in resultMap/collection/association : Generates elements for the parent java class properties.
  

• [1] For better performance, classes in the application libraries (loaded as JARs) are listed only when at least one package segment is specified.

• [2] There is a limitation for the type alias support. Basically, if type aliases are registered using Java API, they are not automatically detected. As a workaround, you can register type aliases in MyBatipse's preference. See the Configuration section.

Hyperlinks

• To referenced resultMap/select/sql element. External reference is supported.
• To mapper interface method.

Validation

• Missing TypeAlias, Java class/property.
• Missing resultMap/select/sql ID.
• etc.
  

Java Editor Enhancements

Auto-completion

• Parameter properties : #{} and ${} in select/insert/udpate/delte annotations.
• javaType, jdbcType, typeHandler in #{} : See the XML example.
• Reference to resultMap in @ResultMap
  

Quick Assist

• Add @Param to method parameters : Put the cursor on the method name and press cmd + 1 (or ctrl + 1).
  
  

Configuration

MyBatis Nature

• By default, each file is validated when it's saved, but you would want to validate the XML mapper when the related Java classes are updated as well. For that purpose, MyBatipse provides a custom nature MyBatis Nature.
  To add the nature, right click the project in the package explorer and choose Configure -> Add MyBatis Nature from the menu.
  

Type Alias

• Type alias are automatically detected if they are registered using XML config file (both mybatis and mybatis-spring config is supported).
  If you register type aliases in Java code, MyBatipse cannot detect them. As a workaround, you can register custom type aliases in the project setting (Open Project -> Properties menu and select MyBatipse from the left column).
  
  For example, with the above settings:
  • The first entry registers all the classes in com.example.domain package as type aliases.
  • The second entry registers the single class domain.Person.
  • The third entry registers the single class domain.SomeLongNamedBean under the alias SomeBean.
  • Note that, in any case, MyBatipse respects @Alias annotation if it exists.

Tips

• To move MyBatis proposals to the top of the XML proposal list, quit Eclipse and open the following file in the workspace: .metadata/.plugins/org.eclipse.core.runtime/.settings/org.eclipse.wst.xml.ui.prefs Find the line started with xml_content_assist_default_page_sort_order= and insert net.harawata.mybatis.proposalCategory.xml\u0000 right after the equal sign.
  

Installation

There are several ways to install MyBatipse.

• Drag this button from browser to your Eclipse workbench (i.e. window).
• Choose Eclipse Marketplace... in Help menu of your Eclipse and search MyBatipse.
• Choose Install New Software... in Help menu and enter the following URL.
  http://dl.bintray.com/harawata/eclipse

Bugs, questions, suggestions, etc.

Please use the issue tracker.

License

MyBatipse is licensed under Eclipse Public License 1.0.