web-dev-qa-db-ja.com

Velocity / FreeMarkerテンプレートを使用したメールの国際化

電子メールの本文を作成するために、VelocityやFreeMarkerなどのテンプレートエンジンを使用してi18nを実現するにはどうすればよいですか？

通常、人々は次のようなテンプレートを作成する傾向があります。

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

そして、次のようなプロパティで作成されたリソースバンドルがあります。

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

これにより、1つの基本的な問題が発生します。私の.vmファイルが多数のテキスト行で大きくなると、それぞれを個別のリソースバンドル（.properties）ファイルに変換して管理するのが面倒になります。

私がやろうとしているのは、.vmのように、言語ごとに個別のmytemplate_en_gb.vm, mytemplate_fr_fr.vm, mytemplate_de_de.vmファイルを作成し、入力ロケールに基づいて正しいものを取得するようにVelocity/Springに指示することです。

これは春に可能ですか？それとも、もっとシンプルで明白な代替アプローチを検討する必要がありますか？

注：テンプレートエンジンを使用して電子メールの本文を作成する方法については、すでに Springチュートリアル を確認しています。しかし、国際化に関する私の質問に答えていないようです。

javaspringinternationalizationtemplate-engine
27
adarshr

1つのテンプレートを使用し、複数のlanguage.propertiesファイルを使用すると、複数のテンプレートを使用することに勝ります。

これにより、1つの基本的な問題が発生します。私の.vmファイルが多くのテキスト行で大きくなると、それらを個別のリソースバンドル（.properties）ファイルに変換して管理するのが面倒になります。

メールの構造が複数の.vmファイルに重複している場合、維持がさらに困難になります。また、リソースバンドルのフォールバックメカニズムを再発明する必要があります。リソースバンドルは、ロケールを指定して最も近い一致を見つけようとします。たとえば、ロケールがen_GBの場合、以下のファイルを順番に見つけようとし、使用できるファイルがない場合は最後のファイルにフォールバックします。

  • language_en_GB.properties
  • language_en.properties
  • language.properties

Velocityテンプレートのリソースバンドルを簡単に読むために私がしなければならなかったことを（詳細に）ここに投稿します。

Velocityテンプレートでのリソースバンドルへのアクセス

スプリング構成

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

TemplateHelperクラス

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

速度テンプレート

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

メッセージバンドルから読み取るために、msgという省略形のマクロを作成する必要がありました。次のようになります。

#**
 * 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

リソースバンドル

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

使用方法

Map<String, Object> data = new HashMap<String, Object>();
data.put("user", "Adarsh");
data.put("emailId", "[email protected]");

String body = templateHelper.merge("send-email.vm", data, locale);
39
adarshr

これがFreemarkerのソリューション（1つのテンプレート、複数のリソースファイル）です。

メインプログラム

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

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

}

フリーマーカーテンプレート

${msg("subject.title")}
18
Vladimir