Skip to content

Commit bf0d222

Browse files
kazuki43zookazuki43zoo
committed
Support databaseId at ProviderContext
1 parent fd49061 commit bf0d222

File tree

9 files changed

+72
-11
lines changed

9 files changed

+72
-11
lines changed

‎src/main/java/org/apache/ibatis/builder/annotation/ProviderContext.java‎

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/**
2-
* Copyright 2009-2017 the original author or authors.
2+
* Copyright 2009-2019 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.
@@ -27,16 +27,19 @@ public final class ProviderContext {
2727

2828
private final Class<?> mapperType;
2929
private final Method mapperMethod;
30+
private final String databaseId;
3031

3132
/**
3233
* Constructor.
3334
*
3435
* @param mapperType A mapper interface type that specified provider
3536
* @param mapperMethod A mapper method that specified provider
37+
* @param databaseId A database id
3638
*/
37-
ProviderContext(Class<?> mapperType, Method mapperMethod) {
39+
ProviderContext(Class<?> mapperType, Method mapperMethod, String databaseId) {
3840
this.mapperType = mapperType;
3941
this.mapperMethod = mapperMethod;
42+
this.databaseId = databaseId;
4043
}
4144

4245
/**
@@ -57,4 +60,14 @@ public Method getMapperMethod() {
5760
return mapperMethod;
5861
}
5962

63+
/**
64+
* Get a database id that provided from {@link org.apache.ibatis.mapping.DatabaseIdProvider}.
65+
*
66+
* @return A database id
67+
* @since 3.5.1
68+
*/
69+
public String getDatabaseId() {
70+
return databaseId;
71+
}
72+
6073
}

‎src/main/java/org/apache/ibatis/builder/annotation/ProviderSqlSource.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ public ProviderSqlSource(Configuration configuration, Object provider, Class<?>
6464

6565
if (providerMethodName.length() == 0 && ProviderMethodResolver.class.isAssignableFrom(this.providerType)) {
6666
this.providerMethod = ((ProviderMethodResolver) this.providerType.getDeclaredConstructor().newInstance())
67-
.resolveMethod(new ProviderContext(mapperType, mapperMethod));
67+
.resolveMethod(new ProviderContext(mapperType, mapperMethod, configuration.getDatabaseId()));
6868
}
6969
if (this.providerMethod == null) {
7070
providerMethodName = providerMethodName.length() == 0 ? "provideSql" : providerMethodName;
@@ -98,7 +98,7 @@ public ProviderSqlSource(Configuration configuration, Object provider, Class<?>
9898
+ this.providerType.getName() + "." + providerMethod.getName()
9999
+ "). ProviderContext can not define multiple in SqlProvider method argument.");
100100
}
101-
this.providerContext = new ProviderContext(mapperType, mapperMethod);
101+
this.providerContext = new ProviderContext(mapperType, mapperMethod, configuration.getDatabaseId());
102102
this.providerContextIndex = i;
103103
}
104104
}

