Как избежать исключения пути кругового представления с помощью теста Spring MVC

Это не имеет ничего общего с тестированием Spring MVC.

Если вы не объявляете ViewResolver, Spring регистрирует значение по умолчанию InternalResourceViewResolver, которое создает экземпляры JstlView для рендеринга View.

Класс JstlView расширяет InternalResourceView, который

Оболочка для JSP или другого ресурса в том же веб-приложении. Предоставляет объекты модели как атрибуты запроса и перенаправляет запрос на указанный URL-адрес ресурса с помощью javax.servlet.RequestDispatcher.

Предполагается, что URL-адрес для этого представления указывает ресурс в веб-приложении, подходящий для метода пересылки или включения RequestDispatcher.

Акцент мой. Другими словами, представление перед рендерингом будет пытаться получить RequestDispatcher, к которому нужно forward(). Перед этим он проверяет следующие

if (path.startsWith("/") ? uri.equals(path) : uri.equals(StringUtils.applyRelativePath(uri, path))) {
    throw new ServletException("Circular view path [" + path + "]: would dispatch back " +
                        "to the current handler URL [" + uri + "] again. Check your ViewResolver setup! " +
                        "(Hint: This may be the result of an unspecified view, due to default view name generation.)");
}

где path - это имя представления, которое вы вернули из @Controller. В этом примере это preference. Переменная uri содержит uri обрабатываемого запроса, который равен /context/preference.

В приведенном выше коде понимается, что если бы вы перешли к /context/preference, тот же сервлет (поскольку тот же обрабатывал предыдущий) обработал бы запрос, и вы вошли бы в бесконечный цикл.

Когда вы объявляете ThymeleafViewResolver и ServletContextTemplateResolver с конкретными prefix и suffix, он строит View по-разному, давая ему путь вроде

WEB-INF/web-templates/preference.html

Экземпляры ThymeleafView находят файл относительно пути ServletContext, используя ServletContextResourceResolver

