Cara menghindari pengecualian "Jalur tampilan melingkar" dengan pengujian Spring MVC

Saya memiliki kode berikut di salah satu pengontrol saya:

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

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

Saya hanya mencoba mengujinya menggunakan tes Spring MVC sebagai berikut:

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

Saya mendapatkan pengecualian berikut:

Jalur tampilan melingkar [preferensi]: akan mengirimkan kembali ke URL penangan saat ini [/ preferensi] lagi. Periksa penyiapan ViewResolver Anda! (Petunjuk: Ini mungkin hasil dari tampilan yang tidak ditentukan, karena pembuatan nama tampilan default.)

Yang saya anggap aneh adalah bahwa ini berfungsi dengan baik ketika saya memuat konfigurasi konteks "lengkap" yang menyertakan template dan resolver tampilan seperti yang ditunjukkan di bawah ini:

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

Saya sangat menyadari bahwa awalan yang ditambahkan oleh pemecah templat memastikan bahwa tidak ada "jalur tampilan melingkar" saat aplikasi menggunakan pemecah templat ini.

Tapi kemudian bagaimana saya bisa menguji aplikasi saya menggunakan tes Spring MVC?

Ini tidak ada hubungannya dengan pengujian Spring MVC.

Saat Anda tidak mendeklarasikan a ViewResolver, Spring mendaftarkan default InternalResourceViewResolveryang membuat instance JstlViewuntuk merender View.

The JstlViewkelas meluas InternalResourceViewyang

Pembungkus untuk JSP atau sumber daya lain dalam aplikasi web yang sama. Mengekspos objek model sebagai atribut permintaan dan meneruskan permintaan ke URL sumber daya yang ditentukan menggunakan javax.servlet.RequestDispatcher.

URL untuk tampilan ini seharusnya menentukan sumber daya dalam aplikasi web, cocok untuk metode penyertaan atau penyertaan RequestDispatcher.

Bold adalah milikku. Dalam otherwords, pandangan, sebelum rendering, akan mencoba untuk mendapatkan RequestDispatcheryang ke forward(). Sebelum melakukan ini, periksa hal-hal berikut

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

di mana pathnama tampilan, apa yang Anda kembalikan dari @Controller. Dalam contoh ini, itu preference. Variabel urimenyimpan uri dari permintaan yang sedang ditangani, yaitu /context/preference.

Kode di atas menyadari bahwa jika Anda meneruskan ke /context/preference, servlet yang sama (karena yang sama menangani sebelumnya) akan menangani permintaan dan Anda akan masuk ke loop tanpa akhir.

Ketika Anda mendeklarasikan a ThymeleafViewResolverdan a ServletContextTemplateResolverdengan spesifik prefixdan suffix, itu membangun secara Viewberbeda, memberinya jalur seperti

WEB-INF/web-templates/preference.html

ThymeleafViewContoh menemukan file relatif ke ServletContextjalur dengan menggunakan file ServletContextResourceResolver

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

yang akhirnya

return servletContext.getResourceAsStream(resourceName);

Ini mendapatkan sumber daya yang relatif terhadap ServletContextjalur. Kemudian dapat menggunakan TemplateEngineuntuk menghasilkan HTML. Tidak mungkin loop tanpa akhir bisa terjadi di sini.

Saya memecahkan masalah ini dengan menggunakan @ResponseBody seperti di bawah ini:

@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

Saya memiliki masalah yang sama dan saya perhatikan bahwa pengontrol saya juga diberi anotasi @Controller. Menggantinya dengan @RestControllermemecahkan masalah. Berikut penjelasan dari Spring Web MVC :

@RestController adalah anotasi tersusun yang dianotasi secara meta dengan @Controller dan @ResponseBody yang menunjukkan pengontrol yang setiap metodenya mewarisi anotasi @ResponseBody level-tipe dan oleh karena itu menulis langsung ke isi respons vs resolusi tampilan dan rendering dengan template HTML.

Beginilah cara saya memecahkan masalah ini:

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

Saya menggunakan Spring Boot untuk mencoba dan memuat halaman web, bukan menguji, dan mengalami masalah ini. Solusi saya sedikit berbeda dari yang di atas mengingat keadaan yang sedikit berbeda. (meskipun jawaban itu membuat saya mengerti.)

