springMVC学习篇 - 搭建环境及关键点

springMVC是spring家族中一个重要的组件，和struts一样作为一套前台框架被广泛的应用于各种项目。

之前在很多项目组都用到springMVC，只感觉很强大，但是对这套框架的知识了解比较少。这几天项目组没那么忙正学习下，过程中遇到很多问题也查找不少资料，整理出来与大家共享。

本文介绍简单springmvc框架环境搭建和我在学习中遇到问题查找资料时间比较长的一些点，这里这称之为关键点。

一、搭建环境

1、下载需要的jar包

①需要的最少spring mvc jar包

②maven pom.xml配置

 <dependencies>
       <dependency>
           <groupId>org.springframework</groupId>
           <artifactId>spring-webmvc</artifactId>
           <version>3.0.1.RELEASE</version>
       </dependency>
       <dependency>
           <groupId>jstl</groupId>
           <artifactId>jstl</artifactId>
           <version>1.2</version>
       </dependency>
 </dependencies>

2、web.xml

 <?xml version="1.0" encoding="UTF-8"?>
 <web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xmlns="http://java.sun.com/xml/ns/javaee"
     xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
         id="WebApp_ID" version="2.5">
     <display-name>deposit</display-name>

     <servlet-mapping>
         <servlet-name>default</servlet-name>
         <url-pattern>/scripts/*</url-pattern>
         <url-pattern>/styles/*</url-pattern>
     </servlet-mapping>

     <!--初始化spring的配置文件-->
     <context-param>
         <param-name>contextConfigLocation</param-name>
         <param-value>classpath:spring/applicationContext.xml</param-value>
     </context-param>
     <!--启动spring容器-->
     <listener>
         <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
     </listener>

     <!-- 初始化DispatcherServlet -->
     <servlet>
         <servlet-name>springmvc</servlet-name>
         <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
         <!--springmvc框架在 web应用程序WEB-INF目录中寻找一个名为[servlet-name]-servlet.xml的文件,可通过<init-param>修改默认文件路径配置
             <init-param>
                 <param-name>contextConfigLocation</param-name>
                 <param-value>classpath:spring/springmvc/springmvc-servlet.xml</param-value>
             </init-param>-->
         <load-on-startup>1</load-on-startup>
     </servlet>
     <servlet-mapping>
         <servlet-name>springmvc</servlet-name>
         <url-pattern>/*</url-pattern>
     </servlet-mapping>
 </web-app>

3、springmvc-servlet.xml

 <?xml version="1.0" encoding="UTF-8"?>
 <beans xmlns="http://www.springframework.org/schema/beans"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xmlns:context="http://www.springframework.org/schema/context"
     xmlns:mvc="http://www.springframework.org/schema/mvc"
     xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
     http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd
     http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc.xsd">

     <!-- 启用spring mvc 注解 -->
     <context:annotation-config />
     <!-- 设置使用注解的类所在的jar包，注入view层控制类 -->
     <context:component-scan base-package="cn.tancp.framework.springmvc.controller" />

     <!-- 对转向页面的路径解析。prefix：前缀， suffix：后缀 -->
     <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
         <property name="prefix" value="/WEB-INF/"/>
         <property name="suffix" value=".jsp"></property>
     </bean>

     <!--注册springmvc拦截类-->
     <mvc:interceptors>
         <bean class="cn.tancp.framework.springmvc.interceptor.CommonInterceptor" />
     </mvc:interceptors>
 </beans>

4、applicationContext.xml

 <?xml version="1.0" encoding="UTF-8"?>
 <beans
     xmlns="http://www.springframework.org/schema/beans"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xmlns:context="http://www.springframework.org/schema/context"
     xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
     http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd">   

     <!-- 设置使用注解的类所在的jar包，注入service层类 -->
     <context:component-scan base-package="cn.tancp.framework.springmvc.service" />
 </beans>

5、controller类

 package cn.tancp.framework.springmvc.controller;

 import org.springframework.stereotype.Controller;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RequestMethod;

 @Controller
 public class SystemController {

     @RequestMapping(value = "/",method = RequestMethod.GET)
     public String home() {
         return "index";
     }

     @RequestMapping(value = "/login", method = RequestMethod.GET)
     public String login() {
         return "login";
     }
 }

6、springmvc拦截器

 package cn.tancp.framework.springmvc.interceptor;

 import javax.servlet.http.HttpServletRequest;
 import javax.servlet.http.HttpServletResponse;
 import org.springframework.web.servlet.ModelAndView;
 import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;

 public class CommonInterceptor extends HandlerInterceptorAdapter {

     @Override
     public boolean preHandle(HttpServletRequest arg0, HttpServletResponse arg1,
             Object arg2) throws Exception {
         System.out.println("Pre-Handle");
         return true;
     }

     @Override
     public void afterCompletion(HttpServletRequest arg0,
             HttpServletResponse arg1, Object arg2, Exception arg3)
             throws Exception {
         System.out.println("After-Completion");
     }

     @Override
     public void postHandle(HttpServletRequest arg0, HttpServletResponse arg1,
             Object arg2, ModelAndView arg3) throws Exception {
         System.out.println("Post-Handle");
     }
 }

二、关键点

1、使用xml标签需要引用相应模式文档，否则报错

2、DispatcherServlet路径配置

在研究springmvc拦截器时，想配置映射为“/”访问项目根路径方法，但始终会访问到index.jsp页面上去，后来发现这个路径配置成了*.shtml

原因：之前以为配置*.shtml只会让后缀名为shtml的链接访问，而实际只会将*.shtml springMVC容器内。

3、xml中classpath:

classpath 代表  /WEB-INF /classes/  这个路径
            常用的场景：
            在SSH架构中，配置spring的上下文环境：
                <context-param>
                    <param-name>contextConfigLocation</param-name>
                    <param-value>classpath:applicationContext.xml</param-value>
                </context-param>
            里面的 classpath:applicationContext.xml 也可以使用  /WEB-INF /classes/ applicationContext.xml  代替

            注意：
            classpath 和 classpath* 区别：
            classpath：只会到你的class路径中查找找文件;
            classpath*：不仅包含class路径，还包括jar文件中(class路径)进行查找

4、HandlerInterceptor接口preHandle方法返回值

在配置springmvc拦截器时如果preHandle方法的返回值是false，则不会跳到相应被拦截的页面，也不会进入下一个拦截器

5、SpringMVC的springmvc-servlet.xml文件中配置扫描包，不要包含 service的注解，Spring的applicationContext.xml文件中配置扫描包，不要包含controller的注解。

如下：
springmvc-servlet.xml的配置：

<!-- 设置使用注解的类所在的jar包，注入view层控制类 -->
<context:component-scan base-package="cn.tancp.framework.springMVC.controller" />

Spring MVC启动时的配置文件，包含组件扫描、url映射以及设置freemarker参数，让spring不扫描带有@Service注解的类。

因为springmvc-servlet.xml与applicationContext.xml不是同时加载，加载springmvc-servlet.xml时spring会将所有带@Service注解的类都扫描到容器中，等到加载applicationContext.xml的时候，会因为容器已经存在Service类，使得cglib将不对Service进行代理，直接导致的结果就是在applicationContext 中的事务配置不起作用。
同样applicationContext.xml的配置如下：

<!-- 设置使用注解的类所在的jar包，注入service层类 --><context:component-scan base-package="cn.tancp.framework.springmvc.service" />

扫描包路径，不扫描带有@Controller注解的类。因为这些类已经随容器启动时，在springmvc.xml中扫描过一遍了。