Una guía para crear un código escalable y fácil de mantener
En una aplicación de React Native, organizar el código es crucial para su mantenibilidad y escalabilidad. La forma en que estructuras tus archivos y carpetas puede influir mucho en lo fácil que será trabajar con el código en el futuro.
Este artículo explora la estructura de carpetas basada en funcionalidades para una aplicación de React Native y el propósito de cada carpeta.
La carpeta src
La carpeta src es el directorio raíz de todo el código fuente de tu aplicación. Dentro de esta carpeta encontrarás varias subcarpetas, cada una con un propósito concreto.
Types
La carpeta types es donde defines los tipos globales de tu aplicación. Esto incluye tipos de módulos, definiciones de interfaces y cualquier otro tipo personalizado que necesites usar en toda la aplicación.
Tener un lugar central para todos tus tipos facilita gestionarlos y mantenerlos a medida que la aplicación crece. Además, garantiza que tus tipos se usen de forma coherente en todas las funcionalidades, lo que reduce el riesgo de bugs relacionados con los tipos y hace más fácil detectarlos cuando aparecen.
Lib
En la carpeta lib puedes guardar cualquier archivo específico de la aplicación que se use de forma global en toda la app. Puede incluir la instancia de axios para hacer llamadas a la API, servicios de manejo de errores, constantes, la configuración del query client de react-query, etc.
Tener estos archivos en un lugar centralizado facilita su mantenimiento y garantiza que sean coherentes en toda la aplicación.
Components
En la carpeta components guardas todos tus componentes reutilizables. Estos componentes deben estar aislados y no ser específicos de ninguna funcionalidad o dominio en particular. Ejemplos de este tipo de componentes son los encabezados, los botones y los elementos de lista.
Mantener estos componentes separados de los componentes específicos de cada funcionalidad facilita gestionarlos y reutilizarlos en toda la aplicación, y reduce la duplicación en tu código.
Hooks
En la carpeta hooks guardas los hooks personalizados que se usan en toda tu aplicación. Un hook es un tipo especial de función de React que te permite reutilizar lógica con estado entre tus componentes.
Tener todos tus hooks personalizados **reutilizables o usados en varios sitios **en un lugar centralizado facilita gestionarlos y mantenerlos, además de reducir el riesgo de duplicar código y facilitar compartir hooks entre distintas partes de tu aplicación.
Localization
En la carpeta localization guardas todos los archivos relacionados con la internacionalización de tu aplicación. Esto incluye los archivos de idioma, las constantes de texto y cualquier otro recurso necesario para soportar varios idiomas en tu aplicación.
Tener estos archivos en un lugar centralizado facilita gestionarlos y mantenerlos, además de reducir el riesgo de duplicar código y facilitar el soporte de varios idiomas en tu aplicación.
Navigation
En la carpeta navigation guardas todo el código relacionado con la navegación de tu aplicación. Esto incluye los stacks, los tipos, las rutas y cualquier otro componente o función necesario para la navegación.
Tener todo tu código de navegación en un lugar centralizado facilita gestionarlo y mantenerlo, además de reducir el riesgo de duplicar código y facilitar compartir la funcionalidad de navegación entre distintas partes de tu aplicación.
Services
En la carpeta services guardas todo el código relacionado con la infraestructura subyacente de tu aplicación. Esto incluye el código para trabajar con notificaciones push, la monitorización de errores y cualquier otro servicio que se use para dar la funcionalidad de base de tu aplicación.
Theme
En la carpeta theme deberías guardar los estilos de tu app, por ejemplo el tema oscuro o claro. Mantener tus archivos de estilos y de tema en un solo lugar facilita gestionar y actualizar el aspecto de tu app cuando haga falta.
Utils
Las funciones de utilidad pueden ser una parte importante de tu aplicación de React Native, ya que permiten reutilizar código en varias partes de la aplicación. La carpeta utils es un buen lugar para guardar las funciones de utilidad que se usan en toda tu aplicación. Al centralizar estas funciones en un solo lugar, te aseguras de que sean fáciles de encontrar y de usar en otras partes del código. Por ejemplo: funciones de utilidad relacionadas con el layout de react-native.
Features
Cuando se trata de construir aplicaciones complejas, es esencial tener una estructura de carpetas clara y concisa que agrupe todo el código en un solo lugar. Tener una carpeta features ayuda a conseguirlo, ya que separa las distintas funcionalidades de la aplicación en categorías diferenciadas. Esto permite a los desarrolladores encontrar rápidamente una funcionalidad concreta y modificarla sin afectar a otras partes de la aplicación.
Además, a medida que la aplicación crece y se añaden más funcionalidades, la estructura de carpetas sigue organizada, lo que facilita que los nuevos desarrolladores se incorporen y entiendan cómo funciona la aplicación. La clara separación de responsabilidades también ayuda a reducir el riesgo de bugs y mejora el rendimiento general de la aplicación.
Así podría verse una carpeta auth:
src/
├── ...
└── features/
├── auth/
| ├── api/
| ├── helpers/
| ├── hooks/
| ├── screens/
| ├── services/
| └── store/
└── ... (other features)
La importancia de la carpeta features reside en que ayuda a dividir el código en partes más pequeñas y manejables. Cada funcionalidad tiene sus propias subcarpetas, como api, helpers (o utils), hooks, screens, services y store, específicas de esa funcionalidad. Esto facilita entender cómo funciona cada funcionalidad y cómo interactúan entre sí.
La carpeta api contiene todo el código relacionado con la API específico de la autenticación. Esto facilita gestionar las llamadas a la API y mantenerlas organizadas.
La carpeta helpers contiene métodos auxiliares o funciones de utilidad específicos de la funcionalidad de autenticación. Se pueden usar exclusivamente dentro de esa funcionalidad y no necesitan compartirse con otras partes de la aplicación.
La carpeta hooks contiene hooks relacionados específicamente con la autenticación. Como React depende mucho de los hooks, esto facilita gestionarlos y mantenerlos organizados.
La carpeta screens contiene todas las pantallas de la funcionalidad de autenticación. Esto incluye la pantalla de inicio de sesión, la de registro y la de contraseña olvidada, entre otras.
La carpeta services contiene servicios específicos de la funcionalidad de autenticación. Por ejemplo, podrías tener un servicio de autenticación que se encargue de gestionar los inicios de sesión y los registros de los usuarios.
Por último, la carpeta store contiene el código de gestión de estado específico de la funcionalidad de autenticación. Puede ser un store de Redux, un store de Zustand o cualquier otra librería de gestión de estado que prefieras.
Al dividir la aplicación en partes más pequeñas y organizadas, resulta mucho más fácil gestionar el código y modificarlo cuando haga falta. También ayuda a mantener el código limpio y legible, lo que facilita que otros desarrolladores lo entiendan y trabajen con él.
Estructura de ejemplo de la carpeta de la funcionalidad auth
src/
└── features/
└── auth/
├── api/
| ├── login.ts
| ├── signup.ts
| └── refresh-token.ts
├── helpers/
| ├── validateToken.ts
| └── dataTransformer.ts
├── screens/
| ├── Login.tsx
| └── Signup.tsx
├── services/
| └── validation.ts
└── store/
└── auth.ts
La carpeta auth es la subcarpeta dedicada a la funcionalidad de autenticación de tu aplicación. Los archivos de esta carpeta se encargan de todo lo relacionado con la autenticación y la autorización, desde las APIs de inicio de sesión y registro hasta las pantallas con las que interactúa el usuario.
La carpeta api contiene las APIs de la funcionalidad de autenticación, como los archivos login.ts y signup.ts, que gestionan las peticiones y respuestas de inicio de sesión y registro del usuario. El archivo refresh-token.ts se encarga de renovar el token.
La carpeta helpers contiene funciones auxiliares que se usan en el proceso de autenticación. Por ejemplo, el archivo validateToken.ts se usa para validar el token, y el archivo dataTransformer.ts transforma los datos que se envían a las APIs de autenticación y los que se reciben de ellas.
La carpeta screens contiene los componentes de interfaz con los que interactúa el usuario. Por ejemplo, los archivos Login.tsx y Signup.tsx contienen los componentes de interfaz para que el usuario inicie sesión y se registre, respectivamente.
La carpeta hooks contiene hooks personalizados relacionados con la autenticación. Por ejemplo, los archivos useLoginAction.ts y useSignupForm.ts contienen hooks que ayudan a gestionar el estado y las acciones de los formularios de inicio de sesión y registro, respectivamente.
La carpeta services contiene servicios relacionados con la autenticación, como el archivo validation.ts, que contiene funciones para validar lo que introduce el usuario.
La carpeta store contiene la gestión de estado relacionada con la autenticación. El archivo auth.ts contiene el estado y las acciones relacionadas con la autenticación, usando una librería de gestión de estado como Zustand, Redux u otra.
ADVERTENCIA
Es importante tener en cuenta que las convenciones de nombres de carpetas y archivos pueden variar de un proyecto a otro y de un desarrollador a otro. Lo importante es la estructura y la organización de las carpetas, más que los nombres exactos de cada una. Por ejemplo, la carpeta utils en la raíz de la app también podría llamarse helpers o utilities, o en lugar de screens podría llamarse pages o de cualquier otra forma que tenga sentido para el proyecto concreto. El objetivo es tener una estructura clara y coherente que ayude a los desarrolladores a entender la organización del código y facilite mantener y escalar la aplicación.
Estructura de carpetas por tipo frente a estructura de carpetas por funcionalidad
Otro método muy extendido para organizar el código de un proyecto es la estructura de carpetas por tipo, que tiene sus propias ventajas e inconvenientes. En la siguiente sección compararemos visualmente estas dos estructuras de carpetas.
Comparación
Feature-based folder structure:
src/
└── features/
├── auth/
| ├── api/
| │ ├── register.tsx
| │ ├── login.tsx
| │ ├── types.tsx
| │ └── helpers.tsx
| ├── helpers/
| ├── hooks/
| └── screens/
| │ ├── LoginScreen.tsx
| │ ├── SignupScreen.tsx
| │ ├── WelcomeScreen.tsx
| │ └── HomeScreen.tsx
| ├── services/
| └── store/
├── todo/
| └── screens/
| │ └── TodoListScreen.tsx
| ├── services/
| └── store/
└── ... (other features)
Type-based folder structure:
src/
├── screens/
| ├── LoginScreen.tsx
| ├── SignupScreen.tsx
| ├── TodoListScreen.tsx
| ├── WelcomeScreen.tsx
| └── HomeScreen.tsx
├── api/
| └── auth/
| ├── register.ts
| ├── login.ts
| ├── types.ts
| └── helpers.ts
Como se ve arriba, en la estructura de carpetas por tipo, las pantallas están separadas de las llamadas a la API y de los helpers, lo que puede hacer que el código sea más difícil de entender. Fíjate en cómo podríamos acabar poniendo pantallas sin relación entre sí, como LoginScreen.tsx y TodoListScreen.tsx, en la misma carpeta con la estructura por tipo. Además, también puede dificultar el mantenimiento del código, porque el código relacionado no está agrupado en un solo lugar. En cambio, en la estructura de carpetas por funcionalidad, todo el código relacionado con la autenticación, incluidas las pantallas, las llamadas a la API, los helpers y los servicios, está agrupado en una sola carpeta auth. Esto facilita entender el código, ya que todo lo relacionado está en un mismo lugar. Este enfoque permite un mejor encapsulamiento del código y hace que el proyecto sea escalable y flexible ante cambios futuros.
El resultado final con una estructura de carpetas por funcionalidad
Así es como quedaría al final la estructura de carpetas por funcionalidad, con archivos de ejemplo:
Feature-based folder structure:
src/
├── components/
│ ├── Button.tsx
│ └── Header.tsx
├── hooks/
│ └── useHeader.ts
├── localization/
│ ├── languages.ts
│ └── locales.ts
├── lib/
│ ├── axios-instance.ts
│ └── constants.ts
├── navigation/
│ ├── root-navigator.tsx
│ └── auth-stack.tsx
├── services/
│ ├── notification.ts
│ └── logging.ts
├── theme/
│ └── index.ts
├── types/
│ ├── env.d.ts
│ └── react-augment.d.ts
├── utils/
│ └── layout.ts
└── features/
├── auth/
│ ├── api/
│ │ ├── login.ts
│ │ ├── signup.ts
│ │ └── refresh-token.ts
│ ├── helpers/
│ │ ├── validateToken.ts
│ │ └── dataTransformer.ts
│ ├── hooks/
│ │ ├── useLoginAction.ts
│ │ └── useSignupForm.ts
│ ├── screens/
│ │ ├── Login.tsx
│ │ └── Signup.tsx
│ ├── services/
│ │ └── validation.ts
│ └── store/
│ └── auth.ts (zustand, redux, jotai etc.)
└── ... (other features)
Los archivos añadidos a las distintas carpetas de arriba (por ejemplo, button.tsx y header.tsx en la carpeta components, useHeader.ts en la carpeta hooks, etc.) sirven como ejemplo y no deben tomarse como 100% exactos. El propósito de incluirlos es ofrecer una representación visual de la estructura de carpetas y ayudar a entender mejor la organización del código. La implementación real puede variar según los requisitos concretos del proyecto. Este artículo se centra en la estructura de carpetas por funcionalidad y en cómo puede ayudar a construir un código escalable y organizado, no en los detalles concretos de cada archivo.
Conclusión
En mi opinión, la estructura de carpetas por funcionalidad es un enfoque útil para organizar proyectos de React/React Native. Al dividir el código en funcionalidades separadas, me resulta más fácil mantener, entender y desarrollar la aplicación. Esta estructura permite un mejor encapsulamiento del código y hace que el proyecto sea escalable y flexible ante cambios futuros. Por supuesto, no es una solución universal, y la estructura exacta puede variar según el tamaño y la complejidad del proyecto. Aun así, la idea clave es mantener una separación clara entre las distintas funcionalidades y sus respectivos componentes, servicios y datos. En mi experiencia, esta estructura me ha ayudado a construir y mantener proyectos bien organizados, capaces de soportar el crecimiento y los cambios con el tiempo. Quería compartir este enfoque con otras personas a las que también les pueda resultar útil.
Publicado en
Este artículo también está publicado en: