Desvendando o ciclo de vida do JSF

Quase todo programador que participou de um projeto baseado em JSF, pelo menos em algum momento, foi apresentado ao famoso ciclo de vida do framework. Na maior parte do tempo ouvimos falar das tais das fases, mas tenho percebido que muitas vezes essas mesmas fases ficam parecendo meio que mágicas. A ideia do post de hoje é mostrar um pouco do código que é implementado para possibilitar que esse ciclo de vida realmente aconteça. Vamos tomar como base a implementação padrão da especificação provida pela própria Oracle, a Mojarra.

Para começar, vamos dar uma olhada na classe que representa ciclo de vida em si, a LifecycleImpl.

    public class LifecycleImpl extends Lifecycle {

        // The Phase instance for the render() method
        private Phase response = new RenderResponsePhase();

        // The set of Phase instances that are executed by the execute() method
        // in order by the ordinal property of each phase
        private Phase[] phases = {
            null, // ANY_PHASE placeholder, not a real Phase
            new RestoreViewPhase(),
            new ApplyRequestValuesPhase(),
            new ProcessValidationsPhase(),
            new UpdateModelValuesPhase(),
            new InvokeApplicationPhase(),
            response
        };
        
        public LifecycleImpl() {
            
        }
        

        // Execute the phases up to but not including Render Response
        public void execute(FacesContext context) throws FacesException {

            if (context == null) {
                throw new NullPointerException
                    (MessageUtils.getExceptionMessageString
                     (MessageUtils.NULL_PARAMETERS_ERROR_MESSAGE_ID, "context"));
            }

            if (LOGGER.isLoggable(Level.FINE)) {
                LOGGER.fine("execute(" + context + ")");
            }

            for (int i = 1, len = phases.length -1 ; i < len; i++) { // Skip ANY_PHASE placeholder

                if (context.getRenderResponse() ||
                    context.getResponseComplete()) {
                    break;
                }

                phases[i].doPhase(context, this, listeners.listIterator());

            }

        }

        //muito resto de código aqui...
            
    }

Perceba que existe um atributo chamado de phases, contendo exatamente as referências para cada uma das fases do JSF. Um outro trecho interessante é o que segue abaixo:

        // Execute the phases up to but not including Render Response
        public void execute(FacesContext context) throws FacesException {

            if (context == null) {
                throw new NullPointerException
                    (MessageUtils.getExceptionMessageString
                     (MessageUtils.NULL_PARAMETERS_ERROR_MESSAGE_ID, "context"));
            }

            if (LOGGER.isLoggable(Level.FINE)) {
                LOGGER.fine("execute(" + context + ")");
            }

            for (int i = 1, len = phases.length -1 ; i < len; i++) { // Skip ANY_PHASE placeholder

                if (context.getRenderResponse() ||
                    context.getResponseComplete()) {
                    break;
                }

                phases[i].doPhase(context, this, listeners.listIterator());

            }

        }

Perceba que a execução de cada uma das fases é resumida a um simples for, chamando cada uma das fases, depois da outra :). Perceba que o método doPhase inclusive recebe como terceiro argumento uma lista PhaseListener. Caso você já tenha criado um deles, eles está no meio da lista passada como parâmetro! Um outro ponto a se destacar é a má prática dentro do código deles, verificando se um argumento é nulo e lançando NPE, ao invés de IllegalArgumentException :/.

Agora vamos analisar um pouco como é a implementação da fase em si. A classe abstrata Phase, representa a abstração mais genérica de uma fase do JSF.

    public abstract class Phase {

        public void doPhase(FacesContext context,
                            Lifecycle lifecycle,
                            ListIterator<PhaseListener> listeners) {

            context.setCurrentPhaseId(getId());
            PhaseEvent event = null;
            if (listeners.hasNext()) {
                event = new PhaseEvent(context, this.getId(), lifecycle);
            }

            // start timing - include before and after phase processing
            Timer timer = Timer.getInstance();
            if (timer != null) {
                timer.startTiming();
            }

            try {
                handleBeforePhase(context, listeners, event);
                if (!shouldSkip(context)) {
                    //método abstrato
                    execute(context);
                }
            } catch (Throwable e) {
                queueException(context, e);
            } finally {
                try {
                    handleAfterPhase(context, listeners, event);
                } catch (Throwable e) {
                    queueException(context, e);
                }
                // stop timing
                if (timer != null) {
                    timer.stopTiming();
                    timer.logResult(
                          "Execution time for phase (including any PhaseListeners) -> "
                          + this.getId().toString());
                }

                context.getExceptionHandler().handle();
            }

        }


        public abstract void execute(FacesContext context) throws FacesException;

        public abstract PhaseId getId();


        //muito resto de código aqui...

    }

