java - 带有 Sql Builder 和注释的 Spring 中的 MyBatis

Question

我正在 Spring 中使用 MyBatis 进行一些测试，我决定测试两种使用注释进行 sql 查询的方法，但其中一种方法不起作用，我需要一些帮助来理解问题。

它正在工作:

@Select("<script> "
    + "SELECT * FROM user "
    + "<where>"
    + "<if test=\"username != null\"> OR username LIKE '%' #{username} '%' </if>"
    + "<if test=\"name != null\"> OR name LIKE '%' #{name} '%' </if>"
    + "<if test=\"email != null\"> OR email LIKE '%' #{email} '%' </if>"
    + "</where>"
    + " </script>")
public List<User> findByDynamicFilter(@Param("username") String username, 
        @Param("name") String name, @Param("email") String email);

不起作用的那个:

映射器

@SelectProvider(type = UserSqlBuilder.class, method = "buildFindByDynamicFilter")
public List<User> findByDynamicFilter(@Param("username") String username, 
        @Param("name") String name, @Param("email") String email);

类 SqlBuilder

public class UserSqlBuilder {

    public static String buildFindByDynamicFilter(final String username, final String name, final String email) {
        return new SQL() {
            {
                SELECT("*");
                FROM("user");
                if (name != null) {
                    OR().WHERE("name like #{name} || '%'");
                }
                if (username != null) {
                    OR().WHERE("username like #{username}");
                }
                if (email != null) {
                    OR().WHERE("email like #{email} || '%'");
                }
            }
        }.toString();
    }

}

错误:

2018-12-12 19:47:12.935 ERROR 7454 --- [nio-8080-exec-1] o.a.c.c.C.[.[.[/].[dispatcherServlet] : Servlet.service() for servlet [dispatcherServlet] in context with path [] threw exception [Request processing failed; nested exception is org.mybatis.spring.MyBatisSystemException: nested exception is org.apache.ibatis.builder.BuilderException: Error invoking SqlProvider method (br.com.andre.springmvcuser.mapper.sqlbuilder.UserSqlBuilder.buildFindByDynamicFilter). Cause: org.apache.ibatis.binding.BindingException: Parameter 'arg0' not found. Available parameters are [name, param3, param1, email, username, param2]] with root cause

org.apache.ibatis.binding.BindingException: Parameter 'arg0' not found. Available parameters are [name, param3, param1, email, username, param2] at org.apache.ibatis.binding.MapperMethod$ParamMap.get(MapperMethod.java:204) ~[mybatis-3.4.6.jar:3.4.6] at org.apache.ibatis.builder.annotation.ProviderSqlSource.extractProviderMethodArguments(ProviderSqlSource.java:156) ~[mybatis-3.4.6.jar:3.4.6] at org.apache.ibatis.builder.annotation.ProviderSqlSource.createSqlSource(ProviderSqlSource.java:120) ~[mybatis-3.4.6.jar:3.4.6] at org.apache.ibatis.builder.annotation.ProviderSqlSource.getBoundSql(ProviderSqlSource.java:102) ~[mybatis-3.4.6.jar:3.4.6] at org.apache.ibatis.mapping.MappedStatement.getBoundSql(MappedStatement.java:292) ~[mybatis-3.4.6.jar:3.4.6] at org.apache.ibatis.executor.CachingExecutor.query(CachingExecutor.java:81) ~[mybatis-3.4.6.jar:3.4.6] at org.apache.ibatis.session.defaults.DefaultSqlSession.selectList(DefaultSqlSession.java:148) ~[mybatis-3.4.6.jar:3.4.6] at org.apache.ibatis.session.defaults.DefaultSqlSession.selectList(DefaultSqlSession.java:141) ~[mybatis-3.4.6.jar:3.4.6] at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method) ~[na:1.8.0_191] at sun.reflect .....

这些参数是什么 [name, param3, param1, email, username, param2]] ？

我做SqlBuilder的方式还需要别的吗？

Answer 1

出现这个问题是因为mybatis无法将mapper方法的参数传递给builder。

您要么需要在构建器中注释参数:

public static String buildFindByDynamicFilter(
   final @Param("username") String username,
   final @Param("name") String name,
   final @Param("email") String email) {

或从构建器方法签名中删除未使用的参数(在您的情况下，所有参数都可以删除，因为构建器中没有使用它们):

public static String buildFindByDynamicFilter() {
    ...
} 

或include method parameter names放入已编译的类中，并确保构建器方法中的参数与映射器方法中的参数命名方式相同。

构建查询的Mybatis java API(SELECT、FROM、WHERE等函数)本身不需要参数。构建器的目的是生成 sql 查询文本。当 mybatis 从构建器(或 @Select 注释或 xml 映射器)检索查询文本并使用 JDBC 准备语句执行查询时，稍后会发生参数绑定(bind)。

[name, param3, param1, email, username, param2] 是映射器方法的参数。每个参数都在两个键下可用，第一个是映射器方法参数上的 @Param 注释的值，第二个只是参数的序号，前缀为 param(索引从零开始，第一个被跳过，因为映射器方法的第一个参数是隐式的 this)。 Mybatis 试图通过可用参数列表显示合理的错误消息，但如果没有可用的方法参数信息，则会令人困惑。

如果没有 @Param 注解存在，在构建器中使用反射来获取方法参数。如果方法参数信息未包含在 -parameters javac 选项中，则参数名称为 arg0、arg1 等。