Organiza el código Dart con paquetes y librerías

Ver en YouTube en una nueva pestaña: "The Dart platform"

En este capítulo, pasarás de la sintaxis básica de Dart a construir aplicaciones de línea de comandos "al estilo Dart", adoptando las buenas prácticas. Aprenderás a refactorizar tu código en componentes reutilizables creando un paquete dedicado para manejar los argumentos de línea de comandos.

Este paso te prepara para construir una aplicación de línea de comandos más avanzada en los próximos capítulos, que integrará paquetes especializados para la lógica de Wikipedia y un framework de command_runner robusto. Este capítulo te ayuda a entender las librerías de Dart, las sentencias de exportación y cómo estructurar tu proyecto para una mejor organización y mantenibilidad.

• Haber completado el Capítulo 3, que cubrió programación asíncrona y solicitudes HTTP.

En este capítulo, refactorizarás la aplicación de CLI dartpedia existente extrayendo la lógica de parseo de argumentos de línea de comandos en un paquete separado llamado command_runner. Esto mejorará la estructura de tu proyecto, haciéndolo más modular y mantenible.

Primero, crea un nuevo paquete Dart para albergar la lógica de parseo de argumentos de línea de comandos.

1. Navega al directorio raíz de tu proyecto (/dartpedia).

2. Ejecuta el siguiente comando en tu terminal:

   bash

   dart create -t package command_runner
   

   content_copy

   Este comando crea un nuevo directorio llamado command_runner con la estructura básica de un paquete Dart. Ahora deberías ver una nueva carpeta command_runner en la raíz de tu proyecto, junto con tu paquete cli.

Ahora que has creado el paquete command_runner, añade una clase de marcador de posición (placeholder) que eventualmente manejará la lógica de parseo de argumentos de línea de comandos.

1. Abre el archivo command_runner/lib/command_runner.dart. Elimina cualquier código de marcador de posición existente y agrega lo siguiente:

   dart

   /// A simple command runner to handle command-line arguments.
   ///
   /// More extensive documentation for this library goes here.
   library;
   ​
   export 'src/command_runner_base.dart';
   // TODO: Export any other libraries intended for clients of this package.
   

   content_copy

   Aspectos destacados del código anterior:

   • library; declara este archivo como una librería, lo que define los límites y la interfaz pública de una unidad reutilizable de código Dart.
   • export 'src/command_runner_base.dart'; es una línea crucial que hace que las declaraciones de command_runner_base.dart estén disponibles para otros paquetes que importen el paquete command_runner. Sin esta sentencia export, las clases y funciones dentro de command_runner_base.dart serían privadas para el paquete command_runner, y no podrías usarlas en tu aplicación dartpedia.

2. Abre el archivo command_runner/lib/src/command_runner_base.dart.

3. Elimina cualquier código de marcador de posición existente y añade la siguiente clase CommandRunner a command_runner/lib/src/command_runner_base.dart:

   dart

   class CommandRunner {
     /// Runs the command-line application logic with the given arguments.
     Future<void> run(List<String> input) async {
       print('CommandRunner received arguments: $input');
     }
   }
   

   content_copy

   Aspectos destacados del código anterior:

   • CommandRunner es una clase que sirve como un sustituto simplificado por ahora. Su método run actualmente solo imprime los argumentos que recibe. En capítulos posteriores, expandirás esta clase para manejar un parseo de comandos complejo y configurable.
   • El tipo de retorno Future<void> indica que este método podría realizar operaciones asíncronas, pero no devuelve un valor.

Ahora que has creado el paquete command_runner y añadido una clase CommandRunner de marcador de posición, necesitas decirle a tu aplicación cli que depende de command_runner. Debido a que el paquete command_runner está ubicado localmente dentro de tu proyecto, puedes usar una dependencia de ruta (path dependency).

1. Abre el archivo cli/pubspec.yaml.

2. Debido a que el paquete cli es un paquete de aplicación y no está destinado a ser publicado en pub.dev, añade publish_to: none después del campo name. Esto ayuda a evitar la publicación accidental y previene advertencias del analyzer al añadir dependencias de ruta.

   yaml

   name: cli
   publish_to: none
   # ...
   

   content_copy

3. Localiza la sección dependencies. Agrega las siguientes líneas:

   yaml

   dependencies:
     http: ^1.3.0 # Keep your existing http dependency
     command_runner:
       path: ../command_runner # Points to your local command_runner package
   

   content_copy

   Esta sección le indica a la aplicación cli que depende del paquete command_runner, y especifica que el paquete está ubicado en el directorio ../command_runner (relativo al directorio cli).

