queryforlist详解

发布时间：2023-05-18

一、queryforlist概述

queryforlist是Spring框架中最常用的JdbcTemplate查询方法之一，它可以将查询结果集封装为List集合，每个元素是一条记录对应的JavaBean对象。 这个方法的核心是SQL语句的编写和结果集到JavaBean的映射转换，通过这个方法可以进行非常复杂的查询操作，应用场景非常广泛。

二、queryforlist参数详解

queryforlist方法定义如下:

public List<T> queryForList(String sql, Object[] args, RowMapper<T> rowMapper) throws DataAccessException;

它有三个参数:

  • sql： 要执行的SQL查询语句，可以是任何合法的SQL语句，包括存储过程和函数。
  • args： 查询语句的参数，是一个数组类型，它会按照数组的顺序替换SQL语句中的占位符?，如果没有占位符，可以传入一个空的数组。
  • rowMapper： 结果集到JavaBean的映射转换器，它将结果集中的每一条记录映射成一个JavaBean对象，可以使用Lambda表达式或者匿名内部类的方式完成。

三、queryforlist使用示例

下面是一个基本的使用示例，查询t_user表中的所有数据并映射成User对象：

// 定义sql语句
String sql = "select id, name, age from t_user";
// 执行查询操作
List<User> userList = jdbcTemplate.queryForList(sql, new Object[]{}, (resultSet, i) -> {
    User user = new User();
    user.setId(resultSet.getLong("id"));
    user.setName(resultSet.getString("name"));
    user.setAge(resultSet.getInt("age"));
    return user;
});

在这个示例中：

  • 第一行定义了要查询的SQL语句，包括字段名和表名。
  • 第二行调用了JdbcTemplate的queryForList方法，传入了三个参数：SQL语句、查询参数数组和结果集映射转换器。
  • 第三个参数是一个Lambda表达式，它接收了两个参数：ResultSet和i，其中ResultSet是查询结果集对象，i是当前记录行的编号。 Lambda表达式内部创建了一个User对象，将查询结果集映射成User对象，并返回这个对象，最后将User对象添加到一个List<User>中。

四、queryforlist的更多使用场景和技巧

除了基本的查询操作，queryforlist还有许多高级的用法和技巧。

1、带参数的查询操作

带参数的查询操作可以通过使用占位符?和参数数组args来实现。例如：

String sql = "select * from t_user where name = ?";
List<User> userList = jdbcTemplate.queryForList(sql, new Object[]{"张三"}, (resultSet, i) -> {
    User user = new User();
    user.setId(resultSet.getLong("id"));
    user.setName(resultSet.getString("name"));
    user.setAge(resultSet.getInt("age"));
    return user;
});

在这个示例中，使用了一个占位符?来表示参数，它对应的值是一个数组{"张三"}，这个数组会按照顺序依次替换占位符。 占位符?也可以表示多个参数，例如：

String sql = "select * from t_user where name = ? and age = ?";
List<User> userList = jdbcTemplate.queryForList(sql, new Object[]{"张三", 30}, (resultSet, i) -> {
    User user = new User();
    user.setId(resultSet.getLong("id"));
    user.setName(resultSet.getString("name"));
    user.setAge(resultSet.getInt("age"));
    return user;
});

在这个示例中，使用了两个占位符?来表示两个参数，它们分别是"张三"和30。

2、分页查询操作

分页查询是应用中经常使用的一种查询方式，通过设置查询语句中的limit子句和查询参数中的分页参数值来实现。例如：

String sql = "select * from t_user limit ?, ?";
List<User> userList = jdbcTemplate.queryForList(sql, new Object[]{0, 10}, (resultSet, i) -> {
    User user = new User();
    user.setId(resultSet.getLong("id"));
    user.setName(resultSet.getString("name"));
    user.setAge(resultSet.getInt("age"));
    return user;
});

在这个示例中，使用了limit子句来表示返回结果的起始位置和返回的记录数，它们分别是0和10。

3、返回指定类型的结果集

除了返回List<T>类型之外，queryforlist还可以返回其他类型的结果集，包括数组、集合和Map等。例如：

String sql = "select id, name from t_user";
List<Map<String, Object>> resultList = jdbcTemplate.queryForList(sql);

在这个示例中，使用了默认的结果集映射转换器，它将每条查询记录映射为一个Map<String, Object>类型的对象，并将这些Map对象添加到一个List<Map<String, Object>>中。

4、批量操作

queryforlist还支持批量操作，它可以使用BatchPreparedStatementSetter接口来实现。例如：

String sql = "insert into t_user (id, name, age) values (?, ?, ?)";
List<User> userList = new ArrayList<>();
// 添加一些User对象到userList中
jdbcTemplate.batchUpdate(sql, new BatchPreparedStatementSetter() {
    @Override
    public void setValues(PreparedStatement preparedStatement, int i) throws SQLException {
        preparedStatement.setLong(1, userList.get(i).getId());
        preparedStatement.setString(2, userList.get(i).getName());
        preparedStatement.setInt(3, userList.get(i).getAge());
    }
    @Override
    public int getBatchSize() {
        return userList.size();
    }
});

在这个示例中，使用了batchUpdate方法来批量执行SQL语句，它需要两个参数：SQL语句和BatchPreparedStatementSetter对象。BatchPreparedStatementSetter是一个接口，它有两个方法：setValues和getBatchSize。setValues会被调用多次，每次传入PreparedStatement对象和当前操作的索引，我们可以在这个方法中设置PreparedStatement对象的参数；getBatchSize方法则返回要执行的操作数量。

5、更多技巧

最后，我们介绍一些queryforlist的更多技巧：

  • 使用BeanPropertyRowMapper实现结果集到JavaBean的自动映射转换。例如： 
    String sql = "select * from t_user";
List<User> userList = jdbcTemplate.query(sql, new BeanPropertyRowMapper<>(User.class));
  • 使用JpaResultMapper实现结果集到Jpa实体类的自动映射转换。例如： 
    String sql = "select id, name from t_user";
List<User> userList = (List<User>)jdbcTemplate.query(sql, new JpaResultMapper(User.class));
  • 使用ResultSetExtractor实现更复杂的结果集映射转换。例如： 
    String sql = "select * from t_user where id = ?";
User user = jdbcTemplate.query(sql, new Object[]{1}, new ResultSetExtractor<User>() {
    @Override
    public User extractData(ResultSet resultSet) throws SQLException, DataAccessException {
        User user = new User();
        if(resultSet.next()) {
            user.setId(resultSet.getLong("id"));
            user.setName(resultSet.getString("name"));
            user.setAge(resultSet.getInt("age"));
        }
        return user;
    }
});
推荐文章