javax.servlet.genericservlet javax.servlet.http.httpservlet MiServlet

Transcripción

1 Lectura 14. Servlets Un Servlet es un programa que se ejecuta en un servidor Web. Los clientes pueden invocarlo utilizando el protocolo HTTP. Comparativamente, así como los applet son ejecutados y cargados por un explorador, los servlet son cargados y ejecutados por un servidor Web. Un servlet acepta peticiones de un cliente, procesa la información y le devuelve resultados que pueden ser mostrados mediante applets, páginas html, etc. Sin embargo, esta no es la única función de un servlet, pues también puede realizar otras tareas, como por ejemplo, comunicarse con otro servlet para colaborar en su tarea o bien facilitar el acceso a bases de datos. Características de los servlet: Al estar escritos en Java, son independientes de la plataforma. Consumen menos recursos porque sólo son cargados la primera vez que se solicitan sus servicios. Son seguros y portables debido a que se ejecutan por la máquina virtual de Java, el mecanismo de excepciones de Java, y el uso del administrador de seguridad de Java(Java Security Manager). Java proporciona el soporte necesario para escribir servlet a través del paquete javax.servlet. Estructura de un servlet Todo servlet implementa la interface Servlet, abstracción principal para manipular este tipo de objetos, localizada en la API servlet. Un servlet no es más que un objeto de alguna de las clases que implementan esta interfaz, según se muestra en la figura siguiente: Object javax.servlet.genericservlet javax.servlet.http.httpservlet MiServlet Nos vamos a ocupar en el caso de servlets que responden a peticiones realizadas desde una página html, simplemente porque son las más comunes; esto es, servlet que son objetos de una clase derivada de HttpServlet. Servlet Básico El tipo de servlet http más básico, puede ser de la forma siguiente: un objeto de una clase derivada de HttpServlet, que encapsula los métodos init, para iniciar el servlet, y dopost y/o doget para responder a las peticiones de los clientes. 1

2 En general se tiene el siguiente esquema: // MiServlet.java import javax.servlet.*; import javax.servlet.http.*; public class MiServlet extends HttpServlet public void init(servletconfig config) throws ServletException super.init(config); // Parámetro establecido en el archivo servlets.properties // del servidor // Método dopost para responder a una petición POST public void dopost(httpservletrequest req, HttpServletResponse res) throws ServletException, IOException // Tipo de respuesta que será enviada al cliente // res.setcontenttype("text/html"); // Obtener un 'PrintWriter' para devolver una respuesta // al solicitante // Método doget para responder a una petición GET public void doget(httpservletrequest req, HttpServletResponse res) throws ServletException, IOException // Escriba aquí su código public void destroy() // Liberar recursos Cuando un servlet de este tipo acepta una llamada de un cliente, después de ejecutarse el método init, se ejecutará el método dopost o doget dependiendo del metodo POST o GET utilizado por el formulario html ejecutado por el cliente. Cualquiera de estos métodos recibe dos objetos: Un HttpServletRequest que encapsula los datos enviados por el cliente al servidor. Ahora, para acceder a los datos del cliente este objeto proporciona métodos como getparameter, que retorna el valor del parámetro especificado, getparametervalues, que retorna una matriz de tipo String con todos los valores que el parámetro tiene, getparameternames, que retorna una enumeración (objeto Enumeration) de objetos String con los nombres de los parámetros y sus valores. Para formularios html que utilizan el métodos GET para enviar datos al servidor (se invoca al método doget del servlet), el método getquerystring retorna un String con los datos enviados por el cliente. Por otra parte, para formularios html que utilizan el método POST para enviar datos al servidor (se invoca al método dopost del servlet), si lo que se espera es 2

