Servlets. João Carlos Pinheiro. Julho / 2005

Transcrição

1 Servlets João Carlos Pinheiro Julho /

2 Objetivos Apresentar Os benefícios de servlets A arquitetura de aplicativo servlet Como funciona um Servlet Os pacotes javax.servlet e javax.servlet.http Como escrever e executar o seu primeiro aplicativo servlet 2

3 Introdução A tecnologia Servlets foi introduzida pela SUN em 1996 com intuito de gerar código HTML Servlets são classes Java mantidas e executadas por um conteiner de servlet Estendem servidores orientados a requisição/resposta, que recebe chamadas de diversos clientes 3

4 Principais funções dos Servlets Ler dados enviados pela aplicação cliente Ler informações anexadas a página Podem ser cookies, identificação da máquina cliente, resposta a pedido de autenticação, etc. Geração de resultados (qualquer tipo MIME) Formatação do resultado e envio para o cliente 4

5 Benefícios do Servlet Desempenho Depois que um Servlet termina de processar uma solicitação, ele permanece na memória, aguardando por uma outra solicitação Portabilidade Pode-se movê-los entre diferentes plataformas sem problemas 5

6 Benefícios do Servlet Robustez Servlets são gerenciados pela JVM Não existe a preocupação com desalocação de memória ou coleta de lixo Aceitação Difundida 6

7 Benefícios do Servlet Suporte a Grandes Sistemas Servlets aproveitam o modelo OO que facilita a organização do sistema, reaproveitamento de código, divisão das tarefas em equipe, etc Custo Existem um grande número de servidores Web gratuitos disponíveis que podem rodar servlets 7

8 Servlets e Aplicações Web Para executar Servlets e JSP é preciso implantá-los em um Container Web, que é responsável: pela delegação de requisição HTTP para os servlets existentes pelo controle dos servlets criação de pool de threads para o processamento das requisições, sendo cada requisição é atendida em uma thread própria 8

9 Tomcat É um servidor capaz de suportar o desenvolvimento e a execução em ambientes de produção, de aplicações web criada segundo os padrões da tecnologia Java Não tem a pretensão de ser um servidor J2EE completo, pois não suporta EJB mas busca ser um ambiente completo para aplicações web com suporte a (Servlets/JSP/JSTL) 9

