Spring MVCテストで「循環ビューパス」例外を回避する方法

コントローラの1つに次のコードがあります。

@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テストとは関係ありません。

を宣言しない場合ViewResolver、Spring InternalResourceViewResolverはJstlViewをレンダリングするためののインスタンスを作成するデフォルトを登録しますView。

JstlViewクラスが拡張InternalResourceViewされています

同じWebアプリケーション内のJSPまたはその他のリソースのラッパー。モデルオブジェクトを要求属性として公開し、javax.servlet.RequestDispatcherを使用して、指定されたリソースURLに要求を転送します。

このビューのURLは、RequestDispatcherのforwardまたはincludeメソッドに適した、Webアプリケーション内のリソースを指定することになっています。

太字は私のものです。つまり、ビューはレンダリングの前に、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と、同じサーブレットが（前のものを処理したため）要求を処理し、無限ループに入ることがわかります。

特定のand でa ThymeleafViewResolverとa ServletContextTemplateResolverを宣言すると、ビルド方法が異なり、次のようなパスが与えられますprefixsuffixView

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を使用して、テストではなくWebページをロードしようとしていますが、この問題がありました。私の解決策は、わずかに異なる状況を考慮して、上記のものとは少し異なっていました。（これらの答えは私が理解するのに役立ちましたが）。

MavenのSpring Bootスターター依存関係を次のように変更するだけです。

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

「web」を「thymeleaf」に変更するだけで問題が解決しました。

実際にビューをレンダリングする必要がない場合の簡単な修正を次に示します。

循環ビューパスをチェックしない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を使用している場合は、thymeleaf依存関係を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ブートを試してみましたが、Circular View Pathの問題が発生しました。以下を試すまで、オンラインで得たすべての提案は役に立ちませんでした：

もともと私は自分のコントローラに注釈を付けていました @Controller

import org.springframework.stereotype.Controller

次に交換@Controllerしました@RestController

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

そしてそれはうまくいった。

@RequestBodyを使用せず@Controller、のみを使用している場合、これを修正する最も簡単な方法は@RestController、@Controller

@ResponseBodyメソッドの戻りにアノテーションを追加します。

ThymeleafでSpring Bootを使用しています。これは私のために働いたものです。JSPにも同様の答えがありますが、私はJSPではなくHTMLを使用していることに注意してください。これらは、ここで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;
}

お役に立てれば。

Spring Boot + Freemarkerを実行しているときにページが表示される場合：

ホワイトラベルエラーページこのアプリケーションには/エラーの明示的なマッピングがないため、これはフォールバックと見なされます。

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とthymeleafを使い始めたばかりですが、このエラーが発生したとき、次のように追加することで解決しました。

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

@Controllerアノテーションを使用する場合は@RequestMapping、@ResponseBodyアノテーションが必要です。アノテーションを追加してから、もう一度お試しください@ResponseBody

このアノテーションを使用してSpring Webアプリを構成InternalResourceViewResolverします。この問題は、構成にBeanを追加することで解決されます。お役に立てれば幸いです。

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

"preference"を削除： "/"

パスを追加： "/" + "preference"

終了文字列： "/ preference"

これは、Springが例外をスローして通知するループに入ります。

「preferenceView」などの別のビュー名を付けることをお勧めします。

Gradleファイルにcompile（ "org.springframework.boot：spring-boot-starter-thymeleaf"）依存関係を追加してみてください。Thymeleafはビューのマッピングに役立ちます。

私の場合、Springブートアプリケーションを使用してJSPページを提供しようとしたときにこの問題が発生しました。

これが私のために働いたものです：

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>

別の簡単なアプローチ：

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