Использование нескольких @RequestMapping в Spring: правила и советы

Быстрый ответ

При работе с @RequestMapping в Spring назначьте аннотации на уровне класса и на уровне метода. Укажите базовый маршрут на уровне класса, а для каждого метода задайте отдельные пути. В качестве примера можно привести следующий код:

@RestController
@RequestMapping("/shop")
public class ProductController {

    @GetMapping("/products")
    public List<Product> listAllProducts() {
        // Выводим список всех товаров, присоединяйтесь к шопингу!
    }

    @GetMapping("/products/{id}")
    public Product getProductDetails(@PathVariable Long id) {
        // Прибыл в поисках товара? Получите информацию прямо тут!
    }
}

При такой конфигурации GET-запросы на /shop/products будут отображать список товаров, а запросы на /shop/products/{id} предоставят информацию о выбранном товаре, где {id} — это переменная часть URL. @GetMapping — это упрощенный аналог @RequestMapping(method = RequestMethod.GET), который делает код более читабельным.

Гибкая маршрутизация с использованием нескольких путей

Чтобы обрабатывать различные сценарии маршрутизации, используйте несколько путей в одной аннотации @RequestMapping:

@Controller
public class WelcomeController {

    @RequestMapping(value={"", "/", "/welcome"}, method=RequestMethod.GET)
    public String welcome(Map<String, Object> model) {
        // Добро пожаловать! Множество путей ведут к одной цели.
        return "welcome";
    }
}

В данном примере метод welcome() обрабатывает три разных URL-адреса: "", "/", и "/welcome".

Работа с шаблонами: использование подстановочных знаков и ant-стиля

C @RequestMapping можно применять дополнительные возможности, в частности подстановочные знаки и пути в ant-стиле:

@Controller
@RequestMapping("/files")
public class FileController {

    @RequestMapping("/images/**")
    public String getImages() {
        // Время улыбнуться: начинается закачка изображений, включая снимки котиков.
    }
    
    @RequestMapping("/docs/*")
    public String getDocuments() {
        // Пришло время к чтению: встречайте документацию.
    }
}

Метод getImages() активизируется при обращении ко всем путям, начинающимся с /files/images/, а getDocuments() — при обращении к путям, начинающимся с /files/docs/.

Применение конкретных HTTP-глаголов для различных маршрутов

Для разделения маршрутов используйте конкретные HTTP-методы, делайте это так, будто бы использовали разные глаголы:

@Controller
public class UserController {

    @GetMapping("/users")
    public List<User> getAllUsers() {
        // Получаем информацию о пользователях.
    }

    @PostMapping("/users")
    public User createUser(@RequestBody User user) {
        // Регистрируем нового пользователя, принимаем JSON.
    }
}

В приведенном примере оба метода настроены на путь /users, однако getAllUsers() обрабатывает GET-запросы, а createUser() — POST-запросы.

Визуализация

Представьте несколько @RequestMapping в Spring как систему обозначенных дверей (🚪) внутри дома (🏠), каждая из которых ведёт в свой отдельный уголок:

🏠: [Гостиная, Кухня, Кабинет, Спальня]
Каждая 🚪 обозначает путь внутри 🏠.

@Controller
public class HouseController {
    @RequestMapping("/living-room")  // 🚪 в Гостиную
    public String goToLivingRoom() { /* ... */ }

    @RequestMapping("/kitchen")      // 🚪 на Кухню
    public String goToKitchen() { /* ... */ }

    @RequestMapping("/study")        // 🚪 в Кабинет
    public String goToStudy() { /* ... */ }

    @RequestMapping("/bedroom")      // 🚪 в Спальню
    public String goToBedroom() { /* ... */ }
}

В результате каждая @RequestMapping становится уникальной точкой доступа к функционалу вашего приложения.

Лучшие практики и ошибка, которые следует избегать

Обработка множества URL может быть полезной, но не забывайте о возможных конфликтах и перекрытиях.

Избегайте конфликтов в маппинге

Если ваши маршрутизационные распорядки пересекаются, это может вызвать проблемы, и нарушить работу вашего дня:

@Controller
public class ConflictController {

    @RequestMapping("/help")
    public String openHelp() {
        // Нужна помощь? Мы всегда к вашим услугам.
    }

    @RequestMapping("/help/how-to")
    public String openHowToGuides() {
        // Ищете подробные инструкции? Вам сюда!
    }
}

Запрос к /help/how-to может некорректно обработать метод openHelp(), вместо openHowToGuides(). Поэтому делайте ваши URL-шаблоны уникальными или следите за их логической последовательностью.

Подробнее об этом расскажет наш спикер на видео

Чистота тропинок маршрутизатора

Структурируйте методы контроллера и маршрутизационные карты так, чтобы было легко навигироваться и понимать их. Группируйте связанные функции, как будто вы размещаете книги на полках библиотеки.

Двукратная проверка с помощью тестирования

Не недооценивайте необходимость тестирования вашего кода. Тщательно проверьте каждый путь отдельно и в связке с другими, для удостоверения правильности работы. Используйте инструменты интеграционного тестирования, такие как MockMvc или RestAssured, для оптимизации вашего кода.

Радиантные альтернативы

Иногда стоит рассмотреть разные подходы, такие как использование конфигурационных файлов для определения стандартных представлений или применение специализированных HTTP-аннотаций для упорядочивания контроллеров.

Полезные материалы

1. Spring Framework Documentation – @RequestMapping
2. Getting Started | Building a RESTful Web Service
3. DZone – A Guide to @RequestMapping
4. DigitalOcean Community Tutorials – Spring @RequestMapping Annotation