วิธีหลีกเลี่ยงข้อยกเว้น“ เส้นทางมุมมองแบบวงกลม” ด้วยการทดสอบ Spring MVC

ฉันมีรหัสต่อไปนี้ในตัวควบคุมของฉัน:

@Controller
@RequestMapping("/preference")
public class PreferenceController {

    @RequestMapping(method = RequestMethod.GET, produces = "text/html")
    public String preference() {
        return "preference";
    }
}

ฉันแค่พยายามทดสอบโดยใช้การทดสอบ Spring MVCดังนี้:

@ContextConfiguration
@WebAppConfiguration
@RunWith(SpringJUnit4ClassRunner.class)
public class PreferenceControllerTest {

    @Autowired
    private WebApplicationContext ctx;

    private MockMvc mockMvc;
    @Before
    public void setup() {
        mockMvc = webAppContextSetup(ctx).build();
    }

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

ฉันได้รับข้อยกเว้นต่อไปนี้:

เส้นทางมุมมองแบบวงกลม [ค่ากำหนด]: จะส่งกลับไปยัง URL ตัวจัดการปัจจุบัน [/ ค่ากำหนด] อีกครั้ง ตรวจสอบการตั้งค่า ViewResolver ของคุณ! (คำแนะนำ: นี่อาจเป็นผลมาจากมุมมองที่ไม่ระบุเนื่องจากการสร้างชื่อมุมมองเริ่มต้น)

สิ่งที่ฉันพบว่าแปลกคือมันทำงานได้ดีเมื่อฉันโหลดการกำหนดค่าบริบท "เต็ม"ที่มีเทมเพลตและตัวแก้ไขมุมมองดังที่แสดงด้านล่าง:

<bean class="org.thymeleaf.templateresolver.ServletContextTemplateResolver" id="webTemplateResolver">
    <property name="prefix" value="WEB-INF/web-templates/" />
    <property name="suffix" value=".html" />
    <property name="templateMode" value="HTML5" />
    <property name="characterEncoding" value="UTF-8" />
    <property name="order" value="2" />
    <property name="cacheable" value="false" />
</bean>

ฉันทราบดีว่าคำนำหน้าที่เพิ่มโดยตัวแก้ไขเทมเพลตทำให้มั่นใจได้ว่าไม่มี "เส้นทางมุมมองแบบวงกลม" เมื่อแอปใช้ตัวแก้ไขเทมเพลตนี้

แต่ฉันควรจะทดสอบแอปของฉันโดยใช้การทดสอบ Spring MVC อย่างไร?

สิ่งนี้ไม่เกี่ยวข้องกับการทดสอบ Spring MVC

เมื่อคุณไม่ประกาศ a ViewResolverสปริงจะลงทะเบียนค่าเริ่มต้นInternalResourceViewResolverซึ่งสร้างอินสแตนซ์JstlViewสำหรับการแสดงผลView.

JstlViewระดับขยายInternalResourceViewซึ่งเป็น

Wrapper สำหรับ JSP หรือทรัพยากรอื่น ๆ ภายในเว็บแอปพลิเคชันเดียวกัน แสดงอ็อบเจ็กต์โมเดลเป็นแอ็ตทริบิวต์คำร้องขอและส่งต่อคำร้องขอไปยัง URL รีซอร์สที่ระบุโดยใช้ javax.servlet.RequestDispatcher

URL สำหรับมุมมองนี้ควรจะระบุทรัพยากรภายในเว็บแอปพลิเคชันซึ่งเหมาะสำหรับวิธีการส่งต่อหรือรวมของ RequestDispatcher

ตัวหนาเป็นของฉัน ใน otherwords มุมมองก่อนการแสดงผลจะพยายามที่จะได้รับในการที่จะ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/preferenceservlet เดียวกัน (เนื่องจากการจัดการแบบเดียวกันก่อนหน้านี้) จะจัดการคำขอและคุณจะเข้าสู่วงวนที่ไม่มีที่สิ้นสุด

เมื่อคุณประกาศ a ThymeleafViewResolverและ a 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 เป็นคำอธิบายประกอบที่ประกอบขึ้นเองซึ่งเป็นคำอธิบายประกอบแบบ meta ที่มี @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>

ถึง:

<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>

การเพิ่ม/หลังจาก/preferenceแก้ไขปัญหาให้ฉันแล้ว:

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

ในกรณีของฉันฉันกำลังทดลองใช้ Kotlin + Spring boot และฉันพบปัญหา Circular View Path คำแนะนำทั้งหมดที่ฉันได้รับทางออนไลน์ไม่สามารถช่วยได้จนกว่าฉันจะลองทำตามด้านล่าง:

แต่เดิมฉันใส่คำอธิบายประกอบคอนโทรลเลอร์โดยใช้ไฟล์ @Controller

import org.springframework.stereotype.Controller

จากนั้นฉันก็แทนที่@Controllerด้วย@RestController

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

และมันได้ผล

หากคุณไม่ได้ใช้ @RequestBody และใช้เพียง@Controllerวิธีเดียวที่ง่ายที่สุดในการแก้ไขปัญหานี้คือใช้@RestControllerแทน@Controller

เพิ่มคำอธิบายประกอบ@ResponseBodyในการส่งคืนวิธีของคุณ

ฉันใช้ Spring Boot กับ Thymeleaf นี่คือสิ่งที่ได้ผลสำหรับฉัน มีคำตอบที่คล้ายกันด้วย JSP แต่ทราบว่าฉันกำลังใช้ HTML ไม่ JSP และเหล่านี้อยู่ในโฟลเดอร์src/main/resources/templatesเหมือนในมาตรฐานโครงการ 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;
}