4. Ejecuta dart pub get en el directorio /dartpedia/cli de tu terminal para obtener la nueva dependencia.

Ahora que has agregado command_runner como una dependencia, puedes importarlo en tu aplicación cli y reemplazar tu lógica de manejo de argumentos existente con la nueva clase CommandRunner. Este paso también corrige el comportamiento de salida del programa discutido al final del Capítulo 3.

1. Abre el archivo cli/bin/cli.dart.

2. Agrega la siguiente sentencia de importación en la parte superior del archivo, junto con tus otras importaciones:

   dart

   import 'package:command_runner/command_runner.dart';
   

   content_copy

   Esta sentencia importa el paquete command_runner, haciendo que la clase CommandRunner esté disponible para su uso.

3. Refactoriza la función main y elimina la lógica antigua: Actualmente, tu función main del Capítulo 3 maneja directamente comandos como version, help y wikipedia, y luego llama a searchWikipedia. Ahora reemplazarás toda esta lógica personalizada de manejo de comandos con una sola llamada a la nueva clase CommandRunner.

   Tu archivo cli/bin/cli.dart (del Capítulo 3) debería verse así actualmente:

   dart

   import 'dart:io';
   import 'package:http/http.dart' as http;
   import 'package:command_runner/command_runner.dart';
   ​
   const version = '0.0.1';
   ​
   void main(List<String> arguments) {
     if (arguments.isEmpty || arguments.first == 'help') {
       printUsage();
     } else if (arguments.first == 'version') {
       print('Dartpedia CLI version $version');
     } else if (arguments.first == 'wikipedia') {
       final inputArgs = arguments.length > 1 ? arguments.sublist(1) : null;
       searchWikipedia(inputArgs);
     } else {
       printUsage();
     }
   }
   ​
   void searchWikipedia(List<String>? arguments) async { /* ... existing logic ... */ }
   void printUsage() { /* ... existing logic ... */ }
   Future<String> getWikipediaArticle(String articleTitle) async { /* ... existing logic ... */ }
   

   content_copy

   **Ahora, reemplaza todo el contenido de cli/bin/cli.dart (excepto la importación de http) con la siguiente versión actualizada:

   dart

   import 'dart:io';
   import 'package:http/http.dart' as http;
   import 'package:command_runner/command_runner.dart';
   ​
   void main(List<String> arguments) async { // main is now async and awaits the runner
     var runner = CommandRunner(); // Create an instance of your new CommandRunner
     await runner.run(arguments); // Call its run method, awaiting its Future<void>
   }
   

   content_copy

   Aspectos destacados del código anterior:

   • void main(List<String> arguments) async aborda directamente el problema de que el programa no finalizaba limpiamente del Capítulo 3. Nota que main ahora está declarada como async. This es esencial porque runner.run() devuelve un Future, y main debe hacer await de su completación para asegurar que el programa espere a que todas las tareas asíncronas terminen antes de salir.
   • var runner = CommandRunner(); crea una instancia de la clase CommandRunner de tu nuevo paquete command_runner.
   • await runner.run(arguments); llama al método run en la instancia de CommandRunner, pasando los argumentos de la línea de comandos.

   Funciones eliminadas:

   • Las funciones printUsage, searchWikipedia y getWikipediaArticle ahora están completamente eliminadas de cli/bin/cli.dart. Su lógica se rediseñará y se moverá al paquete command_runner en futuros capítulos, como parte de la construcción del framework completo de línea de comandos.

Ahora que has refactorizado el código y actualizado la aplicación cli para usar el paquete command_runner, ejecuta la aplicación para verificar que todo esté funcionando correctamente en esta etapa.

1. Abre tu terminal y navega al directorio cli.

2. Ejecuta el comando wikipedia:

   bash

   dart run bin/cli.dart wikipedia Computer_programming
   

   content_copy

3. Asegúrate de que la aplicación ahora se ejecute sin errores e imprima los argumentos en la consola, demostrando que el control se ha transferido con éxito a tu nuevo paquete command_runner.

   bash

   CommandRunner received arguments: [wikipedia, Computer_programming]
   

   content_copy

En el próximo capítulo, te sumergirás en los conceptos de la programación orientada a objetos (OOP) en Dart. Aprenderás cómo crear clases, definir relaciones de herencia y construir un framework de parseo de argumentos de línea de comandos más robusto utilizando principios de OOP dentro de tu nuevo paquete command_runner.