Spring MVC PathVariable with dot is getting truncated

Question

This is continuation of question Spring MVC  PathVariable getting truncated  Spring forum states that it has fixed 3 2 version  as part of ContentNegotiationManager  see the below link  https   jira springsource org browse SPR-6164  https   jira springsource org browse SPR-7632  In my application requestParameter with  com is truncated   Could anyone explain me how to use this new feature  how is it configurable at xml   Note  spring forum-  1 Spring MVC  PathVariable with dot     is getting truncated

User · Answer

Spring considers that anything behind the last dot is a file extension such as .jsonor .xml and trucate it to retrieve your parameter.

So if you have /somepath/{variable} :

/somepath/param, /somepath/param.json, /somepath/param.xml or /somepath/param.anything will result in a param with value param
/somepath/param.value.json, /somepath/param.value.xml or /somepath/param.value.anything will result in a param with value param.value

if you change your mapping to /somepath/{variable:.+} as suggested, any dot, including the last one will be consider as part of your parameter :

/somepath/param will result in a param with value param
/somepath/param.json will result in a param with value param.json
/somepath/param.xml will result in a param with value param.xml
/somepath/param.anything will result in a param with value param.anything
/somepath/param.value.json will result in a param with value param.value.json
...

If you don't care of extension recognition, you can disable it by overriding mvc:annotation-driven automagic :

<bean id="handlerMapping"
      class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping">
    <property name="contentNegotiationManager" ref="contentNegotiationManager"/>
    <property name="useSuffixPatternMatch" value="false"/>
</bean>

So, again, if you have /somepath/{variable} :

/somepath/param, /somepath/param.json, /somepath/param.xml or /somepath/param.anything will result in a param with value param
/somepath/param.value.json, /somepath/param.value.xml or /somepath/param.value.anything will result in a param with value param.value

note : the difference from the default config is visible only if you have a mapping like somepath/something.{variable}. see Resthub project issue

if you want to keep extension management, since Spring 3.2 you can also set the useRegisteredSuffixPatternMatch property of RequestMappingHandlerMapping bean in order to keep suffixPattern recognition activated but limited to registered extension.

Here you define only json and xml extensions :

<bean id="handlerMapping"
      class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping">
    <property name="contentNegotiationManager" ref="contentNegotiationManager"/>
    <property name="useRegisteredSuffixPatternMatch" value="true"/>
</bean>

<bean id="contentNegotiationManager" class="org.springframework.web.accept.ContentNegotiationManagerFactoryBean">
    <property name="favorPathExtension" value="false"/>
    <property name="favorParameter" value="true"/>
    <property name="mediaTypes">
        <value>
            json=application/json
            xml=application/xml
        </value>
    </property>
</bean>

