【FreeMarker】Spring MVC与FreeMarker整合（二）

　　前一篇介绍了FreeMarker的基本使用，本例介绍Spring MVC与FreeMarker整合

　　不熟悉项目搭建，可参考
　　【FreeMarker】FreeMarker快速入门（一）　

整合

　　1、新建Spring MVC项目test-freemarker ，参考：【Maven】Eclipse 使用Maven创建SpringMVC Web项目

　　　　web.xml文件如下：

 <?xml version="1.0" encoding="UTF-8"?>
 <web-app version="3.0" 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_3_0.xsd">

     <display-name>test-freemarker</display-name>

     <!--指定Spring的配置在文件所在的目录，默认配置在WEB-INF目录下-->
     <context-param>
         <param-name>contextConfigLocation</param-name>
         <param-value>classpath:spring-context.xml</param-value>
     </context-param>

     <!-- Spring配置：needed for ContextLoaderListener -->
     <!-- Bootstraps the root web application context before servlet initialization -->
     <listener>
         <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
     </listener>

     <!-- Spring MVC配置 -->
     <!-- The front controller of this Spring Web application, responsible for
         handling all application requests -->
     <servlet>
         <servlet-name>spring</servlet-name>
         <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
         <!-- 可以自定义servlet.xml配置文件的位置和名称，默认为WEB-INF目录下，名称为[<servlet-name>]-servlet.xml，如spring-servlet.xml -->
         <init-param>
             <param-name>contextConfigLocation</param-name>
             <param-value>classpath:spring-mvc.xml</param-value>
         </init-param>
         <load-on-startup>1</load-on-startup>
     </servlet>

     <!-- Map all requests to the DispatcherServlet for handling -->
     <servlet-mapping>
         <servlet-name>spring</servlet-name>
         <url-pattern>/</url-pattern>
     </servlet-mapping>

     <!-- 中文过滤器 -->
     <filter>
         <filter-name>CharacterEncodingFilter</filter-name>
         <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
         <init-param>
             <param-name>encoding</param-name>
             <param-value>UTF-8</param-value>
         </init-param>
         <init-param>
             <param-name>forceEncoding</param-name>
             <param-value>true</param-value>
         </init-param>
     </filter>
     <filter-mapping>
         <filter-name>CharacterEncodingFilter</filter-name>
         <url-pattern>/*</url-pattern>
     </filter-mapping>

 </web-app>

　　2、添加FreeMarker依赖

 <!-- Spring对外部依赖支持 -->
 <dependency>
     <groupId>org.springframework</groupId>
     <artifactId>spring-context-support</artifactId>
     <version>5.1.4.RELEASE</version>
 </dependency>

 <!-- freemarker -->
 <dependency>
     <groupId>org.freemarker</groupId>
     <artifactId>freemarker</artifactId>
     <version>2.3.28</version>
 </dependency>

　　　完整POM如下：

 <project xmlns="http://maven.apache.org/POM/4.0.0"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
     <modelVersion>4.0.0</modelVersion>
     <groupId>com.test</groupId>
     <artifactId>test-freemarker</artifactId>
     <packaging>war</packaging>
     <version>0.0.1-SNAPSHOT</version>
     <name>test-freemarker Maven Webapp</name>

     <!-- 定义maven变量 -->
     <properties>
         <!-- spring -->
         <spring.version>5.1.4.RELEASE</spring.version>

         <!-- logback -->
         <slf4j-api.version>1.7.5</slf4j-api.version>
         <logback.version>0.9.30</logback.version>

         <!-- Servlet -->
         <servlet.version>3.0.1</servlet.version>
         <jsp-api.version>2.2</jsp-api.version>

         <!-- jstl -->
         <jstl.version>1.2</jstl.version>
         <standard.version>1.1.2</standard.version>

         <!-- test junit -->
         <junit.version>3.8.1</junit.version>

         <!-- jdk -->
         <jdk.version>1.8</jdk.version>
         <maven.compiler.plugin.version>2.3.2</maven.compiler.plugin.version>
     </properties>

     <dependencies>

         <!-- Spring IOC 核心容器 -->
         <dependency>
             <groupId>org.springframework</groupId>
             <artifactId>spring-core</artifactId>
             <version>${spring.version}</version>
         </dependency>

         <dependency>
             <groupId>org.springframework</groupId>
             <artifactId>spring-beans</artifactId>
             <version>${spring.version}</version>
         </dependency>

         <dependency>
             <groupId>org.springframework</groupId>
             <artifactId>spring-context</artifactId>
             <version>${spring.version}</version>
         </dependency>

         <dependency>
             <groupId>org.springframework</groupId>
             <artifactId>spring-expression</artifactId>
             <version>${spring.version}</version>
         </dependency>

         <!-- Spring AOP 切面 模块 -->
         <dependency>
             <groupId>org.springframework</groupId>
             <artifactId>spring-aop</artifactId>
             <version>${spring.version}</version>
         </dependency>

         <!-- Spring WEB MVC 模块 -->
         <dependency>
             <groupId>org.springframework</groupId>
             <artifactId>spring-web</artifactId>
             <version>${spring.version}</version>
         </dependency>

         <dependency>
             <groupId>org.springframework</groupId>
             <artifactId>spring-webmvc</artifactId>
             <version>${spring.version}</version>
         </dependency>

         <!-- Spring对外部依赖支持 -->
         <dependency>
             <groupId>org.springframework</groupId>
             <artifactId>spring-context-support</artifactId>
             <version>5.1.4.RELEASE</version>
         </dependency>

         <!-- freemarker -->
         <dependency>
             <groupId>org.freemarker</groupId>
             <artifactId>freemarker</artifactId>
             <version>2.3.28</version>
         </dependency>

         <!-- logback -->
         <dependency>
             <groupId>org.slf4j</groupId>
             <artifactId>slf4j-api</artifactId>
             <version>${slf4j-api.version}</version>
             <type>jar</type>
             <scope>compile</scope>
         </dependency>

         <dependency>
             <groupId>ch.qos.logback</groupId>
             <artifactId>logback-core</artifactId>
             <version>${logback.version}</version>
             <type>jar</type>
         </dependency>

         <dependency>
             <groupId>ch.qos.logback</groupId>
             <artifactId>logback-classic</artifactId>
             <version>${logback.version}</version>
             <type>jar</type>
         </dependency>

         <dependency>
             <groupId>ch.qos.logback</groupId>
             <artifactId>logback-access</artifactId>
             <version>${logback.version}</version>
         </dependency>

         <!-- Servlet -->
         <dependency>
             <groupId>javax.servlet</groupId>
             <artifactId>javax.servlet-api</artifactId>
             <version>${servlet.version}</version>
             <scope>provided</scope>
         </dependency>
         <dependency>
             <groupId>javax.servlet.jsp</groupId>
             <artifactId>jsp-api</artifactId>
             <version>${jsp-api.version}</version>
             <scope>provided</scope>
         </dependency>

         <!-- test -->
         <dependency>
             <groupId>junit</groupId>
             <artifactId>junit</artifactId>
             <version>${junit.version}</version>
             <scope>test</scope>
         </dependency>

     </dependencies>

     <build>
         <plugins>
             <!-- define the project compile level -->
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-compiler-plugin</artifactId>
                 <version>${maven.compiler.plugin.version}</version>
                 <configuration>
                     <source>${jdk.version}</source>
                     <target>${jdk.version}</target>
                 </configuration>
             </plugin>
         </plugins>
         <finalName>test-freemarker</finalName>
     </build>

 </project>

　　3、讲freemarker配置类注入，spring容器，编辑spring-context.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:mybatis-spring="http://mybatis.org/schema/mybatis-spring"
     xmlns:tx="http://www.springframework.org/schema/tx"
     xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
         http://mybatis.org/schema/mybatis-spring http://mybatis.org/schema/mybatis-spring-1.2.xsd
         http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-4.0.xsd
         http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.0.xsd">

     <context:component-scan base-package="com.test.freemarker"></context:component-scan>

     <bean id="freemarkerConfig"
           class="org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer">
         <property name="templateLoaderPath" value="" />
         <property name="freemarkerSettings">
             <props>
                 <!-- 设置标签类型 两种：[] 和 <> , []这种标记解析要快些 -->
                 <prop key="tag_syntax">auto_detect</prop>
                 <!-- 检查模板更新时间间隔，默认5s -->
                 <prop key="template_update_delay">1</prop>
                 <prop key="default_encoding">UTF-8</prop>
                 <prop key="url_escaping_charset">UTF-8</prop>
                 <prop key="locale">zh-CN</prop>
                 <!-- 时间格式化 -->
                 <prop key="datetime_format">yyyy-MM-dd HH:mm:ss</prop>
                 <prop key="date_format">yyyy-MM-dd</prop>
                 <prop key="time_format">HH:mm:ss</prop>
                 <prop key="number_format">0.##########</prop>
                 <!-- 去掉多余的空格 -->
                 <prop key="whitespace_stripping">true</prop>
                 <prop key="classic_compatible">true</prop>
                 <prop key="template_exception_handler">ignore</prop>
             </props>
         </property>
     </bean>
 </beans>

　　4、在springmvc配置文件spring-mvc.xml中，配置freemarker视图解析器，（如果其中包含jsp视图解析器，可以删除）

 <?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/mvc http://www.springframework.org/schema/mvc/spring-mvc-4.0.xsd
         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-4.0.xsd">

     <!--SpringMVC只是控制网站跳转逻辑  -->
     <!-- 只扫描控制器 -->
     <context:component-scan base-package="com.test.freemarker.controller" use-default-filters="false">
         <context:include-filter type="annotation" expression="org.springframework.stereotype.Controller"/>
     </context:component-scan>

     <!-- 视图解析器
     <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
         <property name="prefix" value="/WEB-INF/pages/"></property>
         <property name="suffix" value=".jsp"></property>
     </bean>-->

     <!-- 视图解析器 :针对freemarker的视图配置 -->
     <bean id="viewResolver" class="org.springframework.web.servlet.view.freemarker.FreeMarkerViewResolver">
         <property name="prefix" value="/page/" />
         <property name="suffix" value=".html" />
         <property name="cache" value="true" />
         <property name="contentType" value="text/html;charset=UTF-8"></property>
         <property name="requestContextAttribute" value="request" />
         <property name="exposeSpringMacroHelpers" value="true" />
         <property name="exposeRequestAttributes" value="true" />
         <property name="exposeSessionAttributes" value="true" />
     </bean>

     <!-- 默认的注解映射的支持 -->
     <mvc:annotation-driven></mvc:annotation-driven>

     <!-- 对静态资源文件的访问 -->
     <mvc:default-servlet-handler/>

 </beans>

　　5、编辑freemarker页面模板，webapp/page/first.html

 <!DOCTYPE html>
 <html>
 <head>
 <meta charset="UTF-8">
 <title>Insert title here</title>
 </head>
 <body>
     <h1>${username}</h1>
 </body>
 </html>

　　6、编辑controller，FreemarkerController.java

 package com.test.freemarker.controller;

 import java.util.ArrayList;
 import java.util.Date;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;

 import org.springframework.stereotype.Controller;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.servlet.ModelAndView;

 import com.test.freemarker.method.SortMethod;

 @Controller
 @RequestMapping("/freemarker")
 public class FreemarkerController {

     @RequestMapping("/first")
     public ModelAndView first() {
         ModelAndView modelAndView = new ModelAndView("first");
         modelAndView.addObject("username", "Hello Freemarker!");
         return modelAndView;
     }

 }
  

　　7、发布项目到tomcat，并运行，输入地址：http://localhost:8080/test-freemarker/freemarker/first