Java Jsp Internationalization Struts

Refatoração da Marca HTML fora de Arquivos de Propriedade: Um Guia para Aplicações Struts 1.1

Ao trabalhar com aplicações web internacionalizadas, particularmente aquelas construídas com Struts 1.1, você pode enfrentar desafios ao separar a marca HTML de seus arquivos de propriedade. Isso pode levar a várias complicações, como violações do princípio DRY (Don’t Repeat Yourself, ou Não Repita) e preocupações mistas em relação à gestão de marca, além de dificuldades no tratamento de traduções. Neste post, exploraremos esses problemas em detalhes e forneceremos uma abordagem estruturada para refatorar sua marca HTML de uma maneira que melhore a manutenibilidade e a localização.

Compreendendo o Problema

Problemas com a Estrutura Atual da Marca

Na estrutura atual de uma aplicação baseada em Struts, você pode ter arquivos JSP que se parecem com isto:

<p>
    <bean:message key="alert" />
</p>

E arquivos de propriedade que contêm longas entradas de texto com HTML incorporado:

messages.properties
alert=Por favor, atualize seu <a href="/address.do">endereço</a> e <a href="/contact.do">informações de contato</a>.

Esse cenário gera várias questões significativas:

  1. Violação do DRY: Você possui múltiplas referências a suas URLs de ação (como /address.do), o que introduz o risco de erros quando essas URLs mudam.
  2. Preocupações Misturadas: A marca está espalhada entre arquivos JSP e de propriedades, complicando a tarefa de atualizar o aspecto visual da aplicação.
  3. Problemas de Marca Pós-Tradução: Quando novas traduções são introduzidas, decidir onde colocar os links HTML se torna trabalhoso, especialmente para idiomas que são menos familiares.

Solução Proposta

Aceitando as Limitações

  • Evitar Misturar Marca com Conteúdo: Uma das melhores práticas é limitar o uso de links dentro de longos blocos de texto. Frases curtas e autossuficientes funcionam melhor tanto para a localização quanto para a consistência da interface do usuário.

  • Compromissos de Design: Às vezes, você precisará equilibrar entre o design da interface do usuário e os processos de localização. O objetivo é minimizar o número de vezes que um desenvolvedor interage com strings pós-tradução.

Exemplos de Refatoração

Em vez de ter links complexos misturados em seus arquivos de propriedade, considere uma abordagem mais simples. Por exemplo:

Abordagem Atual:

alert=Por favor, atualize seu <a href="/address.do">endereço</a> e <a href="/contact.do">informações de contato</a>.

Abordagem Refatorada:

Você poderia reescrever o texto em seus arquivos de propriedade e criar uma estrutura mais fácil de gerenciar:

alert=Por favor, atualize seu endereço e informações de contato.

E então, estruture seu arquivo JSP assim:

<p>
    <bean:message key="alert" />
    <br />
    <a href="/address.do">atualizar endereço</a>
    <br />
    <a href="/contact.do">atualizar informações de contato</a>
</p>

Benefícios da Abordagem Refatorada

  • Melhoria na Localização: Ao separar as ações das mensagens, isso simplifica o processo de tradução. Você pode se concentrar puramente no texto sem se preocupar com HTML.
  • Manutenção Mais Fácil: Essa estrutura reduz o risco de bugs associados à cópia e colagem ou edição manual de strings.
  • Marca Mais Limpa: Sua marca permanece limpa e direta, tornando muito mais fácil para especialistas da web trabalharem com ela.

Conclusão

Refatorar a marca HTML de arquivos de propriedade em sua aplicação Struts 1.1 pode ajudar a resolver várias questões centrais, incluindo violações do DRY e preocupações mistas. Ao melhorar a forma como você trata traduções e separa elementos HTML do conteúdo textual, você torna sua aplicação mais robusta, manutenível e amigável ao usuário.

Lembre-se de sempre considerar as implicações do design da interface do usuário no processo de localização, bem como o contrário. Um pouco de planejamento pode fazer uma grande diferença para garantir que sua aplicação permaneça escalável e fácil de manter.