Spring MVC how to create a default controller for index page

Question

I m trying to do one of those standard spring mvc hello world applications but with the twist that I d like to map the controller to the root   for example  http   numberformat wordpress com 2009 09 02 hello-world-spring-mvc-with-annotations    So the only real difference is that they map it to host appname something and I d like to map it to host appname   I placed my index jsp in src main webapp jsp and mapped it in the web xml as the welcome file  I tried    Controller  loginController   public class LoginController      RequestMapping        public String homepage2 ModelMap model  HttpServletRequest request  HttpServletResponse response       System out println  blablabla2        model addAttribute  sigh    lesigh        return  index         As my controller but I see nothing appear in the console of my tomcat  Does anyone know where I m messing up   My web xml    lt  xml version  1 0  encoding  UTF-8   gt   lt web-app xmlns  http   java sun com xml ns javaee  xmlns xsi  http   www w3 org 2001 XMLSchema-instance      xsi schemaLocation  http   java sun com xml ns javaee http   java sun com xml ns javaee web-app 2 5 xsd      version  2 5  gt        lt  -- Index -- gt       lt welcome-file-list gt           lt welcome-file gt  jsp index jsp lt  welcome-file gt       lt  welcome-file-list gt        lt context-param gt           lt param-name gt contextConfigLocation lt  param-name gt           lt param-value gt  WEB-INF mvc-dispatcher-servlet xml lt  param-value gt       lt  context-param gt        lt servlet gt           lt servlet-name gt springweb lt  servlet-name gt           lt servlet-class gt org springframework web servlet DispatcherServlet lt  servlet-class gt           lt load-on-startup gt 1 lt  load-on-startup gt       lt  servlet gt        lt servlet-mapping gt           lt servlet-name gt springweb lt  servlet-name gt           lt url-pattern gt   lt  url-pattern gt       lt  servlet-mapping gt    lt  web-app gt    The mvc-dispatcher-servlet xml    lt  xml version  1 0  encoding  UTF-8   gt   lt beans xmlns  http   www springframework org schema beans      xmlns xsi  http   www w3 org 2001 XMLSchema-instance      xmlns p  http   www springframework org schema p      xmlns aop  http   www springframework org schema aop      xmlns context  http   www springframework org schema context      xmlns mvc  http   www springframework org schema mvc      xsi schemaLocation  http   www springframework org schema aop http   www springframework org schema aop spring-aop-3 0 xsd         http   www springframework org schema mvc http   www springframework org schema mvc spring-mvc-3 0 xsd         http   www springframework org schema beans http   www springframework org schema beans spring-beans-3 0 xsd         http   www springframework org schema context http   www springframework org schema context spring-context-3 0 xsd  gt        lt context annotation-config   gt       lt context component-scan base-package  de claude test      gt        lt bean id  viewResolver          class  org springframework web servlet view UrlBasedViewResolver  gt           lt property name  viewClass              value  org springframework web servlet view JstlView    gt           lt property name  prefix  value   jsp     gt           lt property name  suffix  value   jsp    gt       lt  bean gt    lt  beans gt    I m using Spring 3 0 5 release  Or is this not possible and do I need to put my index jsp back in the root of the web-inf and put a redirect to somewhere inside my jsp so the controller picks it up

User · Answer

The solution I use in my SpringMVC webapps is to create a simple DefaultController class like the following: -

@Controller
public class DefaultController {

    private final String redirect;

    public DefaultController(String redirect) {
        this.redirect = redirect;
    }

    @RequestMapping(value = "/")
    public ModelAndView redirectToMainPage() {
        return new ModelAndView("redirect:/" + redirect);
    }

}

The redirect can be injected in using the following spring configuration: -

<bean class="com.adoreboard.farfisa.controller.DefaultController">
    <constructor-arg name="redirect" value="${default.redirect:loginController}"/>
</bean>

The ${default.redirect:loginController} will default to loginController but can be changed by inserting default.redirect=something_else into a spring properties file / setting an environment variable etc.

As @Mike has mentioned above I have also: -

Got rid of <welcome-file-list> ... </welcome-file-list> section in the web.xml file.
Don't have any files sitting in WebContent that would be considered default pages (index.html, index.jsp, default.html, etc)

This solution lets Spring worry more about redirects which may or may not be what you like.