templateInputStream = resourceResolver.getResourceAsStream(templateProcessingParameters, resourceName);`

что в конечном итоге

return servletContext.getResourceAsStream(resourceName);

Это получает ресурс, относящийся к пути ServletContext. Затем он может использовать TemplateEngine для генерации HTML. Здесь не может быть бесконечного цикла.

Я решил эту проблему, используя @ResponseBody, как показано ниже:

@RequestMapping(value = "/resturl", method = RequestMethod.GET, produces = {"application/json"})
    @ResponseStatus(HttpStatus.OK)
    @Transactional(value = "jpaTransactionManager")
    public @ResponseBody List<DomainObject> findByResourceID(@PathParam("resourceID") String resourceID) {

@Controller → @RestController

У меня была такая же проблема, и я заметил, что мой контроллер также был помечен @Controller. Замена на @RestController решила проблему. Вот объяснение из Spring Web MVC:

@RestController - это составная аннотация, которая сама по себе метааннотирована с помощью @Controller и @ResponseBody, указывающих на контроллер, каждый метод которого наследует аннотацию @ResponseBody на уровне типа и, следовательно, записывается непосредственно в тело ответа, а не в разрешение представления и рендеринг с помощью шаблона HTML.

Вот как я решил эту проблему:

@Before
    public void setup() {
        InternalResourceViewResolver viewResolver = new InternalResourceViewResolver();
        viewResolver.setPrefix("/WEB-INF/jsp/view/");
        viewResolver.setSuffix(".jsp");

        mockMvc = MockMvcBuilders.standaloneSetup(new HelpController())
                                 .setViewResolvers(viewResolver)
                                 .build();
    }

Я использую Spring Boot, чтобы попытаться загрузить веб-страницу, а не тестировать, и у меня возникла эта проблема. Мое решение немного отличалось от приведенного выше, учитывая несколько иные обстоятельства. (хотя эти ответы помогли мне понять.)

Мне просто пришлось изменить мою стартовую зависимость Spring Boot в Maven с:

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
</dependency>

to:

<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>

Простая замена «паутины» на «тимелист» устранила для меня проблему.

Вот простое исправление, если вы на самом деле не заботитесь о рендеринге представления.

Создайте подкласс InternalResourceViewResolver, который не проверяет круговые пути просмотра:

public class StandaloneMvcTestViewResolver extends InternalResourceViewResolver {

    public StandaloneMvcTestViewResolver() {
        super();
    }

    @Override
    protected AbstractUrlBasedView buildView(final String viewName) throws Exception {
        final InternalResourceView view = (InternalResourceView) super.buildView(viewName);
        // prevent checking for circular view paths
        view.setPreventDispatchLoop(false);
        return view;
    }
}

Затем настройте свой тест с его помощью:

MockMvc mockMvc;

@Before
public void setUp() {
    final MyController controller = new MyController();

    mockMvc =
            MockMvcBuilders.standaloneSetup(controller)
                    .setViewResolvers(new StandaloneMvcTestViewResolver())
                    .build();
}

Если вы используете Spring Boot, добавьте зависимость тимелеафа в свой pom.xml:

    <dependency>
        <groupId>org.thymeleaf</groupId>
        <artifactId>thymeleaf-spring4</artifactId>
        <version>2.1.6.RELEASE</version>
    </dependency>

если вы не использовали @RequestBody и используете только @Controller, самый простой способ исправить это - использовать @RestController вместо @Controller

Добавление / после /preference решило проблему для меня:

@Test
public void circularViewPathIssue() throws Exception {
    mockMvc.perform(get("/preference/"))
           .andDo(print());
}

В моем случае я пробовал загрузку Kotlin + Spring и столкнулся с проблемой Circular View Path. Все предложения, которые я получил в Интернете, не помогли, пока я не попробовал следующее:

Изначально я аннотировал свой контроллер с помощью @Controller

import org.springframework.stereotype.Controller

Затем я заменил @Controller на @RestController

import org.springframework.web.bind.annotation.RestController

И это сработало.

Я использую Spring Boot с Thymeleaf. Это то, что у меня сработало. Есть аналогичные ответы с JSP, но обратите внимание, что я использую HTML, а не JSP, и они находятся в папке src/main/resources/templates, как в стандартном проекте Spring Boot, как описано в здесь. Это тоже могло быть вашим случаем.

@InjectMocks
private MyController myController;

@Before
public void setup()
{
    MockitoAnnotations.initMocks(this);

    this.mockMvc = MockMvcBuilders.standaloneSetup(myController)
                    .setViewResolvers(viewResolver())
                    .build();
}

private ViewResolver viewResolver()
{
    InternalResourceViewResolver viewResolver = new InternalResourceViewResolver();

    viewResolver.setPrefix("classpath:templates/");
    viewResolver.setSuffix(".html");

    return viewResolver;
}

Надеюсь это поможет.

Добавьте аннотацию @ResponseBody к возврату вашего метода.

При запуске Spring Boot + Freemarker, если страница появляется:

Страница ошибки Whitelabel В этом приложении нет явного сопоставления для / error, поэтому вы рассматриваете это как запасной вариант.

В версии spring-boot-starter-parent 2.2.1.RELEASE freemarker не работает:

1. переименовать файлы Freemarker из .ftl в .ftlh
2. Добавьте в application.properties: spring.freemarker.expose-request-attributes = true

spring.freemarker.suffix = .ftl

Для тимелеафа:

Я только начал использовать пружину 4 и тимелеаф, когда я столкнулся с этой ошибкой, она была устранена добавлением:

<bean class="org.thymeleaf.spring4.view.ThymeleafViewResolver">
  <property name="templateEngine" ref="templateEngine" />
  <property name="order" value="0" />
</bean> 

При использовании аннотации @Controller вам потребуются аннотации @RequestMapping и @ResponseBody. Повторите попытку после добавления аннотации @ResponseBody

Я использую аннотацию для настройки веб-приложения Spring, проблема решена путем добавления bean-компонента InternalResourceViewResolver в конфигурацию. Надеюсь, это будет полезно.

@Configuration
@EnableWebMvc
@ComponentScan(basePackages = { "com.example.springmvc" })
public class WebMvcConfig extends WebMvcConfigurerAdapter {

    @Bean
    public InternalResourceViewResolver internalResourceViewResolver() {
        InternalResourceViewResolver resolver = new InternalResourceViewResolver();
        resolver.setPrefix("/jsp/");
        resolver.setSuffix(".jsp");
        return resolver;
    }
}

Это происходит потому, что Spring удаляет «предпочтение» и снова добавляет «предпочтение», используя тот же путь, что и Uri запроса.

Происходит так: запрос Uri: "/ preference"

удалить "предпочтение": "/"

добавить путь: "/" + "предпочтение"

конечная строка: "/ предпочтение"

Это входит в цикл, о котором Spring уведомляет вас, выбрасывая исключение.

Лучше всего в ваших интересах дать другое имя представления, например "preferenceView" или что угодно.

попробуйте добавить зависимость compile ("org.springframework.boot: spring-boot-starter-thymeleaf") к вашему файлу gradle. Tymeleaf помогает отображать представления.

В моем случае у меня возникла эта проблема при попытке обслуживать страницы JSP с помощью загрузочного приложения Spring.

Вот что у меня сработало:

application.properties

spring.mvc.view.prefix=/WEB-INF/views/
spring.mvc.view.suffix=.jsp

pom.xml

Чтобы включить поддержку JSP, нам нужно добавить зависимость от tomcat-embed-jasper.

<dependency>
    <groupId>org.apache.tomcat.embed</groupId>
    <artifactId>tomcat-embed-jasper</artifactId>
    <scope>provided</scope>
</dependency>

В моем случае круговой путь просмотра в Spring boot 2 и jdk 11 был исправлен путем перенаправления на index.html:

    @Bean
    public WebMvcConfigurer corsConfigurer() {
        return new WebMvcConfigurer() {
            }
            @Override
            public void addViewControllers(ViewControllerRegistry registry) {
                registry.addViewController("/").setViewName("redirect:/index.html");
            }
        };

Еще один простой подход:

package org.yourpackagename;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.builder.SpringApplicationBuilder;
import org.springframework.boot.context.web.SpringBootServletInitializer;

@SpringBootApplication
public class Application extends SpringBootServletInitializer {

      @Override
        protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {
            return application.sources(PreferenceController.class);
        }


    public static void main(String[] args) {
        SpringApplication.run(PreferenceController.class, args);
    }
}