Kann ich verwenden MyBatis zu generieren Dynamische SQL-ohne es auszuführen?

Obwohl MyBatis wurde entwickelt, um die Abfrage ausführen, nachdem Sie baut, können Sie Gebrauch machen von es, die Konfiguration und ein wenig "Insider-wissen" zu bekommen, was Sie brauchen.

MyBatis ist ein sehr schöner Rahmen, leider fehlt es an den Dokumentationen Seite, so dass der source-code ist Ihr Freund. Wenn Sie Graben, um, sollten Sie die Beule in folgenden Klassen: org.apache.ibatis.mapping.MappedStatement und org.apache.ibatis.mapping.BoundSql Schlüssel die Spieler werden in die dynamic SQL. Hier ist ein basic Beispiel:

MySQL-Tabelle user mit diesen Daten in es:

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

User Klasse:

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

UserService Schnittstelle:

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-Datei:

<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 zu zeigen das Ergebnis:

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();
            }
        }
    }
}

Und das Ergebnis:

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'

InformationsquelleAutor Bogdan

Nur um Bogdan die richtige Antwort: Sie brauchen, um passieren eine JavaBean zu getBoundSql() mit getter ' s für die Schnittstellen-Parameter, wenn Sie die Schnittstelle hat eine komplexere Signatur.

Nehmen wir an, Sie möchten eine Abfrage der Benutzer basierend auf der login-Nummer und/oder den Benutzernamen. Dein interface könnte wie folgt Aussehen:

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);
}

Ich gehe aus der Mapper-code, da es irrelevant für diese Diskussion, aber dein code in AppTester werden sollte:

[...]
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's in the interface declaration
   public Object getNumber() {
     return i;
   }
   public Object getName() {
     return name;
   }

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

InformationsquelleAutor Stefan Haberl