Saya hanya perlu mengubah ketergantungan starter Spring Boot saya di Maven dari:

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

untuk:

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

Hanya mengubah 'web' menjadi 'thymeleaf' telah memperbaiki masalah saya.

Berikut ini perbaikan mudah jika Anda tidak benar-benar peduli tentang rendering tampilan.

Buat subclass InternalResourceViewResolver yang tidak memeriksa jalur tampilan melingkar:

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

Kemudian siapkan pengujian Anda dengannya:

MockMvc mockMvc;

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

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

Jika Anda menggunakan Spring Boot, tambahkan dependensi thymeleaf ke pom.xml Anda:

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

Menambahkan /setelah /preferencememecahkan masalah untuk saya:

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

Dalam kasus saya, saya mencoba boot Kotlin + Spring dan saya mengalami masalah Circular View Path. Semua saran yang saya dapatkan secara online tidak dapat membantu, sampai saya mencoba yang di bawah ini:

Awalnya saya telah menjelaskan pengontrol saya menggunakan @Controller

import org.springframework.stereotype.Controller

Saya kemudian diganti @Controllerdengan@RestController

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

Dan itu berhasil.

jika Anda belum pernah menggunakan @RequestBody dan hanya menggunakan @Controller, cara paling sederhana untuk memperbaiki ini menggunakan @RestControllerbukannya@Controller

Tambahkan anotasi @ResponseBodyke pengembalian metode Anda.

Saya menggunakan Spring Boot dengan Thymeleaf. Inilah yang berhasil bagi saya. Ada jawaban yang mirip dengan JSP tetapi perhatikan bahwa saya menggunakan HTML, bukan JSP, dan ini ada di folder src/main/resources/templatesseperti dalam proyek Spring Boot standar seperti yang dijelaskan di sini . Ini juga bisa menjadi kasus Anda.

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

Semoga ini membantu.

Saat menjalankan Spring Boot + Freemarker jika halaman muncul:

Halaman Kesalahan Label Putih Aplikasi ini tidak memiliki pemetaan eksplisit untuk / error, jadi Anda melihatnya sebagai fallback.

Di spring-boot-starter-parent 2.2.1.RELEASE version freemarker tidak berfungsi:

1. ganti nama file Freemarker dari .ftl menjadi .ftlh
2. Tambahkan ke application.properties: spring.freemarker.expose-request-atribut = true

spring.freemarker.suffix = .ftl

Untuk Thymeleaf:

Saya baru saja mulai menggunakan spring 4 dan thymeleaf, ketika saya menemukan kesalahan ini, itu diatasi dengan menambahkan:

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

Saat menggunakan @Controlleranotasi, Anda membutuhkan @RequestMappingdan @ResponseBodyanotasi. Coba lagi setelah menambahkan anotasi@ResponseBody

Saya menggunakan anotasi untuk mengonfigurasi aplikasi web musim semi, masalah diselesaikan dengan menambahkan InternalResourceViewResolverkacang ke konfigurasi. Semoga bermanfaat.

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

Ini terjadi karena Spring menghapus "preferensi" dan menambahkan "preferensi" lagi dengan membuat jalur yang sama seperti Uri permintaan.

Terjadi seperti ini: request Uri: "/ preference"

hapus "preferensi": "/"

tambahkan jalur: "/" + "preferensi"

string akhir: "/ preferensi"

Ini memasuki loop yang Spring memberi tahu Anda dengan melemparkan pengecualian.

Sebaiknya berikan nama tampilan yang berbeda seperti "preferenceView" atau apa pun yang Anda suka.

coba tambahkan ketergantungan compile ("org.springframework.boot: spring-boot-starter-thymeleaf") ke file gradle Anda. Thymeleaf membantu memetakan tampilan.

Dalam kasus saya, saya mengalami masalah ini saat mencoba menyajikan halaman JSP menggunakan aplikasi Spring boot.

Inilah yang berhasil untuk saya:

application.properties

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

pom.xml

Untuk mengaktifkan dukungan untuk JSP, kita perlu menambahkan ketergantungan pada tomcat-embed-jasper.

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

Pendekatan sederhana lainnya:

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