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,830 thoughts on “Spring Web Flow – displaying your JSR-303 validation messages using FreeMarker”

  3. платная стоматология качественная стоматология

  21. Подборка шаблонов юридических документов для бизнеса и частных лиц: договоры, заявления, соглашения и иные формы. Переходите по запросу образцы правовых документов. Удобные образцы с правильной структурой и актуальными формулировками помогут быстро подготовить документы без лишних затрат и ошибок. Подходят для самостоятельного использования и адаптации под конкретные задачи.

  26. We Supporter You Hole Apartments In Dubai With all speed And Safely.
    Find The Most artistically Deals, Prime Locations, And
    Highest Submit to From Our Experts.

  33. организация свадебного агентства помощь в организации свадьбы

  37. This article provides an excellent overview of the latest advancements in immunotherapy. The integration of real-world evidence strengthens its clinical relevance. – https://nicolediem.ch/en/apps/store-locator Climate change is already affecting vector-borne disease patterns. Physicians need to stay alert. .

  42. Шаблоны юридических документов — удобное решение для быстрого и грамотного оформления договоров, заявлений и иных правовых бумаг. Переходите по запросу образцы составления правовых документов. Готовые формы разработаны с учетом законодательства и помогают избежать ошибок. Скачивайте, адаптируйте под свою ситуацию и экономьте время на подготовке документов без лишних затрат.

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

  48. We Advise You Let out Apartments In Dubai Post-haste And Safely.
    Upon The Paramount Deals, Prime Locations, And Highest Reinforce From Our Experts.

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>