DispatchGroups
Hola amigos, en este artículo explicaremos un poco qué son los DispatchGroups, para qué funcionan y programaremos una pequeña app de ejemplo.
Los DispatchGroups son muy usados en iOS sobretodo en networking cuando queremos hacer múltiples llamadas a algún API. Dentro de un DispatchGroup podemos ejecutar varias tareas síncronas y/o asíncronas y saber el momento exacto en el que todas estas tareas han terminado.
Para que quede más claro, vamos al código, primero empezaremos creando un proyecto nuevo:
Lo primero que haremos es dentro de nuestro controller definir un arreglo de URLs de los sprites de pokemones del Api de pokemon pokeapi.co
let urls = [
URL(string: "https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/pokemon/1.png")!,
URL(string: "https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/pokemon/2.png")!,
URL(string: "https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/pokemon/3.png")!,
URL(string: "https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/pokemon/4.png")!,
URL(string: "https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/pokemon/5.png")!,
URL(string: "https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/pokemon/6.png")!,
URL(string: "https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/pokemon/7.png")!,
URL(string: "https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/pokemon/8.png")!,
URL(string: "https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/pokemon/9.png")!
]
}Lo siguiente que haremos será crear una función que utilizaremos para descargas los sprites de pokemon
func fetchPokemonStarters() {
// Más código a continuación
}Dentro de la función crearemos un DispatchGroup de la siguiente forma:
fetchPokemonStarters() {
let group = DispatchGroup()
}Ahora vamos a crear un for loop para iterar a través de nuestro arreglo de URLs, especial atención en el enumerated() lo usaremos para obtener el índice del arreglo
func fetchPokemonStarters() {
let group = DispatchGroup()
for (index, url) in urls.enumerated() {
}
}Cada vez que entramos al for vamos a ejecutar group.enter() para notificar manualmente al grupo que una tarea ha comenzado.
func fetchPokemonStarters() {
let group = DispatchGroup()
for (index, url) in urls.enumerated() {
group.enter()
print("Entrando a dispatchGroup con indice: \(index)")
}
}Vamos a comenzar a descargar las imágenes para ello usaremos URLSession.shared.dataTask(with: url), que no se nos vaya a olvidar de añadir el .resume() al final
func fetchPokemonStarters() {
let group = DispatchGroup()
for (index, url) in urls.enumerated() {
group.enter()
print("Entrando a dispatchGroup con indice: \(index)")
URLSession.shared.dataTask(with: url) { (data, response, error) in
}.resume()
}
}Y ahora por simplicidad solo verificaremos si hubo error en la descarga
func fetchPokemonStarters() {
let group = DispatchGroup()
for (index, url) in urls.enumerated() {
group.enter()
print("Entrando a dispatchGroup con indice: \(index)")
URLSession.shared.dataTask(with: url) { (data, response, error) in
if let error = error {
print("Error al descargar \(error.localizedDescription)")
}
}.resume()
}
}Con group.leave() podemos a indicar explícitamente que la tarea ha terminado.
El bloque de código dentro de defer será lo último que se ejecutará dentro del scope actual por lo que es un buen lugar para colocar group.leave().
func fetchPokemonStarters() {
let group = DispatchGroup()
for (index, url) in urls.enumerated() {
group.enter()
print("Entrando a dispatchGroup con indice: \(index)")
URLSession.shared.dataTask(with: url) { (data, response, error) in
defer {
group.leave()
print("Saliendo de dispatchGroup del con indice \(index)")
}
if let error = error {
print("Error al descargar \(error.localizedDescription)")
}
}.resume()
}
}Con group.notify podemos saber el momento exacto en el que todas las descargas terminaron
En nuestro caso como vamos a actualizar la UI queremos que notify se ejecute en el main thread
group.notify(queue: .main)func fetchPokemonStarters() {
let group = DispatchGroup()
for (index, url) in urls.enumerated() {
group.enter()
print("Entrando a dispatchGroup con indice: \(index)")
URLSession.shared.dataTask(with: url) { (data, response, error) in
defer {
group.leave()
print("Saliendo de dispatchGroup del con indice \(index)")
}
if let error = error {
print("Error al descargar \(error.localizedDescription)")
}
}.resume()
}
group.notify(queue: .main) {
// Update UI
print("Todas las descargas terminaron")
self.view.backgroundColor = .blue
}
}Si ejecutamos la aplicación podemos ver que la pantalla vuelve azul al momento que todas las descargas terminan
Si vemos nuestra consola:
Aquí podemos observar cómo las descargas comienzan ordenadas pero al momento de finalizar no está garantizado que terminarán en el mismo orden en el que comenzaron.
Este fue un ejemplo muy sencillo aplicando dispatch groups. Espero que les haya servido.
Notas
- Si ejecutamos de nuevo la aplicación podemos ver que las descargas terminan en orden, esto es porque URLSession tiene un cache por default. Para evitar que se guarde en cache podemos declarar nuestra URLSession así:
let session = URLSession(configuration: .ephemeral)-
Si llamamos a leave() antes de enter() nuestra aplicación va a crashear.
-
Por cada enter() debe haber un leave() sino nuestro bloque de código dentro de .notify jamás se ejecutará.
Happy coding!