Software Design Description Caracterización de la comunidad. 06/07/2012 Fabián García Ariel López

Transcripción

1 Software Design Description Caracterización de la comunidad 06/07/2012 Fabián García Ariel López

2 PAGINA DE FIRMAS ALEX LINARES CLIENTE FABIÁN GARCÍA ARIEL LÓPEZ LESMES

3 HISTORIAL DEL CAMBIOS Versión Fecha Sección del documento Descripción del cambio Responsable Sección 1 Se crea el Fabián García documento con la primera sección Sección 2 y 3 Fabián García Sección 4,5 y 6 Fabián García Tabla 1: Historial de cambios

4 PREFACIO El proceso de diseño de software es la actividad dentro del ciclo de vida, en la que se analizan los requerimientos del software, con el fin de producir una descripción de la estructura interna del mismo, que servirá como base para su posterior construcción. Si se quiere ser más preciso, un buen diseño de software; debe describir la arquitectura con la cual funcionará es decir, cómo el software se descompone y se organiza en los componentes que sean necesario además de las interfaces usadas entre estos. También debe describir los componentes con un nivel de detalle que permita su construcción. Este plan está desarrollado según la plantilla SDD de IRONWORK [1] [2] [3], con ligeras adaptaciones. Este documento estará dirigido al Ing. Alex Linares representante de PROSOFI [24] donde se desarrolla el proyecto de caracterización de la comunidad.

5 Contenido 1. Introducción Descripción del Sistema Referencias y Documentos de Apoyo Definiciones, Acrónimos y Abreviaciones Consideraciones de Diseño Restricciones Riesgos Arquitectura Apreciación Global Diagrama de Componentes Cliente Servidor Estrategias de Diseño Diseño de Alto Nivel Diagrama de despliegue Nodo 1 PC Cliente Nodo 1 Servidor JavaEE Comportamiento e Interacción Diagrama de Secuencia Diseño de Bajo Nivel Modelo entidad Relación Diseño de Interfaces de Usuario Árbol de navegabilidad... 19

6 1. Introducción 1.1 Descripción del Sistema En este documento se pretende describir el sistema que será diseñado para la elaboración del proyecto Caracterización de la comunidad del grupo Prosofi de la Pontificia Universidad Javeriana, para apoyo a las comunidades de la localidad de Usme. Se construirá el sistema bajo una arquitectura de 3 capas en la cual se separara la presentación, lógica del negocio y acceso a datos, en diferentes componentes que serán distribuidos en 2 tiers; en uno estará el cliente con un navegador web que se encargara de transformar el código de presentación en html y en el otro tier se encontrara la implementación de la lógica del negocio y la capa de acceso a datos. La aplicación será generada en el lenguaje Java EE 5 a través del IDE Sare.m2t.generator [17]. El presente documento servirá como base para el desarrollo de la aplicación, al equipo de trabajo, quienes son los encargados de implementar las funcionalidades requeridas por el cliente, las cuales serán modeladas y estructuradas en este documento. 1.2 Referencias y Documentos de Apoyo [1] IronWorks, Plantilla SPMP, Pontificia Universidad Javeriana ed., [2] IronWorks, SDD Linea Base.: Pontificia Universidad Javeriana, [3] IronWorks, SRS Linea Base., [4] William Wake, Extreme Programming Explored.: Addison- Wesley, [5] Roy K. Clemmons, Project estimation with use case points., [6] IEEE, Software Engineering Body of Knowledge SWEBOK., [7] ISO 9001:2000, "Quality Management Systems Requirements, ISO," [8] IBM. (2011) Rational Unified Process (RUP). [Online]. " 01.ibm.com/software/awdtools/rup/" 01.ibm.com/software/awdtools/rup/

7 [9] RUP. (2011) Configuration Management Plan. [Online]. " [10] Dropbox. (2011) Dropbox. [Online]. " [12] Google. (2011) Google Project. [Online]. " [13] tigris. (2012) subclipse. [Online]. " [14] Ian Sommerville, Ingenieria de Software, Pearson, Ed., [15] IEEE, Project Management Body of Knowledge (PMBOK), Project Management Institute, Inc, 3rd ed., [16] E. Tello. (Diciembre 2008). Monitorización y Control del Proyecto [En Línea]. Disponible: y- control- del- proyecto [17] J. A. Pavlich and A. López, SARE: Security Assurance for Roundtrip Engineering. [Online]. Available: [Accessed: 02- May- 2012]. [18] Sun Microsystems, The Java EE 5 Tutorial, Available: [Accessed: 18- May- 2012]. [19] JBoss Seam Group, Reference manuals of JBoss Seam, Available: [Accessed: 18- May- 2012]. [20] IEEE SOFTWARE, What s Good Software, Anyway? Hakan Erdogmus., [21] Sparx Systems, Enterprise Architect [Online]. [Accessed: 18- Jun- 2012]. [22] PostgreSQL [Online] [Accessed: 18- Jun- 2012]. [23] B Bruegge, Ingeniería de Software Orientado a Objetos.: Prentice Hall, 2002 [24] Prosofi Programa Social Facultad de Ingenieria. portal.javeriana.edu.co/portal/page/portal/facultad%20de%20ingenieria/plt_facultad/prosofi

