Skip to end of metadata
Go to start of metadata


The Mybatis plugin enables lightweight access to datasources using MyBatis. This plugin does NOT provide domain classes nor dynamic finders like GORM does.


The current version of griffon-mybatis is 0.2
To install just issue the following command


Upon installation the plugin will generate the following artifacts at $appdir/griffon-app/conf:

  • DataSource.groovy - contains the datasource and pool definitions. Its format is equal to GORM's requirements. Additional configuration for this artifact is explained in the DataSource Plugin.
  • BootstrapMybatis.groovy - defines init/destroy hooks for data to be manipulated during app startup/shutdown.

A new dynamic method named withSqlSession will be injected into all controllers, giving you access to a org.apache.ibatis.session.SqlSession object, with which you'll be able to make calls to the database. Remember to make all calls to the database off the EDT otherwise your application may appear unresponsive when doing long computations inside the EDT.
This method is aware of multiple datasources. If no datasourceName is specified when calling it then the default dataSource will be selected. Here are two example usages, the first queries against the default datasource while the second queries a datasource whose name has been configured as 'internal'

This method is also accessible to any component through the singleton griffon.plugins.mybatis.MybatisConnector. You can inject these methods to non-artifacts via metaclasses. Simply grab hold of a particular metaclass and call MybatisConnector.enhance(metaClassInstance).


This plugin provides the following scripts

  • create-mybatis-class - creates a new class along with a Mapper interface and its companion XML Mapper.


Dynamic method injection

The withMybatis() dynamic method will be added to controllers by default. You can change this setting by adding a configuration flag in Config.groovy


The following events will be triggered by this addon

  • MybatisConnectStart[config, dataSourceName] - triggered before connecting to the datasource
  • MybatisConnectEnd[dataSource, sessionFactory] - triggered after connecting to the datasource
  • MybatisDisconnectStart[config, dataSourceName, sessionFactory] - triggered before disconnecting from the datasource
  • MybatisDisconnectEnd[config, dataSourceName] - triggered after disconnecting from the datasource

Multiple DataSources

The config file MybatisConfig.groovy defines a default dataSource block. As the name implies this is the dataSource used by default, however you can configure named dataSources by adding a new config block. For example connecting to a dataSource whose name is 'internal' can be done in this way

This block can be used inside the environments() block in the same way as the default sessionFactory block is used.


Follow these steps to create a simple application that displays data stored inside a database.

1. Create a new application named 'sample'


Following steps must be executed inside the application's directory

2. Install the Mybatis plugin

3. Setup the database. Create the file griffon-app/resources/schema.ddl with the following content

DataBase Specific Content


The schema.ddl file must contain RDBMS specific DDL statements

4. Create a model class in src/mybatis/sample/Person.groovy along with its companion Mappers

This command generates the following files

  • src/mybatis/sample/Person.groovy
  • src/mybatis/sample/mappers/PersonMapper.groovy
  • src/mybatis/sample/mappers/PersonMapper.xml

Java based templates are available too, just use -fileType=java at the command prompt. Edit the files, make them look like the following snippets

5. Setup bootstrapping data. Edit griffon-app/conf/BootstrapMybatis.groovy (We'll use the Griffon's team roster, feel free to input your own data)

6. Download a copy of GlazedLists' latest stable release. Place it under $appdir/lib. Or install the Glazedlists Plugin (recommended!).

7. Edit griffon-app/models/sample/SampleModel.groovy by adding a personList property.

GlazedLists' EventList simplifies working with JList, JTable and their models as you will soon find out.

8. Edit griffon-app/views/sample/SampleView.groovy. We'll add a scrollPane and a table. The Table's model will be tied to model.people.

9. Finally edit griffon-app/controllers/sample/SampleController.groovy. The controller will react to an application event, load the data into a temporary List then update model.people inside the EDT.

10. Run the application by typing

Full source code for this sample application can be found at







Release sync with Griffon 0.9.4



Initial release

  • No labels