30 de septiembre de 2007

Patrón Iterador – ActionScript 3.0

Cuando tenemos colecciones de objetos a veces es necesario iterar sobre estos pero sin exponer su implementación interna, supongamos que tenemos una colección que la queremos solamente para que almacene cadenas:

1   package {
2
3 public class StringCollection {
4
5 private var _strings:Array;
6
7 public function StringCollection() {
8 _strings = new Array();
9 }
10
11 public function addElement(value:String):void {
12 _strings.push(value);
13 }
14
15 }
16 }
17


Como vemos nuestra colección tiene un método addElement que tiene la tarea de añadir cadenas al array “_strings”. Lo interesante en este caso es como podemos accesar al array “_strings” para poder iterar sobre sus valores. Una opción sería poner un método accesor en la clase, algo como esto:

1   package {
2
3 public class StringCollection {
4
5 private var _strings:Array;
6
7 public function StringCollection() {
8 _strings = new Array();
9 }
10
11 public function addElement(value:String):void {
12 _strings.push(value);
13 }
14 //Método accesor al array
15 public function get strings():Array {
16 return _strings;
17 }
18
19 }
20 }
21
22


Y el cliente utilizaría nuestra clase así:

1   var collection:StringCollection = new StringCollection();
2 collection.addElement("cadena1");
3 collection.addElement("cadena2");
4 collection.addElement("cadena3");
5 for(var i:Number = 0; i < collection.strings.length; i++) {
6 trace(collection.strings[i]);
7 }
8
9
10


Aquí hay 2 grandes problemas, estamos exponiendo los detalles de cómo debemos iterar sobre el arreglo y estamos rompiendo con el encapsulamiento al tener acceso directo al array, esto le da la oportunidad a cualquiera de poder cambiar algún valor del arreglo sin que nuestra clase se entere, que tal si en lugar de meter un string, le añado un entero ? (Recuerda que nuestra colección solamente debe almacenar cadenas).

Bueno, entonces se nos ocurre meter la responsabilidad de iterar en la misma clase, quedaría así finálmente:

1   public class StringCollection {
2
3 private var _strings:Array;
4 private var _index:Number;
5
6 public function StringCollection() {
7 _strings = new Array();
8 _index = 0;
9 }
10
11 public function addElement(value:String):void {
12 _strings.push(value);
13 }
14
15 public function reset():void {
16 _index = 0;
17 }
18
19 public function hasNext():Boolean {
20 return _index < _strings.length;
21 }
22
23 public function next():String {
24 return _strings[_index++] as String;
25 }
26 }
27 }
28



Pero nuevamente vemos problemas a la vista, supongamos que estamos en un sistema concurrente y tenemos 2 hilos que están iterando al mismo tiempo sobre la misma instancia de la colección, debido a que _index guarda la posición actual en el array, sería imposible iterar sobre la misma instancia. Otro problema vendría al querer definir nuevos tipos de iteración, por ejemplo en lugar de que la colección empiece de inicia a final, esta empiece de final a inicio, tendríamos que definir esos métodos que cumplan con esa tarea en la clase.

Y principalmente estaríamos rompiendo con un principio de diseño, SRP o Single Responsability Principle, el cual nos dice que nuestra clase solamente debe tener UNA responsabilidad (Debe tener una sola razón de cambiar). Como vemos StringCollection tiene 2 responsabilidades, la de iterar sobre la colección y la parte de la gestión de la misma (añadir, remover, obtener, etc...).

Como bien dice el sabio principio, “Encapsula lo que varíe”, en este caso la implementación de cómo iterar podría cambiar en un futuro no muy lejano.

Así que vamos a separar eso y definamos nuestra interfaz que todos nuestros Iteradores van a implementar:

1   package {
2 public interface IIterator {
3 function next():Object;
4 function hasNext():Boolean;
5 function reset():void;
6 }
7 }
8
9



El método next se encargará de devolvernos el siguiente objeto en la colección, hasNext nos devolvera true si todavía hay elementos en la colección o false en caso contrario, reset reiniciaría la posición del cursor en la colección.

Ahora vamos a hacer 2 iteradores que la implementen, cada uno con sus implementaciones concretas del CÓMO iterar.

Este es un iterador que recorre un Array de inicio a final:

