spring boot整合freemark

比眉伴天荒 2022-06-12 09:09 222阅读 0赞

用过freemark的童孩都知道,freemark与spring的整合,需要在spring配置文件中配置freemrak的解析,原配置内容如下图:

<?xml version="1.0" encoding="UTF-8"?>
    <beans xmlns="http://www.springframework.org/schema/beans"
           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
           xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd"
           default-autowire="byName" default-lazy-init="false">
    
        
        <bean id="freemarkerConfiguration"
              class="org.springframework.beans.factory.config.PropertiesFactoryBean">
            <property name="location" value="classpath:freemarker.properties" />
        </bean>
    
        
        <bean id="freemarkerConfig"
              class="org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer">
            
            <property name="freemarkerSettings" ref="freemarkerConfiguration" />
            <property name="defaultEncoding" value="utf-8" />
            <property name="templateLoaderPath" value="/WEB-INF/ftl/" />
            <property name="freemarkerVariables">
                <map>
                    <entry key="xml_escape" value-ref="fmXmlEscape"/>
                    <entry key="html_escape" value-ref="fmHtmlEscape"/>
                    <entry key="header_data" value-ref="headerHtmlEscape" />
                </map>
            </property>
        </bean>
        
        <bean id="headerHtmlEscape" class="com.xyy.shop.freemarker.HeaderFreemarkerTemplate" />
      	<bean id="fmXmlEscape" class="freemarker.template.utility.XmlEscape"/>
        <bean id="fmHtmlEscape" class="freemarker.template.utility.HtmlEscape"/> 
    
    
        
        <bean id="viewResolver"
              class="org.springframework.web.servlet.view.freemarker.FreeMarkerViewResolver">
            <property name="viewNames" value="*"/>
            <property name="prefix" value=""/>
            <property name="suffix" value=""/>
            <property name="cache" value="true" />
    		<property name="contentType" value="text/html; charset=utf-8"/>
            <property name="viewClass" value="org.springframework.web.servlet.view.freemarker.FreeMarkerView"/>
            <property name="requestContextAttribute" value="request"></property>
        </bean>
    
    </beans>

而在与spring boot的整合上,就显得要整洁很多了,不过默认的配置有没有之前的那么详细或可靠,这个就不从得知,还需要渗析,不废话了,回归话题

既然用到freemark肯定需要用到页面的,spring boot默认的页面文件夹为templates,此处我们就自定义了views,项目结构如下图所示:

![Center][]

依然pom.xml加入freemark与spring boot相关的依赖

<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-freemarker</artifactId>
    		</dependency>

src/main/resources/application.properties添加如下配置

#Freemarker配置
    spring.freemarker.template-loader-path=classpath:/views/
    spring.freemarker.cache=false
    spring.freemarker.charset=UTF-8
    spring.freemarker.check-template-location=true
    spring.freemarker.content-type=text/html
    spring.freemarker.expose-request-attributes=true
    spring.freemarker.expose-session-attributes=true
    spring.freemarker.request-context-attribute=request
    spring.freemarker.suffix=.ftl

这是我这块的配置，如果需要更多的 FreeMarker 配置，可以查看下面的详解

spring.freemarker.allow-request-override=false # Set whether HttpServletRequest attributes are allowed to override (hide) controller generated model attributes of the same name.
    spring.freemarker.allow-session-override=false # Set whether HttpSession attributes are allowed to override (hide) controller generated model attributes of the same name.
    spring.freemarker.cache=false # Enable template caching.
    spring.freemarker.charset=UTF-8 # Template encoding.
    spring.freemarker.check-template-location=true # Check that the templates location exists.
    spring.freemarker.content-type=text/html # Content-Type value.
    spring.freemarker.enabled=true # Enable MVC view resolution for this technology.
    spring.freemarker.expose-request-attributes=false # Set whether all request attributes should be added to the model prior to merging with the template.
    spring.freemarker.expose-session-attributes=false # Set whether all HttpSession attributes should be added to the model prior to merging with the template.
    spring.freemarker.expose-spring-macro-helpers=true # Set whether to expose a RequestContext for use by Spring's macro library, under the name "springMacroRequestContext".
    spring.freemarker.prefer-file-system-access=true # Prefer file system access for template loading. File system access enables hot detection of template changes.
    spring.freemarker.prefix= # Prefix that gets prepended to view names when building a URL.
    spring.freemarker.request-context-attribute= # Name of the RequestContext attribute for all views.
    spring.freemarker.settings.*= # Well-known FreeMarker keys which will be passed to FreeMarker's Configuration.
    spring.freemarker.suffix= # Suffix that gets appended to view names when building a URL.
    spring.freemarker.template-loader-path=classpath:/templates/ # Comma-separated list of template paths.
    spring.freemarker.view-names= # White list of view names that can be resolved.