‎src/site/es/xdoc/java-api.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -463,7 +463,7 @@ try (SqlSession session = sqlSessionFactory.openSession()) {
463463
</ul>
464464
</td>
465465
<td>Estas anotaciones SQL alternativas te permiten especificar un nombre de clases y un método que devolverán la SQL que debe ejecutarse (Since 3.4.6, you can specify the <code>CharSequence</code> instead of <code>String</code> as a method return type).
466-
Cuando se ejecute el método MyBatis instanciará la clase y ejecutará el método especificados en el provider. You can pass objects that passed to arguments of a mapper method, "Mapper interface type" and "Mapper method"
466+
Cuando se ejecute el método MyBatis instanciará la clase y ejecutará el método especificados en el provider. You can pass objects that passed to arguments of a mapper method, "Mapper interface type", "Mapper method" and "Database ID"
467467
via the <code>ProviderContext</code>(available since MyBatis 3.4.5 or later) as method argument.(In MyBatis 3.4 or later, it's allow multiple parameters)
468468
Atributos: type, method. El atributo type es el nombre completamente cualificado de una clase.
469469
El method es el nombre un método de dicha clase

‎src/site/ja/xdoc/java-api.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -476,7 +476,7 @@ try (SqlSession session = sqlSessionFactory.openSession()) {
476476
</td>
477477
<td>これらのアノテーションは動的 SQL を生成するためのものです。実行時に指定されたメソッドが呼び出され、メソッドから返された SQL ステートメントが実行されます (MyBatis 3.4.6以降では、メソッドの返り値として <code>String</code> ではなく <code>CharSequence</code> を指定することができます)。
478478
マップドステートメントを実行する際、プロバイダーによって指定したクラスのインスタンスが作成され、指定されたメソッドが実行されます。
479-
なお、メソッド引数にはMapperメソッドの引数に渡したオブジェクトに加え、<code>ProviderContext</code>(MyBatis 3.4.5以降で利用可能)を介して「Mapperインタフェースの型」と「Mapperメソッド」を渡すことができます。(MyBatis 3.4以降では、複数の引数を渡すことができます)
479+
なお、メソッド引数にはMapperメソッドの引数に渡したオブジェクトに加え、<code>ProviderContext</code>(MyBatis 3.4.5以降で利用可能)を介して「Mapperインタフェースの型」「Mapperメソッド」「データベースID」を渡すことができます。(MyBatis 3.4以降では、複数の引数を渡すことができます)
480480
キー: <code>type</code>, <code>method</code>. <code>type</code> にはクラスオブジェクト、<code>method</code> にはメソッド名を指定します
481481
(MyBatis 3.5.1以降では、<code>method</code> 属性を省略することができます。その際MyBatisは、<code>ProviderMethodResolver</code> インタフェースを介して対象メソッドの解決を試み、
482482
対象メソッドが解決できない場合は、<code>provideSql</code>という名前のメソッドを代替メソッドとして利用します)。

‎src/site/ko/xdoc/java-api.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -598,7 +598,7 @@ try (SqlSession session = sqlSessionFactory.openSession()) {
598598
</td>
599599
<td>실행시 SQL 을 리턴할 클래스 과 메소드명을 명시하도록 해주는 대체수단의 애노테이션이다 (Since 3.4.6, you can specify the <code>CharSequence</code> instead of <code>String</code> as a method return type).
600600
매핑된 구문을 실행할 때 마이바티스는 클래스의 인스턴스를 만들고 메소드를 실행한다.
601-
Mapper 메서드의 인수인 "Mapper interface type" 과 <code>ProviderContext</code>(Mybatis 3.4.5 부터) 를 이용한 "Mapper method" 로 전달 된 객체를 메서드 매개변수로 전달할 수 있다.(마이바티스 3.4이상에서는 복수 파라미터를 허용한다.)
601+
Mapper 메서드의 인수인 "Mapper interface type" and "Database ID" 과 <code>ProviderContext</code>(Mybatis 3.4.5 부터) 를 이용한 "Mapper method" 로 전달 된 객체를 메서드 매개변수로 전달할 수 있다.(마이바티스 3.4이상에서는 복수 파라미터를 허용한다.)
602602
사용가능한 속성들 : type, method.
603603
type 속성은 클래스.
604604
method 속성은 메소드명이다

‎src/site/xdoc/java-api.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -511,7 +511,7 @@ try (SqlSession session = sqlSessionFactory.openSession()) {
511511
a method name that will return the SQL to run at execution time
512512
(Since 3.4.6, you can specify the <code>CharSequence</code> instead of <code>String</code> as a method return type).
513513
Upon executing the mapped statement, MyBatis will instantiate the class, and execute the method, as specified by the provider.
514-
You can pass objects that passed to arguments of a mapper method, "Mapper interface type" and "Mapper method"
514+
You can pass objects that passed to arguments of a mapper method, "Mapper interface type", "Mapper method" and "Database ID"
515515
via the <code>ProviderContext</code>(available since MyBatis 3.4.5 or later) as method argument.
516516
(In MyBatis 3.4 or later, it's allow multiple parameters)
517517
Attributes: <code>type</code>, <code>method</code>. The <code>type</code> attribute is a class.

‎src/site/zh/xdoc/java-api.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -465,7 +465,7 @@ try (SqlSession session = sqlSessionFactory.openSession()) {
465465
<li><code>&lt;select&gt;</code></li>
466466
</ul>
467467
</td>
468-
       <td>允许构建动态 SQL。这些备选的 SQL 注解允许你指定类名和返回在运行时执行的 SQL 语句的方法。（自从MyBatis 3.4.6开始，你可以用 <code>CharSequence</code> 代替 <code>String</code> 来返回类型返回值了。）当执行映射语句的时候，MyBatis 会实例化类并执行方法，类和方法就是填入了注解的值。你可以把已经传递给映射方法了的对象作为参数，"Mapper interface type" 和 "Mapper method" 会经过 <code>ProviderContext</code> （仅在MyBatis 3.4.5及以上支持）作为参数值。（MyBatis 3.4及以上的版本，支持多参数传入）
468+
       <td>允许构建动态 SQL。这些备选的 SQL 注解允许你指定类名和返回在运行时执行的 SQL 语句的方法。（自从MyBatis 3.4.6开始，你可以用 <code>CharSequence</code> 代替 <code>String</code> 来返回类型返回值了。）当执行映射语句的时候，MyBatis 会实例化类并执行方法，类和方法就是填入了注解的值。你可以把已经传递给映射方法了的对象作为参数，"Mapper interface type" 和 "Mapper method" and "Database ID" 会经过 <code>ProviderContext</code> （仅在MyBatis 3.4.5及以上支持）作为参数值。（MyBatis 3.4及以上的版本，支持多参数传入）
469469
属性有： <code>type</code>, <code>method</code>。
470470
<code>type</code> 属性需填入类。
471471
<code>method</code> 需填入该类定义了的方法名

‎src/test/java/org/apache/ibatis/submitted/sqlprovider/SqlProviderTest.java‎

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@
4545
class SqlProviderTest {
4646

4747
private static SqlSessionFactory sqlSessionFactory;
48+
private static SqlSessionFactory sqlSessionFactoryForDerby;
4849

4950
@BeforeAll
5051
static void setUp() throws Exception {
@@ -53,11 +54,18 @@ static void setUp() throws Exception {
5354
.getResourceAsReader("org/apache/ibatis/submitted/sqlprovider/mybatis-config.xml")) {
5455
sqlSessionFactory = new SqlSessionFactoryBuilder().build(reader);
5556
sqlSessionFactory.getConfiguration().addMapper(StaticMethodSqlProviderMapper.class);
57+
sqlSessionFactory.getConfiguration().addMapper(DatabaseIdMapper.class);
5658
}
57-
5859
// populate in-memory database
5960
BaseDataTest.runScript(sqlSessionFactory.getConfiguration().getEnvironment().getDataSource(),
6061
"org/apache/ibatis/submitted/sqlprovider/CreateDB.sql");
62+
63+
// create a SqlSessionFactory
64+
try (Reader reader = Resources
65+
.getResourceAsReader("org/apache/ibatis/submitted/sqlprovider/mybatis-config.xml")) {
66+
sqlSessionFactoryForDerby = new SqlSessionFactoryBuilder().build(reader, "development-derby");
67+
sqlSessionFactoryForDerby.getConfiguration().addMapper(DatabaseIdMapper.class);
68+
}
6169
}
6270

6371
// Test for list
@@ -597,4 +605,31 @@ public void mapperGetByEntity() {
597605
}
598606
}
599607

608+
@Test
609+
void shouldPassedDatabaseIdToProviderMethod() {
610+
try (SqlSession sqlSession = sqlSessionFactory.openSession()){
611+
DatabaseIdMapper mapper = sqlSession.getMapper(DatabaseIdMapper.class);
612+
assertEquals("hsql", mapper.selectDatabaseId());
613+
}
614+
try (SqlSession sqlSession = sqlSessionFactoryForDerby.openSession()){
615+
DatabaseIdMapper mapper = sqlSession.getMapper(DatabaseIdMapper.class);
616+
assertEquals("derby", mapper.selectDatabaseId());
617+
}
618+
}
619+
620+
interface DatabaseIdMapper {
621+
@SelectProvider(type = SqlProvider.class)
622+
String selectDatabaseId();
623+
624+
class SqlProvider {
625+
public static String provideSql(ProviderContext context) {
626+
if ("hsql".equals(context.getDatabaseId())) {
627+
return "SELECT '" + context.getDatabaseId() + "' FROM INFORMATION_SCHEMA.SYSTEM_USERS";
628+
} else {
629+
return "SELECT '" + context.getDatabaseId() + "' FROM SYSIBM.SYSDUMMY1";
630+
}
631+
}
632+
}
633+
}
634+
600635
}

‎src/test/java/org/apache/ibatis/submitted/sqlprovider/mybatis-config.xml‎

Lines changed: 14 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-2017 the original author or authors.
4+
Copyright 2009-2019 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.
@@ -38,8 +38,21 @@
3838
<property name="username" value="sa" />
3939
</dataSource>
4040
</environment>
41+
<environment id="development-derby">
42+
<transactionManager type="JDBC" />
43+
<dataSource type="UNPOOLED">
44+
<property name="driver" value="org.apache.derby.jdbc.EmbeddedDriver" />
45+
<property name="url" value="jdbc:derby:target/derby/sqlprovider;create=true" />
46+
<property name="username" value="" />
47+
</dataSource>
48+
</environment>
4149
</environments>
4250

51+
<databaseIdProvider type="DB_VENDOR">
52+
<property name="HSQL Database Engine" value="hsql"/>
53+
<property name="Apache Derby" value="derby"/>
54+
</databaseIdProvider>
55+
4356
<mappers>
4457
<mapper class="org.apache.ibatis.submitted.sqlprovider.Mapper" />
4558
</mappers>

0 commit comments

Comments
 (0)