3 texto, podemos utilizar el método getreader para recuperarlo, y si lo que se espera son datos binarios, el método getinputstream nos permitirá recuperarlos. Un HttpServletResponse que encapsula los datos enviados por el servidor (por el servlet) al cliente. Este objeto proporciona dos formas de retornar los datos: una, utilizando el método getwriter y otra, utilizando el método getoutputstream. Utilizaremos el método getwriter para devolver cadenas de texto y getoutputstream para devolver datos binarios. Como habrá observado, cuando un formulario html utiliza el método POST para enviar los datos al servidor, a diferencia de GET, resulta más fácil recuperarlos porque permite diferenciar entre cadenas de texto y datos binarios. Trabajo de HTTP GET request: El propósito principal como ya lo mencionabamos de un requerimiento HTTP GET es para recuperar el contenido de un URL específico, el cual normalmente está en documentos html(páginas Web). El servlet que se muestra en el ejemplo, junto con el documento html muestran como los servlet tratan el requerimiento GET. En este caso el servlet responde un requerimiento por la generación dinámica de un documento html para el cliente desplegando Bienvenido a los Servlets!, tal como lo muestra el archivo HTTPGetServletDemo.java // HTTPGetServletDemo.java // Crea y envia una página al cliente. import javax.servlet.*; import javax.servlet.http.*; import java.io.*; public class HTTPGetServletDemo extends HttpServlet public void doget( HttpServletRequest requerimiento, HttpServletResponse responde ) throws ServletException, IOException PrintWriter output; responde.setcontenttype( "text/html" ); // tipo de contenido output = responde.getwriter(); // escribe // crea y envia pagina HTML al cliente StringBuffer buf = new StringBuffer(); buf.append( "<HTML><HEAD><TITLE>\n" ); buf.append( "Un Ejemplo Simple\n" ); buf.append( "</TITLE></HEAD><BODY>\n" ); buf.append( "<H1>Bienvenido a los Servlets!</H1>\n" ); buf.append( "</BODY></HTML>" ); output.println( buf.tostring() ); output.close(); // cierra el stream PrintWriter Por otra parte, HTTPGetServletDemo.html es el documento el cual invita al cliente a accesar el servlet y mostrar la captura de la ventana del cliente browser antes y después de la interacción con el servlet. 3

4 <html> <head>  <title>servlet HTTP GET Demo</title> </head> <body> <form action=" method="get"> <p>click sobre el botón para que el servlet envie el documento HTML. </p> <input type="submit" value="obtener Documento HTML"> </form> <br> <br> <br> </body> </html> 4

5 El documento HTML en este ejemplo fue desplegado usando el browser Nestcape 6.2. sin embargo, este hecho es irrelevante, pues puede trabajar sobre cualquier browser. Comentarios: Para los servlet que trabajan el requerimiento GET y POST, cuentan con que JSDK proporciona una superclase HttpServlet (del paquete javax.servlet.http). Esta clase implementa la interface javax.servlet.servlet y agrega los métodos que soportan el protocolo HTTP. Por esta razón la clase HttpGetServletDemo extiende HttpServlet. La superclase HttpServlet proporciona los métodos doget para responder a los requerimientos GET. Por otra parte el método doget obtiene 2 parametros, un objeto que implementa javax.servlet.http.httpservletrequest y javax.servlet.http.httpservletresponse el objeto HttpServletRequest representa los requerimientos del cliente, mientra que el objeto HttpServletResponse representa la respuesta del servidor. Si doget esta deshabilitado para responder al requerimiento del cliente, se genera la execepción a través de javax.servlet.servletexception, y si por otra parte doget encuentra un error durante el proceso de stream es decir leer desde el cliente o escribir al cliente, se genera la excepción por javax.io.ioexception. Para mostrar la respuesta al requerimiento GET, nuestro servlet crea un documento html que contiene el texto Bienvenido a los Servlets!. El texto del documento html es para responder al cliente. La respuesta es enviada al cliente a través de un objeto PrintWriter que es accedido a través de output una instancia de un objeto HttpServletResponse. En la línea responde.setcontenttype( "text/html" ); // tipo de contenido se usa setcontenttype del objeto responde de HttpServletResponse, para indicar el tipo de contenido para la respuesta al cliente, en este caso se especifica text/html para indicarle al browser que la respuesta es a través de un archivo html.. Para tal efecto, el browser deberá reconocer los tipos tags en el archivo html, formateando el documentode acuerdo a los tags y desplegando el documento en la ventana del browser para que el usuario la vea. output = responde.getwriter(); // escribe usa el método getwriter del objeto responde de HttpServletResponse, para obtener una referencia al objeto PrintWriter, que envia el texto del documento HTML al cliente. Observar si la respuesta son datos binarios, como por ejemplo imágenes, el método usado es getoutputstream para obtener una referencia al objeto ServletOutputStream. StringBuffer buf = new StringBuffer(); buf.append( "<HTML><HEAD><TITLE>\n" ); buf.append( "Un Ejemplo Simple\n" ); buf.append( "</TITLE></HEAD><BODY>\n" ); buf.append( "<H1>Bienvenido a los Servlets!</H1>\n" ); buf.append( "</BODY></HTML>" ); crea el documento HTML, con la inclusión de buf a StringBuffer 5