หวังว่านี่จะช่วยได้

เมื่อเรียกใช้ 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

สำหรับ Thymeleaf:

ฉันเพิ่งเริ่มใช้สปริง 4 และไทม์ลีฟเมื่อฉันพบข้อผิดพลาดนี้ได้รับการแก้ไขโดยเพิ่ม:

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

เมื่อใช้@Controllerคำอธิบายประกอบคุณต้องมี@RequestMappingและ@ResponseBodyคำอธิบายประกอบ ลองอีกครั้งหลังจากเพิ่มคำอธิบายประกอบ@ResponseBody

ฉันใช้คำอธิบายประกอบเพื่อกำหนดค่า Spring web app ปัญหาแก้ไขได้โดยการเพิ่มInternalResourceViewResolverbean ในการกำหนดค่า หวังว่าคงจะเป็นประโยชน์

@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: "/ ค่ากำหนด"

ลบ "ค่ากำหนด": "/"

ต่อท้ายเส้นทาง: "/" + "ค่ากำหนด"

สตริงสิ้นสุด: "/ ค่ากำหนด"

สิ่งนี้กำลังเข้าสู่วงรอบซึ่ง Spring จะแจ้งให้คุณทราบโดยการโยนข้อยกเว้น

คุณควรตั้งชื่อมุมมองที่แตกต่างออกไปเช่น "PreferencesView" หรืออะไรก็ได้ที่คุณต้องการ

ลองเพิ่มการพึ่งพาคอมไพล์ ("org.springframework.boot: spring-boot-starter-thymeleaf") ให้กับไฟล์ gradle ของคุณ Thymeleaf ช่วยในการทำแผนที่

ในกรณีของฉันฉันมีปัญหานี้ขณะพยายามให้บริการเพจ JSP โดยใช้แอปพลิเคชัน Spring boot

นี่คือสิ่งที่ใช้ได้ผลสำหรับฉัน:

application.properties

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

pom.xml

ในการเปิดใช้งานการสนับสนุน JSPs เราจำเป็นต้องเพิ่มการพึ่งพา tomcat-embed-jasper

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

อีกวิธีง่ายๆ:

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);
    }
}