Instalación
- Spring Tool Suite
- Instalación Maven
- Convenciones en STS
- Formatter
- Imports
- Save Actions
- Configuración de Code Template
- Otras configuraciones
- Configuración de MySQL
- Configuración de GitHub en STS
- Configuración de Maven en STS
- Configuración del certificado SSL
- Configuración del archivo de propiedades
- Configuración de tomcat para Pentaho
En el siguiente manual encontraremos el uso de las herramientas básicas utilizadas hasta ahora para el desarrollo de la aplicación MARLO. Las herramientas que configuraremos son:
- Spring Tool Suite.
- Maven.
- Freemarker.
Spring Tool Suite (STS), es un framework de desarrollo de aplicaciones en Eclipse, este provee un ambiente de trabajo basado en el modelo vista-controlador; dicho framework será usado en el desarrollo de la aplicación MARLO.
Para la instalación de Spring, debemos comprobar inicialmente si tenemos instalada una versión reciente de Java SE Development Kit (JDK); se recomienda 7u o superior; si no se tiene, se deberá descargar la versión más reciente en la página oficial y posteriormente instalarlo siguiendo las instrucciones descritas en el siguiente sitio web.
http://www.oracle.com/technetwork/es/java/javase/downloads/index.html
Una vez instalado el JDK, se procede a la descarga de la herramienta STS, ingresando a la página web oficial https://spring.io/tools/sts descargaremos el paquete de instalación en una versión actual, dependiendo la arquitectura de nuestra máquina elejimos la arquitectura (32 o 64 bits).
Una vez descargado el archivo de instalación, procedemos a descomprimir el archivo .zip, con las herramientas que dispongamos para ello (Winzip, 7-zip entre otros). Después de descomprimido, lo guardamos en un lugar seguro ya que este contendrá los archivos necesarios para la ejecución de la plataforma.
Por recomendación y facilidad de ubicación del archivo creamos un acceso directo al escritorio del aplicativo, para ello buscamos la ruta \spring-tool-suite-3.8.1.RELEASE-e4.6-win32-x86_64\sts-bundle\sts-3.8.1.RELEASE y creamos un acceso directo al escritorio del archivo STS.exe.
Todo lo anterior, para que nos resulte más fácil acceder al programa desde nuestro escritorio, abrimos el archivo STS, lo cual nos desplegará la siguiente interfaz de bienvenida de la aplicación.
Una vez configurado STS, procedemos a configurar Maven, herramienta utilizada para el control de versiones de las librerías y empaquetamiento de la aplicación. Para la instalación seguiremos los siguientes pasos:
- Descargamos el archivo de instalación de la página oficial, https://archive.apache.org/dist/maven/maven-3/ y escogemos la version 3.3.3.
-
Descomprimimos el archivo en una carpeta donde se pueda conservar, lo recomendable es guardarla en el sistema de archivos en la ruta C:\Program Files\Apache Software Foundation\apache-maven-3.3.3.
-
A continuación realizaremos la configuración de las variables de entorno del sistema, para ello damos clic con el botón derecho a Mi PC -> Propiedades -> Configuraciones avanzadas -> Variables de entorno
Una vez ubicados en la ventana anterior, procederemos a configurar las variables M2_HOME y M2, variables de la herramienta Maven.
En windows existen dos tipos de variables de entorno: variables de usuario y variables de sistema.
Variables de sistema: siempre están establecidas cuando un usuario inicia sesión y no pueden ser cambiadas por cualquier usuario.
Variables de usuario: toman precedencia sobre las variables de sistema, el usuario debe agregarlas, modificarlas o eliminarlas. Tienen una excepción a la regla de precedencia con respecto a la variable PATH, esta es necesaria para el correcto funcionamiento de la aplicación, y se construye a partir de la concatenación de la variable del sistema+variable de usuario.
Para configuración del proyecto se modifican las variables de usuario.
Para la configuración realizaremos los siguientes pasos:
- Corroboramos que la variable JAVA_HOME esté funcionando correctamente, para ello revisamos en las variables de usuario si está creada y con la ruta correcta de JDK. Si esta no estuviera creada, procedemos a configurarla.
- Posteriormente, crearemos la variable de usuario M2_HOME, dando clic en NEW, dónde nos despliega las opciones para ingresar los datos. En el campo Variable name, ingresamos M2_HOME y en el campo Variable value la ruta de instalación de nuestro Maven
- Para la variable de usuario M2, realizamos el procedimiento anterior.
- Agregamos la variable PATH y agregamos la misma variable que M2.
Finalmente comprobamos que tenemos instalado Maven en nuestro equipo, para eso abrimos la consola de Windows cmd y escribimos el comando mvn --version
Las convenciones en el desarrollo de la aplicación MARLO, las utilizaremos para manejar una codificación estándar en el contenido de nuestro STS, ésta se regirá bajo unos parámetros que se han establecido inicialmente; dichos parámetros nos indican la manera de indentación del código, el nombre que deben de llevar las variables, la forma de los comentarios, entre otros. A continuación mostraremos el procedimiento para la configuración de dichas convenciones.
El proceso consta de importar ciertos estilos establecidos en el código de la aplicación, para la importación de dichos estilos haremos el siguiente proceso:
Iremos a Window-Preferences->Java>Code Style->Formatter
Luego importamos el archivo que contiene el estilo de código a utilizar, dando clic en import e importando el archivo el archivo ccafs-java-style-config.xml.
Luego nos aparecerá la convención de Java que hemos importado, damos clic en aceptar.
Para JavaScript realizamos el proceso anterior, pero cambiando la ruta de configuración. Window-Preferences->JavaScript>Code Style->Formatter e importando el archivo el archivo ccafs-javascript-style.xml.
Para esto ingresamos a la ruta Window-Preferences->Web>CSS Files, en ella editamos las siguientes opciones:
En este modificaremos la opción Encoding a ISO 10646/Unicode(UTF-8)
Para esto ingresamos a la ruta Window-Preferences->Web->CSS->Editor, en ella editamos las siguientes opciones:
-
En el bloque Formating, en la opción Line width digitamos 120; posteriormente seleccionamos los tres checkbox (Insert line, Insert whitespace y disable), luego seleccionamos la opción Indent using spaces y finalmente en Indentation size escogemos 2.
-
En el bloque Capitalization style, seleccionamos las siguientes opciones.
Bloque Identifier-> Opción Uppercase Bloque Type selections-> Opción Lowercase Bloque Property name-> Opcion Lowercase Bloque Property value-> Opción Lowercase
El proceso consta de organizar el orden que tendrán las clases que importemos en nuestro código Java. Para realizarlo seguiremos los siguientes pasos:
Iremos a Window->Preferences->Java>Code Style->Organize Imports
Damos en clic en el botón Import, luego importamos el archivo adjunto ccafs-java-style.importorder.
Posteriormente revisamos las opciones configuradas.
Este proceso nos ayudará a que nuestro código tenga las correcciones automáticas una vez lo guardemos.Iremos a la ruta Window-Preferences->Java->Editor->SaveActions, habilitamos Format source code -> Fomrat all lines. Luego se habilita Additional actions, posteriormente al botón configurar, modificaremos la ruta de cada una de las opciones. Una vez en la ventana emergente Additional Save Actions, modificaremos las opciones de cada una de las pestaña de la ventana.
- Seleccionar el checkbox Correct indentación.
- Seleccionar el checkbox Sort members.
- Clic botón OK.
-
En el bloque Control statements seleccionamos el checkbox ”Use blocks in if/while/for/do statements“- Opción Always.
-
En el bloque expressions deshabilitamos el check ‘Use parentheses in expressions’ y el check ‘Convert for loops to enhanced’.
-En los bloques ’Variable declarations’ y ‘Functional interfaces’ dejamos las opciones que trae por defecto.
-En el bloque ‘Non static accesses’, seleccionamos la opción ‘Use this qualifier for method accceses’ opción ‘Always’.
Seleccionamos la opción ‘Add missing Annotations’.
En esta parte dejamos las opciones por defectos , revisar que correspondan con la imagen de de abajo.
Revisamos que nuestra convención esté correctamente, para eso revisamos las opciones generales de Save Actions.
Ingresamos a la ruta Window-Preferences->JavaScript->Editor->SaveActions Seleccionamos el botón Configure, y en la ventana emergente editamos las siguientes opciones:
Seleccionamos el check Use blocks if/while/for/do statements, opción Always.
Seleccionamos todos los checkbox de esta sección exceptuando Vars.
Seleccionamos el check Remove trailing whitespace opción All lines.
En esta parte comprobamos si las opciones fueron configuradas correctamente.
Luego configuramos los archivos por defecto de Java, para eso:
Ingresamos a la ruta Window-Preferences->Java>Code Style->Code Template y en la ventana vamos a la ruta Code->New Java Files, luego damos clic en el botón Edit.
Ingresamos la siguiente estructura de cabecera para nuestras clases en Java y damos clic en aceptar.
License Text:
/*****************************************************************
* This file is part of Managing Agricultural Research for Learning &
* Outcomes Platform (MARLO).
* MARLO is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* at your option) any later version.
* MARLO is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with MARLO. If not, see <http://www.gnu.org/licenses/>.
*****************************************************************/
- Iremos a la ruta Window-Preferences->General>Editors->Text Editors, donde modificaremos las opciones de Displayed tab width en 2, y la opción Print margin column en 120.
- Otra configuración a realizar es los Workspace, para eso vamos a la ruta Window-Preferences->General>Workspace, donde configuramos en Other la opción UTF-8.
Debemos tener instalado el motor base de datos de MySQL, después de escoger nuestra herramienta de acceso a los datos, en este caso MySQL Workbech, crearemos la base de datos ccafs_marlo; posteriormente importamos el archivo script sql adjunto marlo db 08-04-2016.sql.
Con esto preparamos la base de datos para la operación del sistema.
Para configurar el GitHub, primero debemos de tener instalado la herramienta en nuestro pc, esto lo podemos hacer desde la página oficial https://windows.github.com/.
Después desde el STS, le damos clic en File->Import->Git->Project From Git.
Luego seleccionamos Clone URI
En el campo URI ingresamos la ruta del proyecto en github https://github.com/CCAFS/MARLO.git
Luego agregamos todos los Branch y damos clic en Next.
Posteriormente configuramos el Wokspace (Ruta donde tengamos instalado nuestro proyecto).
Luego seleccionamos Import as general project y Working Directory.
Finalmente el nombre del Proyecto y damos clic en Finish.
Elimine el proyecto de Eclipse, pero no del disco.
Para empezar vamos a la ruta File->Import -> Maven -> Existing Maven Projects.
Luego le damos clic en browse (Root Directory), buscamos nuestro Workspace, le agregamos todas las dependencias y damos clic en Finish.
Vamos a la ruta Run -> Run Configurations -> Maven Build y le damos doble clic. En Maven Runtime Damos clic en Configure
Damos clic en Add y agregamos la ruta de la carpeta de instalación de Maven, le agregamos un nombre y le damos clic en Finish.
Finalmente nos ubicamos en el workspace en una consola de Windows, y ejecutamos la siguiente instrucción mvn clean install.
A la aplicación se le debe de configurar el certificado, para eso copiaremos en la carpeta …\Workspace\MARLO\marlo-web el archivo adjunto .keystore.
Nos ubicamos en el package explorer de STS, y ubicamos la ruta \MARLO\configuration\dev, creamos una copia del archivo marlo.properties.sample, y a este nuevo le cambiamos la extensión a marlo.properties, después de esto procedemos configurarlo con los datos de acceso a la base de datos.
Existen tres directorios con properties independientes creados por maven para cada ambiente:
- dev (Development)
- pro (Production)
- test (Testing)
Hacer una copia del archivo context.xml.sample ubicado en el directorio /marlo-web/tomcat/ y nombrarlo a “context.xml”
Configuramos dicho archivo con los parámetros descritos en la siguiente imagen:
- userdatabase: Nombre de usuario de Mysql.
- databasePass: contraseña de Mysql.
- url: Nombre de host, puerto y nombre de la base de datos.
Nos ubicamos en la ruta Run->Run configurations, en la parte izquierda buscamos el Maven Build, damos clic derecho y editamos la configuración.
En la pestaña main, agregamos un Base directory dando clic en Browse Workspace y agregamos marlo-web. En Goals agregamos tomcat7:run
