@RequestParam for query strings in Spring Boot

Introduction

@RequestParam helps you get values from the URL query string easily. It lets your program read small pieces of information sent by the user in the web address.

When you want to get user input from the URL like ?name=John

When you need to filter or search data based on query parameters

When you want to handle optional values sent in the URL

When building simple APIs that accept parameters via URL

When you want to read multiple parameters from the query string

Syntax

Spring Boot

@RequestParam(type) parameterName

You usually put @RequestParam before a method parameter in a controller.

You can set a default value or make the parameter optional.

Examples

Gets a required query parameter named 'name' as a String.

Spring Boot

@RequestParam String name

Gets an optional query parameter 'age' as an Integer. If missing, it will be null.

Spring Boot

@RequestParam(required = false) Integer age

Gets 'user' parameter, but if missing, uses "guest" as default.

Spring Boot

@RequestParam(defaultValue = "guest") String user

Sample Program

This controller has a GET endpoint /greet that reads 'name' and optional 'lang' from the query string. It returns a greeting in English or Spanish based on 'lang'.

Spring Boot

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class GreetingController {

    @GetMapping("/greet")
    public String greetUser(@RequestParam String name, @RequestParam(required = false, defaultValue = "en") String lang) {
        if (lang.equals("es")) {
            return "Hola, " + name + "!";
        } else {
            return "Hello, " + name + "!";
        }
    }
}

Important Notes

If you forget to send a required parameter, Spring will return an error automatically.

You can use @RequestParam with many types like int, boolean, or even lists.

Always validate or sanitize query parameters to keep your app safe.

Summary

@RequestParam reads values from the URL query string.

You can make parameters required, optional, or give default values.

It helps your app respond differently based on user input in the URL.

Practice

1. What does the @RequestParam annotation do in a Spring Boot controller?

easy

A. It maps the URL path to a controller method.

B. It extracts query string parameters from the URL and passes them to the method.

C. It defines the HTTP method type like GET or POST.

D. It handles exceptions thrown by the controller.

Solution

1. Step 1: Understand the role of @RequestParam

   @RequestParam is used to get values from the URL query string, like ?name=John.

2. Step 2: Compare with other annotations

   @RequestMapping maps URLs, @RequestParam extracts query parameters, others handle HTTP methods or errors.

3. Final Answer:

   It extracts query string parameters from the URL and passes them to the method. -> Option B

4. Quick Check:

   @RequestParam reads query parameters = A [OK]

Hint: Remember: @RequestParam reads URL query values [OK]

Common Mistakes:

• Confusing @RequestParam with @PathVariable
• Thinking it maps URLs instead of parameters
• Assuming it handles HTTP methods

2. Which of the following is the correct syntax to make a query parameter optional with a default value using @RequestParam?

easy

A. @RequestParam(value = "id", required = true, defaultValue = "0") int id

B. @RequestParam(name = "id", optional = true, default = 0) int id

C. @RequestParam(name = "id", required = false, defaultValue = "0") int id

D. @RequestParam("id", default = 0) int id

Solution

1. Step 1: Identify correct attributes for optional param

   To make a parameter optional, use required = false and provide defaultValue as a string.

2. Step 2: Check syntax correctness

   @RequestParam(name = "id", required = false, defaultValue = "0") int id uses required = false and defaultValue = "0" correctly; others use invalid attributes or miss required parts.

3. Final Answer:

   @RequestParam(name = "id", required = false, defaultValue = "0") int id -> Option C

4. Quick Check:

   Optional param syntax = A [OK]

Hint: Use required=false and defaultValue="value" for optional params [OK]

Common Mistakes:

• Using 'optional' instead of 'required'
• Setting defaultValue as a number instead of string
• Omitting required attribute

3. Given the controller method:

@GetMapping("/greet")
public String greet(@RequestParam String name) {
    return "Hello, " + name + "!";
}

What will be the output when accessing /greet?name=Anna?

medium

A. Hello, Anna!

B. Hello, null!

C. Hello, !

D. Error: Missing required parameter

Solution

1. Step 1: Understand @RequestParam behavior

   The method expects a query parameter 'name' which is required by default.

2. Step 2: Check the URL query string

   The URL provides ?name=Anna, so the method receives "Anna" as the parameter.

3. Final Answer:

   Hello, Anna! -> Option A

4. Quick Check:

   Query param 'name' = Anna, output greeting = D [OK]

Hint: If param is required and given, output uses it directly [OK]

Common Mistakes:

• Assuming missing param causes null instead of error
• Confusing query string with path variable
• Expecting default value without setting one

4. Identify the error in this Spring Boot controller method:

@GetMapping("/search")
public String search(@RequestParam int page) {
    return "Page: " + page;
}

What happens if the URL /search is accessed without any query parameters?

medium

A. The method returns "Page: 0"

B. The method returns "Page: null"

C. The method returns an empty string

D. The method throws a 400 Bad Request error

Solution

1. Step 1: Check @RequestParam default behavior

   By default, @RequestParam is required. Since 'page' is primitive int, it cannot be null.

2. Step 2: Analyze missing parameter effect

   Accessing /search without 'page' causes Spring to reject the request with 400 Bad Request due to missing required param.

3. Final Answer:

   The method throws a 400 Bad Request error -> Option D

4. Quick Check:

   Missing required param causes 400 error = C [OK]

Hint: Required params missing cause 400 error, primitives can't be null [OK]

Common Mistakes:

• Assuming default 0 for missing int param
• Expecting null for primitive types
• Thinking method returns empty string on error

5. You want to create a Spring Boot controller method that accepts an optional query parameter sort with default value "asc" and a required parameter page. Which method signature is correct?

hard

A. @GetMapping("/items")
public String items(@RequestParam(required = false, defaultValue = "asc") String sort, @RequestParam int page) { ... }

B. @GetMapping("/items")
public String items(@RequestParam(required = true, defaultValue = "asc") String sort, @RequestParam int page) { ... }

C. @GetMapping("/items")
public String items(@RequestParam(required = false) String sort, @RequestParam(required = true) int page) { ... }

D. @GetMapping("/items")
public String items(@RequestParam String sort = "asc", @RequestParam int page) { ... }

Solution

1. Step 1: Set optional param with default value

   Use required = false and defaultValue = "asc" for the optional 'sort' parameter.

2. Step 2: Ensure required param is declared correctly

   The 'page' parameter is required by default, so just @RequestParam int page is enough.

3. Step 3: Evaluate each option

   @GetMapping("/items") public String items(@RequestParam(required = false, defaultValue = "asc") String sort, @RequestParam int page) { ... } correctly combines required=false and defaultValue for 'sort' and required 'page'. Incorrect options include one with required=true and defaultValue (still required on missing), one with required=false without defaultValue (null on missing), and one with invalid syntax.

4. Final Answer:

   @GetMapping("/items") public String items(@RequestParam(required = false, defaultValue = "asc") String sort, @RequestParam int page) { ... } -> Option A

5. Quick Check:

   Optional with default + required param = B [OK]

Hint: Use required=false with defaultValue for optional params [OK]

Common Mistakes:

• Omitting required=false for optional param
• Trying to assign default value in method signature
• Forgetting defaultValue causes errors