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

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

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

  40. Покупка шаблона «Аспро Корпоративный сайт 3.0» — быстрый старт для современного корпоративного сайта на 1С-Битрикс. Переходите по запросу шаблон Aspro All corp 3. Готовый адаптивный дизайн, удобные настройки, высокая скорость работы и 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>