6 En las líneas output.println( buf.tostring() ); output.close(); envia la respuesta, es decir el contenido de StringBuffer al cliente, cerrando el output stream output PrintWriter. Observar que el cliente podrá accesar el servlet si el servlet esta corriendo sobre el servidor, ahora existen variados Web servers que soportan servlet y cada uno de ellos tiene su forma particular de trabajarlos y ejecutarlos, de manera que si Ud. intenta ejecutar su servlet como parte de un web server remitase a la documentación de cómo instalar los servlet. Estos ejemplos están dados usando JSDK Web Server. El JSDK WebServer asume que los archivos.class para los servlet deben ser instalados en el subdirectorio webpages\web-inf\servlets del JSDK, vea la distribución. Dónde y cómo instalo un servlet, a propo? Para responder el donde?, deberá conseguirse un servidor que sea capaz de soportar servlet, hoy en día existen varios, tales como Apache, Tomcat, y el propio JSDKWS, vea cuales son los requerimientos para que ello pueda suceder, me refiero a las versiones. Para responder el cómo instalarlo, deberá compilar el servlet con javac, como es usual, luego situe el archivo.class que se genero en el directorio servlets antes mencionado. Esto instalara los servlet sobre el JSDK Web Server. Observar que en el directorio JSDK encuentra los archivos startserver.bat, que es usado para partir el JSDK Web Server, de la misma manera encuentra un stopserver.bat, que es usado para detener el JSDK Web Server. Así se vé tras la ejecución de startserver. 6

7 La pantalla DOS nos Indica que JSDK WebServer esta esperando los requerimientos por la puerta 8080, en este caso las puertas NO son componentes físicas del hardware, sino números enteros que usan los clientes para diferentes servicios dentro del mismo servidor. Ud. podrá especificar una puerta diferente para JSDK Web Server editando el archivo default.cfg, de la instalación del JSDK, cambiando la línea server.port= 8080, para especificar la puerta que desee, sin embargo no olvide que algunos sistemas operativos tienen reservados ciertos privilegios para usar tal o cuales puertas, de manera que en este sentido debería informarse mejor respecto de los servicios que desee implementar para escoger el rango apropiado de enteros. Una vez que JSDK Web Server este corriendo, Ud. podrá cargar el documento HTTPGetServlet.html en su browser. La parte importante del documento HTML para este ejemplo es la form especificada por <form action=" method="get"> <p>click sobre el botón para que el servlet envie el documento HTML. </p> <input type="submit" value="obtener Documento HTML"> </form> Las primeras 3 líneas indican que la action para esta forma es y el método es GET. " Otra forma de ver el efecto de este servlet es efectivamente tipear la URL " Trabajo de HTTP POST Request: Un HTTP POST por lo general se usa para datos postales en forma HTML es decir a la forma del servidor para procesar los datos, por lo general encuestas u otras variantes. El ejemplo que se muestra a continuación es una situación común, en la cual nos vemos involucrados en dar alguna opinión o respuesta cuando nos llega un requerimiento. En este ejemplo, se realiza una encuesta en donde el servlet almacena los resultados respecto de determinar el lenguaje de programación de su preferencia en un archivo de texto, entregando posteriormente los resultados estadísticos de la misma. Recordamos que los archivos por defecto son almacenados en el directorio de JSDK2.1, pudiendo en todo caso ser dejados donde Ud. desee. El servlet que se implementa a continuación recibe una petición de un cliente, un alumno, relativa a concertar una cita con alguno de sus profesores. Los datos enviados por el cliente hacia el servidor son el nombre del alumno, el del profesor, el día de la semana elegido para la cita y la hora seleccionada entre cuatro posibles. El servidor irá recogiendo las peticiones durante una semana para la siguiente, y la almacenará en un fichero en el disco. Así mismo, cada vez que el servidor reciba una petición responderá al cliente indicándole si la petición fue registrada, o si ocurrió un error, en cuyo caso tendrá que volver a realizarla. // Citas.java 7

