@PathVariable drops extension [SPR-9333]

[spring-projects-issues]

Will Glass-Husain opened SPR-9333 and commented

There's a bug introduced in 3.0.6 (also exists in 3.0.7) with the @PathVariable. It's very similar to #10038 though it was actually reintroduced in #13187.

If a item is included on the path that has a period, it's impossible for the full string to be picked up by the path variable. For example, with this URL and request mapping, userEmail is set to "jsmith@mail".

http://mydomain.com/myapp/api/user/jsmith@mail.com

and this method

@RequestMapping(value = {"/{userEmail}"}, method = RequestMethod.GET)
public ModelAndView doGet(@PathVariable final String userEmail)
{
}

My code also had a class-wide request mapping, though I'm not sure if it's relevant.

The usual advice is to include a DefaultAnnotationHandlerMapping in the context and set the property useDefaultSuffixPattern to false. However, in 3.0.6, code was introduced into AnnotationMethodHandlerAdapter.getMatchingPattern() which adds .* to the pattern (eliminating the so-called file extension) but which is not suppressed by useDefaultSuffixPattern.

---

Affects: 3.0.6, 3.0.7

Sub-tasks:

• Backport "@PathVariable drops extension" [SPR-9419] #14055 Backport "@PathVariable drops extension"

Referenced from: commits cf5d551, 8143d66

0 votes, 5 watchers

[spring-projects-issues]

Rossen Stoyanchev commented

Although I haven't tried it yet, the analysis looks right. The split request mapping decision between the HandlerMapping and the HandlerAdapter in this and other case makes fixes like the one in #13187 very brittle. Fortunately in Spring 3.1 we have new @MVC support classes that replace the ones above and the decisions is made in one place, the RequestMappingHandlerMapping. Hence unless there is something preventing you, I highly recommend upgrading and using these new classes.

That said I'll take a closer look to see what can be done. I'm afraid it may be difficult to address both scenarios but we'll see. Short of upgrading to 3.1, there is another workaround. Simply adding a regular expression like the one below should work:

@RequestMapping(value = {"/{userEmail:.*}"}, method = RequestMethod.GET)

[spring-projects-issues]

Daniel Serodio commented

Thanks Rossen, I'm using 3.1.2 and Spring was still chomping the "file extension" of a @PathVariable, so I had to add a regular expression like you suggested.

[spring-projects-issues]

Rossen Stoyanchev commented

It's in 3.1.3 (not 3.1.2). See the backport sub-task #14055.

[spring-projects-issues]

Daniel Serodio commented

I've updated to 3.1.3 and still see this problem.

BTW, #14055 says it's fixed in 3.1.2.

[spring-projects-issues]

Rossen Stoyanchev commented

And useDefaultSuffixPattern in your DefaultAnnotationHandlerMapping is set to false? We do have a test case for the issue that went from red to green but may be there is something else less obvious going on. The next most obvious step would be to create an issue reproduction project. If you have time to submit it, it would help speed things up.

[spring-projects-issues]

Will Glass-Husain commented

I have upgraded to Spring 3.1.3 and can verify the problem seen in the example I gave has gone away.

[spring-projects-issues]

Mike Whitman commented

The problem seems to be back in 3.2.0.

[spring-projects-issues]

Rossen Stoyanchev commented

You need to open a new ticket with an up-to-date description. This ticket is closed for good.