PUT과 PATCH 메서드

웹 개발에서 HTTP 메서드는 클라이언트와 서버 간의 통신을 정의하는 중요한 요소입니다. 그중에서도 PUT과 PATCH는 모두 리소스를 업데이트하는 데 사용되지만, 그 목적과 동작 방식에는 분명한 차이점이 있습니다. 이번 블로그에서는 Spring Boot를 활용하여 PUT과 PATCH의 차이점을 이해하고, 각 메서드를 어떻게 사용해야 하는지 코드 예제와 함께 살펴보겠습니다.

1. PUT은 전체 리소스를 대체하는 메서드이다.

설명: PUT 메서드는 지정된 리소스를 새로운 데이터로 완전히 대체합니다. 즉, 요청에서 제공된 데이터로 기존 리소스의 모든 내용을 덮어씁니다.

사용 상황:

• 리소스의 모든 필드를 업데이트해야 할 때
• 클라이언트가 리소스의 전체 상태를 알고 있으며, 이를 서버에 전달할 때

코드 예제:

@RestController
@RequestMapping("/users")
public class UserController {

    // PUT 요청 처리: 전체 업데이트
    @PutMapping("/{id}")
    public ResponseEntity<User> updateUser(@PathVariable Long id, @RequestBody User user) {
        // 기존 사용자 정보를 새로운 정보로 완전히 대체
        User updatedUser = userService.replaceUser(id, user);
        return ResponseEntity.ok(updatedUser);
    }
}

 

서비스 레이어 예제:

@Service
public class UserService {

    @Autowired
    private UserRepository userRepository;

    public User replaceUser(Long id, User user) {
        // 데이터베이스에서 사용자 조회
        User existingUser = userRepository.findById(id)
            .orElseThrow(() -> new ResourceNotFoundException("User not found"));

        // 모든 필드를 새로운 값으로 대체
        existingUser.setName(user.getName());
        existingUser.setEmail(user.getEmail());
        existingUser.setAge(user.getAge());
        existingUser.setAddress(user.getAddress());
        // 기타 필요한 필드들...

        // 저장 후 반환
        return userRepository.save(existingUser);
    }
}

---

2. PATCH는 리소스의 일부를 수정하는 메서드이다.

설명: PATCH 메서드는 리소스의 일부 필드만 업데이트합니다. 요청에서 제공된 필드들만 수정되며, 나머지 필드는 변경되지 않습니다.

사용 상황:

• 리소스의 일부 속성만 변경해야 할 때
• 클라이언트가 변경할 필드만 알고 있을 때

코드 예제:

@RestController
@RequestMapping("/users")
public class UserController {

    // PATCH 요청 처리: 부분 업데이트
    @PatchMapping("/{id}")
    public ResponseEntity<User> updateUserPartially(@PathVariable Long id, @RequestBody Map<String, Object> updates) {
        // 기존 사용자 정보를 일부 업데이트
        User updatedUser = userService.updateUserPartially(id, updates);
        return ResponseEntity.ok(updatedUser);
    }
}

 

서비스 레이어 예제:

@Service
public class UserService {

    @Autowired
    private UserRepository userRepository;

    public User updateUserPartially(Long id, Map<String, Object> updates) {
        User existingUser = userRepository.findById(id)
            .orElseThrow(() -> new ResourceNotFoundException("User not found"));

        // 리플렉션이나 ObjectMapper 등을 활용하여 동적으로 필드 업데이트
        updates.forEach((key, value) -> {
            Field field = ReflectionUtils.findField(User.class, key);
            field.setAccessible(true);
            ReflectionUtils.setField(field, existingUser, value);
        });

        // 저장 후 반환
        return userRepository.save(existingUser);
    }
}

---

3. PUT과 PATCH의 차이점은 업데이트 범위이다.

차이점 요약:

• PUT: 리소스의 전체를 대체합니다. 요청에 모든 필드를 포함해야 하며, 누락된 필드는 null 또는 기본값으로 설정될 수 있습니다.
• PATCH: 리소스의 일부를 수정합니다. 요청에 포함된 필드들만 업데이트되며, 나머지 필드는 변경되지 않습니다.

예시를 통한 이해:

• PUT 요청 예시

PUT /users/1
Content-Type: application/json

{
  "name": "홍길동",
  "email": "hong@example.com",
  "age": 30,
  "address": "서울시 강남구"
}

 

이 요청은 ID가 1인 사용자의 name, email, age, address 필드를 모두 새로운 값으로 대체합니다. 만약 phoneNumber 필드를 누락했다면, 해당 필드는 null로 설정될 수 있습니다.

• PATCH 요청 예시

PATCH /users/1
Content-Type: application/json

{
  "email": "hong_new@example.com"
}

이 요청은 ID가 1인 사용자의 email 필드만 hong_new@example.com으로 변경하며, 다른 필드는 그대로 유지됩니다.

 

4. 언제 PUT과 PATCH를 사용해야 할까?

PUT을 사용해야 하는 경우:

• 클라이언트가 리소스의 전체 상태를 알고 있으며, 이를 서버에 전달하여 완전히 대체하고자 할 때
• 리소스의 모든 필드를 항상 업데이트해야 하는 API 디자인을 원할 때

PATCH를 사용해야 하는 경우:

• 클라이언트가 리소스의 일부만 변경하고자 할 때
• 대역폭 절약이 필요하거나, 변경할 필드만 전달하는 것이 효율적일 때

---

5. 주의사항 및 베스트 프랙티스

• 일관성 유지: API 설계 시 PUT과 PATCH의 사용을 일관되게 유지하는 것이 중요합니다. 혼용하면 클라이언트 개발자가 혼란스러워할 수 있습니다.
• HTTP 표준 준수: PUT과 PATCH의 의미를 정확히 이해하고, HTTP 표준에 맞게 사용해야 합니다.
• 부분 업데이트 시 검증: PATCH를 사용할 때, 업데이트하려는 필드에 대한 유효성 검증을 철저히 해야 합니다. 누락된 필드나 잘못된 값으로 인해 데이터 무결성이 손상될 수 있습니다.
• 멱등성(Idempotency): PUT은 멱등성을 가지지만, PATCH는 그렇지 않을 수 있습니다. 즉, 같은 요청을 여러 번 보내도 결과가 동일한지 고려해야 합니다.

---

6. 결론

PUT과 PATCH는 모두 리소스를 업데이트하기 위한 HTTP 메서드이지만, 그 동작 방식은 크게 다릅니다. PUT은 리소스를 전체 대체하고, PATCH는 부분 수정을 합니다. Spring Boot에서 이를 구현할 때도 이러한 차이점을 명확히 이해하고 사용해야 합니다. 올바른 메서드를 사용함으로써 API의 효율성과 일관성을 높일 수 있습니다.