Настройка Spring Boot: как связать корень приложения и index.html?

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

Если вы хотите сделать переход с корневого URL (/) на index.html в Spring Boot, реализуйте интерфейс WebMvcConfigurer и переопределите метод addViewControllers. Добавьте контроллер представления, чтобы перенаправлять запросы на index.html:

@Configuration
public class MvcConfig implements WebMvcConfigurer {
    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
        registry.addViewController("/").setViewName("forward:/index.html");
    }
}

Заключительным шагом будет помещение index.html в каталоге src/main/resources/static, после чего корневой путь вашего приложения будет отображать этот файл.

Сохраняем умолчания Spring Boot

Spring Boot придерживается принципа "меньше — это больше". При использовании аннотаций следует учитывать, чтобы они не создавали конфликтных ситуаций со встроенной автоконфигурацией. В частности, будьте осторожны с аннотациями @RequestMapping("/") и @EnableWebMvc, они могут вступить в конфликт с автоматическим сопоставлением статических ресурсов или отключить автоконфигурацию в пользу ручной настройки.

Устранение неполадок в сопоставлении

Если в поведении статических ресурсов наблюдаются необъяснимые особенности, стоит проверить их доступность, перейдя напрямую к index.html через браузер. Это простой способ определить проблемы в сопоставлении. И не забывайте о разнице в автоматическом сопоставлении между разными версиями Spring Boot.

Перенаправление вместо переадресации

Если вам необходимо выполнить перенаправление, а не переадресацию:

@Override
public void addViewControllers(ViewControllerRegistry registry) {
    registry.addRedirectViewController("/", "index.html");
}

Также можно провести ручное перенаправление через контроллер:

@RestController
public class RootController {
    @GetMapping("/")
    public String redirectToIndex() {
        return "forward:/index.html";
    }
}

Для послепроцессинга ваших запросов используйте @Configuration и @EnableWebMvc. С Java 8+ Рекомендуется использовать WebMvcConfigurer вместо устаревшего WebMvcConfigurerAdapter.

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

Spring Boot-приложение можно представить как дом с различными точками доступа, представляющими собой отдельные комнаты. А index.html — это коврик у входа:

Дом (🏠): [ /api, /contacts, /about, / ] 
Коврик (🚪🧺): "Добро пожаловать на '/index.html'"

В этой метафоре корневому пути соответствует:

🚪🧺📍-> Дом: [ / -> /index.html ]
КОРЕНЬ ('/'). Здесь вас встретят радушно, как дома.

Это элегантное и интуитивно понятное решение позволяет эффективно навигировать по вашему приложению.

Использование Thymeleaf и нескольких путей

Для работы с Thymeleaf достаточно создать @Controller, который будет возвращать нужный шаблон:

@Controller
public class WebController {
    @GetMapping("/")
    public String index() {
        return "index";
    }
}

Поместите index.html в папку src/main/resources/templates, и Spring Boot автоматически настроит остальное для работы с Thymeleaf. Если у приложения есть несколько "входных точек", просто настройте для каждой свое перенаправление через контроллеры представлений.

В API-ориентированных приложениях для улучшения ответов рекомендуется использовать Spring HATEOAS.

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

1. Основные возможности — официальная документация Spring Boot.
2. Начало работы | Обслуживание веб-контента с использованием Spring MVC — руководство по Spring Boot.
3. Учебник: Thymeleaf + Spring — использование Thymeleaf в Spring.
4. Настройка стартовой страницы в Spring Boot — учебник от Baeldung.
5. Настройка Spring MVC для пользовательских обработчиков ресурсов — как настроить обработчики ресурсов для Spring MVC.