使用freemarker生成模板(模板存在数据库text类型字段)

ゞ浴缸里的玫瑰 2024-04-17 14:28 69阅读 0赞

以前使用模板都是加载模板文件(\*.ftl文件)，这次处理的文件是保存在数据库的字符串，在新版freemarker中增加了StringTemplateLoader类，没错这个就是字符串转成模板，以前我们还需要自己继承这个TemplateLoader类重写(当然需要再改造的可以当我没说)

好，废话不多说

提供一下pom.xml，用的版本号

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

ok，你们一定问，如果项目已经有点旧，不能随意升级版本号怎么办，那自己写一个把，我顺便提供一下源码

import java.io.Reader;
    import java.io.StringReader;
    import java.util.HashMap;
    import java.util.Map;
    
    import freemarker.template.utility.StringUtil;
    
    
    public class StringTemplateLoader implements TemplateLoader {
        
        private final Map<String, StringTemplateSource> templates = new HashMap<String, StringTemplateSource>();
        
    
        public void putTemplate(String name, String templateContent) {
            putTemplate(name, templateContent, System.currentTimeMillis());
        }
    
        public void putTemplate(String name, String templateContent, long lastModified) {
            templates.put(name, new StringTemplateSource(name, templateContent, lastModified));
        }
        
    
        public boolean removeTemplate(String name) {
            return templates.remove(name) != null;
        }
        
        public void closeTemplateSource(Object templateSource) {
        }
        
        public Object findTemplateSource(String name) {
            return templates.get(name);
        }
        
        public long getLastModified(Object templateSource) {
            return ((StringTemplateSource) templateSource).lastModified;
        }
        
        public Reader getReader(Object templateSource, String encoding) {
            return new StringReader(((StringTemplateSource) templateSource).templateContent);
        }
        
        private static class StringTemplateSource {
            private final String name;
            private final String templateContent;
            private final long lastModified;
            
            StringTemplateSource(String name, String templateContent, long lastModified) {
                if (name == null) {
                    throw new IllegalArgumentException("name == null");
                }
                if (templateContent == null) {
                    throw new IllegalArgumentException("source == null");
                }
                if (lastModified < -1L) {
                    throw new IllegalArgumentException("lastModified < -1L");
                }
                this.name = name;
                this.templateContent = templateContent;
                this.lastModified = lastModified;
            }
            
            @Override
            public int hashCode() {
                final int prime = 31;
                int result = 1;
                result = prime * result + ((name == null) ? 0 : name.hashCode());
                return result;
            }
    
            @Override
            public boolean equals(Object obj) {
                if (this == obj)
                    return true;
                if (obj == null)
                    return false;
                if (getClass() != obj.getClass())
                    return false;
                StringTemplateSource other = (StringTemplateSource) obj;
                if (name == null) {
                    if (other.name != null)
                        return false;
                } else if (!name.equals(other.name))
                    return false;
                return true;
            }
    
    
            @Override
            public String toString() {
                return name;
            }
            
        }
        
    
        @Override
        public String toString() {
            StringBuilder sb = new StringBuilder();
            sb.append(TemplateLoaderUtils.getClassNameForToString(this));
            sb.append("(Map { ");
            int cnt = 0;
            for (String name : templates.keySet()) {
                cnt++;
                if (cnt != 1) {
                    sb.append(", ");
                }
                if (cnt > 10) {
                    sb.append("...");
                    break;
                }
                sb.append(StringUtil.jQuote(name));
                sb.append("=...");
            }
            if (cnt != 0) {
                sb.append(' ');
            }
            sb.append("})");
            return sb.toString();
        }
        
    }

自己建一个就好，也方便重写

然后怎么用呢，我给出测试类你们

public static void main(String[] args) throws Exception {
    		Configuration cfg = new Configuration(Configuration.DEFAULT_INCOMPATIBLE_IMPROVEMENTS); 
    		cfg.setCacheStorage(new freemarker.cache.NullCacheStorage());
    		StringTemplateLoader stl = new StringTemplateLoader();
    		//单个测试
            //stl.putTemplate("temp", "你好：${user}");
    
    		//嵌套测试
    		stl.putTemplate("greetTemplate", "<#macro greet>${user}</#macro>");
    		stl.putTemplate("myTemplate", "<#include \"greetTemplate\"><@greet/> World!");
            cfg.setTemplateLoader(stl);
            Template template = cfg.getTemplate("myTemplate","utf-8");    
    
            Map<String,Object> root = new HashMap<String,Object>();    
            root.put("user", "yemon");    
          
            StringWriter writer = new StringWriter();    
            template.process(root, writer);    
            System.out.println(writer.toString());   
    
    
    	}

这里用到单个和嵌入模板（include 语句），方便案例测试

常见问题

嵌入模板有什么用？

如果cms，header和footer页一般是一样的，这里可以通用，没必要多设置，这样可以统一打理

测试方法好像打印debug日志，能不能消除？

能，在log4j日志配置文件配置就好？

#设置关闭freemarker日志
    log4j.logger.freemarker=ERROR

这个日志文件在哪里？

如果你是spring项目，就是项目下resources的log4j.properties，最底下加进上一句就可以了