14 - Documentar Arquitectura de Software Ingeniería de Software Proceso de Diseño de la Arquitectura Definir los Requerimientos Crear un modelo desde los requerimientos que guiarán el diseño de la arquitectura basado en los atributos de calidad esperados. Diseñar la Arquitectura Definir la estructura y las responsabilidades de los componentes que comprenderán la Arquitectura de Software. Validar la Arquitectura Significa “probar” la arquitectura, típicamente comparando a través del diseño contra los requerimientos actuales y cualquier posible requerimiento a futuro. Proceso de Diseño de la Arquitectura Requerimientos Seleccionar Arquitectura (estilo arquitectónico) Identificar y ubicar los componentes Vistas de Arquitectura Modelo C4 Haciendo Zoom a la Arquitectura El modelo C4 Propósito El uso de UML proporcionan una forma efectiva de comunicar la arquitectura de software, pero menudo los equipos de desarrollo los descartan en favor de diagramas de cajas y líneas mucho más simples. El modelo C4 se creó como una forma de ayudar a los equipos de desarrollo de software a describir y comunicar la arquitectura de software de forma más simple. El modelo C4 Propósito C4 busca emular el uso de mapas del código en varios niveles de detalle, de la misma manera que lo haría Google Maps para acercar y alejar un área que le interesa. El modelo C4 Propósito Proporciona una forma para que los equipos de desarrollo de software comuniquen de manera eficiente y efectiva su arquitectura de software, en diferentes niveles de detalle, contando diferentes historias a diferentes tipos de audiencia, al hacer un diseño inicial o retrospectivamente. Los diferentes niveles de zoom le permiten contar diferentes historias a diferentes audiencias Tiene un enfoque de "abstracción primero" que reflejan cómo los arquitectos y desarrolladores piensan y construyen software. Abstracciones C4 C4 usa un conjunto de abstracciones o definiciones comunes para crear un lenguaje que permita describir la estructura estática de un sistema de software. Un sistema de software está hecho contenedores como por ejemplo: aplicaciones web, móviles, de escritorio, bases de datos, sistemas de archivos, etc., Cada contenedor agrupa uno o más componentes. (Módulos y componentes) Que a su vez son implementados por uno o más elementos de código: clases, interfaces, objetos, funciones, etc. Abstracciones C4 1. Persona: Una persona representa a uno de los usuarios humanos de su sistema de software. por ejemplo, actores, roles, personajes, etc. 3. Contenedor: Representa una aplicación o un almacén de datos. Es un contexto o límite dentro del cual se ejecuta algún código o se almacenan algunos datos. 2. Sistema de software: Es el nivel más alto de abstracción y describe algo que ofrece valor a sus usuarios. En general un sistema es "propiedad de" un solo equipo de desarrollo de software. 4. Componente: Es una agrupación de funcionalidades relacionadas encapsuladas detrás de una interfaz bien definida sin importar su compilación. Reglas y recomendaciones Modelo C4 Reglas de Notación Se recomienda la estructura del ejemplo: Se permite usar colores y formas para complementar el diagrama, para agregar información adicional o para hacer que el diagrama sea más agradable estéticamente. Todos los diagramas deben tener su título y una clave o leyenda para hacer explícita la notación. Recomendaciones ● Cada diagrama debe tener un título que describa el tipo de diagrama y su alcance, como "Diagrama de contexto del sistema para <mi app>". ● El tipo de cada elemento debe especificarse explícitamente, por ejemplo, Persona, Sistema de software, Contenedor o Componente. ● Cada diagrama debe tener una clave o leyenda que explique la notación: formas, colores, estilos de borde, tipos de líneas, puntas de flecha, etc. ● Cada elemento debe tener una descripción breve, para proporcionar "de un vistazo" sus responsabilidades. ● Cada contenedor y componente debe tener una tecnología especificada explícitamente. ● Los acrónimos y abreviaturas de negocio, dominio o tecnología deben ser comprensibles para todas las audiencias o estar en la leyenda. Recomendaciones ● Cada relación debe ser unidireccional. ● ● Cada relación debe estar etiquetada, la etiqueta debe ser coherente con la dirección e intención de la relación. La etiqueta debe de ser lo más específica posible, idealmente evitando palabras sueltas como "Usa". Puede usar esta lista de verificación para validar que su diagrama se encuentre completo ● Use herramientas como Structurizr para facilitar el proceso de creación y documentación ● Cuando las relaciones entre contenedores representan la comunicación entre procesos deben tener una tecnología o protocolo etiquetado explícitamente. Diagramas principales Modelo C4 Diagramas principales La visualización de esta jerarquía de abstracciones se realiza creando una colección de diagramas de Contexto , Contenedor , Componente y (opcionalmente) Código (como diagramas UML). De aquí es de donde el modelo C4 recibe su nombre. 1: Diagrama de Contexto Es el punto de partida para diagramar y documentar un sistema porque permite ver el panorama general. En este diagrama el sistema es una caja en el centro, rodeado por sus usuarios y los otros sistemas con los que interactúa. El enfoque de este diagrama debe estar en las personas (actores, roles, personas, etc.) y sistemas de software en lugar de tecnologías, protocolos y otros detalles de bajo nivel. 1: Diagrama de Contexto Alcance: Un solo sistema de software. Elementos primarios: El sistema en el alcance. Elementos de apoyo: personas (como usuarios, actores, roles o personas) y otros sistemas de software (dependencias externas) directamente conectados al sistema en el alcance. Por lo general, estos otros sistemas están fuera del alcance o límites del propio sistema, y no se tiene responsabilidad ni propiedad sobre ellos. Público objetivo: todos, tanto técnicos como no técnicos, dentro y fuera del equipo de desarrollo de software. Recomendado para la mayoría de equipos: sí. 2: Diagrama de Contenedores El diagrama de contenedores muestra la arquitectura del software y la manera cómo se distribuyen las responsabilidades en ella (módulos). También muestra las principales opciones tecnológicas (stack tecnológico) y cómo los contenedores se comunican entre sí. Es un diagrama centrado en la tecnología de alto nivel que es útil tanto para los desarrolladores de software como para el personal de operaciones y soporte. 2: Diagrama de Contenedores Alcance: Un solo sistema de software. Elementos primarios: Contenedores dentro del sistema de software en el alcance. Elementos de apoyo: Personas y sistemas de software directamente conectados a los contenedores. Público objetivo: personal técnico dentro y fuera del equipo de desarrollo de software; incluidos arquitectos de software, desarrolladores y personal de operaciones / soporte. Recomendado para la mayoría de equipos: sí. Notas: Este diagrama no dice nada sobre escenarios de implementación, agrupación en clústeres, replicación, conmutación por error, etc. 3: Diagrama de Componentes Se puede acercar y descomponer más cada contenedor para identificar los principales bloques de construcción estructural y sus interacciones. El diagrama de componentes muestra que contiene un contenedor: de una serie de componentes: cuáles son cada uno de esos componentes, sus responsabilidades y los detalles de tecnología o implementación. Nivel 3: diagrama de componentes Alcance: Un solo contenedor. Elementos primarios: componentes dentro del contenedor en el alcance. Elementos de apoyo: Contenedores dentro del sistema de software en el alcance, personas y sistemas de software directamente conectados a los componentes. Público objetivo: arquitectos y desarrolladores de software. Recomendado para la mayoría de equipos: no, solo cree diagramas de componentes si cree que agregan valor y considere automatizar su creación para una documentación de larga duración. (Sí para esta clase) 4: Código Finalmente, puede profundizar en cada componente para mostrar cómo se implementa a nivel de código C4 no crea una especificación para este nivel, sino que recomienda diagramas UML como el de clases, de relación de entidades o similares. Este es un nivel de detalle opcional y C4 no lo recomienda para nada más que los componentes más importantes o complejos. Remítase al apartado del modelo 4+1 Alcance: Un solo componente. Elementos primarios: Elementos de código como clases, interfaces, objetos, funciones, tablas de bases de datos, etc. dentro del componente en el alcance. Público objetivo: arquitectos y desarrolladores de software. Recomendado para la mayoría de los equipos: no, para la documentación de larga duración, los IDE pueden generar este nivel de detalle bajo demanda. Diagramas Complementarios Diagrama de despliegue Permite ilustrar cómo los sistemas y los contenedores son asignados a la infraestructura Se basa en un diagrama de implementación UML simplificado para mostrar el mapeo entre los contenedores y los nodos de despliegue. Un nodo de despliegue puede ser: ● ● ● infraestructura física: un servidor o dispositivo físico infraestructura virtualizada: IaaS, PaaS, una máquina virtual Entornos de ejecución: servidor de base de datos, Java EE web server, Microsoft IIS, Docker Los nodos de implementación se pueden anidar. Arquitectura de la Solución Actividad Para su proyecto final, y a partir de boceto de la actividad anterior, realice el diseño arquitectónico de su aplicación: ● ● ● Vista de contexto, Vista de contenedores Vista de componentes. IMPORTANTE: Una vez acordado con el equipo el diseño inicial de la arquitectura, es altamente recomendable iniciar con la implementación de los componentes básicos o infraestructura de su solución. Modelo de Vistas de Arquitectura 4+1 Modelo de Vistas de Arquitectura 4+1 Modelo para "describir la arquitectura de sistemas software, basados en el uso de múltiples vistas concurrentes". Philippe Kruchten Lógica Las vistas buscan describir el sistema desde diferentes puntos de vista: vista lógica, vista de desarrollo, vista de proceso y vista física (o despliegue). Desarrollo Escenarios Incluye una sección de escenarios para ilustrar la arquitectura en uso o funcionamiento. Proceso Despliegue Vista lógica Está enfocada en describir la estructura y funcionalidad del sistema. Lógica Desarrollo Apoya principalmente los requisitos funcionales. Sirve para identificar mecanismos y elementos de diseño comunes a diversas partes del sistema. Escenarios Hace uso de los diagramas UML: ● ● Diagrama de Clases ** Diagrama de Comunicación ** En mi vida los he utilizado o los he visto Proceso Despliegue Diagrama de Clases https://www.uml-diagrams.org/ Diagrama de Comunicación https://www.uml-diagrams.org/ Vista de Desarrollo o implementación Ilustra el sistema desde la perspectiva del programador. ● Lógica Desarrollo Se centra en la organización real de los módulos de software en el ambiente de desarrollo del software. Apoya la asignación de requisitos y trabajo al equipo de desarrollo, apoya la evaluación de costos, la planificación, el monitoreo de progreso del proyecto, y también como base para analizar reuso, portabilidad y seguridad. Escenarios Hace uso de los diagramas UML: ● ● Diagrama de Componentes Diagrama de Paquetes Proceso Despliegue Diagrama de Componentes https://www.uml-diagrams.org/ Diagrama de Paquetes https://www.uml-diagrams.org/ Vista de Proceso Se encarga de los aspectos dinámicos del sistema, explica los procesos de sistema y cómo se comunican. Lógica Desarrollo Se enfoca en el comportamiento del sistema en tiempo de ejecución. La vista considera aspectos no funcionales como la concurrencia, distribución, rendimiento, escalabilidad, etc. Escenarios Hace uso de los diagramas UML: ● ● Diagrama de Secuencia Flujos BPMN Proceso Despliegue Diagrama de Actividad https://www.uml-diagrams.org/ Vista física o de despliegue Está relacionada con la topología de componentes de software en la capa física, así como las conexiones físicas entre estos componentes. Lógica Toma en cuenta los requisitos no funcionales del sistema tales como la disponibilidad, confiabilidad (tolerancia a fallas), performance (throughput), y escalabilidad. Desarrollo Escenarios Hace uso de los diagramas UML: ● Diagrama de Despliegue Proceso Despliegue Diagrama de Despliegue https://www.uml-diagrams.org/ Vista de Escenarios Los escenarios describen secuencias de interacciones entre objetos, y entre procesos. ● Lógica Desarrollo Los escenarios son de alguna manera una abstracción de los requisitos más importantes. Se utilizan para identificar y validar el diseño de arquitectura, así como punto de partida de las pruebas de un prototipo de la arquitectura. Escenarios Hace uso de los diagramas UML: ● Diagrama de Casos de uso Proceso Despliegue Diagrama de Casos de Uso https://www.uml-diagrams.org/ Relaciones entre las vistas De la lógica al desarrollo: Una clase se implementan dentro de módulos, y si son muy grandes, se descomponen en colecciones de clases y paquetes, que pueden agruparse en subsistemas. Lógica De la lógica a los procesos: En la vista lógica debemos considerar que cada objeto es activo teniendo comportamiento en paralelo con otros objetos. Desarrollo Escenarios De desarrollo o procesos a despliegue: Los componentes y los procesos deben mapearse sobre el hardware el físico, por lo que saber qué componentes y qué procesos corren en qué parte de la infraestructura es vital. Los escenarios permiten comprobar de manera completa el funcionamiento de los requerimientos, lo que involucra que todas las vistas de la arquitectura estén funcionando correctamente. Proceso Despliegue ¡Gracias! ¿preguntas? daniel.saavedra@unisabana.edu.co CREDITS: This template was downloaded and modified from Slidesgo, including icons by Flaticon and infographics & images by Freepik Other image credits: ●
0
You can add this document to your study collection(s)
Sign in Available only to authorized usersYou can add this document to your saved list
Sign in Available only to authorized users(For complaints, use another form )