Jugando con el #PHP SDK de Amazon Web Services ( #AWS ) V3 para Simple Queue Service (#SQS)

Simple introducción a Amazon Simple Queue Service usando Composer, PHP y la versión 3 del SDK de Amazon.  Amazon SQS es un servicio de mensajería para la comunicación entre distintas plataformas y/o dispositivos.

Origen: Basic SDK Usage

Código del Proyecto : Jugando con PHP SDK y SQS

Hace un tiempo que quería empezar a usar SQS para separar la lógica de envío de correos de mi plataforma, en especial desde que tuve problemas en su momento con el servidor SMTP de Mandrill lo que finalizaba en un error para el usuario. En este momento cambie a usar el sistema de mails de Amazon, pero siempre quedé con la intención de separar el procesamiento de emails en caso de tener problemas con esto nuevamente.

Me llamó mucho la atención que los ejemplos de Amazon para el SDK simplemente están basados en S3, por l oque no fue tan sencillo comenzar con SQS como lo hubiera imaginado, casi todos los ejemplos con SQS usaban las librerías antiguas.

Amazon SQS, no solo sirve para poder enviar emails de manera asyncrónica con la aplicación, la verdad es que puedes hacer lo que se te ocurra. Por ahora empezaremos un proyecto desde cero en el cual crearemos mensajes y luego los procesaremos.

Amazon SQS Ejemplo PHP SDK V3
Amazon SQS Ejemplo PHP SDK V3

Inicializando El Proyecto de SQS.

Lo primero que necesitamos es instalar las librerías del SDK, por lo crearemos una nueva carpeta y utilizaremos composer para instalarlas. Si no sabes lo que es composer te recomiendo que vayas a su sitio web para instalarlo : https://getcomposer.org/

composer require aws/aws-sdk-php

 

Con esto crearemos la estructura básica para continuar, en donde las librerías necesarias se descargarán en la nueva carpeta vendor.

Ahora crearemos 3 archivos en la raiz del directorio :

  • sharedConfig.php que tendrá los datos de conexión y valores por defecto.
  • createMessage.php que creará la Queue si es que no existe y agregará un nuevo mensaje.
  • readMessages.php que leerá todos los mensajes que tenemos en el Queue, los procesará y luego los eliminará.

sharedConfig.php

// Usaremos esta información por defecto.
$sharedConfig = [
 'region' => 'us-west-2',
 'version' => 'latest',
 'credentials' => [
 'key' => 'TUKEY',
 'secret' => 'TUSECRET',
 ],
];

$my_queue_name = "MyQueueExample";

La verdad no es recomendable hardcodiar los datos de conexión, pero como ejemplo está perfecto. Recomiendo usar las variables de entorno para los datos de conexión.

Creando Los Mensajes de SQS

El siguiente código crea la instancia del SDK, y desde ella obtenemos el cliente para SQS, creamos el queue y agregamos un mensaje. Si el nombre del Queue existe hace nada. Si bajaste el código desde el repositorio recuerda crear el archivo sharedConfig.php como aparece en la sección anterior.

Es bueno destacar que cualquier llamada del cliente a amazon puede tener un error que debemos capturar en caso de ser necesario.

createMessage.php

require 'vendor/autoload.php';
include_once 'sharedConfig.php';

// Creamos la clase SDK.
$sdk = new Aws\Sdk($sharedConfig);

// Creamos el cliente SQS desde el SDK
$client = $sdk->createSqs();

// Creamos la QUEUE
$queue_options = array(
 'QueueName' => $my_queue_name
);

try {
 $client->createQueue($queue_options);
} catch (Exception $exc) {
 echo $exc->getTraceAsString();
 die('Error creando la queue ' . $exc->getMessage());
}


// Obtenemos la URL de la queue.
$result = $client->getQueueUrl(array('QueueName' => $my_queue_name));
$queue_url = $result->get('QueueUrl');

print_r($queue_url);

// The message we will be sending
$our_message = array(
 'tipo' => 'MAIL',
 'content' => rand(0, 110000010)
);

// Send the message

try {
 $client->sendMessage(array(
 'QueueUrl' => $queue_url,
 'MessageBody' => json_encode($our_message)
 ));
} catch (Exception $ex) {
 die('Error enviando el mensaje a la queue ' . $e->getMessage());
}

 

  1. Se cargan las librerías de composer. En este caso solo tenemos las de Amazon SDK
  2. Incluímos el archivo de configuración con las KEY. Recuerda que debes de cear este archivo.
  3. Creamos la instancia del SDK.
  4. Creamos el cliente de SQS.
  5. Creamos las opciones para la creación del Queue.
  6. Creamos el Queue. Recueda que si ya existe no hará nada.
  7. Obtenemos e imprimos en pantalla la url de la Queue.
  8. Creamos el mensaje a agregar a la cola. En este caso nuestro mensaje es un arreglo, por eso usaremos json_enconde al momento de enviar el contenido.
  9. Enviamos el contenido del mensaje.

En este caso solo estamos enviando un mensaje. Sin embargo puedes ejecutar el código cuantas veces quieras. Ejecutando por consola sería :

$ php createMessage.php

 

 

Leyendo, Procesando Y Eliminando Los Mensajes de SQS

Ahora a la parte entretenida. En este caso, solo por preferencia, el código se ejecutará por siempre y para no tener el CPU al 100% si es que no existen mensajes pendientes esperaremos un tiempo definido por la variable backoff. Esto lo aprendí cuando hice experimentación con redes inalambricas :).

Con cada iteración se obtendrá un solo mensaje en caso de existir. Si el mensaje no es eliminado, volverá a estar en la cola luego de un tiempo.

readMessages.php

require 'vendor/autoload.php';
include_once 'sharedConfig.php';

// Creamos la clase SDK.
$sdk = new Aws\Sdk($sharedConfig);

// Creamos el cliente SQS desde el SDK
$client = $sdk->createSqs();

// Obtenemos la URL de la queue.
$result = $client->getQueueUrl(array('QueueName' => $my_queue_name));
$queue_url = $result->get('QueueUrl');

/*
 * Si no hay un mensaje en el Queue 
 * esperaremos un tiempo
 * definido por backoff y delimitado por 
 * $backoffMax
 */

$backoff = 0;
$backoffMax = 3;
while (true) {

try {
 $message = $client->receiveMessage(array(
 'QueueUrl' => $queue_url
 ));
 } catch (Exception $exc) {
 echo "No se pudo obtener mensaje \n";
 echo $exc->getTraceAsString();
 }

if ($message['Messages'] == null) {
 // No hay mensajes a procesar.
 echo "No hay mensajes a procesar. Duermo.\n";
 $backoff += 0.5;
 if ($backoff > $backoffMax) {
 $backoff = $backoffMax;
 }
 echo "Espero $backoff segundos";
 sleep($backoff);
 } else {
 $backoff = 0;
 echo "Hay mensajes a procesar. Proceso.\n";
 // Obtengo la información del mensaje

$result_message = array_pop($message['Messages']);
 $queue_handle = $result_message['ReceiptHandle'];
 $message_json = $result_message['Body'];

//Imprimimos el contenido del mensaje
 print_r($message_json);

echo "\n";
 //Ahora eliminamos.

try {
 $client->deleteMessage(array(
 'QueueUrl' => $queue_url,
 'ReceiptHandle' => $queue_handle
 ));
 echo "\t Mensaje eliminado\n";
 } catch (Exception $exc) {
 echo $exc->getTraceAsString();
 echo "\t Mensaje NO eliminado\n";
 }
 }
}

Ignoraré la explicación de lo que se explicó anteriormente.

  1. La variable backoff corresponde al tiempo de espera para ver si existen nuevos mensajes.
  2. La variable backoffMax corresponde al tiempo máximo de espera.
  3. result_message corresponde al mensaje que desencolamos del Queue.
  4. queue_handler corresponde a la variable a utilizar en caso de que queramos borrar el mensaje.
  5. $message_json corresponde al mensaje en formato json. Recuerda que lo encondificamos al enviarlo.
  6. la funciona deleteMessage hace exactamente eso, elimina el mensaje del Queue.

¿ Y ahora ?

Eres bienvenido a ejecutar el código que está en el repositorio, solo recuerda crear el archivo sharedConfig.php con tus datos de Amazon : https://github.com/ctala/Jugando-con-PHP-SDK-y-SQS

One Reply to “Jugando con el #PHP SDK de Amazon Web Services ( #AWS ) V3 para Simple Queue Service (#SQS)”

Deja un comentario

This site uses Akismet to reduce spam. Learn how your comment data is processed.