[Spring] Spring 요청값 처리 방식

@PathVariable, @RequestParam, @ModelAttribute, @RequestBody, @Vaild, @JsonInclude

---

Spring에서 세부 요청으로 인입되는 값들

Spring에서는 클라이언트가 HTTP 요청을 통해 전달한 데이터를 다양한 방식으로 컨트롤러에 전달할 수 있다.

각 요청마다 데이터의 처리 방식이 달라지고, 그에 따라 Model이나 View도 다양해질 수 있다. Spring에서 요청값을 처리하는 주요 어노테이션에 대해 알아보도록 하자.

 

@PathVaribale: /api/users/{id}

@PathVariable은 URL 경로에서 동적으로 값을 추출할 때 사용된다. 예를 들어, 사용자의 ID나 특정 리소드에 대한 고유 값을 URL 경로에서 직접 추출할 수 있다.

package com.example.demo.controller;

import com.example.demo.service.User;
import com.example.demo.service.UserServiceInterface;
import lombok.AccessLevel;
import lombok.RequiredArgsConstructor;
import lombok.experimental.FieldDefaults;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

import java.util.List;

@Controller
@RequestMapping("/users")
@RequiredArgsConstructor
@FieldDefaults(makeFinal = true, level = AccessLevel.PRIVATE)
public class UserController {
    UserServiceInterface userService;

    @Autowired
    private ApplicationContext applicationContext;

    @GetMapping("/bean")
    @ResponseBody
    public String bean() {
        return applicationContext.getBean(UserServiceInterface.class).toString();
    }

    @GetMapping("")
    public String userPage(Model model) {
        List<User> users = userService.findAll();
        model.addAttribute("users", users);
        return "/users/list";
    }

    @GetMapping("/{id}/detail")
    public String detailPage(@PathVariable Integer id, Model model) {
        User user = userService.findById(id);
        model.addAttribute("id", user.getId());
        model.addAttribute("name", user.getName());
        model.addAttribute("age", user.getAge());
        model.addAttribute("job", user.getJob());
        model.addAttribute("specialty", user.getSpecialty());
        return "/users/detail";
    }

    @GetMapping("/{id}/data")
    @ResponseBody
    public User detailData(@PathVariable Integer id) {
        User user = userService.findById(id);
        return user;
    }
}

• 위 코드에서 @PathVariable을 사용하여 동적으로 URl에서 사용자 ID를 받아 사용하고 있다. 예를 들어 /users/1/detail 같은 요청이 들어오면, @PathVariable을 통해 ID 값을 받아 해당 사용자의 상세 정보를 조회하여 반환한다.
• 해당 ID를 기반으로 userService.findById(id) 메서드를 호출하여 사용자의 정보를 가져온다.
• 만약 @PathVariable을 사용할 때 에러가 발생한다면, value옵션을 추가하여 변수명을 명확히 지정해야한다.
  • `@PathVariable Integer id` → `@PathVariable("id") Integer id`

@RequestParam: ?key=value

@RequestParam은 URL에 붙는 쿼리 파라미터를 처리하는데 사용된다. 쿼리 파라미터는 일반적으로 특정 검색 조건이나 필터링 조건을 전달할 때 사용된다.

 

package com.example.demo.controller;

import com.example.demo.service.User;
import com.example.demo.service.UserServiceInterface;
import lombok.AccessLevel;
import lombok.RequiredArgsConstructor;
import lombok.experimental.FieldDefaults;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.*;

import java.util.List;

@Controller
@RequestMapping("/users")
@RequiredArgsConstructor
@FieldDefaults(makeFinal = true, level = AccessLevel.PRIVATE)
public class UserController {
    UserServiceInterface userService;

    @Autowired
    private ApplicationContext applicationContext;

    // ApplicationContext에서 UserService Bean 확인
    @GetMapping("/bean")
    @ResponseBody
    public String bean() {
        return applicationContext.getBean(UserServiceInterface.class).toString();
    }

    // 전체 사용자 목록을 조회하여 리스트 페이지 반환
    @GetMapping("")
    public String userPage(Model model) {
        List<User> users = userService.findAll();
        model.addAttribute("users", users);
        return "/users/list";
    }

