Internacjonalizacja poczty e-mail przy użyciu szablonów Velocity/FreeMarker

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);