@RequestParam for query strings in Spring Boot - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of the @RequestParam annotation in Spring Boot?

It is used to extract query string parameters from the URL in HTTP requests and bind them to method parameters in controller methods.

beginner

How do you make a @RequestParam optional in a Spring Boot controller method?

Set the attribute 'required = false' in the @RequestParam annotation. For example: @RequestParam(required = false) String name.

intermediate

What happens if a required @RequestParam is missing in the HTTP request?

Spring Boot throws a MissingServletRequestParameterException, resulting in a 400 Bad Request response by default.

beginner

How can you provide a default value for a @RequestParam in Spring Boot?

Use the 'defaultValue' attribute in the annotation. For example: @RequestParam(defaultValue = "guest") String user.

beginner

Show a simple example of a Spring Boot controller method using @RequestParam to get a 'page' query parameter.

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

What does @RequestParam do in a Spring Boot controller?

A Binds query string parameters to method arguments

B Maps HTTP POST body to an object

C Defines a REST endpoint URL

D Handles exceptions globally

The @RequestParam annotation binds query string parameters from the URL to method parameters.

How do you make a @RequestParam optional?

A Set required = true

B Use @OptionalParam annotation

C Use @Nullable annotation

D Set required = false

Setting required = false makes the @RequestParam optional.

What is the default behavior if a required @RequestParam is missing?

A Spring Boot uses null value

B Spring Boot uses defaultValue automatically

C Spring Boot throws an error and returns 400 Bad Request

D Spring Boot ignores the parameter

If a required @RequestParam is missing, Spring Boot throws an exception and returns 400 Bad Request.

How to provide a default value for a @RequestParam?

A Use defaultValue attribute

B Use @Default annotation

C Set required = false only

D Use @Value annotation

The defaultValue attribute sets a default value if the parameter is missing.

Which HTTP method is commonly used with @RequestParam?

A POST

B GET

C PUT

D DELETE

@RequestParam is often used with GET requests to read query parameters.

Explain how @RequestParam works in Spring Boot and how to handle optional query parameters.

Think about how URLs pass data and how controller methods receive it.

Describe what happens when a required @RequestParam is missing in a request and how to avoid errors.

Consider error handling and parameter defaults.

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