    // 특정 사용자 상세 정보를 조회하여 뷰에 전달
    @GetMapping("/detail")
    public String detailPage(@RequestParam Integer id, Model model) {
        User user = userService.findById(id);
        model.addAttribute("id", user.getId());
        model.addAttribute("name", user.getName());
        model.addAttribute("age", user.getAge());
        model.addAttribute("job", user.getJob());
        model.addAttribute("specialty", user.getSpecialty());
        return "/users/detail";
    }

    // 특정 사용자 상세 정보를 JSON 형식으로 반환
    @GetMapping("/data")
    @ResponseBody
    public User detailData(@RequestParam Integer id) {
        User user = userService.findById(id);
        return user;
    }
}

• @RequestParam은 URL에서 쿼리 파라미터로 전달된 값을 가져오는 데 사용된다.  예를들어http://localhost:8080/users/detail?id=1 같은 요청이 들어오면 id 값이 추출되어 서비스 메서드로 전달된다
• @RequestParam Integer id: 쿼리 파라미터로 전달된 id 값을 추출한다.
• 예시 요청: http://localhost:8080/users/detail?id=3

@ReqeustParam 사용 시 확장 사용 가능한 옵션들

1. 필수 / 비필수 여부: `@RequestParam(required = false)
2. 기본값 설정: `@RequestParam(defaultValue = "원하는 값을 String으로 명시")`

@ModelAttribue: ?key1=value&key2=value2

@ModelAttribute는 여러 개의 요청 파라미터를 객체로 매핑할 때 사용한다. 주로 폼 데이터를 처리하거나 다수의 파라미터를 한 번에 객체로 받아야 할때 사용된다.

package com.example.demo.controller;

import com.example.demo.controller.dto.UserCreateRequestDto;
import com.example.demo.service.User;
import com.example.demo.service.UserServiceInterface;
import lombok.AccessLevel;
import lombok.RequiredArgsConstructor;
import lombok.experimental.FieldDefaults;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.*;

import java.util.List;

@Controller
@RequestMapping("/users")
@RequiredArgsConstructor
@FieldDefaults(makeFinal = true, level = AccessLevel.PRIVATE)
public class UserController {
    UserServiceInterface userService;

    @Autowired
    private ApplicationContext applicationContext;

    // ApplicationContext에서 UserService Bean 확인
    @GetMapping("/bean")
    @ResponseBody
    public String bean() {
        return applicationContext.getBean(UserServiceInterface.class).toString();
    }

    // 전체 사용자 목록을 조회하여 리스트 페이지 반환
    @GetMapping("")
    public String userPage(Model model) {
        List<User> users = userService.findAll();
        model.addAttribute("users", users);
        return "/users/list";
    }

    // 특정 사용자 상세 정보를 조회하여 뷰에 전달
    @GetMapping("/detail")
    public String detailPage(@RequestParam Integer id, Model model) {
        User user = userService.findById(id);
        model.addAttribute("id", user.getId());
        model.addAttribute("name", user.getName());
        model.addAttribute("age", user.getAge());
        model.addAttribute("job", user.getJob());
        model.addAttribute("specialty", user.getSpecialty());
        return "/users/detail";
    }

    // 특정 사용자 상세 정보를 JSON 형식으로 반환
    @GetMapping("/data")
    @ResponseBody
    public User detailData(@RequestParam Integer id) {
        User user = userService.findById(id);
        return user;
    }

    // 새로운 사용자 저장
    @RequestMapping(value = "", method = RequestMethod.POST)
    @ResponseBody
    public User save(@ModelAttribute UserCreateRequestDto request) {
        User user = userService.save(request.getName(), request.getAge(), request.getJob(), request.getSpecialty());
        return user;
    }
}

• @ModelAttribute UserCreateRequestDto request: 여러 개의 요청 파라미터가 UserCreateRequestDto 객체로 자동 매핑된다. 사용자가 입력한 값들이 DTO 객체의 필드로 자동으로 매핑된다.

UserCreateReqeustDto 클래스:

package com.example.demo.controller.dto;

import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;

@Getter
@Setter
@NoArgsConstructor
public class UserCreateRequestDto {
    private String name;
    private Integer age;
    private String job;
    private String specialty;
}

• 주의: 요청 객체 클래스에 아래 Lombok이 없다면 역직렬화가 되지 않아 값이 제대로 들어오지 않는다.
  1. @AllArgsConstructor
  2. @NoArgsConstructor + @Setter ← 기본값이 설정 가능한 이 방법을 더 선호한다.

테스트 예시:

• 전체 사용자 조회:
  • URL: http://localhost:8080/users
• 특정 사용자 조회 (뷰 반환):
  • URL: http://localhost:8080/users/detail?id=1
• 특정 사용자 조회(JSON 반환):
  • URL: http://localhost:8080/users/data?id=1
• 새 사용자 생성:
  • URL: http://localhost:8080/users
  • HTTP 메서드: POST
  • 파라미터: name, age, job, specialty
  • 예시: http://lcoalhost:8080/users?name=cheonsang&age=20&job=developer&specialty=backend

@ReqeustBody: JSON { property: 'value' }

@ReqeustBody는 요청 본문(body)에서 데이터륿 ㅏㄷ아 처리한다. 주로 클라이언트에서 JSON 형식으로 데이터를 전송할 때 사용되며, POST 요청과 함께 많이 사용된다.

package com.example.demo.controller;

import com.example.demo.controller.dto.UserCreateRequestDto;
import com.example.demo.service.User;
import com.example.demo.service.UserServiceInterface;
import lombok.AccessLevel;
import lombok.RequiredArgsConstructor;
import lombok.experimental.FieldDefaults;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.*;

import java.util.List;

@Controller
@RequestMapping("/users")
@RequiredArgsConstructor
@FieldDefaults(makeFinal = true, level = AccessLevel.PRIVATE)
public class UserController {
    UserServiceInterface userService;

    @Autowired
    private ApplicationContext applicationContext;

    // ApplicationContext에서 UserService Bean 확인
    @GetMapping("/bean")
    @ResponseBody
    public String bean() {
        return applicationContext.getBean(UserServiceInterface.class).toString();
    }

    // 전체 사용자 목록을 조회하여 리스트 페이지 반환
    @GetMapping("")
    public String userPage(Model model) {
        List<User> users = userService.findAll();
        model.addAttribute("users", users);
        return "/users/list";
    }

    // 특정 사용자 상세 정보를 조회하여 뷰에 전달
    @GetMapping("/detail")
    public String detailPage(@RequestParam Integer id, Model model) {
        User user = userService.findById(id);
        model.addAttribute("id", user.getId());
        model.addAttribute("name", user.getName());
        model.addAttribute("age", user.getAge());
        model.addAttribute("job", user.getJob());
        model.addAttribute("specialty", user.getSpecialty());
        return "/users/detail";
    }

    // 특정 사용자 상세 정보를 JSON 형식으로 반환
    @GetMapping("/data")
    @ResponseBody
    public User detailData(@RequestParam Integer id) {
        User user = userService.findById(id);
        return user;
    }

    // 새로운 사용자 저장
    @RequestMapping(value = "", method = RequestMethod.POST)
    @ResponseBody
    public User save(@RequestBody UserCreateRequestDto request) {
        User user = userService.save(request.getName(), request.getAge(), request.getJob(), request.getSpecialty());
        return user;
    }
}

• @RequestBody UserCreateRequestDto request: 클라이언트로부터 전달된 JSON 형식의 데이터를 UserCreateRequestDto 객체로 변환하여 컨트롤러 메서드로 전달한다.

테스트 예시

• 새 사용자 생성:
  • URL: http://localhost:8080/users
  • HTTP 메서드: POST
  • Contenty-Type: application/json
• 요청 본문 예시 (JSON):

{
  "name": "cheosange",
  "age": 20,
  "job": "Developer",
  "specialty": "Backend"
}

Spring에서의 요청값 유효성 검증: @Valid, @Validated

Spring에서는 클라이언트가 전송한 요청값의 유효성을 검증할수 있다. 주요 어노테이션으로 @Valid와 @Validated가 있다.

• @Valid: Java 표준 유효성 검증 어노테이션으로, 요청 파라미터에 대한 기본적인 검증을 제공한다.
• @Validated: Spring에서 제공하는 유효성 검증 어노테이션으로, 좀 더 복잡한 검증을 수행할 수 있다.

필수조건: `build.gradle`에 다음 라이브러리를 추가해야한다.

implementation 'org.springframework.boot:spring-boot-starter-validation'

 

UserController.java

package com.example.demo.controller;

import com.example.demo.controller.dto.UserCreateRequestDto;
import com.example.demo.service.User;
import com.example.demo.service.UserServiceInterface;
import jakarta.validation.Valid;
import lombok.AccessLevel;
import lombok.RequiredArgsConstructor;
import lombok.experimental.FieldDefaults;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.*;

import java.util.List;

@Controller
@RequestMapping("/users")
@RequiredArgsConstructor
@FieldDefaults(makeFinal = true, level = AccessLevel.PRIVATE)
public class UserController {
    UserServiceInterface userService;

    @Autowired
    private ApplicationContext applicationContext;

    @GetMapping("/bean")
    @ResponseBody
    public String bean() {
        return applicationContext.getBean(UserServiceInterface.class).toString();
    }

    @GetMapping("")
    public String userPage(Model model) {
        List<User> users = userService.findAll();
        model.addAttribute("users", users);
        return "/users/list";
    }

    @GetMapping("/detail")
    public String detailPage(@RequestParam Integer id, Model model) {
        User user = userService.findById(id);
        model.addAttribute("id", user.getId());
        model.addAttribute("name", user.getName());
        model.addAttribute("age", user.getAge());
        model.addAttribute("job", user.getJob());
        model.addAttribute("specialty", user.getSpecialty());
        return "/users/detail";
    }

    @GetMapping("/data")
    @ResponseBody
    public User detailData(@RequestParam Integer id) {
        User user = userService.findById(id);
        return user;
    }

    // @Valid를 사용하여 요청 데이터의 유효성 검증
    @PostMapping("")
    @ResponseBody
    public User save(@RequestBody @Valid UserCreateRequestDto request) {
        User user = userService.save(request.getName(), request.getAge(), request.getJob(), request.getSpecialty());
        return user;
    }
}

• save() 메서드에서 @Valid를 사용하여 UserCreateRequestDto 필드 검증을 수행한다.
• 요청에 포함된 데이터가 검증 조건을 만족하지 않으면, Spring에서 자동으로 400 Bad Reqeust 응답을 반환한다.

 

UserCreateRequestDto.java

package com.example.demo.controller.dto;

import jakarta.validation.constraints.Min;
import jakarta.validation.constraints.NotBlank;
import jakarta.validation.constraints.NotNull;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;

@Getter
@Setter
@NoArgsConstructor
public class UserCreateRequestDto {
    // 이름은 빈 값일 수 없다
    @NotBlank
    private String name;
    
    // 나이는 최소 10이어야 한다
    @Min(10)
    private Integer age;
    
    // 직업은 반드시 있어야 한다
    @NotNull
    private String job;
    
    // 특기는 선택사항, 기본값은 "(empty)"
    private String specialty = "(empty)";
}

• 필드에 검증 어노테이션을 적용하여 각 필드의 유효성 조건을 설정한다.
• 이름이 비어 있으면 안되고, 나이는 최소 10이상 이어야하며, 직업은 null일 수 없다.

 

주요 검증 어노테이션:

• @NotBlank: 필드가 null, 빈 문자열, 공백 문잠나 있는 경우 허용하지 않음.
• @Min(value): 필드의 최소값을 지정
• @NotNull: 필드가 반드시 null이 아니여야함.

테스트 예시:

 

1. 유효한 데이터로 요청:

• URL: http://localhost:8000/users
• HTTP 메서드: POST
• Content-Type: application/json
• 요청 본문:

{
  "name": "CheonSang",
  "age": 20,
  "job": "Developer"
}

• 응답 본문:

{
  "id": 1,
  "name": "CheonSang",
  "age": 20,
  "job": "Developer",
  "specialty": "(empty)"
}

 

2. 유효하지 않은 데이터로 요청(이름 X):

• 요청 본문:

{
  "name": "",
  "age": 20,
  "job": "Developer"
}

• 응답: 400 Bad Request

{
  "status": 400,
  "error": "Bad Request",
  "message": "Validation failed for object='userCreateRequestDto'. Error count: 1"
}

 

3. 유효하지 않은 데이터로 요청 (나이가 10 미만):

• 요청 본문:

{
  "name": "CheonSang",
  "age": 5,
  "job": "Developer"
}

• 응답: 400 Bad Request

{
  "status": 400,
  "error": "Bad Request",
  "message": "Validation failed for object='userCreateRequestDto'. Error count: 1"
}

 

4. 유효하지 않은 데이터로 요청 (직업이 null):

• 요청 본문:

{
  "name": "CheonSang",
  "age": 30,
  "job": null
}

• 응답: 400 Bad Requeest

{
  "status": 400,
  "error": "Bad Request",
  "message": "Validation failed for object='userCreateRequestDto'. Error count: 1"
}

 

Spring 응답 세부 조율: @JsonInclude

@JsonInclude는 응답으로 반환될 JSON 데이터에서 null 값을 포함할지 제외할지를 설정할 수 있는 어노테이션이다. 예를 들어, 값이 null인 필드는 JSON 응답에 포함되지 않도록 설정할 수 있다.

package com.example.demo.controller.dto;

import com.example.demo.service.User;
import com.fasterxml.jackson.annotation.JsonInclude;
import lombok.AccessLevel;
import lombok.AllArgsConstructor;
import lombok.Getter;

@Getter
@AllArgsConstructor(access = AccessLevel.PACKAGE)
public class UserResponseDto {
    private Integer id;
    private String name;
    private Integer age;
    private String job;
    private String specialty;
    
    // null인 경우 JSON 응답에서 제외
    @JsonInclude(JsonInclude.Include.NON_NULL)
    private String address;
    
    // null인 경우 JSON 응답에서 제외
    @JsonInclude(JsonInclude.Include.NON_NULL)
    private String postcode;

    // User 엔티티로부터 UserResponseDto로 변환
    public static UserResponseDto from(User entity) {
        return new UserResponseDto(
                entity.getId(),
                entity.getName(),
                entity.getAge(),
                entity.getJob(),
                entity.getSpecialty(),
                null,  // Address는 null로 설정
                null   // Postcode도 null로 설정
        );
    }
}

• User 엔티티로부터 데이트를 받아 응답을 위한 DTO로 변환한다.
• address와 postcode는 null일 수 있으며, null인 경우 응답에 포함되지 않는다.

테스트 예시:

 

1. 주소와 우편번호가 없는 경우:

• URL: http://localhost:8080/users/data?id=1
• 요청이 들어오면, 응답에 address와 postcode는 필드에 포함되지 않는다.

{
  "id": 1,
  "name": "CheonSang",
  "age": 20,
  "job": "Developer",
  "specialty": "(empty)"
}

 

2. 주소와 우편번호가 있는 경우(값이 있는 경우):

{
  "id": 1,
  "name": "cheonsang",
  "age": 20,
  "job": "Developer",
  "specialty": "(empty)",
  "address": "seoul",
  "postcode": "56789"
}

 

필드가 아닌 클래스(Dto) 단위로도 제약 적용이 가능하다

package com.example.demo.controller.dto;

import com.example.demo.service.User;
import com.fasterxml.jackson.annotation.JsonInclude;
import lombok.AccessLevel;
import lombok.AllArgsConstructor;
import lombok.Getter;

@Getter
@AllArgsConstructor(access = AccessLevel.PACKAGE)
@JsonInclude(JsonInclude.Include.NON_NULL)
public class UserResponseDto {
    private Integer id;
    private String name;
    private Integer age;
    private String job;
    private String specialty;
    private String address;
    private String postcode;

    // User 엔티티를 UserResponseDto로 변환하는 정적 메서드
    public static UserResponseDto from(User entity) {
        return new UserResponseDto(
                entity.getId(),
                entity.getName(),
                entity.getAge(),
                entity.getJob(),
                entity.getSpecialty(),
                null,  // address는 null로 설정
                null   // postcode도 null로 설정
        );
    }
}

---

ℹ️ 참고

[ASAC 6기 강의자료]