Estndares de Programacin

Taller de Proyecto 2

Estndares de Programacin de Base de Datos v1.1

Historial de Revisin

Fecha

Versin

Descripcin

Autor

11/09/2008

1.0

Estndares de Programacin / Nomenclatura Oracle

Encarnacin, Ral

15/09/2008

1.1

Correccin de Nomenclatura

Encarnacin, Ral

ndice

61.Introduccin

61.1Objetivo y Alcance

72.Generalidades

72.1Conceptos

72.1.1Aplicaciones

72.1.2Mdulos

82.1.3Identificador

82.2Entornos

82.2.1Definicin

82.2.2Desarrollo

92.2.3Integracin

92.2.4Produccin

92.3Responsabilidades

92.3.1Desarrollo

92.3.2Integracin

102.3.3Produccin

112.3.4Usuarios

113.Identificacin de Mdulos

113.1Aplicacin

113.2Mdulo

114.Lenguajes y Tecnologas

125.Objetos de Base de Datos

125.1Tablas, Stored Procedures, Funciones, Triggers y Secuencias

135.1.1Nomenclatura de Tablas

135.1.2Nomenclatura de Paquetes

145.1.3Nomenclatura de Stored Procedures

145.1.4Nomenclatura de Functions

155.1.5Nomenclatura de Triggers

155.1.6Nomenclatura de Secuencias

165.2Indices

175.3Campos

176.SQL

176.1Introduccin

176.2Estilo

176.2.1SELECT

186.2.2JOIN

196.2.3INSERT

206.3Optimizacin

207.PL/SQL

207.1Variables de trabajo y de Entrada/Salida

217.2Estilo

227.3Cursores

227.4Excepciones y control de errores

Estndares de Programacin

1. Introduccin

El presente documento describe detalladamente los Estndares de Programacin a utilizarse para el trabajo del curso de Taller de Proyectos 2. Uno de los aspectos clave de este documento es la definicin y uso homogneo de todas las herramientas de desarrollo.

1.1 Objetivo y Alcance

El objetivo y alcance del presente documento es listar y describir cada uno de los Estndares de Programacin para el trabajo del desarrollo del curso de Taller de Proyectos 2.

Aumentar la confianza del usuario final en las aplicaciones desarrolladas, ofrecindole un entorno familiar, sin sorpresas ni excepciones.

Facilitar el mantenimiento de aplicaciones haciendo que un mdulo no est ligado al programador del mismo.

Los principales destinatarios son los analistas y programadores responsables del desarrollo de aplicaciones.

El documento no pretende ser completo. Muchos aspectos del desarrollo de software quedarn fuera de estas especificaciones. Por ello, resulta especialmente interesante que los responsables de las diferentes aplicaciones propongan nuevos estndares para todos aquellos aspectos no cubiertos en este documento, evitando la diversificacin de criterios en las soluciones propuestas a problemas comunes.

2. Generalidades

2.1 Conceptos

Llamaremos aplicacin a cualquier desarrollo software funcionalmente independiente que, no obstante, puede interconectarse, puntualmente, a otros desarrollos.

Un mdulo puede ser cualquier programa: jsp, scripts, formas, reportes, etc. Los mdulos pueden ser fuentes o ejecutables, si bien, algunas clases de mdulos (procedimientos SQL) pueden tratarse indistintamente como fuentes o ejecutables.

2.1.3 Identificador

El identificador puede contener exclusivamente los caracteres a-z,

Al identificador genrico se le aadirn cdigos que aporten informacin sobre el objeto identificado como se describe posteriormente en este documento) por lo que las palabras elegidas para construir el identificador no deben hacer referencia a la naturaleza del objeto identificado.

2.2 Entornos

2.2.1 Definicin

Desde un punto de vista lgico se distinguirn tres entornos bien diferenciados: Desarrollo, Integracin y Produccin.

2.2.2 Desarrollo

El Entorno de Desarrollo comprende todos los mdulos sobre los cuales trabaja el grupo de programacin en las primeras fases del desarrollo de una nueva aplicacin: desarrollo y pruebas unitarias. Existir un Entorno de Desarrollo por cada nueva aplicacin que se empiece.

2.2.3 Integracin

