Spring Boot validating request parameters

Question

I am trying to learn Spring Boot and working on a simple REST API which I develop a simple calculator.

I have a service class annotated with @Service and it has a simple method

public double calculate(String operation, double num1, double num2) {
        ...
}

And I am calling this method from the controller like

@GetMapping("/calculate")
public double calculate(@RequestParam(value = "op") String op,
                        @RequestParam(value = "num1") double num1,
                        @RequestParam(value = "num2") double num2) {

    return calculatorService.calculate(op, num1, num2);
}

I want to validate these parameters(Whether num1 and num2 are numeric and all parameters should be not null). What is the best practice to validate the request parameters for Spring Boot?

Jason · Accepted Answer · 2019-03-06 02:29:37Z

1

It depends on what validation you want to perform.

One way would be to use validation annotations on the parameters themselves.

For example, @NotNull, @Min, @Max, etc. These particular ones can be found in javax.validation:validation-api, but there are many others (and you can build your own).

@GetMapping("/calculate")
public double calculate(@RequestParam(value = "op") @NotNull String op,
                        @RequestParam(value = "num1") double num1,
                        @RequestParam(value = "num2") double num2) {

The @NotNull validation will ensure that op is not null - you might want to use a @NotEmpty or @NotBlank annotation to ensure that the actual value of op has a length > 0 or a trimmed length > 0 respectively.

As Cristian Colorado points out in their comment below, Spring will automatically fail validation (or endpoint matching) if either num1 or num2 are not valid double values.

edited Mar 6, 2019 at 2:29

answered Mar 5, 2019 at 22:17

Jason

11.8k3 gold badges45 silver badges48 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

Tartar Over a year ago

Using BigDecimal makes sense but I do not need to check the value range of my parameters. I just need to check whether they are numeric or not.

Cristian Colorado Over a year ago

If num1 is not numeric, spring will not be able to bind the parameter and either would throw a ServletRequestBindingException or just will not find a proper endpoint to handle the request.

Romil Patel · Accepted Answer · 2019-03-06 04:40:56Z

0

As you have told that you want to validate only Number @NumberFormat Annotation is there. The @NumberFormat annotation applies to subclasses of java.lang.Number (Integer, Float, Double, BigDecimal, etc.)

@NumberFormat(style=Style.NUMBER)

answered Mar 6, 2019 at 4:40

Romil Patel

14k9 gold badges54 silver badges84 bronze badges

Collectives™ on Stack Overflow

Spring Boot validating request parameters

2 Answers 2

2 Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

2 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related