Customizable parameter name when binding an object [SPR-10183]

[spring-projects-issues]

Bozhidar Bozhanov opened SPR-10183 and commented

When binding request parameters to an object, you should be able to customize the name, like you can with @RequestParameter("prop_name") propName.

Something like:

@CommandParameter("editor_text")
private String text;

I have written on the subject here: http://techblog.bozho.net/?p=779

---

Issue Links:

• Provide a way to customize the names of JavaBean properties when they're read and written for data binding purposes [SPR-9242] #13880 Provide a way to customize the names of JavaBean properties when they're read and written for data binding purposes
• Add @FormAttribute attributes to customize x-www-form-urlencoded [SPR-13433] #18012 Add @FormAttribute attributes to customize x-www-form-urlencoded ("is superseded by")

2 votes, 6 watchers

[spring-projects-issues]

Rossen Stoyanchev commented

The request sounds reasonable enough but I wonder how well a solution along these lines would work in practice. Note that you can also bind all request parameters to a MultiValueMap and then access them by name, which happens to work well with the example in the referenced blog where there are only two parameters and both are simple strings. It would help to have more concrete cases where this need arises and possibly consider other solutions as well. Certainly a situation where this annotation is used very often doesn't seem right.

[spring-projects-issues]

Bozhidar Bozhanov commented

Our case was as follows:
We defined our command objects (which we then send to the service layer), and everything worked fine. Then came the SEO consultancy and said "you should name your GET parameters differently". We could have renamed the fields, but it would mean ugly code. And we would need to refactor every time a parameter name changes.

If it is only 2 parameters, then it's ok to have them as @RequestParam, but usually it's more.
A MultiValueMap might be ok if you don't want to have validation - @NotEmpty @CommandParameter("foo") is way more convenient. But even without validation, mapping a MultiValueMap to a your DTO (that goes to the service layer) is an addtional, tedious step.

[spring-projects-issues]

Victor Tarnavsky commented

We have a bit different use case.
Some parameters have java-not-compatible names, like "max-results", and it is not the thing we can change. Request object can have many parameters, so using MultiValueMap looks dirty. Also we using bean validation too.
What about fork&pull request? Looks like @bozho have a solution, or our team can do it.

[spring-projects-issues]

Bozhidar Bozhanov commented

It would probably be best if you do it (feel free to use pieces of my code, of course). I've already left the job where I've built this, and it has been a long time (year and a half), so you are the better option, as currently more focused on the task.

[spring-projects-issues]

wu wen commented

+1

[spring-projects-issues]

Rossen Stoyanchev commented

Resolving this as superseded by #18012.