Commons DbUtils 源码阅读八

  距离DbUtils组件源码七的解读已经有大半个月了，今天让我们来继续AbstractKeyedHandler<K,V>和AbstractListHandler<T>及其子类的阅读解析，OK。come on!

  1)AbstractKeyedHandler<K,V> :该类返回一个Map集合，它会将ResultSet的每行转换为objects（Vs：即返回Map的value），然后在指定的keys（Ks：即返回Map的key）将转换后的objects存储在该Map中，下面我们来看看这个类

 

    /**
     * 将ResultSet的每行转换为一个Map,
     * 然后存储在以ResultSet.getObject(key)获取的值为key的Map中
     * @param rs 待处理的ResultSet实例.
     * @return 返回一个不为null的Map 
     */
    public Map<K,V> handle(ResultSet rs) throws SQLException {
        Map<K,V> result = createMap();
        while (rs.next()) {
            result.put(createKey(rs), createRow(rs));
        }
        return result;
    }

    /**
     * createMap由handle()方法调用并创建一个Map，然后将记录存入其中。
     * 这个实现返回一个HashMap实例
     * @return 存储记录的Map实例
     */
    protected Map<K,V> createMap() {
        return new HashMap<K,V>();
    }

    /**
     * createKey由handle()方法调用，
     * 获取当前ResultSet行的指定Key值
     * @param rs 创建key的ResultSet
     * @return K 从指定的键的列名/列下标获取Map主键值
     */
    protected abstract K createKey(ResultSet rs) throws SQLException;

    /**
     * createRow由handle()方法调用，
     * 并在返回的对象中存储当前ResultSet行.
     * @param rs 用于创建行的ResultSet实例
     * @return V 当前行创建的对象
     */
    protected abstract V createRow(ResultSet rs) throws SQLException;

   我们看看对ResultSet集合的处理方法handle(ResultSet rs)：首先通过createMap()方法创建一个空的Map变量result，然后通过while循环来对ResultSet进行解析，然后分别通过调用抽象方法createKey以及createRow来创建值，以达到解析ResultSet的目的。OK，很有趣对吧，到底怎么个解析法呢，让我们继续它的子类KeyedHandler:

   1-1)KeyedHandler :

    我想我绝对有必要把这个类的完整签名copy一份：public class KeyedHandler extends AbstractKeyedHandler<Object, Map<String,Object>>

   Look at this，父类AbstractKeyedHandler的泛型类型，这样给我们一个很直观的对象返回类型，一个Map，它的值还是一个Map，即Map中的Maps？！Maps我们或许会猜到是结果集，那么，Map的主键会是？？？Yes，你太聪明了，估计你肯定会想到了，指定集合中的一个值，即对应数据库中的某一属性值，也许是id，随你高兴喽，当然，最好唯一，Map主键可最好不要重复，如果重复，最好值是一样的，不然会出现值覆盖的情况噢！看看KeyedHandler类的主要实现代码如下：

 

    /**
     * 当调用handle()方法时，获取到当前ResultSet行的键值,
     * 这个实现返回指定键名或者索引的ResultSet.getObject()值 
     */
    @Override
    protected Object createKey(ResultSet rs) throws SQLException {
        return (columnName == null) ? rs.getObject(columnIndex) : rs
                .getObject(columnName);
    }

    /**
     * 存储当前的ResultSet在一些对象里。
     * 返回一个不区分大小写列名为键的Map集合
     * 即：map.get("COL")/map.get("col")返回相同的值.
     */
    @Override
    protected Map<String,Object> createRow(ResultSet rs) throws SQLException {
        return this.convert.toMap(rs);
    }

    所有的一切，都一目了然了，通过指定ResultSet集合中的字段的下标索引或列值，来得到返回Map的key值，该类默认的下标为1，Map的值通过this.convert.toMap返回，默认的convert为BasicRowProcessor,不说了。 

  2）AbstractListHandler<T> ：该类简化了ResultSetHandler将ResultSet转换为List的开发。我们知道ResultHandler的实现类，必须实现的方法handle(ResultSet rs)，现对该类的此方法进行详细的解析：

 

    public List<T> handle(ResultSet rs) throws SQLException {
        List<T> rows = new ArrayList<T>();
        while (rs.next()) {
            rows.add(this.handleRow(rs));
        }
        return rows;
    }

    该方法用于将ResultSet转换为一个List集合。它使用handleRow(ResultSet)方法,将单个行的结果转换为T类型的对象，现看看handleRow方法：

 

protected abstract T handleRow(ResultSet rs) throws SQLException

   抽象方法，它的重写方法应该处理ResultSet的每行记录，并转换为T类型的对象，我们可以联想到之前学习的各个ResultSet单行的处理类，我们自己也可以组织处理一下对吧，呵呵，例如：BeanHandler<T>、MapHandler等等，来看看DbUtils组件提供的几种实现。

  2-1）ArrayListHandler ：我们拜读的第一个AbstractListHandler的子类，它用于将每一行的ResultSet结果集转换为元素为Object[]的List集合。默认的处理类当然还是BasicRowProcessor类实例，现看看handleRow(ResultSet rs)的重载方法

 

    public Object[] handle(ResultSet rs) throws SQLException {
        return rs.next() ? this.convert.toArray(rs) : null;
    }

 将ResultSet的每行转换为一个Object[]数组并返回，如果为空则返回null。很简单对吧，呵呵~让我们继续下一个吧：

 2-2）ColumnListHandler ：该实现类通过指定一个下标或者列名，从ResultSet中取出，并将结果集存储到List中返回。好吧，这个类的实现我们直接上核心代码吧:

 

   protected Object handleRow(ResultSet rs) throws SQLException {
        if (this.columnName == null) {
            return rs.getObject(this.columnIndex);
        } else {
            return rs.getObject(this.columnName);
        }
   }

 看到了吧，随意指定列号或者属性名就可得到对应的值，如果你不指定，默认获取下标为1的列值。

 2-3）MapListHandler ：正如你猜想到的，将ResultSet结果集转换为Map的List集合返回

 

    protected Map<String,Object> handleRow(ResultSet rs) throws SQLException {
        return this.convert.toMap(rs);
    }

 至此，AbstractKeyedHandler<K,V>和AbstractListHandler<T>及其子类都已解析阅读完毕了。很明显，都是些理论上的阐述，没有什么比敲些应用测试代码更有说服力了，在之前的解析阅读中也有提及到些零散的代码测试程序。所以呢，在下一篇中，把之前的代码整合以及新增些测试代码来看看DbUtils组件对ResultSet的解析转换情况。