设计模式系列——迭代器模式

迭代器模式介绍

迭代器模式是行为模式之一，又称为（Cursor）模式。
迭代器模式源于对容器的访问，如List,Map等。
如果想对一个容器进行遍历操作，我们可以在容器内部定义遍历的方法，但这样对容器来说就承担了过多的功能，因为不仅要维护自身数据元素还要对外提供遍历的接口方法；如果我们自己实现，又会让容器的内部细节暴露。因此，迭代器模式应运而生，在访问者和容器类之间加个第三者——迭代器，很好地解决了上述弊端。
感谢《Android源码设计模式解析与实战》。

迭代器模式的定义

提供一种方法顺序访问一个容器对象中的各个元素，而又不需要暴露该对象的内部表示。

迭代器模式的使用场景

遍历一个容器对象时。

迭代器模式的UML类图

迭代器模式的UML类图.png

Iterator: 迭代器接口。
负责定义、访问和遍历元素的接口。
ConcreteIterator: 具体的迭代器类
实现迭代器接口，并记录当前遍历的位置。
Aggregate: 容器接口
负责操作元素和创建具体迭代器角色的接口。
ConcreteAggregate: 具体的容器类。
实现容器接口，创建具体迭代器角色。

根据UML类图可以得出一个迭代器模式的通用模板代码。如下：

迭代器接口

public interface Iterator<T> {
    /**
     * 是否还有下一个元素
     *
     * @return true 表示有，false表示没有
     */
    boolean hasNext();

    /**
     * 返回当前位置的元素并将位置移至下一位
     *
     * @return
     */
    T next();
}

具体迭代器类

public class ConcreteIterator<T> implements Iterator<T> {

    private List<T> list = new ArrayList<>();
    private int cursor = 0;

    public ConcreteIterator(List<T> list) {
        this.list = list;
    }

    @Override
    public boolean hasNext() {
        return cursor != list.size();
    }

    @Override
    public T next() {
        T obj = null;
        if (this.hasNext()) {
            obj = this.list.get(cursor++);
        }
        return obj;
    }
}

容器接口

public interface Aggregate<T> {
    /**
     * 添加一个元素
     *
     * @param obj
     */
    void add(T obj);

    /**
     * 移除一个元素
     *
     * @param obj
     */
    void remove(T obj);

    /**
     * 获取容器的迭代器
     *
     * @return
     */
    Iterator<T> iterator();

}

具体容器类

public class ConcreteAggregate<T> implements Aggregate<T> {

    private List<T> list = new ArrayList<>();

    @Override
    public void add(T obj) {
        list.add(obj);
    }

    @Override
    public void remove(T obj) {
        list.remove(obj);
    }

    @Override
    public Iterator<T> iterator() {
        return new ConcreteIterator<>(list);
    }
}

客户端类

public class Client {

    private static Iterator<String> i;

    public static void main(String[] args) {
        Aggregate<String> a = new ConcreteAggregate();
        a.add("java");
        a.add("android");
        a.add("ios");
        a.add("php");
        i = a.iterator();
        while (i.hasNext()) {
            System.out.println(i.next());
        }
    }

}

运行日志如下：

java
android
ios
php

Android 中的迭代器模式

除了List、Map等这种数据结构体所包含的迭代器外，Android中也提供了迭代器遍历数据，典型的就是数据库查询使用的Cursor，Cursor这个游标对象其实就是一个具体的迭代器。这里用一个简单数据库查询的例子来介绍迭代器模式的使用。

首先定义一个SQLiteOpenHelper

public class DbOpenHelper extends SQLiteOpenHelper {

    public static final String DB_NAME = "user_provider_db";
    public static final String USER_TABLE_NAME = "user";
    public static final int DA_VERSION = 1;

    private static final String CREATE_USER_TABLE = "CREATE TABLE IF NOT EXISTS " + USER_TABLE_NAME
            + "(_id INTEGER PRIMARY KEY, " + " name TEXT," + " sex INT)";

    public DbOpenHelper(Context context) {
        super(context, DB_NAME, null, DA_VERSION);
    }

    @Override
    public void onCreate(SQLiteDatabase db) {
        db.execSQL(CREATE_USER_TABLE);
    }

    @Override
    public void onUpgrade(SQLiteDatabase sqLiteDatabase, int i, int i1) {

    }
}

创建一个ContentProvider类,在onCreate方法中插入两条数据，简单起见，只实现了query方法。

public class UserProvider extends ContentProvider {

    private SQLiteDatabase mDb;

    @Override
    public boolean onCreate() {
        initDb();
        return true;
    }

    private void initDb() {
        mDb = new DbOpenHelper(getContext()).getWritableDatabase();
        mDb.execSQL("delete from " + DbOpenHelper.USER_TABLE_NAME);
        mDb.execSQL("insert into user values(1,'mary',0);");
        mDb.execSQL("insert into user values(2,'linda',1);");
    }

    @Nullable
    @Override
    public String getType(@NonNull Uri uri) {
        return null;
    }

    @Nullable
    @Override
    public Cursor query(@NonNull Uri uri, @Nullable String[] projection, @Nullable String selection, @Nullable String[] selectionArgs, @Nullable String sortOrder) {
        return mDb.query("user", projection, selection, selectionArgs, null, null, sortOrder, null);
    }

    @Nullable
    @Override
    public Uri insert(@NonNull Uri uri, @Nullable ContentValues contentValues) {
        return null;
    }

    @Override
    public int delete(@NonNull Uri uri, @Nullable String s, @Nullable String[] strings) {
        return 0;
    }

    @Override
    public int update(@NonNull Uri uri, @Nullable ContentValues contentValues, @Nullable String s, @Nullable String[] strings) {
        return 0;
    }
}

AndroidManifest中添加UserProvider和权限

<provider
    android:name=".UserProvider"
    android:authorities="com.linda.sqlite_example.UserProvider" />

<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />

查询数据库

public class MainActivity extends AppCompatActivity {

    private static final String TAG = "MainActivity";

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        Uri userUri = Uri.parse("content://com.linda.sqlite_example.UserProvider/user");
        Cursor userCursor = getContentResolver().query(userUri, new String[]{"_id", "name", "sex"}, null, null, null);
        while (userCursor.moveToNext()) {
            User user = new User();
            user.userId = userCursor.getInt(0);
            user.userName = userCursor.getString(1);
            user.isMale = userCursor.getInt(2) == 1;
            Log.e(TAG, "query user:  " + user.toString());
        }
        userCursor.close();
    }
}