java - 使用 MyBatis 映射输入和输出参数

Question

我正在学习如何使用 MyBatis .老实说，我非常喜欢这个框架。它易于使用，我对它很满意，因为我可以用它来使用我的 sql 命令:) 我使用 MyBatis 3.4.2 和 PostgreSQL 数据库。

例如，我喜欢在使用 @SelectKey 插入之前执行查询是多么容易注解。如果我在接口(interface)方法之前添加一些注释，数据映射就像这样:@Results({ @Result(property = "javaField", column = "database_field", javaType = TypeHandler.class) .

我不喜欢的(希望您能引导我走向正确的方向)如下:

---

(问题 1) 我有一些查询允许我使用空值和正常值，而无需任何额外的“if”java 语句来检查变量是否包含空值。它们看起来像这样:

SELECT * FROM table
WHERE key_name = ? AND ((? IS NULL AND user_id IS NULL) OR User_id = ?) 

对于 JDBC，我需要执行以下操作:

stmt = connection.prepareStatement(query);
stmt.setString(1, "key");
stmt.setString(2, userId);
stmt.setString(3, userId);

如您所见，我需要传递两次 userId，因为这是 JDBC 的工作方式。老实说，我的期望是下面的代码可以与 MyBatis 一起使用，但不幸的是它不起作用。第三个参数还需要定义。

不知是否可以将此功能添加到MyBatis中。如果 MyBatis 可以自动绑定(bind)两次 userId 应该没问题，像这样:

@Select("SELECT * FROM table key_name = #{key} and ((#{userId} is null and user_id is null) OR user_id = #{userId})
SomeClass findByKeyAndUserId(String key, Long userId);

我实际做的解决方法如下。我讨厌它，因为它很棘手并且需要额外的 java“if”语句:

@Select("SELECT * FROM table WHERE key_name = #{key} AND COALESCE(user_id, -1) = #{userId}")
SomeClass findByKeyAndUserId(String key, Long userId);

userId = (userId == null) ? -1 : userId;
SomeClass abc = mapper.findByKeyAndUserId(key, userId);

我不知道用 MyBatis 管理这种情况的最佳实践是什么。请指导我。

---

(问题 2) @Select 情况下的映射.在映射具有相同结果类型的查询结果时，有什么方法可以避免重复代码？

第一个查询:

@Select("SELECT * FROM table WHERE ...")
@Results({
        @Result(property = "key", column = "key_name", javaType = String.class),
        @Result(property = "value", column = "key_value", javaType = String.class),
        @Result(property = "userId", column = "user_id", javaType = Long.class),
        @Result(property = "interval", column = "interval", javaType = Long.class),
        @Result(property = "description", column = "description", javaType = String.class),
        @Result(property = "status", column = "status", typeHandler = StatusTypeHandler.class)
})
SomeClass findByKeyAndUserId(@Param("key") String key, @Param("userId") Long userId);

第二个查询:

@Select("SELECT * FROM table WHERE <different conditions then before>")
@Results({
        <I need to add here the exact same code then before in query 1>
})
SomeClass findByKeyAndUserId(@Param("key") String key, @Param("userId") Long userId);

我能以某种方式重用与映射相关的代码吗？我需要添加映射，因为我对状态字段使用了特殊类型的处理程序。我使用基于注释的配置。

---

(第三期) @Param注解 我在文档中看不到任何关于 @Param 的内容注解。很难弄清楚为什么我的 java 参数没有正确绑定(bind)。最后我意识到 @Param我的代码中缺少注释。为什么官方文档中没有提到这一点？我做错了事@Param没必要用？

该代码工作正常:

SomeClass findByKeyAndUserId(@Param("key") String key, @Param("userId") Long userId);

这不起作用:

SomeClass findByKeyAndUserId(String key, Long userId);

---

更新(第 1 期)

我的第一个想法与 @blackwizard 提到的类似:“Mybatis 确实通过名称绑定(bind)参数，然后一次、两次、N 次，可能会被引用，它起作用了。 "

但这实际上并不能正常工作。如果 userId 不为空，它会起作用。如果它为空，我会得到一个从数据库返回的异常。我猜想 MyBatis 以错误的方式绑定(bind)了 null 值。也许这是一个错误。我不知道:(

异常(exception):

org.apache.ibatis.exceptions.PersistenceException: 
### Error querying database.  Cause: org.postgresql.util.PSQLException: ERROR: could not determine data type of parameter $2
### The error may exist in com/.../dao/TableDao.java (best guess)
### The error may involve ....dao.Table.findByKeyAndUserId-Inline
### The error occurred while setting parameters
### SQL: SELECT * FROM table WHERE key_name = ? AND (? IS NULL AND user_id IS NULL) OR user_id = ? AND status = 1
### Cause: org.postgresql.util.PSQLException: ERROR: could not determine data type of parameter $2

最后我找到了三种不同的解决方案。

(问题1:解决方案1)

我遵循了@blackwizard 提到的内容，我能够移动条件 userId = (userId == null) ? -1 : userId从java到MyBatis级别。而且还不错!正确的语法是:<if test='userId==null'><bind name='userId' value='-1'/></if> .

(问题 1:解决方案 2) 我回来的原因could not determine data type of parameter $2来自 postgres 的错误是因为在 null 值的情况下，JDBC 驱动程序无法确定参数的类型。因此，让我们手动定义它。

@Select("SELECT * FROM table "
        + "WHERE key_name = #{key} AND ((#{userId}::BIGINT IS NULL AND user_id IS NULL) OR user_id = #{userId})")
})
SomeClass findByKeyAndUserId(@Param("key") String key, @Param("userId") Long userId);

(问题 1:解决方案 3) 第二个解决方案取决于 PortgreSQL。以下解决方案完全独立于数据库。感谢@blackwizard 的精彩评论。

@Select("SELECT * FROM table "
        + "WHERE key_name = #{key} AND ((#{userId, jdbcType=BIGINT} IS NULL AND user_id IS NULL) OR user_id = #{userId})")
})
SomeClass findByKeyAndUserId(@Param("key") String key, @Param("userId") Long userId);

