Skip to content

Support to configure LanguageDriver via SqlSessionFactoryBean #379

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 2, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions src/main/java/org/mybatis/spring/SqlSessionFactoryBean.java
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
import org.apache.ibatis.plugin.Interceptor;
import org.apache.ibatis.reflection.factory.ObjectFactory;
import org.apache.ibatis.reflection.wrapper.ObjectWrapperFactory;
import org.apache.ibatis.scripting.LanguageDriver;
import org.apache.ibatis.session.Configuration;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
Expand Down Expand Up @@ -125,6 +126,10 @@ public class SqlSessionFactoryBean

private Class<?> typeAliasesSuperType;

private LanguageDriver[] scriptingLanguageDrivers;

private Class<? extends LanguageDriver> defaultScriptingLanguageDriver;

// issue #19. No default provider.
private DatabaseIdProvider databaseIdProvider;

Expand Down Expand Up @@ -435,6 +440,28 @@ public void setEnvironment(String environment) {
this.environment = environment;
}

/**
* Set scripting language drivers.
*
* @param scriptingLanguageDrivers
* scripting language drivers
* @since 2.0.2
*/
public void setScriptingLanguageDrivers(LanguageDriver... scriptingLanguageDrivers) {
this.scriptingLanguageDrivers = scriptingLanguageDrivers;
}

/**
* Set a default scripting language driver class.
*
* @param defaultScriptingLanguageDriver
* A default scripting language driver class
* @since 2.0.2
*/
public void setDefaultScriptingLanguageDriver(Class<? extends LanguageDriver> defaultScriptingLanguageDriver) {
this.defaultScriptingLanguageDriver = defaultScriptingLanguageDriver;
}

/**
* {@inheritDoc}
*/
Expand Down Expand Up @@ -519,6 +546,15 @@ protected SqlSessionFactory buildSqlSessionFactory() throws Exception {
});
}

if (!isEmpty(this.scriptingLanguageDrivers)) {
Stream.of(this.scriptingLanguageDrivers).forEach(languageDriver -> {
targetConfiguration.getLanguageRegistry().register(languageDriver);
LOGGER.debug(() -> "Registered scripting language driver: '" + languageDriver + "'");
});
}
Optional.ofNullable(this.defaultScriptingLanguageDriver)
.ifPresent(targetConfiguration::setDefaultScriptingLanguage);

if (this.databaseIdProvider != null) {// fix #64 set databaseId before parse mapper xmls
try {
targetConfiguration.setDatabaseId(this.databaseIdProvider.getDatabaseId(this.dataSource));
Expand Down
46 changes: 46 additions & 0 deletions src/test/java/org/mybatis/spring/SqlSessionFactoryBeanTest.java
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,10 @@
import org.apache.ibatis.reflection.factory.ObjectFactory;
import org.apache.ibatis.reflection.wrapper.DefaultObjectWrapperFactory;
import org.apache.ibatis.reflection.wrapper.ObjectWrapperFactory;
import org.apache.ibatis.scripting.LanguageDriver;
import org.apache.ibatis.scripting.LanguageDriverRegistry;
import org.apache.ibatis.scripting.defaults.RawLanguageDriver;
import org.apache.ibatis.scripting.xmltags.XMLLanguageDriver;
import org.apache.ibatis.session.Configuration;
import org.apache.ibatis.session.ExecutorType;
import org.apache.ibatis.session.SqlSessionFactory;
Expand Down Expand Up @@ -440,6 +444,42 @@ void testAddCache() {
assertThat(this.factoryBean.getCache().getId()).isEqualTo("test-cache");
}

@Test
void testScriptingLanguageDriverEmpty() throws Exception {
setupFactoryBean();
this.factoryBean.setScriptingLanguageDrivers();
LanguageDriverRegistry registry = this.factoryBean.getObject().getConfiguration().getLanguageRegistry();
assertThat(registry.getDefaultDriver()).isInstanceOf(XMLLanguageDriver.class);
assertThat(registry.getDefaultDriverClass()).isEqualTo(XMLLanguageDriver.class);
}

@Test
void testScriptingLanguageDriver() throws Exception {
setupFactoryBean();
this.factoryBean.setScriptingLanguageDrivers(new MyLanguageDriver1(), new MyLanguageDriver2());
LanguageDriverRegistry registry = this.factoryBean.getObject().getConfiguration().getLanguageRegistry();
assertThat(registry.getDefaultDriver()).isInstanceOf(XMLLanguageDriver.class);
assertThat(registry.getDefaultDriverClass()).isEqualTo(XMLLanguageDriver.class);
assertThat(registry.getDriver(MyLanguageDriver1.class)).isNotNull();
assertThat(registry.getDriver(MyLanguageDriver2.class)).isNotNull();
assertThat(registry.getDriver(XMLLanguageDriver.class)).isNotNull();
assertThat(registry.getDriver(RawLanguageDriver.class)).isNotNull();
}

@Test
void testScriptingLanguageDriverWithDefault() throws Exception {
setupFactoryBean();
this.factoryBean.setScriptingLanguageDrivers(new MyLanguageDriver1(), new MyLanguageDriver2());
this.factoryBean.setDefaultScriptingLanguageDriver(MyLanguageDriver1.class);
LanguageDriverRegistry registry = this.factoryBean.getObject().getConfiguration().getLanguageRegistry();
assertThat(registry.getDefaultDriver()).isInstanceOf(MyLanguageDriver1.class);
assertThat(registry.getDefaultDriverClass()).isEqualTo(MyLanguageDriver1.class);
assertThat(registry.getDriver(MyLanguageDriver1.class)).isNotNull();
assertThat(registry.getDriver(MyLanguageDriver2.class)).isNotNull();
assertThat(registry.getDriver(XMLLanguageDriver.class)).isNotNull();
assertThat(registry.getDriver(RawLanguageDriver.class)).isNotNull();
}

private void assertDefaultConfig(SqlSessionFactory factory) {
assertConfig(factory, SqlSessionFactoryBean.class.getSimpleName(),
org.mybatis.spring.transaction.SpringManagedTransactionFactory.class);
Expand All @@ -464,4 +504,10 @@ private void assertConfig(SqlSessionFactory factory, String environment,
assertThat(factory.getConfiguration().getSqlFragments().size()).isEqualTo(0);
}

private static class MyLanguageDriver1 extends RawLanguageDriver {
}

private static class MyLanguageDriver2 extends RawLanguageDriver {
}

}