Что нужно сделать для метода, чтобы получить id из пути?

Получение параметра ID из пути в Spring

Получение параметров из пути URL — одна из самых частых задач при разработке REST API на Spring. Рассмотрим различные способы реализации этого с примерами.

1. Использование @PathVariable (основной способ)

// Самый простой и распространённый подход
@RestController
@RequestMapping("/api/v1/users")
public class UserController {
    
    // GET /api/v1/users/123
    @GetMapping("/{id}")
    public ResponseEntity<User> getUserById(@PathVariable Long id) {
        User user = userService.findById(id);
        return ResponseEntity.ok(user);
    }
}

2. Явное указание имени переменной

// Если имя параметра отличается от имени переменной в пути
@GetMapping("/users/{userId}")
public ResponseEntity<User> getUserById(
    @PathVariable("userId") Long id  // "userId" - имя в пути, id - имя переменной
) {
    return ResponseEntity.ok(userService.findById(id));
}

// Более явный вариант с требованием значения
@GetMapping("/users/{id}")
public ResponseEntity<User> getUserById(
    @PathVariable(name = "id", required = true) Long userId
) {
    return ResponseEntity.ok(userService.findById(userId));
}

3. Несколько параметров из пути

@RestController
@RequestMapping("/api/v1")
public class CommentController {
    
    // GET /api/v1/posts/5/comments/10
    @GetMapping("/posts/{postId}/comments/{commentId}")
    public ResponseEntity<Comment> getComment(
        @PathVariable Long postId,
        @PathVariable Long commentId
    ) {
        Comment comment = commentService.findByIdAndPostId(commentId, postId);
        return ResponseEntity.ok(comment);
    }
}

4. Различные типы данных

@RestController
@RequestMapping("/api/v1")
public class ResourceController {
    
    // ID как UUID
    @GetMapping("/resources/{id}")
    public ResponseEntity<Resource> getResourceById(
        @PathVariable UUID id
    ) {
        return ResponseEntity.ok(resourceService.findById(id));
    }
    
    // ID как String (slug)
    @GetMapping("/posts/{slug}")
    public ResponseEntity<Post> getPostBySlug(
        @PathVariable String slug
    ) {
        return ResponseEntity.ok(postService.findBySlug(slug));
    }
    
    // ID как Integer
    @GetMapping("/items/{itemId}")
    public ResponseEntity<Item> getItemById(
        @PathVariable Integer itemId
    ) {
        return ResponseEntity.ok(itemService.findById(itemId));
    }
}

5. Автоматическая валидация с @Validated

@RestController
@RequestMapping("/api/v1")
@Validated
public class ValidatedController {
    
    // ID должен быть положительным числом
    @GetMapping("/users/{id}")
    public ResponseEntity<User> getUserById(
        @PathVariable @Positive Long id
    ) {
        return ResponseEntity.ok(userService.findById(id));
    }
    
    // Email с валидацией формата
    @GetMapping("/search/{email}")
    public ResponseEntity<User> searchByEmail(
        @PathVariable @Email String email
    ) {
        return ResponseEntity.ok(userService.findByEmail(email));
    }
    
    // String с ограничением по длине
    @GetMapping("/categories/{name}")
    public ResponseEntity<Category> getCategoryByName(
        @PathVariable @Size(min = 1, max = 100) String name
    ) {
        return ResponseEntity.ok(categoryService.findByName(name));
    }
}

6. Обработка ошибок валидации

@RestControllerAdvice
public class GlobalExceptionHandler {
    
    // Обработка ConstraintViolationException
    @ExceptionHandler(ConstraintViolationException.class)
    public ResponseEntity<ErrorResponse> handleConstraintViolation(
        ConstraintViolationException e
    ) {
        String message = e.getConstraintViolations()
            .stream()
            .map(cv -> cv.getPropertyPath() + ": " + cv.getMessage())
            .collect(Collectors.joining(", "));
        
        return ResponseEntity
            .badRequest()
            .body(new ErrorResponse("Validation failed", message));
    }
    
    // Обработка неверного формата пути
    @ExceptionHandler(IllegalArgumentException.class)
    public ResponseEntity<ErrorResponse> handleIllegalArgument(
        IllegalArgumentException e
    ) {
        return ResponseEntity
            .badRequest()
            .body(new ErrorResponse("Invalid path parameter", e.getMessage()));
    }
}

record ErrorResponse(String error, String message) {}

7. Работа с регулярными выражениями в пути

@RestController
@RequestMapping("/api/v1")
public class PatternController {
    
