Spring @RequestParam mapping Boolean based on 1 or 0 instead of true or false

Question

Why is Spring 3.2 only mapping my Boolean based on that the requestparam is "0" or "1" ?

@RequestParam(required= false, defaultValue = "false") Boolean preview

Preview will only be "true" when the requestparam is "?preview=1" which is wierd

I want it to be "?preview=true". How do I do that?

did you know a way, where the request parameter which has default value and required is false, that can be totally ignored in the URL, meaning we don't even have to put anything in the URL for that request parameter. In your example, `preview` will not even be a part of the URL. — Soumitri Pattnaik, Jun 16 '16 at 11:37

Tydaeus · Answer 1 · 2017-01-10T17:36:38.610

106

I think we may need more detail in order to be effective answering your question.

I have working Spring 3.2 code along the lines of:

@RequestMapping(value = "/foo/{id}", method = RequestMethod.GET)
@ResponseBody
public Foo getFoo(
    @PathVariable("id") String id, 
    @RequestParam(value="bar", required = false, defaultValue = "true")
        boolean bar)
{ 
    ... 
}

Spring correctly interprets ?bar=true, ?bar=1, or ?bar=yes as being true, and ?bar=false, ?bar=0, or ?bar=no as being false.

True/false and yes/no values ignore case.

edited Jan 10 '17 at 17:36

answered Aug 04 '14 at 16:09

Tydaeus

1,505
1
13
13

Does it do equalsIgnoreCase as well? I mean what would be expected result if I send `bar=TRUE` ,`bar=TrUe` or `bar=yES`...? – Raja Anbazhagan Jan 09 '17 at 06:57
According to the sorucecode linked by Pavel below, it ignores case. – stenix Mar 08 '18 at 08:59
Just a small info: Supplying a defaultValue implicitly sets required as false. So don't need to pass `required=false`. – dheeraj9499 Feb 27 '23 at 13:01

score 23 · Answer 2 · answered Oct 04 '13 at 18:45

23

Spring should be able to interpret true, 1, yes and on as true boolean value... check StringToBooleanConverter.

answered Oct 04 '13 at 18:45

Pavel Horal

17,782
3
65
89

is there a way in which, we turn required off and provide a default value and in the URL we don't even have to mention the request parameter? – Soumitri Pattnaik Jun 16 '16 at 11:35
2

{{@RequestParam(defaultValue = "true") boolean notify}} Should suffice to solve your problem. – varra Dec 17 '16 at 06:53
@SoumitriPattnaik Supplying a default value implicitly sets required to false. – I'm_Pratik Apr 30 '20 at 04:42

score 0 · Answer 3 · answered May 28 '20 at 11:28

you can use jackson's JsonDeserialize annotation, short and clean

create the following deserializer:

public class BooleanDeserializer extends JsonDeserializer<Boolean> {
    public BooleanDeserializer() {
    }

    public Boolean deserialize(JsonParser parser, DeserializationContext context) throws IOException {
        return !"0".equals(parser.getText());
    }
}

and add the annotation to your DTO like so:

public class MyDTO {
    @NotNull
    @JsonDeserialize(using = BooleanDeserializer.class)
    private Boolean confirmation;
}

score 0 · Answer 4 · answered Mar 30 '21 at 05:10

We can do using

@GetMapping("/getAudioDetails/organizations/{orgId}/interactions/{interactionId}")
public ResponseEntity<?> getAudioDetails(@PathVariable("orgId") String orgId,@PathVariable("interactionId") String interactionId,
        @RequestParam(name = "verbose", required = false, defaultValue = "false") boolean verbose){
    System.out.println(verbose);
    return null;
}

where verbose is an boolean flag which by default happens to be false as can be referred from inage below on api call .

score 0 · Answer 5 · answered Dec 19 '22 at 15:19

I suppose you are missing value="preview" in the @RequestParam. Due to this, Spring is setting the variable preview to false always, as that is the defaultValue.


@RequestParam(value = "preview", required= false, defaultValue = "false") Boolean preview

Spring @RequestParam mapping Boolean based on 1 or 0 instead of true or false

5 Answers5

Linked