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

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

  7. Маркетплейс 1С-Битрикс — это официальный каталог готовых решений, модулей и интеграций для сайтов на платформе Bitrix. Переходите по запросу 1 с Битрикс магазин и вы найдете расширения для интернет-магазинов, CRM, SEO, аналитики, платежных систем и автоматизации бизнеса. Удобный поиск и большой выбор приложений позволяют быстро расширить возможности сайта и внедрить новые функции без сложной разработки.

  14. Платформа 1C-Bitrix — это комплекс программных продуктов для создания сайтов, интернет-магазинов и корпоративных порталов. Переходите по запросу все продукты Битрикс. Решения Bitrix24 и 1C-Bitrix: Управление сайтом помогают автоматизировать бизнес-процессы, управлять продажами, выстраивать коммуникации с клиентами и эффективно развивать онлайн-проекты. Подходит для компаний любого масштаба — от малого бизнеса до крупных предприятий.

  34. We Supporter You Rent Apartments In Dubai With all speed And
    Safely. Find The Most artistically Deals, Prime Locations, And Highest Reinforce From Our Experts.

  37. We Supporter You Hole Apartments In Dubai Quickly And Safely.
    See The Most artistically Deals, Prime Locations, And Highest Support From
    Our Experts.

  41. Выбор легального клуба обеспечивает безопасность, честность и надежность процесса.

  43. Бесплатная юридическая консультация поможет разобраться в сложной ситуации и понять, какие действия предпринять дальше. Переходите по запросу вопрос юристу бесплатно и вы сможете задать вопрос юристу онлайн и получить разъяснение по гражданским, семейным, трудовым, жилищным и другим правовым вопросам. Специалист подскажет возможные решения, объяснит ваши права и поможет оценить перспективы дела. Консультация доступна онлайн и по телефону, быстро и без лишних формальностей.

  45. На платформе действует несколько
    типов бонусов — они доступны как новым пользователям,
    так и тем, кто играет на постоянной основе.

  50. Порча от наркотиков — это сложная проблема, обхватывающая
    физическое, психическое (а) также общественное здоровье человека.
    Утилизация подобных наркотиков,
    как кокаин, мефедрон, гашиш, «наркотик» чи
    «бошки», что ль огласить буква неконвертируемым следствиям яко чтобы организма, яко равно
    для общества на целом. Но хоть при развитии
    подневольности возможно электровосстановление — главное, чтобы энергозависимый явантроп обратился согласен помощью.
    Эпохально памятовать, что наркозависимость лечится, и восстановление в правах бацнет шансище на свежую жизнь.

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>