其它相关的代码没任何变化.主要表现在controller需要返回一个页面,详细如下:

package com.xyy.controller;
    
    import java.util.HashMap;
    import java.util.Map;
    
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.ui.ModelMap;
    import org.springframework.web.bind.annotation.PathVariable;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    import org.springframework.web.servlet.ModelAndView;
    
    import com.xyy.model.Favorite;
    import com.xyy.service.FavoriteService;
    
    /**
     * Favorite控制层
     * @ClassName: FavoriteController 
     * @author wujing
     * @date 2017-07-13 15:09:50
     */
    @RestController
    @RequestMapping("/favorite")
    public class FavoriteController{
    	private static final Logger LOGGER = LoggerFactory.getLogger(FavoriteController.class);
    	
    	@Autowired
    	private FavoriteService favoriteService;
    	
    	/**
         * Favorite编辑
         * @Title: update
         * @param favorite 修改对象
         * @return Object
         * @author wujing 
         * @date 2017-07-13 15:09:50
         */
    	//@RequestMapping("/detail2/{id}")
    	public Object detail2(@PathVariable Long id,ModelMap modelMap) {
    		Map<String,Object> resultMap = new HashMap<String,Object>();
    		try {
    			Favorite tempFavorite = favoriteService.selectByPrimaryKey(id);
    			resultMap.put("status", "success");
    			resultMap.put("data", tempFavorite);
    		} catch (Exception e) {
    			resultMap.put("status", "error");
    			resultMap.put("errorMsg", "系统异常");
    			LOGGER.error("Favorite添加异常", e);
    		}
    		return resultMap;
    	}
    	
    	@RequestMapping("/detail/{id}")
    	public Object detail(@PathVariable Long id,ModelMap modelMap) {
    		try {
    			Favorite tempFavorite = favoriteService.selectByPrimaryKey(id);
    			modelMap.put("tempFavorite", tempFavorite);
    		} catch (Exception e) {
    			LOGGER.error("Favorite查询异常", e);
    		}
    		return new ModelAndView("favorite/detail");
    	}
    }

detail.ftl文件内容:

<div>
                <#if tempFavorite??>
                    ${tempFavorite.id }<br/>
                    ${tempFavorite.productId }<br/>
                    ${tempFavorite.merchantId }<br/>
                    ${tempFavorite.status }<br/>
                    ${tempFavorite.creator }<br/>
                    ${tempFavorite.createTime?string('yyyy-MM-dd HH:mm:ss') }
                </#if>
            </div>

右键运行main主入口,浏览器访问,如下图所示:

![Center 1][]

大功告成,页面出来的,是不是感觉奇丑无比![委屈][wronged.gif],那就对了,接下来,看看,静态资源文件的配置吧; [ 第五节:spring boot静态资源文件的访问以及自定义][_spring boot]

[Center]: /images/20220612/70abbd7b73e94abfba7437012ed73052.png
[Center 1]: /images/20220612/652e53433b6141a8a289f1029f9c1b88.png
[wronged.gif]: http://static.blog.csdn.net/xheditor/xheditor_emot/default/wronged.gif
[_spring boot]: /images/20220612/7c55cc32d10646108256e4279a54fa8a.png