8 import javax.servlet.*; import javax.servlet.http.*; import java.io.*; import java.util.*; public class Citas extends HttpServlet implements SingleThreadModel String dirdelfichresultante = null; public void init(servletconfig config) throws ServletException super.init(config); // Parámetro establecido en el fichero servlets.properties // del servidor dirdelfichresultante = getinitparameter("dirdelfichresultante"); if (dirdelfichresultante == null) System.err.println("Debe existir un parámetro"); // Método dopost para responder a una petición POST public void dopost(httpservletrequest req, HttpServletResponse res) throws ServletException, IOException // Tipo de la respuesta que será enviada al cliente res.setcontenttype("text/html"); // Obtener un 'PrintWriter' para devolver una respuesta // al solicitante PrintWriter solicitante = res.getwriter(); try // Abrir el fichero para el registro de citas FileWriter fw = new FileWriter(dirDelFichResultante + System.getProperty("file.separator") + "citas.txt", true); PrintWriter fichcitas = new PrintWriter(fw); // Tomar los datos recibidos del cliente y escribirlos // en el fichero. Delimitamos los registros por las marcas // <INICIO> y <FIN> para su posterior identificación. fichcitas.println("<inicio>"); Enumeration nombresparams = req.getparameternames(); while (nombresparams.hasmoreelements()) String nombre = (String)nombresParams.nextElement(); String valor = req.getparametervalues(nombre)[0]; fichcitas.println(nombre + ": " + valor); fichcitas.println("<fin>"); // Cerrar el fichero fichcitas.close(); fw.close(); // Responder al solicitante solicitante.println("<html>"); solicitante.println("<title>respuesta a la solicitud</title>"); solicitante.println("su cita ha sido registrada<br>un saludo"); 8

9 solicitante.println("</html>"); catch(ioexception e) solicitante.println("hubo problemas al cursar su solicitud." + "<BR>Por favor, inténtelo otra vez."); // Cerrar el flujo solicitante.close(); Ejecución de un Servlet: Cómo se ejecuta un servlet? Todo servlet se comporta según el siguiente ciclo de vida: se carga, responde a las peticiones de los clientes y se descarga. Cuando un servlet como el del ejemplo anterior recibe una petición de un cliente, el servidor lo carga para su ejecución, instante en el que se ejecuta el método init que lo inicia. La forma más sencilla de iniciar un servlet es invocando al método init de su superclase, aunque no siempre se hace. Por otra parte, aunque el servlet reciba múltiples peticiones este método sólo se ejecuta una vez, cuando el servidor lo carga. Cuando el método init finaliza, el servlet está en condiciones de atender a las peticiones de los clientes; en el ejemplo anterior, para cada una de las peticiones se ejecuta el método dopost. El servlet permanecerá en ejecución hasta que el servidor decida destruirlo, intante en el que se ejecutará el método destroy si fue implementado. Software necesario para ejecutar Servlet Para convertir un PC en un servidor de servlets una de las alternativas es ejecutar los pasos siguientes: 1. Instalar el kit de desarrollo de Java (JDK). Recuerde que el entorno desde el que se trabaje debe conocer dónde se localiza java.exe y tools.jar. 2. Instalar el JSWDK (Java Server Web Development Kit kit de desarrollo del servidor Web de Java) Este kit soporta además JSP (java Server Page páginas Java activadas en el servidor, versión java del desarrollo ASP de la Microsoft) y la API servlet. También incluye archivos.bat para arrancar (startserver.bat) y para detener los procesos del servidor (stopserver.bat). 3. Una vez instalado JSWSK, el entorno desde el que se trabaje debe conocer dónde se localiza servlet.jar. Para ello, como opción más sencilla, se recomienda copiar este fichero en la carpeta jdk1.x\jre\lib\ext. Ejecutando un Servlet Para ejecutar un servlet, siga los pasos siguientes: 1. Compile el servlet y añada el archivo.class resultante a la carpeta webpages\webinf\servlets del servidor. La siguiente orden compila el servlet de nuestro ejemplo: 9