    // Только числовые ID
    @GetMapping("/users/{id:\\d+}")
    public ResponseEntity<User> getUserById(@PathVariable Long id) {
        return ResponseEntity.ok(userService.findById(id));
    }
    
    // UUID pattern
    @GetMapping("/resources/{id:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}}")
    public ResponseEntity<Resource> getResourceById(@PathVariable UUID id) {
        return ResponseEntity.ok(resourceService.findById(id));
    }
    
    // Slug с буквами, цифрами и дефисами
    @GetMapping("/posts/{slug:[a-z0-9-]+}")
    public ResponseEntity<Post> getPostBySlug(@PathVariable String slug) {
        return ResponseEntity.ok(postService.findBySlug(slug));
    }
}

8. Глобальная конвертация типов

@Configuration
public class WebConfig implements WebMvcConfigurer {
    
    @Override
    public void addFormatters(FormatterRegistry registry) {
        // Кастомный конвертер для класса User ID
        registry.addConverter(String.class, UserId.class, 
            source -> new UserId(Long.parseLong(source))
        );
        
        // Конвертер для LocalDate
        registry.addConverter(String.class, LocalDate.class,
            source -> LocalDate.parse(source, DateTimeFormatter.ISO_DATE)
        );
    }
}

// Использование кастомного типа
@GetMapping("/users/{id}")
public ResponseEntity<User> getUserById(@PathVariable UserId id) {
    return ResponseEntity.ok(userService.findById(id.value()));
}

record UserId(Long value) {}

9. Матричные переменные (продвинутый подход)

// GET /api/v1/users/5;name=John;active=true
@GetMapping("/users/{id}")
public ResponseEntity<User> getUserById(
    @PathVariable Long id,
    @MatrixVariable(required = false) String name,
    @MatrixVariable(required = false) Boolean active
) {
    return ResponseEntity.ok(userService.findById(id, name, active));
}

// Конфигурация для включения матричных переменных
@Configuration
public class WebConfig implements WebMvcConfigurer {
    @Override
    public void configurePathMatch(PathMatchConfigurer configurer) {
        UrlPathHelper urlPathHelper = new UrlPathHelper();
        urlPathHelper.setRemoveSemicolonContent(false);
        configurer.setUrlPathHelper(urlPathHelper);
    }
}

10. RESTful API паттерн с ID

@RestController
@RequestMapping("/api/v1/users")
public class FullRESTfulController {
    
    // GET /api/v1/users
    @GetMapping
    public ResponseEntity<List<UserDTO>> getAllUsers() {
        return ResponseEntity.ok(userService.findAll());
    }
    
    // GET /api/v1/users/123
    @GetMapping("/{id}")
    public ResponseEntity<UserDTO> getUserById(@PathVariable Long id) {
        return ResponseEntity.ok(userService.findById(id));
    }
    
    // POST /api/v1/users
    @PostMapping
    public ResponseEntity<UserDTO> createUser(@RequestBody UserCreateRequest request) {
        return ResponseEntity.status(HttpStatus.CREATED)
            .body(userService.create(request));
    }
    
    // PUT /api/v1/users/123
    @PutMapping("/{id}")
    public ResponseEntity<UserDTO> updateUser(
        @PathVariable Long id,
        @RequestBody UserUpdateRequest request
    ) {
        return ResponseEntity.ok(userService.update(id, request));
    }
    
    // DELETE /api/v1/users/123
    @DeleteMapping("/{id}")
    public ResponseEntity<Void> deleteUser(@PathVariable Long id) {
        userService.delete(id);
        return ResponseEntity.noContent().build();
    }
    
    // GET /api/v1/users/123/posts
    @GetMapping("/{id}/posts")
    public ResponseEntity<List<PostDTO>> getUserPosts(@PathVariable Long id) {
        return ResponseEntity.ok(userService.getUserPosts(id));
    }
}

Best Practices

1. Используй @PathVariable для обязательных ID из пути
2. Валидируй ID с аннотациями типа @Positive, @NotNull
3. Обрабатывай ошибки с @ExceptionHandler
4. Используй типы вместо String для ID (UUID, Long, Integer)
5. Документируй параметры пути в Swagger/OpenAPI
6. Имена переменных должны быть в {camelCase} в пути
7. Логируй получение ID для отладки

Итог: @PathVariable — это основной и рекомендуемый способ получения параметров из пути URL в Spring. Правильное использование с валидацией и обработкой ошибок обеспечивает безопасный и надёжный REST API.