Para quem curte Design Patterns, esse é a típica implementação do Template Method. Perceba que o método doPhase, que é invocado lá pelo ciclo de vida, tem um algoritmo bem definido e abre espaço para especialização através do método execute. Esse é o método que vai ser implementado por cada uma das fases do JSF. Um outro método abstrato importante é o getId, que retorna uma enum representando a fase associado com o objeto é em questão. É ele que é usado pelos métodos handleBeforePhase handleAfterPhase  para descobrir se um PhaseListener deve ser executado.

Como acabamos de ver na classe LifecycleImpl, existem seis implementações da   classe Phase, representando justamente as seis etapas do ciclo de vida do JSF.

  1. RestoreViewPhase

  2. ApplyRequestValuesPhase

  3. ProcessValidationsPhase

  4. UpdateModelValuesPhase

  5. InvokeApplicationPhase

  6. RenderResponsePhase

Cada uma delas implementa o método execute getId. Vamos dar uma olhada na RestoreViewPhase.

    public class RestoreViewPhase extends Phase {

        public PhaseId getId() {

            return PhaseId.RESTORE_VIEW;

        }

        public void execute(FacesContext facesContext) throws FacesException {

            //já vamos olhar um pouco dele
        }
        
        //muito resto de código aqui...

    } // end of class RestoreViewPhase