10 >javac Citas.java de donde se obtiene el archivo Citas.class. Añádalo a la carpeta ya indicada. 2. Registre el servlet añadiendo al archivo webpages/web-inf/servlets.properties líneas con la siguiente sintaxis. nombre_servlet.code=nombre_servlet nombre_servlet.intparams=parámetro_1=valor.parámetro_2=valor La propiedad code asocia un nombre con la clase que define el servlet, y la propiedad initparams hace referencia a los parámetros de iniciación del servlet especificado. El nombre del archivo.class no tenemos por qué hacerlo coincidir con el nombre que aquí damos al servlet, pero por sencillez normalmente lo hacemos. Según lo expuesto, para registrar el servlet de nuestro ejemplo, añada al archivo servlets.properties las líneas siguientes: Citas.code=Citas Citas.initparams=dirDelFichResultante=c:\\Temp Se puede observar que la propiedad code hace referencia a Citas.class e initparams al parámetro dirdelfichresultante que especifica la carpeta donde se guardará el archivo citas.txt. 3. Arranque el servidor, o bien vuélvalo a iniciar. Para arrancarlo por primera vez, abra una ventana MS-DOS, cambie al directorio del servidor y ejecute: startserver Si tiene problemas de falta de espacio para las variables del entorno, en una plataforma Windows, tendrá que abrir una ventana MS-DOS desde la ventana Ejecutar (Inicio, Ejecutar) mediante la orden: comand / e:2048 El valor 2048 es el espacio en bytes de memoria reservado para almacenar las variables de entorno, pudiendo ser otro valor. Una vez abierta la ventana MS- DOS, cambie al directorio del servidor y ejecute: startserver. Si tiene algún aviso relativo a que no ha incluido en la variable CLASSPATH los paquetes necesarios, detenga el servidor con: stopserver, establezca el valor para esta variable, para la variable JAVA_HOME, y arranque de nuevo el servidor. Por ejemplo: set CLASSPATH=%CLASSPATH%;c:\java\jdkl.3\lib set JAVA_HOME=c:\java\jdkl.3 startserver Cuando quiera detener el servidor, por ejemplo, para reiniciarlo, hágalo ejecutando la orden siguiente desde la línea de órdenes: stopserver Una vez arrancado el servidor, para verificar si está funcionando correctamente abra el explorador y busque por la siguiente dirección. El explorador debe mostrar la página del JSWDK: 10

11 También puede utilizar el URL :8080. Su máquina, localhost, ejecutará el servlet requerido, en el servidor JWS registrado en el puerto Este valor puede cambiarse cuando sea necesario, editando el archivo webserver.xml del servidor. 4. Invoque al servlet para su ejecución: donde nombre_servlet es el nombre asociado al servlet en la propiedad code (en nuestro ejemplo es Citas y coincide con el nombre de la clase). Por ejemplo, la dirección siguiente invocará al servlet Citas pero sólo ejecutará su método init, ya que fue implementado para que fuera llamado desde un formulario que emplee el método POST para enviar los datos al servidor. Invocando al servlet desde una página HTML La página HTML que invoque a un servlet debe: Visualizar un formulario con los controles precisos para introducir los datos requeridos por el servlet, y un botón Enviar datos que permita enviarlos hacia el servidor. Al parámetro action del formulario se le debe asignar el URL del servlet que tiene que manipular los datos. Volviendo al ejemplo que estamos realizando, donde nuestro PC hace de cliente y de servidor, este URL es el siguiente: El formulario enviará los datos al servidor utilizando el método POST. 11