Как настроить мапинг запросов на ресурсы web-приложения?

Question

[Николай Ступак]

Web-приложение имеет такой контроллер:

@RestController
@RequestMapping("/")
public class HttpRequestController implements ControllerConstants {

    @Autowired
    private ApplicationContext context;
    
    @Autowired
    private ApiService apiService;

    @RequestMapping(value = "/{version}/**", method = {GET, POST, PUT, DELETE})
    public Object handleHttpRequest(@PathVariable("version") String version, HttpServletRequest request) {
        final Api api = apiService.getApiByVersion(version);
        if ( api == null ) {
            throw new NotFoundException("Api with version " + version + " not founded");
        }
        //далее вызов методов api
    }

    @RequestMapping("/example/{example}.html")
    public ModelAndView getExample(@PathVariable("example") String example) {
        return new ModelAndView("example/" + example);
    }
    
}

И такой конфиг:

@Configuration
@EnableWebMvc
@ComponentScan()
public class SpringWebConfig extends WebMvcConfigurerAdapter {

  @Bean
  public InternalResourceViewResolver getInternalResourceViewResolver() {
    InternalResourceViewResolver resolver = new InternalResourceViewResolver();
    resolver.setPrefix("/WEB-INF/");
    resolver.setSuffix(".html");
    return resolver;
  }

  @Override
  public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {
    configurer.enable();
  }

  @Bean
  public WebContentInterceptor webContentInterceptor() {
    WebContentInterceptor interceptor = new WebContentInterceptor();
    interceptor.setCacheSeconds(0);
    interceptor.setUseExpiresHeader(true);
    interceptor.setUseCacheControlHeader(true);
    interceptor.setUseCacheControlNoStore(true);

    return interceptor;
  }

  @Override
  public void addInterceptors(InterceptorRegistry registry) {
    registry.addInterceptor(webContentInterceptor());
  }
}

В директории WEB-INF есть директория example, в которой лежит файл some.html.

Приложение развернуто на Tomcat-е с контекстным путем /api.

Когда я оправляю запрос localhost:8080/api/v1/someMethod, то вызов правильно обрабатывается, метод вызывается и результат отправляется клиенту. Когда я отправляю запрос localhost:8080/api/example/some.html, то в ответ получаю следующую ошибку:
.
Подскажите, как сделать так, чтобы при запросах вида localhost:8080/api/example/some.html возвращалась запрошенная страница?

Answer 1

[Александр Косарев]

Всё правильно, так как адрес example/some.html попадает под оба правила.
Правило /{version}/** в твоём случае перекрывает все варианты, так что самый простой способ избавиться от проблемы - сделать правило более строгим (например, /api/{version}/**).

И да, в @RestController возвращать ModelAndView из методов, ИМХО, как-то некрасиво.

UPD: методом тыка вышел на такой вариант:

@Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/**.html").addResourceLocations("/WEB-INF/");
    }

Добавляешь это в SpringWebConfig, в результате чего все файлы, заканчивающиеся на .html будут искаться в /WEB-INF/. Из контроллера можешь убрать обработку .html-запросов

Comments

[Николай Ступак]

Я хотел, чтобы путь к методам начинался с версии по следующей причине: развернув приложение с контекстном путем /api, я получаю в результате запросы вида app.org/api/v1/someMethod, а развернув приложение в корне томката, но на поддомене, я получаю запросы вида api.app.org/v1/someMethod. Если сделать способом, который предложили вы, я не смогу разворачивать приложение с контекстным путем /api, потому что запросы будут иметь вид app.org/api/api/v1/someMethod. Вы сказали, что это самый простой способ. А есть сложнее?
Насчет @RestController и ModelAndView это вы правы, поправлю.

[Александр Косарев]

Николай Ступак: ну, этот вариант в голову пришёл в первую очередь. А развернуть приложение в ROOT можешь? Если можешь, то проблема с дублированием /api будет решена.

[Николай Ступак]

Развернуть в ROOT могу, но как я написал выше, хотелось бы, чтобы работали оба варианта: с разворачиванием в ROOT и с разворачиванием в /api

[Александр Косарев]

Николай Ступак: Обновил свой ответ.