Jak mogę osiągnąć i18n za pomocą silnika szablonów, takiego jak Velocity lub FreeMarker, do konstruowania treści wiadomości e-mail?

Zazwyczaj ludzie tworzą szablony, takie jak:

<h3>${message.hi} ${user.userName}, ${message.welcome}</h3>
<div>
   ${message.link}<a href="mailto:${user.emailAddress}">${user.emailAddress}</a>.
</div>

I mieć utworzony pakiet zasobów z właściwościami takimi jak:

message.hi=Hi
message.welcome=Welcome to Spring!
message.link=Click here to send email.

Stwarza to jeden podstawowy problem: jeśli moje .vm pliki stają się duże i zawierają wiele wierszy tekstu, staje się nużące tłumaczenie i zarządzanie każdym z nich w oddzielnych plikach pakietu zasobów (.properties).

To, co próbuję zrobić, to utworzyć osobny plik .vm dla każdego języka, coś takiego jak mytemplate_en_gb.vm, mytemplate_fr_fr.vm, mytemplate_de_de.vm, a następnie jakoś powiedzieć Velocity/Spring, aby wybrał właściwy na podstawie ustawień regionalnych.

Czy to możliwe na wiosnę? A może powinienem przyjrzeć się może prostszym i bardziej oczywistym alternatywnym podejściom?

Uwaga: widziałem już samouczek wiosenny o tym, jak tworzyć treści wiadomości e-mail za pomocą silników szablonów. Ale to nie wydaje się odpowiadać na moje pytanie na i18n.

30
adarshr 7 marzec 2012, 20:54

2 odpowiedzi

Najlepsza odpowiedź

Okazuje się, że użycie jednego szablonu i wielu plików language.properties wygrywa z posiadaniem wielu szablonów.

Stwarza to jeden podstawowy problem: jeśli moje pliki .vm stają się duże i zawierają wiele wierszy tekstu, staje się nużące tłumaczenie każdego z nich i zarządzanie nim w osobnych plikach pakietu zasobów (.properties).

Jeszcze trudniej jest utrzymać, jeśli struktura wiadomości e-mail jest zduplikowana w wielu plikach .vm. Ponadto trzeba będzie ponownie wymyślić mechanizm awaryjny wiązek zasobów. Paczki zasobów próbują znaleźć najbliższy odpowiednik dla danego regionu. Na przykład, jeśli ustawienia regionalne to en_GB, próbuje znaleźć poniższe pliki w kolejności, powracając do ostatniego, jeśli żaden z nich nie jest dostępny.

  • language_pl_PL.properties
  • language_pl.properties
  • język.właściwości

Opublikuję (szczegółowo), co musiałem zrobić, aby uprościć odczytywanie pakietów zasobów w szablonach Velocity.

Uzyskiwanie dostępu do pakietu zasobów w szablonie Velocity

Konfiguracja wiosenna

<bean id="messageSource" class="org.springframework.context.support.ResourceBundleMessageSource">
    <property name="basename" value="content/language" />
</bean>

<bean id="velocityEngine" class="org.springframework.ui.velocity.VelocityEngineFactoryBean">    
    <property name="resourceLoaderPath" value="/WEB-INF/template/" />
    <property name="velocityProperties">
        <map>
            <entry key="velocimacro.library" value="/path/to/macro.vm" />
        </map>
    </property>
</bean>

<bean id="templateHelper" class="com.foo.template.TemplateHelper">
    <property name="velocityEngine" ref="velocityEngine" />
    <property name="messageSource" ref="messageSource" />
</bean>

Klasa pomocnika szablonów

public class TemplateHelper {
    private static final XLogger logger = XLoggerFactory.getXLogger(TemplateHelper.class);
    private MessageSource messageSource;
    private VelocityEngine velocityEngine;

    public String merge(String templateLocation, Map<String, Object> data, Locale locale) {
        logger.entry(templateLocation, data, locale);

        if (data == null) {
            data = new HashMap<String, Object>();
        }

        if (!data.containsKey("messages")) {
            data.put("messages", this.messageSource);
        }

        if (!data.containsKey("locale")) {
            data.put("locale", locale);
        }

        String text =
            VelocityEngineUtils.mergeTemplateIntoString(this.velocityEngine,
                templateLocation, data);

        logger.exit(text);

        return text;
    }
}

Szablon prędkości

#parse("init.vm")
#msg("email.hello") ${user} / $user,
#msgArgs("email.message", [${emailId}]).
<h1>#msg("email.heading")</h1>

Musiałem stworzyć skrócone makro msg, aby czytać z pakietów wiadomości. To wygląda tak:

#**
 * msg
 *
 * Shorthand macro to retrieve locale sensitive message from language.properties
 *#
#macro(msg $key)
$messages.getMessage($key,null,$locale)
#end

#macro(msgArgs $key, $args)
$messages.getMessage($key,$args.toArray(),$locale)
#end

Pakiet zasobów

email.hello=Hello
email.heading=This is a localised message
email.message=your email id : {0} got updated in our system.

Użycie

Map<String, Object> data = new HashMap<String, Object>();
data.put("user", "Adarsh");
data.put("emailId", "adarsh@email.com");

String body = templateHelper.merge("send-email.vm", data, locale);
41
adarshr 21 wrzesień 2016, 17:30

Oto rozwiązanie (jeden szablon, kilka plików zasobów) dla Freemarker.

główny program

// defined in the Spring configuration file
MessageSource messageSource;

Configuration config = new Configuration();
// ... additional config settings

// get the template (notice that there is no Locale involved here)
Template template = config.getTemplate(templateName);

Map<String, Object> model = new HashMap<String, Object>();
// the method called "msg" will be available inside the Freemarker template
// this is where the locale comes into play 
model.put("msg", new MessageResolverMethod(messageSource, locale));

Klasa MessageResolverMethod

private class MessageResolverMethod implements TemplateMethodModel {

  private MessageSource messageSource;
  private Locale locale;

  public MessageResolverMethod(MessageSource messageSource, Locale locale) {
    this.messageSource = messageSource;
    this.locale = locale;
  }

  @Override
  public Object exec(List arguments) throws TemplateModelException {
    if (arguments.size() != 1) {
      throw new TemplateModelException("Wrong number of arguments");
    }
    String code = (String) arguments.get(0);
    if (code == null || code.isEmpty()) {
      throw new TemplateModelException("Invalid code value '" + code + "'");
    }
    return messageSource.getMessage(code, null, locale);
  }

}

Szablon Freemarker

${msg("subject.title")}
21
Vladimir 15 maj 2013, 22:54