O método getId, como era esperado, retorna RESTORE_VIEW. Lembre que usamos essa enum para informarmos em quais das fases o nosso PhaseListener deve ser executado. O método execute é um tanto quanto grande, então eu decidi pegar apenas uma parte da implementação, para podermos discutir.

        try {

            // Reconstitute or create the request tree
            Map requestMap = facesContext.getExternalContext().getRequestMap();
            String viewId = (String)
              requestMap.get("javax.servlet.include.path_info");
            if (viewId == null) {
                viewId = facesContext.getExternalContext().getRequestPathInfo();
            }

            // It could be that this request was mapped using
            // a prefix mapping in which case there would be no
            // path_info.  Query the servlet path.
            if (viewId == null) {
                viewId = (String)
                  requestMap.get("javax.servlet.include.servlet_path");
            }

            if (viewId == null) {
                viewId = facesContext.getExternalContext().getRequestServletPath();
            }

            if (viewId == null) {
                throw new FacesException(MessageUtils.getExceptionMessageString(
                  MessageUtils.NULL_REQUEST_VIEW_ERROR_MESSAGE_ID));
            }

            ViewHandler viewHandler = Util.getViewHandler(facesContext);

            boolean isPostBack = (facesContext.isPostback() && !isErrorPage(facesContext));
            if (isPostBack) {
                facesContext.setProcessingEvents(false);
                // try to restore the view
                viewRoot = viewHandler.restoreView(facesContext, viewId);
                if (viewRoot == null) {
                ....

Ele tenta de várias formas descobrir a origem da requisição para a view. Depois disso, ainda existe a verificação de postback. Essa é a verificação para descobrir se a requisição veio em função de um formulário do JSF ou se é apenas a primeira requisição para a view. Inclusive, se é um postback, o JSF tenta restaurar o estado da tela! Caso tenha ficado curioso, tente passear pelas outras implementações!

Esse foi mais um post daqueles que tentam te ajudar a entender mais do ambiente que você está executando o seu código. Estamos cercados por diversos frameworks e, em algum momento, é importante compreender o que acontece além da visão de simples usuário.

Advertisements

Melhorias no SetupMyProject

Nos últimos tempos trabalhamos para atender algumas solicitações dos usuários do nosso serviço :). As melhorias passam por projetos baseados em Spring, VRaptor e JSF. Abaixo seguem algumas delas.

A primeira tem a ver com o tipo de servidor que você quer usar no seu projeto. Antigamente o SetupMyProject gerava todas as configurações supondo que o programador estava trabalhando com um Servlet Container, estilo Tomcat. A partir de agora você pode decidir se quer realmente usar um Servlet Container ou Application Server. Por enquanto os projetos suportados para isso são o VRaptor e o JSF, que já fazem uso da stack do JAVA EE. Quando a opção Application Server for escolhida, as dependências do pom.xml já virão marcadas como provided, o que é o ideal quando vamos usar as bibliotecas que já estão no servidor.

Uma segunda novidade interessante, para qualquer projeto baseado no CDI, é a possibilidade de adicionar o DeltaSpike. Nesse momento fizemos o suporte apenas para os projetos baseados no JSF, mas não vai demorar para projetos baseados no VRaptor também passarem a ter esse benefício.  Só não adicionamos para o VRaptor porque ele já possui um plugin para integração com a JPA e, por enquanto, esse foi o único módulo que adicionamos do DeltaSpike.

Um outro ponto que chateava os usuários é que nosso projeto gerava uma tag chamada dependencyManagement que, na maioria das vezes, era inútil para o projeto em questão. Acaba que o programador adicionava a dependência lá e a mesma não era refletida no projeto!

Para fechar, adicionamos mais possibilidades para a geração de CRUD’s. Uma muito legal é que adicionamos um componente de paginação para as listagens de projetos baseados em VRaptor ou Spring. Paginação está presente em quase todo cadastro que somos obrigados a fazer e, querendo ou não, perdemos um certo tempo nas lógicas. Para os amantes do JSF, ainda vamos suportar a paginação baseada no componente do PrimeFaces.

Ainda no campo do CRUD, agora também é possível gerar novos cadastros para projetos que já estejam em andamento. Logo na primeira tela do fluxo de geração, tem uma opção para você seguir baseado em algum projeto que já esteja em andamento. No fim é gerado um zip que você pode importar como um archive file no seu Eclipse.

Estamos comprometidos em ser uma ferramenta de geração de código que não deixa o programador alienado. Hoje já geramos um pequeno readme explicando o que ele precisa fazer quando escolhe cada uma das opções. Nossa ideia é deixar esse readme mais completo, mostrando para o programador o motivo da geração de cada parte do código.

Por enquanto é isso pessoal, o projeto vai andando bem e com downloads diários. O objetivo é suportar a geração automática de código para o máximo de trabalho braçal que for possível. Afinal de contas queremos gastar tempo pensando em features que realmente exijam da gente :).

 

Arquivos XHTML, no JSF, são bem mais que estruturas de páginas

Provavelmente todo mundo que utiliza o JSF já passou por algum problema que estava relacionado ao seu famoso ciclo de vida.
Existem vários pontos que podemos estudar relacionados a este assunto, mas hoje quero focar no que realmente representa sua página (geralmente com extensão .xhtml) para o ciclo de vida do JSF.

Muitas vezes os programadores ainda olham para uma página xhtml e associam apenas com a geração do HTML final, o que em algum momento até vai ser verdade.
Vamos analisar o código abaixo:

	<h:form>			
		<h:outputLabel value="Nome:" for="nome" />
		<h:inputText id="nome" value="${produtoBean.produto.nome}" />
		<h:outputLabel value="Descrição:" for="descricao" />
		<h:inputTextarea id="descricao" value="${produtoBean.produto.descricao}" />
		<h:outputLabel value="Preço:" for="preco" />
		<h:inputText id="preco" value="${produtoBean.produto.preco}" />
		<h:commandButton value="Gravar" action="#{produtoBean.grava}" />
		
	</h:form>
	<h:dataTable value="#{produtoBean.produtos}" var="produto" id="tabela">
		<h:column>
			<f:facet name="header">Nome</f:facet>
		          #{produto.nome}
		</h:column>
		<h:column>
			<f:facet name="header">Descrição</f:facet> #{produto.descricao}
		</h:column>
		<h:column>
			<f:facet name="header">Preço</f:facet> #{produto.preco}
      	</h:column>

	</h:dataTable>

Temos um formulário e uma tabela. Mas, o mais importante para mim, neste momento, é o que representa os bindings que colocamos nos elementos. Por exemplo, usamos a expression language no commandButton para informar um método que deve ser invocado.
O engraçado é que para quem vem de um framework action based significa que este método deveria ser chamado no exato momento que a expressão #{…} fosse interpretada.

Só que pensando pelo lado do JSF isso não faz muito sentido, já que no primeiro request para essa página, nenhum botão foi clicado ainda.

Você pode usar a mesma linha de pensamento para os bindings que foram feitos nos inputs dentro do formulário: quando que ele deve chamar o getter ou o setter? 

Percebe que depende do momento?

Ele sempre vai querer chamar o getter do objeto associado, já que existe a necessidade popular os campos que serão enviados para o cliente. Só que o setter só faz sentido ser chamado quando alguém fizer o submit do formulário, para que as informações do objeto em questão possam ser populadas.

Para finalizar, podemos analisar a tag dataTable, que também faz uso do binding. Ela está relacionada com o método getProdutos e podemos pensar de novo, em qual momento ele deve ser chamado? Nesse caso a resposta vai ser: sempre! 
Isso porque o tempo todo queremos popular a nossa tabela.

É interessante notar que os próprios componentes decidem quando as expression languages associadas a eles vão ser interpretadas. É por esta razão que sua página é muito mais que uma montagem do seu HTML, ela serve de configuração para o JSF saber o que precisa fazer, a cada novo request.

Essa é uma parte bem importante da manutenção de estado dos componentes da sua tela, que o JSF provê. O que ele mantém no servidor é justamente quais são os componentes e quais são seus respectivos bindings. Uma parte desses bindings é processada, por exemplo, na fase APPLY_REQUEST_VALUES, dependendo do comportamento do componente em questão.