User · Answer

I had the same problem  even after following Sinhue s setup  but I solved it   The problem was that that something  Tomcat   was forwarding from     to   index jsp  when I had the file index jsp in my WebContent directory   When I removed that  the request did not get forwarded anymore   What I did to diagnose the problem was to make a catch-all request handler and printed the servlet path to the console   This showed me that even though the request I was making was for http   localhost myapp   the servlet path was being changed to   index html    I was expecting it to be        RequestMapping      public String hello HttpServletRequest request        System out println request getServletPath         return  hello       So in summary  the steps you need to follow are    In your servlet-mapping use  lt url-pattern gt   lt  url-pattern gt  In your controller use RequestMapping      Get rid of welcome-file-list in web xml Don t have any files sitting in WebContent that would be considered default pages  index html  index jsp  default html  etc    Hope this helps

User · Answer

It can be solved in more simple way  in web xml   lt servlet-mapping gt       lt servlet-name gt dispatcher lt  servlet-name gt       lt url-pattern gt   htm lt  url-pattern gt   lt  servlet-mapping gt   lt welcome-file-list gt       lt welcome-file gt index htm lt  welcome-file gt   lt  welcome-file-list gt    After that use any controllers that your want to process index htm with  RequestMapping  index htm    Or just use index controller   lt bean id  urlMapping  class  org springframework web servlet handler SimpleUrlHandlerMapping  gt       lt property name  mappings  gt           lt props gt               lt prop key  index htm  gt indexController lt  prop gt           lt  props gt       lt  property gt   lt bean name  indexController  class  org springframework web servlet mvc ParameterizableViewController        p viewName  index    gt   lt  bean gt

User · Answer

One way to achieve it  is by map your welcome-file to your controller request path in the web xml file    web xml    lt web-app       lt  -- Index -- gt   lt welcome-file-list gt       lt welcome-file gt home lt  welcome-file gt   lt  welcome-file-list gt    lt  web-app gt     LoginController java    Controller  loginController   public class LoginController    RequestMapping   home   public String homepage2 ModelMap model  HttpServletRequest request  HttpServletResponse response       System out println  blablabla2        model addAttribute  sigh    lesigh        return  index

User · Answer

We can simply map a Controller method for the default view  For eg  we have a index html as the default page    RequestMapping value        method   GET  public String index         return  index       once done we can access the page with default application context    E g http   localhost 8080 myapp

User · Answer

It works for me  but some differences    I have no welcome-file-list in web xml I have no  RequestMapping at class level  And at method level  just  RequestMapping        I know these are no great differences  but I m pretty sure  I m not at work now  this is my configuration and it works with Spring MVC 3 0 5   One more thing  You don t show your dispatcher configuration in web xml  but maybe you have some preffix  It has to be something like this    lt servlet-mapping gt       lt servlet-name gt myServletName lt  servlet-name gt       lt url-pattern gt   lt  url-pattern gt   lt  servlet-mapping gt    If this is not your case  you ll need an url-rewrite filter or try the redirect solution   EDIT  Answering your question  my view resolver configuration is a little different too    lt bean class  org springframework web servlet view InternalResourceViewResolver  gt       lt property name  prefix  value   WEB-INF view     gt       lt property name  suffix  value   jsp    gt   lt  bean gt

User · Answer

Just put one more entry in your spring xml file i e mvc-dispatcher-servlet xml   lt mvc view-controller path     view-name  index   gt    After putting this to your xml put your default view or jsp file in your custom JSP folder as you have mentioned in mvc-dispatcher-servlet xml file   change index with your jsp name

User · Answer

The redirect is one option  One thing you can try is to create a very simple index page that you place at the root of the WAR which does nothing else but redirecting to your controller like   lt    taglib uri  http   java sun com jsp jstl core  prefix  c    gt   lt c redirect url   welcome html   gt    Then you map your controller with that URL with something like    Controller  loginController    RequestMapping value     welcome html   public class LoginController          Finally  in web xml  to have your  new  index JSP accessible  declare   lt welcome-file-list gt       lt welcome-file gt index jsp lt  welcome-file gt   lt  welcome-file-list gt

[spring] Spring MVC: how to create a default controller for index page?

Examples related to spring

Examples related to spring-mvc