Могу ли я использовать MyBatis для генерации динамического SQL без его выполнения?

Ответ 1

Хотя MyBatis был разработан для выполнения запроса после его сборки, вы можете использовать его конфигурацию и немного "внутренних знаний", чтобы добраться до того, что вам нужно.

MyBatis - очень приятная инфраструктура, к сожалению, ей не хватает документации, поэтому исходный код - ваш друг. Если вы копаетесь, вы должны столкнуться с этими классами: org.apache.ibatis.mapping.MappedStatement и org.apache.ibatis.mapping.BoundSql, которые являются ключевыми игроками в построении динамического SQL. Вот пример использования:

Таблица MySQL user с этими данными:

name    login
-----   -----
Andy    a
Barry   b
Cris    c

user класс:

package pack.test;
public class User {
    private String name;
    private String login;
    // getters and setters ommited
}

UserService интерфейс:

package pack.test;
public interface UserService {
    // using a different sort of parameter to show some dynamic SQL
    public User getUser(int loginNumber);
}

UserService.xml файл карты:

<mapper namespace="pack.test.UserService">
    <select id="getUser" resultType="pack.test.User" parameterType="int">
       <!-- dynamic change of parameter from int index to login string -->
       select * from user where login = <choose>
                                           <when test="_parameter == 1">'a'</when>
                                           <when test="_parameter == 2">'b'</when>
                                           <otherwise>'c'</otherwise>
                                        </choose>   
    </select>
</mapper>

sqlmap-config.file:

<configuration>
    <settings>
        <setting name="lazyLoadingEnabled" value="false" />
    </settings>
    <environments default="development"> 
        <environment id="development"> 
            <transactionManager type="JDBC"/> 
            <dataSource type="POOLED"> 
                <property name="driver" value="com.mysql.jdbc.Driver"/> 
                <property name="url" value="jdbc:mysql://localhost/test"/> 
                <property name="username" value="..."/> 
                <property name="password" value="..."/> 
            </dataSource> 
        </environment> 
      </environments>
    <mappers>
        <mapper resource="pack/test/UserService.xml"/>
    </mappers>
</configuration>

AppTester, чтобы показать результат:

package pack.test;

import java.io.Reader;
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.mapping.BoundSql;
import org.apache.ibatis.mapping.MappedStatement;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;

public class AppTester {
    private static String CONFIGURATION_FILE = "sqlmap-config.xml";

    public static void main(String[] args) throws Exception {
        Reader reader = null;
        SqlSession session = null;
        try {

            reader = Resources.getResourceAsReader(CONFIGURATION_FILE);
            session = new SqlSessionFactoryBuilder().build(reader).openSession();
            UserService userService = session.getMapper(UserService.class);

            // three users retreived from index
            for (int i = 1; i <= 3; i++) {
                User user = userService.getUser(i);
                System.out.println("Retreived user: " + user.getName() + " " + user.getLogin());

                // must mimic the internal statement key for the mapper and method you are calling
                MappedStatement ms = session.getConfiguration().getMappedStatement(UserService.class.getName() + ".getUser");
                BoundSql boundSql = ms.getBoundSql(i); // parameter for the SQL statement
                System.out.println("SQL used: " + boundSql.getSql());
                System.out.println();
            }

        } finally {
            if (reader != null) {
                reader.close();
            }
            if (session != null) {
                session.close();
            }
        }
    }
}

И результат:

Retreived user: Andy a
SQL used: select * from user where login =  'a'

Retreived user: Barry b
SQL used: select * from user where login =  'b'

Retreived user: Cris c
SQL used: select * from user where login =  'c'

Ответ 2

Всем известно, как использовать BoundSql.getSql(), чтобы получить строку с параметризованными запросами из MyBatis, например:

// get parameterized query
MappedStatement ms = configuration.getMappedStatement("MyMappedStatementId");
BoundSql boundSql = ms.getBoundSql(parameters);
System.out.println("SQL" + boundSql.getSql());
// SELECT species FROM animal WHERE name IN (?, ?) or id = ?

Но теперь вам нужна другая половина уравнения, список значений, соответствующих вопросительным знакам:

// get parameters
List<ParameterMapping> boundParams = boundSql.getParameterMappings();
String paramString = "";
for(ParameterMapping param : boundParams) {
    paramString += boundSql.getAdditionalParameter(param.getProperty()) + ";";
}
System.out.println("params:" + paramString);
// "Spot;Fluffy;42;"

Теперь вы можете сериализовать его, чтобы отправить в другое место для запуска, или вы можете распечатать его в журнале, чтобы вы могли сшить их вместе и запустить запрос вручную.

* не проверен код, могут быть проблемы с небольшим типом или тому подобное

Ответ 3

Просто добавьте правильному ответу Богдана: вам нужно передать JavaBean на getBoundSql() с помощью getter для параметров интерфейса, если у вас интерфейс имеет более сложную подпись.

Предположим, вы хотите запросить пользователя на основе номера входа и/или имени пользователя. Ваш интерфейс может выглядеть так:

package pack.test;
public interface UserService {
    // using a different sort of parameter to show some dynamic SQL
    public User getUser(@Param("number") int loginNumber, @Param("name") String name);
}

Я оставляю код Mapper, поскольку он не имеет отношения к этому обсуждению, но ваш код в AppTester должен стать:

[...]
final String name = "Andy";
User user = userService.getUser(i, name);
System.out.println("Retreived user: " + user.getName() + " " + user.getLogin());

// must mimic the internal statement key for the mapper and method you are calling
MappedStatement ms  = session.getConfiguration().getMappedStatement(UserService.class.getName() + ".getUser");
BoundSql boundSql = ms.getBoundSql(new Object() {
   // provide getters matching the @Param in the interface declaration
   public Object getNumber() {
     return i;
   }
   public Object getName() {
     return name;
   }

});
System.out.println("SQL used: " + boundSql.getSql());
System.out.println();
[...]