我个人更喜欢方案 3。它包含的附加代码较少。

Answer 1

问题 1:

命名参数:

@Select("SELECT * FROM table key_name = #{key} and ((#{userId} is null and user_id is null) OR user_id = #{userId}")
SomeClass findByKeyAndUserId(@Param("key") String key, @Param("userId") Long userId);

Mybatis 确实是按名称绑定(bind)参数，然后一次，两次，N 次，可能会被引用，就可以了。

您可以在 Mybatis 中执行 if:使用 XML 标记，虽然它并不是真的更好......无论如何，这是一个很好的技巧，您可能有一天会为其他目的重用。要在注释值中使用 XML 标记，该值必须嵌入到 <script> 中标记恰好位于字符串的开头和结尾。

@Select({"<script>",
         "<if 'userId==null'><bind name='userId' value='1'/></if>",
         "SELECT * FROM table WHERE key_name = #{key} ", 
         "AND COALESCE(user_id, -1) = #{userId}", 
         "</script>"})
SomeClass findByKeyAndUserId(@Param("key") String key, @Param("userId") Long userId);

您也可以使用 typeHandler 设置默认值，只需将其与参数一起使用:#{userId, typeHandler=CustomDefaultValueTypeHandler}

Edit: reply to additional question: 如果你想允许传递 null 值而不是处理默认值替换那么你必须给 Mybatis 一些关于假定的绑定(bind)参数类型的提示，因为它无法解析null 的实际类型，因为它不知道/看不到 Mapper 接口(interface)中的变量声明。所以:#{userId, javaType=int,jdbcType=NUMERIC} .这两个属性中只有一个可能就足够了。

Documentation状态:

Like the rest of MyBatis, the javaType can almost always be determined from the parameter object, unless that object is a HashMap. Then the javaType should be specified to ensure the correct TypeHandler is used.

NOTE The JDBC Type is required by JDBC for all nullable columns, if null is passed as a value. You can investigate this yourself by reading the JavaDocs for the PreparedStatement.setNull() method.

问题 2:您绝对不能重用/相互化您在注解中定义的内容。这不是因为Mybatis，而是注解。您必须在使用 @ResultMap 引用它们的 XML 中定义结果映射。 Documentation状态:

ResultMap   Method  N/A     This annotation is used to provide the id of a <resultMap> element in an XML mapper to a @Select or @SelectProvider annotation. This allows annotated selects to reuse resultmaps that are defined in XML. This annotation will override any @Results or @ConstructorArgs annotation if both are specified on an annotated select.

问题 3:我已经知道了 answered in your other question , @Param 注解具有将方便的参数列表转换为映射的效果，例如:

Map<String, Object> params = new HashMap<String, Object>();
params.put("key", key);
params.put("userId", userId);

我同意 Mybatis 文档可以做得更好，您会找到更多资源，例如 here .

然而，Mybatis documentation声明以下关于@Param注解

@Param  Parameter   N/A     If your mapper method takes multiple parameters, this annotation can be applied to a mapper method parameter to give each of them a name. Otherwise, multiple parameters will be named by their position prefixed with "param" (not including any RowBounds parameters). For example #{param1}, #{param2} etc. is the default. With @Param("person"), the parameter would be named
#{person}.