Note that mvc:annotation-driven accepts now a contentNegotiation option to provide a custom bean but the property of RequestMappingHandlerMapping has to be changed to true (default false) (cf. https://jira.springsource.org/browse/SPR-7632).

For that reason, you still have to override the all mvc:annotation-driven configuration. I opened a ticket to Spring to ask for a custom RequestMappingHandlerMapping : https://jira.springsource.org/browse/SPR-11253. Please vote if you are intereted in.

While overriding, be carreful to consider also custom Execution management overriding. Otherwise, all your custom Exception mappings will fail. You will have to reuse messageCoverters with a list bean :

<bean id="validator" class="org.springframework.validation.beanvalidation.LocalValidatorFactoryBean" />
<bean id="conversionService" class="org.springframework.format.support.FormattingConversionServiceFactoryBean" />

<util:list id="messageConverters">
    <bean class="your.custom.message.converter.IfAny"></bean>
    <bean class="org.springframework.http.converter.ByteArrayHttpMessageConverter"></bean>
    <bean class="org.springframework.http.converter.StringHttpMessageConverter"></bean>
    <bean class="org.springframework.http.converter.ResourceHttpMessageConverter"></bean>
    <bean class="org.springframework.http.converter.xml.SourceHttpMessageConverter"></bean>
    <bean class="org.springframework.http.converter.xml.XmlAwareFormHttpMessageConverter"></bean>
    <bean class="org.springframework.http.converter.xml.Jaxb2RootElementHttpMessageConverter"></bean>
    <bean class="org.springframework.http.converter.json.MappingJacksonHttpMessageConverter"></bean>
</util:list>

<bean name="exceptionHandlerExceptionResolver"
      class="org.springframework.web.servlet.mvc.method.annotation.ExceptionHandlerExceptionResolver">
    <property name="order" value="0"/>
    <property name="messageConverters" ref="messageConverters"/>
</bean>

<bean name="handlerAdapter"
      class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter">
    <property name="webBindingInitializer">
        <bean class="org.springframework.web.bind.support.ConfigurableWebBindingInitializer">
            <property name="conversionService" ref="conversionService" />
            <property name="validator" ref="validator" />
        </bean>
    </property>
    <property name="messageConverters" ref="messageConverters"/>
</bean>

<bean id="handlerMapping"
      class="org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping">
</bean>

I implemented, in the open source project Resthub that I am part of, a set of tests on these subjects : see https://github.com/resthub/resthub-spring-stack/pull/219/files & https://github.com/resthub/resthub-spring-stack/issues/217

User · Answer

As far as i know this issue appears only for the pathvariable at the end of the requestmapping    We were able to solve that by defining the regex addon in the requestmapping     somepath  variable

User · Answer

The complete solution including email addresses in path names for spring 4 2 is    lt bean id  contentNegotiationManager      class  org springframework web accept ContentNegotiationManagerFactoryBean  gt       lt property name  favorPathExtension  value  false    gt       lt property name  favorParameter  value  true    gt       lt property name  mediaTypes  gt           lt value gt              json application json             xml application xml          lt  value gt       lt  property gt   lt  bean gt   lt mvc annotation-driven     content-negotiation-manager  contentNegotiationManager  gt       lt mvc path-matching suffix-pattern  false  registered-suffixes-only  true    gt   lt  mvc annotation-driven gt    Add this to the application-xml

User · Answer

One pretty easy way to work around this issue is to append a trailing slash      e g    use     somepath filename jpg    instead of    somepath filename jpg

User · Answer

In addition to Martin Frey s answer  this can also be fixed by adding a trailing slash in the RequestMapping value    path  variable     Keep in mind that this fix does not support maintainability  It now requires all URI s to have a trailing slash - something that may not be apparent to API users   new developers  Because it s likely not all parameters may have a   in them  it may also create intermittent bugs

User · Answer

In Spring Boot Rest Controller  I have resolved these by following Steps   RestController     GetMapping   statusByEmail  email        public String statusByEmail  PathVariable value    email   String email       code     And From Rest Client   Get http   mywebhook com statusByEmail abc test gmail com

User · Answer

For me the  GetMapping path    quot  a  variableName     quot    does work but only if you also encode the  quot dot quot  in your request url as  quot  2E quot  then it works   But requires URL s to all be that   which is not a  quot standard quot  encoding  though valid   Feels like something of a bug    The other work around  similar to the  quot trailing slash quot  way is to move the variable that will have the dot  quot inline quot  ex   GetMapping path    quot   variableName  a quot   now all dots will be preserved  no modifications needed

User · Answer

If you are using Spring 3 2 x and  lt mvc annotation-driven   gt   create this little BeanPostProcessor   package spring   public final class DoNotTruncateMyUrls implements BeanPostProcessor        Override     public Object postProcessBeforeInitialization Object bean  String beanName  throws BeansException           if  bean instanceof RequestMappingHandlerMapping                  RequestMappingHandlerMapping bean  setUseSuffixPatternMatch false                     return bean             Override     public Object postProcessAfterInitialization Object bean  String beanName  throws BeansException           return bean            Then put this in your MVC config xml    lt bean class  spring DoNotTruncateMyUrls    gt

User · Answer

If you write both back and frontend  another simple solution is to attach a  quot   quot  at the end of the URL at front  If so  you don t need to change your backend    somepath myemail gmail com   Be happy

User · Answer

If you are using Spring 3 2  then below solution will help  This will handle all urls so definitely better than applying regex pattern in the request URI mapping to allow   like   somepath  variable     Define a bean in the xml file  lt bean class  quot org springframework web servlet mvc method annotation RequestMappingHandlerMapping quot  gt           lt property name  quot useSuffixPatternMatch quot  value  quot false quot   gt           lt property name  quot useRegisteredSuffixPatternMatch quot  value  quot true quot   gt       lt  bean gt   The flags usage can be found on the documentation  I am putting snipped to explain exlanation of useRegisteredSuffixPatternMatch is said to be resolving the issue  From the java doc in the class If enabled  a controller method mapped to  quot  users quot  also matches to  quot  users json quot  assuming  quot  json quot  is a file extension registered with the provided   link  setContentNegotiationManager ContentNegotiationManager  contentNegotiationManager   This can be useful for allowing only specific URL extensions to be used as well as in cases where a  quot   quot  in the URL path can lead to ambiguous interpretation of path variable content   e g  given  quot  users  user  quot  and incoming URLs such as  quot  users john j joe quot  and  quot  users john j joe json quot

User · Answer

Here s an approach that relies purely on java configuration   import org springframework context annotation Bean  import org springframework context annotation Configuration  import org springframework web servlet config annotation WebMvcConfigurationSupport  import org springframework web servlet mvc method annotation RequestMappingHandlerMapping    Configuration public class MvcConfig extends WebMvcConfigurationSupport        Bean     public RequestMappingHandlerMapping requestMappingHandlerMapping             RequestMappingHandlerMapping handlerMapping   super requestMappingHandlerMapping            handlerMapping setUseSuffixPatternMatch false           handlerMapping setUseTrailingSlashMatch false           return handlerMapping

User · Answer

Finally I found solution in Spring Docs   To completely disable the use of file extensions  you must set both of the following   useSuffixPatternMatching false   see PathMatchConfigurer   favorPathExtension false   see ContentNegotiationConfigurer   Adding this to my WebMvcConfigurerAdapter implementation solved the problem   Override public void configureContentNegotiation ContentNegotiationConfigurer configurer        configurer favorPathExtension false       Override public void configurePathMatch PathMatchConfigurer matcher        matcher setUseSuffixPatternMatch false

User · Answer

As of Spring 5 2 4  Spring Boot v2 2 6 RELEASE   PathMatchConfigurer setUseSuffixPatternMatch and ContentNegotiationConfigurer favorPathExtension have been deprecated   https   spring io blog 2020 03 24 spring-framework-5-2-5-available-now and https   github com spring-projects spring-framework issues 24179    The real problem is that the client requests a specific media type  like  com  and Spring added all those media types by default  In most cases your REST controller will only produce JSON so it will not support the requested output format   com    To overcome this issue you should be all good by updating your rest controller  or specific method  to support the  ouput  format   RequestMapping produces   MediaType ALL VALUE   and of course allow characters like a dot   username        Example    RequestMapping value   USERNAME  consumes   MediaType APPLICATION JSON VALUE  produces   MediaType APPLICATION JSON VALUE  public class UsernameAPI        private final UsernameService service        GetMapping value      username       consumes   MediaType APPLICATION JSON VALUE  produces   MediaType ALL VALUE      public ResponseEntity isUsernameAlreadyInUse  PathVariable value    username    Valid  Size max   255  String username            log debug  Check if username already exists            if  service doesUsernameExist username                 return ResponseEntity status HttpStatus NO CONTENT  build                      return ResponseEntity notFound   build              Spring 5 3 and above will only match registered suffixes  media types

User · Answer

In Spring Boot  The  Regular expression solve the problem  like   GetMapping   path  param1

User · Answer

adding the       worked for me  but not until I removed outer curly brackets   value      username  id       didn t work  value     username  id        works  Hope I helped someone

User · Answer

Update for Spring 4  since 4 0 1 you can use PathMatchConfigurer  via your WebMvcConfigurer   e g    Configuration protected static class AllResources extends WebMvcConfigurerAdapter         Override     public void configurePathMatch PathMatchConfigurer matcher            matcher setUseRegisteredSuffixPatternMatch true               Configuration public class WebConfig implements WebMvcConfigurer        Override    public void configurePathMatch PathMatchConfigurer configurer           configurer setUseSuffixPatternMatch false            In xml  it would be  https   jira spring io browse SPR-10163     lt mvc annotation-driven gt                 lt mvc path-matching registered-suffixes-only  true   gt   lt  mvc annotation-driven gt

User · Answer

somepath  variable     works in Java requestMapping tag

[spring] Spring MVC @PathVariable with dot (.) is getting truncated

Examples related to spring

Examples related to rest

Examples related to spring-mvc

Examples related to spring-annotations