El Entorno de Integracin se compone de los mdulos y escenarios de datos necesarios para realizar las pruebas de integracin previas a la puesta en servicio de una aplicacin. Una vez entregada a los usuarios, el grupo de mantenimiento realizar su labor sobre este entorno. Cada aplicacin dispondr de su propio Entorno de Integracin siendo posible disponer simultneamente de ms de una versin de la misma aplicacin.

2.2.4 Produccin

El Entorno de Produccin consta de los datos y mdulos ejecutables que emplean los usuarios finales as como de todos los mdulos necesarios para reconstruir la versin actual de los ejecutables.

2.3 Responsabilidades

2.3.1 Desarrollo

Cada programador dispondr de sus propios directorios de trabajo as como de datos independientes para realizar pruebas unitarias de los mdulos que vaya desarrollando. Es responsabilidad del programador la organizacin de su directorio de trabajo as como el mantenimiento de sus datos de prueba.

Se favorecer el traspaso de mdulos en desarrollo entre programadores con la nica limitacin de que un programador no pueda modificar el trabajo de otro.

2.3.2 Integracin

Desde el primer momento que se necesite probar la integracin de dos o ms mdulos se crear un Entorno de Integracin para la aplicacin correspondiente. A este entorno se pasarn los mdulos que hayan superado las pruebas unitarias y sobre los que se vayan a realizar las pruebas de integracin.

El rea de Sistemas crear los Entornos de Integracin necesarios pasando, a continuacin, la responsabilidad del mantenimiento de los escenarios de pruebas y de la coherencia del Entorno de Integracin al Analista responsable de la aplicacin.

Hasta la puesta en servicio de la aplicacin, existirn simultneamente los Entornos de Desarrollo e Integracin para una misma aplicacin. Una vez creado el Entorno de Explotacin dejar de existir el de desarrollo.

Para las aplicaciones en explotacin es posible mantener varias versiones de la misma en el Entorno de Integracin (Para mantenimiento y otra para desarrollar nuevas funcionalidades).

Los Entornos de Integracin de las diferentes aplicaciones estarn aislados. Con el acuerdo previo de los Analistas responsables, el rea de Sistemas facilitar la colaboracin entre los diferentes grupos de desarrollo.

2.3.3 Produccin

Las aplicaciones se distribuirn en el Entorno de Produccin atendiendo a consideraciones de seguridad y de rendimiento. La integridad y seguridad de los datos y mdulos en el Entorno de Explotacin sern responsabilidad exclusiva del rea de Sistemas. Se facilitaran los mecanismos adecuados para permitir a los grupos de mantenimiento de aplicaciones el traspaso de mdulos modificados o nuevos al Entorno de Explotacin.

El Analista responsable de cada aplicacin dispondr de acceso no restringido a los mens de su aplicacin en el Entorno de Explotacin. Adems podr acceder a las tablas correspondientes de la base de datos, si bien, no podr modificar la estructura de las mismas.

2.3.4 Usuarios

Los usuarios podrn acceder a los datos en explotacin exclusivamente a travs de la aplicacin correspondiente. El responsable del rea para la que se ha desarrollado una aplicacin definir claramente los perfiles de todos los usuarios de modo que puedan delimitarse responsabilidades.

La alteracin de datos en explotacin slo ser posible, en general, por medio de la aplicacin, y por un usuario debidamente autorizado (con el perfil adecuado). No obstante, en casos excepcionales y con la debida autorizacin del responsable del rea correspondiente, el Analista de la aplicacin podr modificar los datos cuando as se considere oportuno.

3. Identificacin de Mdulos

El nombre de un mdulo consta de no ms de 12 caracteres en minsculas (a-z) distribuidos de la siguiente forma: de tal forma que se le pueda identificar unvocamente.

El significado de los caracteres que componen el nombre de un mdulo es el siguiente:

3.1 Aplicacin

Cdigo de la Aplicacin a la que pertenece el mdulo.

3.2 Mdulo

Esta palabra deber identificar un mdulo dentro de una Aplicacin.

4. Lenguajes y Tecnologas

Los Lenguajes y Tecnologas seleccionadas para el desarrollo de aplicaciones en el Grupo 1 son los siguientes:

Oracle PL/SQL como lenguaje para la construccin de Objetos del Servidor de Base de Datos.

JDK 6 actualizacin 7 como Framework de desarrollo.

Las versiones superiores de estos productos podrn irse incorporando al desarrollo de aplicaciones conforme se vaya probando su idoneidad.