10 Principais Componentes do Tomcat Container Web: conhecido como Catalina fornece a infraestrutura para o gerenciamento e execução de Servlet Compilador de JSP (Jasper): Transforma páginas JSP em Servlets equivalentes e os compila para bytecode java Resulta em velocidade de execução (para acessos repetidos bem superior a outras tecnologias similares Conectores: determina os protocolos cliente/servidor utilizado para acessar o Tomcat. O conector HTTP é ativado por padrão de modo que não há necessidade de um servidor web 10

11 O contexto de um Servlet O contexto de um servlet é o ambiente onde ele executa Containers Web suportam a implantação de múltiplas aplicações Definem contextos separados para execução de servlets No Tomcat, essas aplicações estão na pasta webapps/ Veja o conteúdo de webapps no seu servidor 11

12 O contexto de um Servlet Todo diretório de contexto tem uma estrutura definida, que consiste de: Área de documentos do contexto (/), acessível externamente Área inaccessível (/WEB-INF), que possui pelo menos um arquivo de configuração padrão (web.xml) O WEB-INF pode conter ainda dois diretórios reconhecidos pelo servidor: 1. Um diretório que pertence ao CLASSPATH da aplicação (/WEB-INF/classes) e 2. outro onde podem ser colocados JARs para inclusão no CLASSPATH (/WEB-INF/lib) 12

13 Servlets e Aplicações Web Seis etapas para executar um servlet 1. Crie uma estrutura de diretório para o seu aplicativo Tomcat O diretório webapps é onde fica armazenado os aplicativos web 1. Crie o contexto (diretório) meusservlets (aparece na URL) 2. Crie o sub-diretório WEB-INF e classes (fica as classes Java), conforme apresentado na figura ao lado 13

14 2ª. Escreva o código fonte do Servlet Este arquivo (PrimeiroServlet.class) deve import java.io.*; import javax.servlet.*; ser salvo em meusservlets/web-inf/classes import javax.servlet.http.*; public class PrimeiroServlet extends HttpServlet { protected void doget(httpservletrequest req, HttpServletResponse resp) } } throws ServletException, IOException { PrintWriter out = resp.getwriter(); out.println("<html>"); out.println("<head>"); out.println("<title> Meu primeiro Servlet</TITLE>"); out.println("</head>"); out.println("<body>"); out.println("bem vindo ao meu primeiro servlet"); out.println("</body></html>"); 14

15 3ª Etapa: Compilar o código fonte 15

16 4ª Etapa: Crie a distribuição descritiva no arquivo /meusservlets/web-inf/web.xml <?xml version="1.0" encoding="iso "?> <!DOCTYPE web-app PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN " <web-app> <servlet> <servlet-name>exemplo1</servlet-name> <servlet-class>primeiroservlet</servlet-class> </servlet> <servlet-mapping> <servlet-name>exemplo1</servlet-name> <url-pattern>/servlet/exemplo1</url-pattern> </servlet-mapping> <session-config> <session-timeout>10</session-timeout> </session-config> </web-app> 16

17 5ª Etapa: Execute o Tomcat 17

18 6ª Etapa: Chame o Servlet a partir de um navegador web 18

19 Por dentro da API Servlets 19

20 API Servlet A API dos servlets estão definidas no pacote javax.servlet. Contém: 7 interfaces, 3 classes e 2 exceções Interfaces RequestDispatcher, Servlet, ServletConfig, ServletContext, ServletRequest, ServletResponse, SingleThread Classes GenericServlet (Abstrata) ServletInputStream ServletOutputStream Exceções ServletException UnavailableException 20

21 API Servlet (Principais classes e Interfaces) javax.servlet <<interface>> ServletContext <<interface>> ServletRequest <<interface>> Servlet (Classe Abstrata) GenericServlet <<interface>> ServletConfig <<interface>> ServletResponse javax.servlet.http <<interface>> HttpServletRequest HttpSession HttpServlet Cookie <<interface>> HttpServletResponse Legenda Classe Interface 21

22 O Ciclo de Vida de um Servlet A interface Servlet é a abstração central da tecnologia Servlet Cada aplicação Servlet que você escrever implementa esta interface, direta ou indiretamente O ciclo de vida de um servlet é determinado por três dos métodos definidos na interface Servlet init(), service() e destroy() 22

23 O Ciclo de Vida de um Servlet O ciclo de vida é controlado pelo container, que: 1. Carrega a classe na memória 2. Cria uma instância da classe do servlet 3. Inicializa a instância chamando o método init() O método init() é chamado apenas uma vez, para indicar que o servlet esta sendo colocado em serviço 23

24 Método init( ) É importante para escrever código de inicialização, como: carregar um driver de banco de dados Iniciar atributos e assim por diante... Assinatura do método init() public void init(servletconfig config) throws ServletException OBS: SevletException é a exceção mais importante em programação servlet 24

25 O método service( ) Depois que o servlet foi iniciado, se torna possível responder a uma solicitação através do método service() public void service(servletrequest req, ServletResponse resp) throws ServletException, java.io.ioexception O objetoservletrequest contém a solicitação do cliente O objeto ServletResponse contém a resposta do servlet 25

26 O método destroy() Quando o container decidir remover o servlet da memória, ele o finaliza chamando destroy() Este método só poderá ser chamado depois que todas as threads que os referencia terem executadas Este método da uma chance de limpar quaisquer recursos que estejam sendo mantidos 26

27 Ciclo de Vida de um Servlet Container Servlet Container Servlet A Servlet é solicitada pelo cliente Primeira chamada? Sim A Servlet é instanciada destroy( ) não Uma thread é alocada para executar o Servlet O método init() é executado Libera a Memória O método Service() é executado Resposta HTTP Gera a resposta (HTML, XML,...) 27

28 Demonstração do ciclo de vida de um Servlet public class DemoCicloServlet implements Servlet { public void init(servletconfig conf) throws ServletException { System.out.println("init"); } public void service(servletrequest req, ServletResponse resp) throws ServletException, IOException { System.out.println("service"); } public void destroy() { System.out.println("destroy"); } public String getservletinfo() {return null; } public ServletConfig getservletconfig() { return null; } } 28

29 Comentário sobre os métodos getservletinfo() e getservletconfig() String getservletinfo() Deve retornar um String que contém informações do servlet, tais como o autor e a versão do servlet ServletConfig getservletconfig( ) Retorna um objeto que implementa a interface ServletConfig que fornece acesso às informações de configuração do servlet, tais como os parâmetros de inicialização e o ServletContext do servlet 29

30 Como obter informações de configuração? Para cada servlet registrado no arquivo web.xml, você tem a opção de especificar um conjunto de parâmetros iniciais de pares nome/valor que pode ser recuperado pelo servlet Exemplo 30

31 Como obter informações de configuração? <web-app> <servlet> <servlet-name>testando</servlet-name> <servlet-class>primeiroservlet</servlet-class> <init-param> <param-name>admin </param-name> </init-param> <init-param> <param-name>admincontato</param-name> <param-value> </param-value> </init-param> </servlet> </web-app> <!ELEMENT servlet (icon?, servlet-name, display-name?, description?, (servlet-class jsp-file), init-param*, load-on-startup?, security-role-ref*)> 31

32 Como obter informações de configuração? public class ConfigDemoServlet implements Servlet { } public void init(servletconfig config) throws ServletException { Enumeration parameters= config.getinitparameternames(); while (parameters.hasmoreelements()) { }... String parameter = (String) parameters.nextelement(); System.out.println("Parameter name : " + parameter); System.out.println("Parameter value : " + config.getinitparameter(parameter)); A Saída do código na console é a seguinte: Parameter name : admin Parameter value: [email protected] Parameter name : admincontato Parameter value:

33 Como obter informações de configuração? Qual é a vantagem disto? O arquivo web.xml é texto puro, sendo possível editar o seu conteúdo facilmente Enquanto codificar este parâmetros dentro do servlet significa que você precisaria recompilar caso as informações mudem 33

34 Solicitações e Respostas As solicitações e as respostas são tudo do que trata um aplicativo web Em um paradigma de servlet a solicitação do usuário é representada pelo objeto ServletRequest passado pelo Container como primeiro argumento ao método service() O segundo argumento é um objeto ServletResponse, que representa a resposta ao usuário 34

35 A interface ServletRequest Define um objeto usado para encapsular informações sobre a solicitação do usuário Esta interface oferece métodos importantes, que lhes permite acessar informações sobre o usuário. Por exemplo, os métodos: getparameternames() retorna um Enumaration contendo os parâmetros de nome para solicitação atual getparameter( String name ) Retorna o valor associado com um parâmetro. O argumento name representa o nome do parâmetro getremoteaddress() e getremotehost() recupera o IP da máquina e o nome do Host Confira o exemplo: RequestDemoServlet.java 35

36 A interface ServletResponse Representa a resposta ao usuário No caso de HTTP isto consiste de preencher os cabeçalhos de resposta O método mais importante desta interface é getwriter() a partir do qual você pode obter um stream de resposta (objetos de java.io.printwriter) e escrever os dados no stream através do método println() PrintWriter out = response.getwriter(); out.println("<html>"); Confira o exemplo: ResponseDemoServlet.java 36

37 A classe envoltória GenericServlet Em todos os exemplos anteriores era necessária fornece uma implementação aos 5 métodos da interface Servlet, o que torna o código desnecessariamente complicado O objeto ServletConfig é passado ao método init(). Você precisa?... Um servlet genérico deve estender GenericServlet e implementar seu método service() 37

38 A classe envoltória GenericServlet Confira o exemplo: Ex6GenericServlet.java 38

39 O pacote javax.servlet.http 39

40 O pacote javax.servlet.http Neste pacote a classe HttpServlet representa um servlet, estendendo GenericServlet e fornece métodos próprios associados ao protocolo HTTP que são mais ricos e convenientes de usar 40

41 A classe HttpServlet Essa classe sobrescreve o método service() com uma implementação padrão Todos os métodos da classe HttpServlet recebem parâmetros do tipo HttpServletRequest e HttpServletResponse e retornamvoid) Os dois principais métodos [doget() e dopost()] são utilizados para tratar os dois principais tipos de requisições dos clientes GET e POST 41

42 As Interfaces HttpServletRequest e HttpServletResponse HttpServletRequest Define métodos que permitem o acesso aos parâmetros da solicitação, a cookies que podem estar armazenados no cliente e à sessão em que o usuário daquele servlet se encontra HttpServletResponse Contém métodos que permitem a manipulação de dados referentes ao resultado da solicitação, a criação de cookies no computador do cliente, e uma referência ao objeto que realmente escreve os caracteres de resposta ao usuário 42

43 import java.io.*; import javax.servlet.*; import javax.servlet.http.*; Exemplo HttpServlet public class ExemploHttpServlet extends HttpServlet { protected void doget(httpservletrequest req, HttpServletResponse resp) } } throws ServletException, IOException { resp.setcontenttype( text/html ); PrintWriter out = resp.getwriter(); out.println("<html>"); out.println("<head>"); out.println("<title> Meu primeiro Servlet</TITLE>"); out.println("</head>"); out.println("<body>"); out.println("bem vindo ao meu primeiro servlet"); out.println("</body>"); out.close(); Os métodos init() e service() são herdados de HttpServlet Saída é uma página html Fecha o fluxo de saída e envia a página montada para o cliente

44 Lendo dados de Formulários Os dados provenientes de formulários em páginas web são enviados para o servidor HTTP de duas formas: Método GET e POST Método GET Os dados a serem enviados são colocados no final da URL que faz a referência a Servlet que receberá as informações 44

45 Anatômia de uma URL Exemplo a=joao+da+silva Podemos dividir a URL em várias partes: indica o servidor web que processa o pedido validacao: o nome da servlet que receberá a solicitação?: marca o início dos dados que estão sendo enviados chave=valor: onde a chave representa o nome da variável e valor, o conteúdo &: é o separador entre chaves e valores + : todo espaço em branco é substituído por + Os dados enviados após este sinal corresponde a informações enviadas ao servidor 45

46 Lendo dados de Formulários Anatômia de uma URL Método POST Os dados são enviados separados do endereço da página Não existe limitação do número de caracteres enviados Dentro da servlet a leitura das informações enviadas é independente do método de envio, é feita da mesma forma: request.getparameter( nomedoparametro ) 46

47 Exemplo Recebendo informações com o método GET <html><head> <title>envio de Dados - GET</title> </head> <body> <form name="form" method= GET" action="/exemplos_servlets/servlet/formulario/recebeget"> Nome: <input name="nome" type="text" id="nome"> Senha: <input name="senha" type="text" id="senha"> <input type="submit" name="submit" value="enviar"> </form> </body> </html> Servlet que receberá as informações 47

48 Exemplo Recebendo informações com o método GET public class RecebeGet extends HttpServlet { protected void doget(httpservletrequest request, HttpServletResponse response) throws ServletException, IOException { response.setcontenttype("text/html"); PrintWriter out = response.getwriter();//obtém o escritor out.println("<html><head>"); out.println("<title> Recebe Dados </TITLE>"); out.println("</head>"); out.println("<body>"); out.println("<br>nome :" + request.getparameter("nome")); out.println("<br>senha:"+request.getparameter("senha")); out.println("</body>"); } out.println("</html>"); out.close(); } // fim do método doget Os dados do formulário são lidos com o método getparameter() 48

49 Recebendo informações via Post Caso as informações tenham sido enviadas pelo método POST devem ser lidas dentro do método dopost() do Servlet 49

50 Recebendo informações independente da forma de envio public class RecebeGet extends HttpServlet { protected void doget(httpservletrequest request, HttpServletResponse response) throws ServletException, IOException { dopost(request, response) } protected void dopost(httpservletrequest request, HttpServletResponse response) throws ServletException, IOException { // A implementação fica aqui } 50

51 Diagrama de Seqüência e uma requisição GET :Browser :Container Web :Servlet :HttpServlet :RecebeGet 1:GET/RecebeGet 2:service() 3:service() 4:doGet() 5:resposta da requisição 51

52 Monitoramento de Sessões 52

53 Gerenciamento de Sessões Como o HTTP não mantém estado de sessão, são as aplicações Web que precisam cuidar de mantê-lo quando necessário Uma sessão pode ser compreendida como o local onde todas as ações realizadas por um determinado usuário podem ser acessadas Cada usuário que utiliza um Servlet possuirá a sua própria sessão 53

54 Técnicas para o Gerenciamento de Sessão Existem duas soluções populares para o problema, com propósitos distintos: cookies e sessões 54

55 Cookies São pequenos arquivos textos gravados pelo browser, a pedido do servidor web, no HD do usuário, relevantes a apenas uma aplicação Estes arquivos podem ser posteriormente alterados ou lidos pelo servidor web Foram especificado pela Nestcape e se transformou em um padrão Internet, conforme especificado na RFC

56 Cookies Alguns inconvenientes desta solução: Como os arquivos ficam disponíveis para serem lidos após a visita do usuário, qualquer pessoa com acesso ao computador do cliente poderia ver, por exemplo: A lista de produtos comprados em uma sessão Identificação do usuário no site Preferências do usuário O usuário pode ter desativado a opção de escrever cookie do navegador etc. 56

57 Cookies OBS: Como os cookies são carregados nos cabeçalhos das solicitação e resposta, não é possível acrescentá-lo depois de uma saída ter sido escrita no objeto HttpServletResponse, caso contrário será lançada uma exceção 57

58 Cookies Em programação Servlet um cookie é representado pela classe javax.servlet.http.cookie Exemplo de criação de Cookies: Cookie cookie =new Cookie( mycookie, secreto ); mycookie : nome de identificação secrecto : valor do cookie (informações) 58

59 Cookies Para criar cookies que duram mais que uma sessão (cookies persistentes no disco do cliente) é preciso: Criar um novo objeto Cookie Definir a duração do cookie com o método setmaxage() Definir outros métodos se necessário Adicionar o cookie à resposta 59

60 Cookies: adicionando // definir um cookie que contenha o nome do // usuário recebido como parâmetro na requisição String nome = request.getparameter("nome"); Cookie cookie =new Cookie( usuario,nome); //tempo em segundos até o cookie ser removido cookie.setmaxage(7 * 24 * 60 * 60); // 7 dias // Adicionar o cookie à resposta response.addcookie(cookie ); // Como cookies são enviados ao cliente como parte do // cabeçalho HTTP deve preceder getwriter output = response.getwriter();... 60

61 Cookies: lendo // obtém os cookies dos clientes Cookie cookies[] = request.getcookies(); response.setcontenttype("text/html"); output = response.getwriter(); if (cookies!= null) { // obtém o nome de cada cookie for (int i = 0; i < cookies.length; i++) output.println(cookies[i].getname()+ cookies[i].getvalue()); } 61

62 Sessões Toda aplicação Servlet faz parte de um único contexto e utiliza várias sessões (uma para cada usuário) 62

63 Sessões com a interface HttpSession O objeto sessão é uma instância da classe HttpSession É acessível por outros servlets no mesmo aplicativo e são obtidas a partir de uma requisição HttpSession session = request.getsession(false); Se a sessão não existir, retornanull, caso contrário retornasessão HttpSession session = request.getsession(); Retorna a sessão ou cria uma nova. Mesmo que getsession(true) 63

64 Sessões com a interface HttpSession Um objeto de HttpSession age como um HashMap, onde você pode armazenar qualquer quantidade de chaves/objetos Para recuperar um objeto é necessário somente passar a chave É acessível a partir de outros servlets no mesmo aplicativo (contexto) 64

65 Compartilhamento de objetos na sessão Principais métodos: Retorna o objeto associado a string public Object getattribute(string name) throws IllegalStateException Adiciona um objeto a sessão do usuário, associado a uma string public void setattribute(string name, Object value) throws IllegalStateException Principais Vantagens Permitem, além de strings, o compartilhamento de objetos na sessão Como são armazenados no servidor, não precisam ser reenviados ao cliente toda hora 65

66 Compartilhamento de objetos na sessão Exemplo: Requisição 1 String[] vetor = {"um", "dois", "tres"}; HttpSession session = request.getsession(); session.setattribute("dados", vetor); Requisição 2 HttpSession session = request.getsession(); String[] dados = (String[])session.getAttribute("dados"); 66

67 Remoção de objetos da sessão Como a sessão pode persistir além do tempo de uma requisição, é possível que a persistência de alguns objetos não sejam desejáveis Use: public removeattribute(string name) throws IllegalStateException 67

68 Gerência de Sessão Não há como saber que cliente não precisa mais da sessão Pode-se definir um timeout em minutos para a duração de uma sessão desde a última requisição do cliente define novo valor para timeout public void setmaxinactiveinterval(int) Nota: Passar um número negativo fará com que esse objeto HttpSession nunca encerre recupera valor de timeout public int getmaxinactiveinterval() Timeout default pode ser definido no web.xml para todas as sessões 68

69 Gerência de Sessão Deve aparecer depois dos elementos <servlet-mapping> <session-config> <session-timeout>10</session-timeout> </session-config> define o tempo de duração default da sessão em 10 minutos para todas as sessões Para destruir uma sessão use session.invalidate(); 69

70 Considerações Finais A API de Servlets é o alicerce de muitas outras tecnologias como, JSP, JSTL e JSF Mesmo que o desenvolvedor não use servlets diretamente, certamente utilizará diversos objetos da API, como request, response, session,... 70

71 Bibliografia SCWCD Exam Study Kit Java Web Component Developer Certification. Autores: Hanumant Deshmukh, Jignesh Malavia, Jacquelyn Carter, Artigo: Servlets do Básico aos Detalhes. Java Magazine, Edição