1   package {
2
3 public class ArrayIterator implements IIterator {
4
5 private var _index:Number = 0;
6 private var _collection:Array;
7
8 public function ArrayIterator(collection:Array) {
9 _collection = collection;
10 _index = 0;
11 }
12
13 public function hasNext():Boolean {
14 return _index < _collection.length;
15 }
16
17 public function next():Object {
18 return _collection[_index++];
19 }
20
21 public function reset():void {
22 _index = 0;
23 }
24
25 }
26 }
27



Este es un iterador que recorre un Array de final a inicio ósea en reversa:

1   package {
2
3 public class ArrayReverseIterator implements IIterator {
4
5 private var _index:Number = 0;
6 private var _collection:Array;
7
8 public function ArrayIterator(collection:Array) {
9 _collection = collection;
10 _index = _collection.length - 1;
11 }
12
13 public function hasNext():Boolean {
14 return _index > = 0;
15 }
16
17 public function next():Object {
18 return _collection[_index--];
19 }
20
21 public function reset():void {
22 _index = _collection.length - 1;
23 }
24
25 }
26 }
27



Por último definamos la interfaz común para nuestras colecciones, esta solo consta de un método que nos devolverá el tipo de iterador deseado.

1   package {
2 public interface ICollection {
3 function iterator(type:String = null):IIterator;
4 }
5 }
6
7



Y la implementamos a nuestra existente colección StringColleciton:

1   package {
2
3 public class StringCollection implements ICollection {
4
5 private var _strings:Array;
6
7 public function StringCollection() {
8 _strings = new Array();
9 }
10
11 public function addElement(value:String):void {
12 _strings.push(value);
13 }
14
15 public function iterator(type:String = null):IIterator {
16 if(type == "ArrayReverseIterator") {
17 return new ArrayReverseIterator(_strings);
18 }else {
19 new ArrayIterator(_strings);
20 }
21 }
22 }
23 }
24



Genial !!!, ahora nuestro cliente solo sabe que nuestra clase solamente devuelve objetos que implementan la interfaz IIterator, ya no estamos exponiendo al cliente los detalles de implementación de la clase, él ya sabe que le devuelve un IIterator no importando si es un array, dictionary, etc…, sabrá que cuenta con una interfaz común para navegar sobre la colección, y en un futuro podríamos agregar más tipos de iteradores para otro tipo de colecciones sin ningún problema.

Ejemplo de uso en la parte del cliente:

1   var collection:StringCollection = new StringCollection();
2 collection.addElement("uno");
3 collection.addElement("dos");
4 collection.addElement("tres");
5 collection.addElement("cuatro");
6 var iterator:IIterator = collection.iterator();
7 while(iterator.hasNext()) {
8 trace(iterator.next());
9 }
10 iterator = collection.iterator("ArrayReverseIterator");
11 while(iterator.hasNext()) {
12 trace(iterator.next());
13 }
14
15



A poco no está fregón ?, la colección nos puede devolver 2 tipos de iteradores dependiendo del tipo de parámetro que le pasemos al método iterator, cualquiera de las 2 implementaciones concretas implementa la misma interfaz por tanto el cliente no tendrá que cambiar su código del cómo itera sobre los elementos si más adelante decide implementar otro tipo de iterador.

Aquí les dejo el diagrama de clases del ejemplo:



Cómo mejorarías el patrón compositive ó compuesto utilizando este patrón ?, bueno eso te toca a ti, ojala les haya quedado claro todo y cualquier comentario o sugerencia es bienvenida.

Para el próximo post veremos probablemente otro patrón, es una sorpresilla.

Un saludote !

3 comentarios:

Anónimo dijo...

Tu blog es excelente. me voy a leer cada artículo. Saludos.

nestor dijo...

algún momento del artículo hablaste de hilos y de concurrencia... alguna vez lo has implementado en actionscript 3.0?
P.e. tengo tres tiendas -hilos- y cada una de las tiendas solo puede atender a un cliente al mismo tiempo. los clientes llegan aleatoriamente... es posible implementarlo en actionscript 3.0 sin tener problemas de concurrencia???

Anónimo dijo...

Excelente explicación del patrón. Es muy bueno el enfoque de partir de un ejemplo donde no se aplique el patrón, analizando las desventajas, hasta llegar al ejemplo final, con el patrón aplicado y explicando las diferencias positivas.