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

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

  18. Специалисты компании выполнят изготовление этикеток любого формата и сложности: тканых жаккардовых, деревянных, металлических, кожаных и проч.
    Чтобы картонные бирки для одежды не утратили своего первоначального вида и были износостойкими, мы используем только качественные материалы.

  31. Нужна бесплатная юридическая консультация? Переходите по запросу помощь адвоката в Санкт-Петербурге и получите помощь опытного юриста по любым правовым вопросам: семейные споры, долги, недвижимость, трудовые конфликты, защита прав потребителей и многое другое. Задайте вопрос онлайн или по телефону и получите подробный разбор вашей ситуации и рекомендации по дальнейшим действиям. Консультация проводится бесплатно и конфиденциально.

  37. Wow that was strange. I just wrote an incredibly long comment
    but after I clicked submit my comment didn’t show up. Grrrr…
    well I’m not writing all that over again. Regardless, just
    wanted to say great blog!

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

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

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

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

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

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>