跳到主要内容

@Query 注解

注解说明​

用来标记在接口方法上，它接受一个字符串参数或字符串数组来表示执行一个可以返回结果集的查询语句。

信息

如果传入的是一个字符串数组，它们会被连接起来，并且中间用一个空格隔开。
通过字符串数组以合理阅读方式来管理SQL。

示例：查询用户列表
@SimpleMapper
public interface UserMapper {
    @Query("select * from users where id > #{id}")    // 1. 定义 SQL 语句
    List<User> listUsers(@Param("id") long searchId); // 2. id 为参数名，User 为返回类型
}

分页查询​

当标有 @Query 注解的方法参数中通过增加 Page 分页参数对象就可支持分页查询（分页参数可以出现在方法参数的任意位置）。

使用 Page 参数实现分页查询
@SimpleMapper
public interface UserMapper {
    @Query("select * from users where id > #{id}")
    List<User> listUsers(@Param("id") long searchId, Page page);
}
在分页查询中使用 PageResult 接收分页结果
@SimpleMapper
public interface UserMapper {
    @Query("select * from users where id > #{id}")
    PageResult<User> listUsers(@Param("id") long searchId, Page page);
}
  • PageResult 分页结果中还会包含 原始分页信息、总记录数、总页数。

属性清单​

属性名描述
value必选 将要被执行的查询语句。
statementType可选 表示查询类型，表示 JDBC 查询使用何种方式。默认值为 PREPARED
- STATEMENT 对应 java.sql.Statement
- PREPARED 对应 java.sql.PreparedStatement
- CALLABLE 对应 java.sql.CallableStatement
timeout可选 通过设置一个大于 0 时会被设置到 java.sql.Statement.setQueryTimeout(int) 可以让查询在执行时候设置一个超时时间，单位是秒，默认值为 -1
fetchSize可选 通过设置一个大于 0 时会被设置到 java.sql.Statement.setFetchSize(int)，用于为 JDBC 驱动程序提供一个提示。它提示此查询生成的 ResultSet 对象需要更多行时应该从数据库获取的行数。默认值是 256
resultSetType可选 当通过 java.sql.Connection 创建查询 statement 时候，该值决定了 resultSetType 参数的具体值。
- 可选值列表： FORWARD_ONLY、SCROLL_INSENSITIVE、SCROLL_SENSITIVE 和 DEFAULT。默认值为 DEFAULT 相当于未设置。
- statementType 为 STATEMENT 时对应 java.sql.Connection.createStatement(int, int) 方法第一个参数。
- statementType 为 PREPARED 时对应 java.sql.Connection.prepareStatement(java.lang.String, int, int)方法第二个参数。
- statementType 为 CALLABLE 时对应 java.sql.Connection..prepareCall(java.lang.String, int, int)方法第二个参数。
resultSetExtractor可选 可为该方法配置一个 ResultSetExtractor 对象用于结果集处理（如果配置了 bindOut 那么该配置将会失效）
resultRowCallback可选 可为该方法配置一个 RowCallbackHandler 对象用于结果集处理（如果配置了 bindOut 那么该配置将会失效）
resultRowMapper可选 可为该方法配置一个 RowMapper 对象用于结果集处理（如果配置了 bindOut 那么该配置将会失效）
bindOut可选 当 Query 中使用了 多值 或者 存储过程调用，使用 bindOut 参数可以绑定其中的输出参数。
请注意：一旦使用了该参数那么接口返回值类型必须为 Map<String,Object> 类型。