8 1.3 Definiciones, Acrónimos y Abreviaciones TÉRMINO SDD Sare JSF EJB Prosofi M2t DEFINICIÓN Software Design Description. Security Assurance for Roundtrip Engineering Java Server Faces Enterprise Java Beans Programa Social de la facultad de ingeniería. Model to Text Tabla # 2: Definiciones y acrónimos

9 2. Consideraciones de Diseño 2.1 Restricciones Caracterisycas de usuario Haber leido previamente el manual de usuario de la aplicación. Hardware El equipo en el que se ejecute la aplicacion debera tener por lo menos 2 Gb de memoria principal (RAM) y un procesador de uno o mas nucleos a una velocidad minima de 2.0 Ghz. So{ware El motor de base de datos debera ser SQLPostgres en su version 9. El IDE de desarrollo debera ser Eclipse Indigo; y tendra que estar configurado con Sare M2t.generator [17], servidor de aplicaciones JBoss 5.1 GA y ademas tendra que tener incorporado el generador de codigo Seam Riesgos Grafica # 1: Restricciones Para realizar el diseño y la arquitectura se toman los mismos riesgos que se describieron en el SPMP (Ver SPMP 5.4 Plan de administración de riesgos).

10 3.1 Apreciación Global 3. Arquitectura Para la realización de la aplicación hemos decidido usar la plataforma de programación Java EE 5. Java EE tiene definida una arquitectura multi nivel para sus aplicaciones, esto con el objetivo de separar diferentes aspectos del desarrollo en diferentes capas. Para la realización de la aplicación basada en CRUDs para cada una de las entidades obtenidas a partir del modelo de datos, hemos decidido definir una arquitectura de 3 capas como se muestra en la siguiente figura: Grafica #2: Arquitectura de la aplicación basada en CRUDS Además de esto decidimos distribuir estas 3 capas en 2 tiers como se explica a continuación. Tier Cliente: La máquina del usuario debe tener un navegador web y éste se responsabilizará de presentar la interfaz de usuario al usuario final y de comunicarlo con el nivel de lógica de negocio. Tier Servidor: En esta maquina estará la implementación de la lógica del negocio y se encontrara la capa de acceso a datos con su correspondiente base de datos donde estará almacenada toda la información de las encuestas. 3.2 Diagrama de Componentes Este diagrama representa la composición que tendrá la aplicación basada en CRUDs, la arquitectura a usar y las relaciones entre componentes. En la siguiente grafica se muestra el diagrama de componentes:

11 cmp Componentes Server Logica de Presentación Cliente Interfaz Grafica Cliente (HTML) Logica de Negocio (EJB) Base de Datos Relacional Grafica # 3: Diagrama de Componentes Cliente Este subsistema es un paquete que conyene todos los componentes usados por el Cliente que ejecutara la aplicacion web. Este subsistema es un paquete que conyene todos los componentes usados por el Servidor. Servidor Gráfica # 4: Subsistemas del diagrama de componentes

12 La tabla 2 muestra la plantilla que se utilizará para documentar cada uno de los componentes. COMPONENTE FUNCIÓN RELACIONES Nombre del componente a describir Función que realiza dicho componente en el subsistema Relaciones que tiene con otros componentes Tabla # 2: Plantilla de documentación de componentes Cliente COMPONENTE FUNCIÓN RELACIONES Este componente permite al Interfaz Grafica Cliente cliente la visualización de la aplicación. Se encarga de comunicar al cliente con la lógica de presentación ubicada en el servidor. Une el Cliente y Servidor por medio del componente Interface de Entrada. Tabla # 3: Documentación componentes Subsistema Cliente Servidor COMPONENTE FUNCIÓN RELACIONES Lógica de Presentación Este componente separa toda la lógica de presentación; en esta se encuentran las páginas JSF, Faces Servlets, etc; para cada uno de los casos de uso CRUD. Este componente se encarga Se comunica con el componente de lógica de negocio. Generalmente cada uno de los botones de las páginas invoca un método de un EJB de sesión. Se comunica con la base de de separar la datos por de una instancia Lógica de Negocio (EJB) implementación de la lógica de negocio, en este se encuentran todos los EJBs de sesión y las entidades del entity manager que esta asociada con un contexto de persistencia. Un contexto de persistencia es un conjunto

13 persistentes. (Session beans & entity beans). de instancias de entidades persistentes. Este componente representa la base de datos Base de Datos Relacional relacional en la cual se encuentran todos los datos de las encuestas. Tabla # 4: Documentación componentes Subsistema Servidor 3.3 Estrategias de Diseño Las arquitecturas de aplicaciones empresariales realizadas en java EE que utilizan el framework de generación Seam, tienen un principal elemento el cual es el meta patrón MVC, este se explica en la siguiente figura: Gráfica # 5: Meta patrón MVC Modelo: Maneja las reglas del negocio y estructura de los datos. Vista: Maneja presentación de los datos del modelo al usuario.

14 Controlador: Transforma pedidos del usuario en operaciones sobre los objetos del modelo y selecciona vista para mostrar resultados al usuario.

15 4. Diseño de Alto Nivel 4.1 Diagrama de despliegue El presente diagrama es la representación física del hardware donde se muestran los nodos, con su especificación y dentro de ellos elementos de software, con asociaciones entre los nodos representando como se comunican entre sí. A continuación, en la gráfica se muestra el diagrama de despliegue para la aplicación de CRUDs, que se realizara en la plataforma Java EE5. Grafica # 5: Diagrama de Despliegue Se identificaron dos nodos, los cuales representan al cliente y al servidor, cada nodo con sus correspondientes componentes. De esta manera se entiende que estas maquinas deben tener diferentes características y funcionan de manera distinta Nodo 1 PC Cliente Este nodo representa el computador del cliente, en el cual se encuentran los siguientes componentes: Web Browser Es una aplicacion que opera a traves de internet, interpretando la informacion enviada por la logica de presentacion del servidor, y combiryendola en html, permiyendo al usuario interactuar con el contenido. Grafica # 6: Componentes del nodo PC Cliente.

16 4.1.2 Nodo 1 Servidor JavaEE Este nodo representa el nodo del servidor de la aplicación JavaEE en el cual se encuentran los siguientes componentes: EJB Container Este contenedor aloja el pool de componentes EJB de toda la aplicacion, Administrador de Datos Este componente representa la base de datos relacional en la cual se encuentra alamacenada toda la informacion de las encuenstas. Grafica # 7: Componentes del nodo Servidor JavaEE. 4.2 Comportamiento e Interacción Diagrama de Secuencia Ya que todos los casos de uso son de tipo CRUD estos tienen la misma estructura, por tanto solo se mostrara un diagrama de secuencia en este documento. La siguiente grafica muestra el diagrama de secuencia de un caso de uso CRUD:

17 sd Use Case Model Usuario pagina JSF Caracterizacion PROSOFI Session Bean CRUD Entity Bean Base de datos SQLPostgres Ingresar() invoca() Trabaja sobre() extraer() muestra() Visualizar Resultados() Grafica # 8: Diagrama de secuencia caso de uso CRUD. Se usara la siguiente tabla para realizar la documentación de este diagrama. ESPECIFICACIÓN Nombre Descripción Casos de uso Asociados Entradas Objetivo Nombre de la Diagrama Descripción detallada del diagrama. Casos de uso asociados al diagrama Acciones o peticiones que realiza el actor Meta del diagrama Tabla #5: Especificación Diagramas de Secuencia Diagrama de secuencia caso de uso CRUD. Nombre Descripción Casos de uso Asociados Entradas Nombre de la Diagrama El diagrama de la gráfica 8 muestra la secuencia que se realiza en cada una de las operaciones de listar, crear, eliminar y editar de un caso de uso CRUD. Todos los casos de uso. Ingreso a la aplicación desde un navegador web, la opción login

18 queda opcional pero para esto se debe insertar una tupla directamente en la base de datos. Objetivo Muestra la interacción de un usuario con la aplicación y la comunicación que se hace entre las capas. Tabla #6: Documentación Diagrama de Secuencia caso de uso CRUD.

19 5.1 Modelo entidad Relación 5. Diseño de Bajo Nivel Para más información sobre este diagrama, (ver el enlace de google code: c- p.googlecode.com/svn/trunk/prosofi.caracterizacion.usmecaracterizacion/modelo/caracteriza cioncomunidad.uml ), en base a este diagrama se generó el código de la aplicación. Para visualizar este diagrama se debe hacer uso de la herramienta eclipse en cualquiera de sus versiones con el plugin UMLtools, además se debe hacer check out del proyecto desde el repositorio c- p.googlecode.com/svn.

20 6.1. Árbol de navegabilidad 6. Diseño de Interfaces de Usuario La siguiente figura describe el flujo de navegación de uno de los casos de uso CRUDs de la aplicación JavaEE: Grafica # 9: Flujo de navegación caso de uso CRUD.