Skip to content

Commit deba316

Browse files
kazuki43zookazuki43zoo
authored
Merge pull request #971 from kazuki43zoo/gh-970_allow-customize-default-enum-typehandler
Allow to customize default typehandler for enum
2 parents a3f506e + a238186 commit deba316

File tree

10 files changed

+110
-5
lines changed

10 files changed

+110
-5
lines changed

‎src/main/java/org/apache/ibatis/builder/xml/XMLConfigBuilder.java‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Copyright 2009-2016 the original author or authors.
2+
* Copyright 2009-2017 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -45,6 +45,7 @@
4545
import org.apache.ibatis.session.LocalCacheScope;
4646
import org.apache.ibatis.transaction.TransactionFactory;
4747
import org.apache.ibatis.type.JdbcType;
48+
import org.apache.ibatis.type.TypeHandler;
4849

4950
/**
5051
* @author Clinton Begin
@@ -254,6 +255,9 @@ private void settingsElement(Properties props) throws Exception {
254255
configuration.setLazyLoadTriggerMethods(stringSetValueOf(props.getProperty("lazyLoadTriggerMethods"), "equals,clone,hashCode,toString"));
255256
configuration.setSafeResultHandlerEnabled(booleanValueOf(props.getProperty("safeResultHandlerEnabled"), true));
256257
configuration.setDefaultScriptingLanguage(resolveClass(props.getProperty("defaultScriptingLanguage")));
258+
@SuppressWarnings("unchecked")
259+
Class<? extends TypeHandler> typeHandler = (Class<? extends TypeHandler>)resolveClass(props.getProperty("defaultEnumTypeHandler"));
260+
configuration.setDefaultEnumTypeHandler(typeHandler);
257261
configuration.setCallSettersOnNulls(booleanValueOf(props.getProperty("callSettersOnNulls"), false));
258262
configuration.setUseActualParamName(booleanValueOf(props.getProperty("useActualParamName"), true));
259263
configuration.setReturnInstanceForEmptyRow(booleanValueOf(props.getProperty("returnInstanceForEmptyRow"), false));

‎src/main/java/org/apache/ibatis/session/Configuration.java‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Copyright 2009-2016 the original author or authors.
2+
* Copyright 2009-2017 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -88,6 +88,7 @@
8888
import org.apache.ibatis.transaction.managed.ManagedTransactionFactory;
8989
import org.apache.ibatis.type.JdbcType;
9090
import org.apache.ibatis.type.TypeAliasRegistry;
91+
import org.apache.ibatis.type.TypeHandler;
9192
import org.apache.ibatis.type.TypeHandlerRegistry;
9293

9394
/**
@@ -461,6 +462,18 @@ public TypeHandlerRegistry getTypeHandlerRegistry() {
461462
return typeHandlerRegistry;
462463
}
463464

465+
/**
466+
* Set a default {@link TypeHandler} class for {@link Enum}.
467+
* A default {@link TypeHandler} is {@link org.apache.ibatis.type.EnumTypeHandler}.
468+
* @param typeHandler a type handler class for {@link Enum}
469+
* @since 3.4.5
470+
*/
471+
public void setDefaultEnumTypeHandler(Class<? extends TypeHandler> typeHandler) {
472+
if (typeHandler != null) {
473+
getTypeHandlerRegistry().setDefaultEnumTypeHandler(typeHandler);
474+
}
475+
}
476+
464477
public TypeAliasRegistry getTypeAliasRegistry() {
465478
return typeAliasRegistry;
466479
}

‎src/main/java/org/apache/ibatis/type/TypeHandlerRegistry.java‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,8 @@ public final class TypeHandlerRegistry {
4747

4848
private static final Map<JdbcType, TypeHandler<?>> NULL_TYPE_HANDLER_MAP = new HashMap<JdbcType, TypeHandler<?>>();
4949

50+
private Class<? extends TypeHandler> defaultEnumTypeHandler = EnumTypeHandler.class;
51+
5052
public TypeHandlerRegistry() {
5153
register(Boolean.class, new BooleanTypeHandler());
5254
register(boolean.class, new BooleanTypeHandler());
@@ -155,6 +157,16 @@ public TypeHandlerRegistry() {
155157
register(char.class, new CharacterTypeHandler());
156158
}
157159

160+
/**
161+
* Set a default {@link TypeHandler} class for {@link Enum}.
162+
* A default {@link TypeHandler} is {@link org.apache.ibatis.type.EnumTypeHandler}.
163+
* @param typeHandler a type handler class for {@link Enum}
164+
* @since 3.4.5
165+
*/
166+
public void setDefaultEnumTypeHandler(Class<? extends TypeHandler> typeHandler) {
167+
this.defaultEnumTypeHandler = typeHandler;
168+
}
169+
158170
public boolean hasTypeHandler(Class<?> javaType) {
159171
return hasTypeHandler(javaType, null);
160172
}
@@ -224,7 +236,7 @@ private Map<JdbcType, TypeHandler<?>> getJdbcHandlerMap(Type type) {
224236
if (clazz.isEnum()) {
225237
jdbcHandlerMap = getJdbcHandlerMapForEnumInterfaces(clazz);
226238
if (jdbcHandlerMap == null) {
227-
register(clazz, new EnumTypeHandler(clazz));
239+
register(clazz, getInstance(clazz, defaultEnumTypeHandler));
228240
return TYPE_HANDLER_MAP.get(clazz);
229241
}
230242
} else {

‎src/site/es/xdoc/configuration.xml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -401,6 +401,20 @@ SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, environ
401401
org.apache.ibatis.scripting.xmltags.XMLLanguageDriver
402402
</td>
403403
</tr>
404+
<tr>
405+
<td>
406+
defaultEnumTypeHandler
407+
</td>
408+
<td>
409+
Specifies the <code>TypeHandler</code> used by default for Enum. (Since: 3.4.5)
410+
</td>
411+
<td>
412+
A type alias or fully qualified class name.
413+
</td>
414+
<td>
415+
org.apache.ibatis.type.EnumTypeHandler
416+
</td>
417+
</tr>
404418
<tr>
405419
<td>
406420
callSettersOnNulls

‎src/site/ja/xdoc/configuration.xml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -429,6 +429,20 @@ SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, environ
429429
org.apache.ibatis.scripting.xmltags.XMLLanguageDriver
430430
</td>
431431
</tr>
432+
<tr>
433+
<td>
434+
defaultEnumTypeHandler
435+
</td>
436+
<td>
437+
Enum型に適用するデフォルトの <code>TypeHandler</code> を指定します。(導入されたバージョン: 3.4.5)
438+
</td>
439+
<td>
440+
タイプエイリアスまたは完全修飾クラス名
441+
</td>
442+
<td>
443+
org.apache.ibatis.type.EnumTypeHandler
444+
</td>
445+
</tr>
432446
<tr>
433447
<td>
434448
callSettersOnNulls

‎src/site/ko/xdoc/configuration.xml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -409,6 +409,20 @@ SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, environ
409409
org.apache.ibatis.scripting.xmltags.XMLLanguageDriver
410410
</td>
411411
</tr>
412+
<tr>
413+
<td>
414+
defaultEnumTypeHandler
415+
</td>
416+
<td>
417+
Specifies the <code>TypeHandler</code> used by default for Enum. (Since: 3.4.5)
418+
</td>
419+
<td>
420+
A type alias or fully qualified class name.
421+
</td>
422+
<td>
423+
org.apache.ibatis.type.EnumTypeHandler
424+
</td>
425+
</tr>
412426
<tr>
413427
<td>
414428
callSettersOnNulls

‎src/site/xdoc/configuration.xml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -487,6 +487,20 @@ SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, environ
487487
org.apache.ibatis.scripting.xmltags.XMLLanguageDriver
488488
</td>
489489
</tr>
490+
<tr>
491+
<td>
492+
defaultEnumTypeHandler
493+
</td>
494+
<td>
495+
Specifies the <code>TypeHandler</code> used by default for Enum. (Since: 3.4.5)
496+
</td>
497+
<td>
498+
A type alias or fully qualified class name.
499+
</td>
500+
<td>
501+
org.apache.ibatis.type.EnumTypeHandler
502+
</td>
503+
</tr>
490504
<tr>
491505
<td>
492506
callSettersOnNulls

‎src/site/zh/xdoc/configuration.xml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -411,6 +411,20 @@ SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(reader, environ
411411
org.apache.ibatis.scripting.xmltags.XMLLanguageDriver
412412
</td>
413413
</tr>
414+
<tr>
415+
<td>
416+
defaultEnumTypeHandler
417+
</td>
418+
<td>
419+
Specifies the <code>TypeHandler</code> used by default for Enum. (Since: 3.4.5)
420+
</td>
421+
<td>
422+
A type alias or fully qualified class name.
423+
</td>
424+
<td>
425+
org.apache.ibatis.type.EnumTypeHandler
426+
</td>
427+
</tr>
414428
<tr>
415429
<td>
416430
callSettersOnNulls

‎src/test/java/org/apache/ibatis/builder/CustomizedSettingsMapperConfig.xml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<?xml version="1.0" encoding="UTF-8" ?>
22
<!--
33
4-
Copyright 2009-2016 the original author or authors.
4+
Copyright 2009-2017 the original author or authors.
55
66
Licensed under the Apache License, Version 2.0 (the "License");
77
you may not use this file except in compliance with the License.
@@ -52,6 +52,7 @@
5252
<setting name="logImpl" value="SLF4J"/>
5353
<setting name="vfsImpl" value="org.apache.ibatis.io.JBoss6VFS"/>
5454
<setting name="configurationFactory" value="java.lang.String"/>
55+
<setting name="defaultEnumTypeHandler" value="org.apache.ibatis.type.EnumOrdinalTypeHandler"/>
5556
</settings>
5657

5758
<typeAliases>

‎src/test/java/org/apache/ibatis/builder/XmlConfigBuilderTest.java‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Copyright 2009-2016 the original author or authors.
2+
* Copyright 2009-2017 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -17,6 +17,7 @@
1717

1818
import java.io.InputStream;
1919
import java.io.StringReader;
20+
import java.math.RoundingMode;
2021
import java.sql.CallableStatement;
2122
import java.sql.PreparedStatement;
2223
import java.sql.ResultSet;
@@ -50,6 +51,8 @@
5051
import org.apache.ibatis.session.LocalCacheScope;
5152
import org.apache.ibatis.transaction.jdbc.JdbcTransactionFactory;
5253
import org.apache.ibatis.type.BaseTypeHandler;
54+
import org.apache.ibatis.type.EnumOrdinalTypeHandler;
55+
import org.apache.ibatis.type.EnumTypeHandler;
5356
import org.apache.ibatis.type.JdbcType;
5457
import org.apache.ibatis.type.TypeHandler;
5558
import org.apache.ibatis.type.TypeHandlerRegistry;
@@ -96,6 +99,7 @@ public void shouldSuccessfullyLoadMinimalXMLConfigFile() throws Exception {
9699
assertNull(config.getLogPrefix());
97100
assertNull(config.getLogImpl());
98101
assertNull(config.getConfigurationFactory());
102+
assertThat(config.getTypeHandlerRegistry().getTypeHandler(RoundingMode.class), is(instanceOf(EnumTypeHandler.class)));
99103
}
100104

101105
enum MyEnum {
@@ -197,6 +201,7 @@ public void shouldSuccessfullyLoadXMLConfigFile() throws Exception {
197201
assertThat(config.getTypeHandlerRegistry().getTypeHandler(Long.class), is(instanceOf(CustomLongTypeHandler.class)));
198202
assertThat(config.getTypeHandlerRegistry().getTypeHandler(String.class), is(instanceOf(CustomStringTypeHandler.class)));
199203
assertThat(config.getTypeHandlerRegistry().getTypeHandler(String.class, JdbcType.VARCHAR), is(instanceOf(CustomStringTypeHandler.class)));
204+
assertThat(config.getTypeHandlerRegistry().getTypeHandler(RoundingMode.class), is(instanceOf(EnumOrdinalTypeHandler.class)));
200205

201206
ExampleObjectFactory objectFactory = (ExampleObjectFactory)config.getObjectFactory();
202207
assertThat(objectFactory.getProperties().size(), is(1));

0 commit comments

Comments
 (0)