Spring Web Flow – displaying your JSR-303 validation messages using FreeMarker

Posted on by

Instead of creating a custom validator in the traditional sense I’m relying on JSR-303 annotations to specify validation constraints, because, it is the future, and I shouldn’t have to do a load of coding to specify common validation requirements like an email address regular expression or a numeric value that is required to be within a defined range.

Using Spring web flow, I found that binding error messages weren’t available when I called “<@spring.showErrors ‘<br/>’/>” in my freemarker view (after I had bound the field I wanted to show errors for of course).

So where are my error messages?

It turns out that Spring Web Flow has a different way of providing the user with feedback messages. The Spring Web Flow reference documentation says: “Spring Web Flow’s MessageContext is an API for recording messages during the course of flow executions”.

The message context (with all your binding error messages in it) can be found here: flowRequestContext.messageContext. I’ve written a couple of macros to make retrieving error messages from this object a little easier:

<#--
 * Shows flow messages (which reside in flowRequestContext.messageContext)
 *
 * @param source Name of the field that caused the error
 * @param severity String representation of org.springframework.binding.message.Severity
 * @param separator the html tag or other character list that should be used to
 *    separate each option. Typically '<br>'.
 * @param classOrStyle either the name of a CSS class element (which is defined in
 *    the template or an external CSS file) or an inline style. If the value passed in here
 *    contains a colon (:) then a 'style=' attribute will be used, else a 'class=' attribute
 *    will be used.
 * @param tag The HTML tag to wrap the error in
-->
<#macro showFlowMessages source severity separator classOrStyle="" tag="">
  <#assign messages = flowRequestContext.messageContext.getMessagesBySource(source)/>
  <#if (messages?size > 0)>
    <#list messages as message>
      <#if message.severity?string == severity>
        <#if classOrStyle == "" && tag == "">
          ${message.getText()}
        <#else>
          <#if classOrStyle == "">
            <${tag}>${message.getText()}</${tag}>
          <#else>
            <#if tag == ""><#local tag = "span" /></#if>
            <#if classOrStyle?index_of(":") == -1><#local attr="class"><#else><#local attr="style"></#if>
            <${tag} ${attr}="${classOrStyle}">${message.getText()}</${tag}>
          </#if>
        </#if>
        <#if message_has_next>${separator}</#if>
      </#if>
    </#list>
  </#if>
</#macro>

<#--
 * Shows flow messages (which reside in flowRequestContext.messageContext) in an ordered or unordered list
 *
 * @param source Name of the field that caused the error
 * @param severity String representation of org.springframework.binding.message.Severity
 * @param classOrStyle either the name of a CSS class element (which is defined in
 *    the template or an external CSS file) or an inline style. If the value passed in here
 *    contains a colon (:) then a 'style=' attribute will be used, else a 'class=' attribute
 *    will be used.
 * @param ordered Whether or not the macro should output the list as an <ol> or <ul>
-->
<#macro showFlowMessagesList source severity classOrStyle="" ordered=false>
  <#local errorsList><@showFlowMessages source, severity, "", "", "li" /></#local>
  <#if errorsList?trim != "">
    <#if classOrStyle == "">
      <#local attr="">
    <#elseif classOrStyle?index_of(":") == -1>
      <#local attr=" class=" + classOrStyle>
    <#else>
      <#local attr=" style=" + classOrStyle>
    </#if>
    <#if ordered><ol${attr}><#else><ul${attr}></#if>
    ${errorsList}
    <#if ordered></ol><#else></ul></#if>
  </#if>
</#macro>

I’ve added these to my spring extensions, which you can download here: springx.ftl

1,815 thoughts on “Spring Web Flow – displaying your JSR-303 validation messages using FreeMarker”

  11. Адаптивный шаблон «Аспро: Корпоративный сайт 2.0» для создания современного сайта компании на 1С-Битрикс. Переходите по запросу Аспро Алкорп 2.0. Подходит для бизнеса, услуг, производства и корпоративных проектов. Готовые блоки, удобная настройка дизайна, SEO-оптимизация и высокая скорость запуска. Поможем купить, установить и настроить шаблон под задачи вашего бизнеса.

  29. Покупка шаблона Aspro Digital — быстрый старт для современного корпоративного сайта на 1С-Битрикс. Переходите по запросу купить шаблон Aspro Digital. Готовое решение с адаптивным дизайном, SEO-оптимизацией, высокой скоростью загрузки и удобным управлением контентом. Подходит для digital-агентств, IT-компаний, студий и бизнеса, которому нужен стильный и функциональный сайт без долгой разработки.

  45. Купите шаблон Аспро Инжиниринг для создания современного корпоративного сайта на 1С-Битрикс. Переходите по запросу сайт Aspro Heat. Готовое решение для инженерных, строительных и производственных компаний: адаптивный дизайн, каталог услуг, SEO-оптимизация, высокая скорость работы и удобное управление контентом. Быстрый запуск проекта без лишних затрат и доработок.

  49. Купите шаблон Аспро Инжиниринг для создания современного корпоративного сайта на 1С-Битрикс. Переходите по запросу купить Аспро Heat. Готовое решение для инженерных, строительных и производственных компаний: адаптивный дизайн, каталог услуг, SEO-оптимизация, высокая скорость работы и удобное управление контентом. Быстрый запуск проекта без лишних затрат и доработок.

Leave a Reply

Your email address will not be published. Required fields are marked *

You may use these HTML tags and attributes: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>