goja.mvc.Freemarkers Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of goja-boot Show documentation
The newest version!
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 2013-2014 sagyf Yang. The Four Group.
 */

package goja.mvc;

import goja.Goja;
import goja.core.StringPool;
import goja.logging.Logger;
import com.jfinal.kit.PathKit;
import com.jfinal.render.FreeMarkerRender;
import com.jfinal.render.RenderException;

import freemarker.cache.StringTemplateLoader;
import freemarker.ext.beans.BeansWrapperBuilder;
import freemarker.template.Configuration;
import freemarker.template.DefaultObjectWrapper;
import freemarker.template.Template;
import freemarker.template.TemplateException;

import org.slf4j.LoggerFactory;

import java.io.BufferedWriter;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStreamWriter;
import java.io.StringWriter;
import java.io.Writer;
import java.util.Map;

/**
 *  . 
 *
 * @author walter yang
 * @version 1.0 2013-11-11 12:46 AM
 * @since JDK 1.5
 */
public class Freemarkers {

    public static final  String               UPDATE_RESPONSE_TEMPLATE = "__updateResponseTemplate";
    private static final org.slf4j.Logger     logger                   = LoggerFactory.getLogger(Freemarkers.class);
    private static final StringTemplateLoader stringLoader             = new StringTemplateLoader();
    //配置
    private static       Configuration        appConfig                = null;
    private static       Configuration        stringConfig             = null;

    static {
        getAppConfiguration();
        initStringConfiguration();
    }

    private static Configuration initStringConfiguration() {
        if (stringConfig == null) {
            //从freemarker 视图中获取所有配置
            stringConfig = (Configuration) FreeMarkerRender.getConfiguration().clone();

            stringLoader.putTemplate(UPDATE_RESPONSE_TEMPLATE, StringPool.EMPTY);
        }
        return stringConfig;
    }

    /**
     * appConfig配置所有参数 重写freemarker中的  reader方法，读取该配置文件
     *
     * @return config
     */
    private static Configuration getAppConfiguration() {
        if (appConfig == null) {
            //从freemarker 视图中获取所有配置
            appConfig = (Configuration) FreeMarkerRender.getConfiguration().clone();
            try {
                //设置模板路径
                appConfig.setDirectoryForTemplateLoading(
                        new File(PathKit.getWebRootPath() + Goja.viewPath));
                appConfig.setObjectWrapper(new BeansWrapperBuilder(Configuration.VERSION_2_3_21).build());
            } catch (IOException e) {
                logger.error("The Freemarkers has error!", e);
            }
        }
        return appConfig;
    }

    /**
     * 渲染模版为字符串，并制定参数
     *
     * @param tpl          模版
     * @param renderParams 参数信息
     * @return 渲染后的字符串
     */
    public static String processString(String tpl, Map renderParams) {
        if (appConfig == null) {
            getAppConfiguration();
        }
        StringWriter result = new StringWriter();
        try {
            Template template = appConfig.getTemplate(tpl);
            template.process(renderParams, result);
        } catch (IOException e) {
            throw new RenderException(e);
        } catch (TemplateException e) {
            throw new RenderException(e);
        }
        return result.toString();
    }

    /**
     * 将Freemakrer的字符串模版，渲染参数为字符串形式的结果。
     *
     * @param strTemplat   字符串模版，而不是文件模版
     * @param renderParams 渲染参数
     * @return 字符串形式的渲染结果
     */
    public static String renderStrTemplate(String strTemplat, Map renderParams) {
        stringLoader.putTemplate(UPDATE_RESPONSE_TEMPLATE, strTemplat);
        stringConfig.setTemplateLoader(stringLoader);
        Writer out = new StringWriter(2048);

        try {
            Template tpl = stringConfig.getTemplate(UPDATE_RESPONSE_TEMPLATE, StringPool.UTF_8);
            tpl.process(renderParams, out);
        } catch (IOException e) {
            Logger.error("Get update response template occurs error.", e);
        } catch (TemplateException e) {
            Logger.error("Process template occurs error.template content is:\n {}", e, strTemplat);
            throw new IllegalArgumentException("Error update response template.", e);
        }

        return out.toString();
    }

    /**
     * 生成HTML
     *
     * @param tlDirectory tl模板目录
     * @param tlName      ftl模板
     * @param paramMap    参数map
     * @param htmlPath    生成HTML存放路径
     */
    public static void makeHtml(String tlDirectory, String tlName, Map paramMap,
                                String htmlPath) {
        FileOutputStream fileOutputStream = null;
        OutputStreamWriter outputStreamWriter = null;
        try {
            Configuration configuration = new Configuration(Configuration.VERSION_2_3_22);
            File file = new File(tlDirectory);// .ftl模板目录
            configuration.setDirectoryForTemplateLoading(file);
            configuration.setObjectWrapper(new DefaultObjectWrapper(Configuration.VERSION_2_3_22));
            Template template = configuration.getTemplate(tlName, StringPool.UTF_8);

            File file2 = new File(htmlPath);// 生成html目录
            fileOutputStream = new FileOutputStream(file2);
            outputStreamWriter = new OutputStreamWriter(fileOutputStream, StringPool.UTF_8);
            BufferedWriter bufferedWriter = new BufferedWriter(outputStreamWriter);
            template.process(paramMap, bufferedWriter);
            bufferedWriter.flush();
            outputStreamWriter.close();
            fileOutputStream.close();
        } catch (IOException e) {
            e.printStackTrace();
        } catch (TemplateException e) {
            e.printStackTrace();
        } finally {
            if (null != fileOutputStream) {
                try {
                    fileOutputStream.close();
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
            if (null != outputStreamWriter) {
                try {
                    outputStreamWriter.close();
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }
    }
}