spring - 如何在 WebApplicationInitializer.onStartup() 中指定欢迎文件列表

Question

目前我有一个 Web 应用程序，我们在其中使用 web.xml 来配置应用程序。 web.xml 有welcome-file-list。

<web-app>  
   ...
   <welcome-file-list>  
     <welcome-file>home.html</welcome-file>  
   </welcome-file-list>  
</web-app>  

我们计划使用spring框架，使用java类进行应用配置。

class MyApplication extends WebApplicationInitializer {
    public void onStartUp(ServletContext context){
        ...
    }
}

如何在这个 java 类中指定welcome-file-list？

Answer 1

在使用纯 Java Based Configuration 开发 Spring MVC 应用程序时，我们可以通过使我们的应用程序配置类扩展 WebMvcConfigurerAdapter 来设置主页。类并覆盖 addViewControllers我们可以设置默认主页的方法，如下所述。

@Configuration
@EnableWebMvc
@ComponentScan(basePackages = { "com.myapp.controllers" })
public class ApplicationConfig extends WebMvcConfigurerAdapter {

  @Bean
  public InternalResourceViewResolver getViewResolver() {
    InternalResourceViewResolver viewResolver = new InternalResourceViewResolver();
    viewResolver.setPrefix("/WEB-INF/view/");
    viewResolver.setSuffix(".jsp");
    return viewResolver;
  }

  @Override
  public void addViewControllers(ViewControllerRegistry registry) {
    registry.addViewController("/").setViewName("home");
  }

}

返回home.jsp View ，可以作为主页。无需创建自定义 Controller 逻辑即可返回主页 View 。

addViewControllers 的 JavaDoc方法说-

Configure simple automated controllers pre-configured with the response status code and/or a view to render the response body. This is useful in cases where there is no need for custom controller logic -- e.g. render a home page, perform simple site URL redirects, return a 404 status with HTML content, a 204 with no content, and more.

第二种方式 - 对于静态 HTML 文件主页，我们可以在配置类中使用以下代码。它将返回 index.html 作为主页 -

    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
        registry.addViewController("/").setViewName("forward:/index.html");
    }

第三种方式 - 下面的请求映射“/”还将返回 home View ，该 View 可用作应用的主页。但推荐以上方式。

@Controller
public class UserController {
    @RequestMapping(value = { "/" })
    public String homePage() {
        return "home";
    }
}