Enjoy指令扩展管理常用文本模板

个人站：http://www.wenhaofan.com/article/20190304102258

平时在项目中使用短信模板 邮件模板以及 站内消息通知等文本模板一般都是通过手动的字符串拼接来完成，例如："欢迎"+user.getName()+"加入俱乐部。"

然而这种方法不仅代码难看而且还不方便管理，因此为了更方便的在项目中管理使用这类文本模板，参考JFinal源码中的activerecord管理sql的代码来扩展了Enjoy的指令。


1.扩展代码

  1. package com.autu.common.keys;
  2.  
  3.  
  4. import com.jfinal.kit.StrKit;
  5. import com.jfinal.template.Directive;
  6. import com.jfinal.template.Env;
  7. import com.jfinal.template.expr.ast.Const;
  8. import com.jfinal.template.expr.ast.Expr;
  9. import com.jfinal.template.expr.ast.ExprList;
  10. import com.jfinal.template.io.Writer;
  11. import com.jfinal.template.stat.ParseException;
  12. import com.jfinal.template.stat.Scope;
  13.  
  14. /**
  15.  * KeysDirective
  16.  */
  17. public class KeysDirective extends Directive {
  18. 	
  19. 	static final String KEYS_DIRECTIVE="_KEYS_DIRECTIVE";
  20. 	
  21. 	private String id;
  22. 	
  23. 	public void setExprList(ExprList exprList) {
  24. 		if (exprList.length() == 0) {
  25. 			throw new ParseException("The parameter of #keys directive can not be blank", location);
  26. 		}
  27. 		if (exprList.length() > 1) {
  28. 			throw new ParseException("Only one parameter allowed for #keys directive", location);
  29. 		}
  30. 		Expr expr = exprList.getExpr(0);
  31. 		if (expr instanceof Const && ((Const)expr).isStr()) {
  32. 		} else {
  33. 			throw new ParseException("The parameter of #keys directive must be String", location);
  34. 		}
  35. 		
  36. 		this.id = ((Const)expr).getStr();
  37. 	}
  38. 	
  39. 	
  40. 	public void exec(Env env, Scope scope, Writer writer) {
  41. 		String beforeKey=(String)scope.get(KeysDirective.KEYS_DIRECTIVE);
  42.  
  43. 		String key = StrKit.isBlank(beforeKey) ? id : beforeKey + "." + id;
  44. 		scope.set(KEYS_DIRECTIVE, key);
  45. 	
  46. 		stat.exec(env, scope, writer);
  47. 	
  48. 	}
  49. 	
  50. 	public boolean hasEnd() {
  51. 		return true;
  52. 	}
  53. }
  1. package com.autu.common.keys;
  2.  
  3.  
  4. import java.util.Map;
  5.  
  6. import com.jfinal.kit.StrKit;
  7. import com.jfinal.template.Directive;
  8. import com.jfinal.template.Env;
  9. import com.jfinal.template.Template;
  10. import com.jfinal.template.expr.ast.Const;
  11. import com.jfinal.template.expr.ast.Expr;
  12. import com.jfinal.template.expr.ast.ExprList;
  13. import com.jfinal.template.io.Writer;
  14. import com.jfinal.template.stat.ParseException;
  15. import com.jfinal.template.stat.Scope;
  16.  
  17. /**
  18.  * KeyDirective
  19.  */
  20. public class KeyDirective extends Directive {
  21. 	
  22. 	static final String KEY_DIRECTIVE="_KEY_DIRECTIVE";
  23. 	
  24. 	private String id;
  25. 	
  26. 	public void setExprList(ExprList exprList) {
  27. 		if (exprList.length() == 0) {
  28. 			throw new ParseException("The parameter of #key directive can not be blank", location);
  29. 		}
  30. 		if (exprList.length() > 1) {
  31. 			throw new ParseException("Only one parameter allowed for #key directive", location);
  32. 		}
  33. 		Expr expr = exprList.getExpr(0);
  34. 		if (expr instanceof Const && ((Const)expr).isStr()) {
  35. 		} else {
  36. 			throw new ParseException("The parameter of #key directive must be String", location);
  37. 		}
  38. 		
  39. 		this.id = ((Const)expr).getStr();
  40. 	}
  41. 	
  42. 	
  43. 	@SuppressWarnings("unchecked")
  44. 	public void exec(Env env, Scope scope, Writer writer) {
  45. 		String nameSpace = (String)scope.get(KeysDirective.KEYS_DIRECTIVE);
  46. 		String key = StrKit.isBlank(nameSpace) ? id : nameSpace + "." + id;
  47. 		Map<String, Template> keyTemplateMap = (Map<String, Template>)scope.get(KeyKit.KEY_TEMPLATE_MAP_KEY);
  48. 		if (keyTemplateMap.containsKey(key)) {
  49. 			throw new ParseException("Key already exists with key : " + key, location);
  50. 		}
  51. 		
  52. 		keyTemplateMap.put(key, new Template(env, stat));
  53. 	}
  54. 	
  55. 	public boolean hasEnd() {
  56. 		return true;
  57. 	}
  58. }
  1. package com.autu.common.keys;
  2.  
  3.  
  4. import com.jfinal.template.source.ISource;
  5.  
  6. /**
  7.  * 封装 key 模板源
  8.  */
  9. class KeySource {
  10. 	
  11. 	String file;
  12. 	ISource source;
  13. 	
  14. 	KeySource(String file) {
  15. 		this.file = file;
  16. 		this.source = null;
  17. 	}
  18. 	
  19. 	KeySource(ISource source) {
  20. 		this.file = null;
  21. 		this.source = source;
  22. 	}
  23. 	
  24. 	boolean isFile() {
  25. 		return file != null;
  26. 	}
  27. }
  1. package com.autu.common.keys;
  2.  
  3. import java.util.ArrayList;
  4. import java.util.HashMap;
  5. import java.util.List;
  6. import java.util.Map;
  7.  
  8. import com.jfinal.kit.Kv;
  9. import com.jfinal.kit.StrKit;
  10. import com.jfinal.template.Engine;
  11. import com.jfinal.template.Template;
  12. import com.jfinal.template.source.ISource;
  13. import com.jfinal.template.stat.ParseException;
  14.  
  15. /**
  16.  * Email Kit
  17.  */
  18. public class KeyKit {
  19.  
  20. 	static final String KEY_TEMPLATE_MAP_KEY = "_KEY_TEMPLATE_MAP_";
  21. 	static final boolean DEFAULT_DEV_MODE=false;
  22. 	public static final String MAIN_CONFIG_NAME = "keys";
  23. 	public String configName;
  24. 	private  boolean devMode=false;
  25. 	private Engine engine;
  26. 	private List<KeySource> keySourceList = new ArrayList<KeySource>();
  27. 	public Map<String, Template> keyTemplateMap;
  28.  
  29. 	private static final Map<String,KeyKit> keyKitMap=new HashMap<>();
  30. 	
  31. 	public static KeyKit use(String configName) {
  32. 		return keyKitMap.get(configName);
  33. 	}
  34. 	
  35. 	public static KeyKit use() {
  36. 		return use(MAIN_CONFIG_NAME);
  37. 	}
  38. 	
  39. 	private KeyKit(boolean devMode) {
  40. 		this(MAIN_CONFIG_NAME, devMode);
  41. 	}
  42.  
  43. 	public static KeyKit load(String configName) {
  44. 		
  45. 		if(keyKitMap.containsKey(configName)) {
  46. 			return keyKitMap.get(configName);
  47. 		}
  48. 		
  49. 		return new KeyKit(configName,DEFAULT_DEV_MODE);
  50. 	}
  51. 	
  52. 	public static KeyKit load(boolean devMode) {
  53. 		if(keyKitMap.containsKey(MAIN_CONFIG_NAME)) {
  54. 			return keyKitMap.get(MAIN_CONFIG_NAME);
  55. 		}
  56. 		return new KeyKit(devMode);
  57. 	}
  58.  
  59. 	public static KeyKit load(String configName, boolean devMode) {
  60. 		if(keyKitMap.containsKey(configName)) {
  61. 			return keyKitMap.get(configName);
  62. 		}
  63. 		return new KeyKit(configName, devMode);
  64. 	}
  65.  
  66. 	private KeyKit(String configName, boolean devMode) {
  67. 		this.configName = configName;
  68. 		this.devMode = devMode;
  69.  
  70. 		if(keyKitMap.containsKey(configName)) {
  71. 			throw new ParseException("Key already exists", null );
  72. 		}
  73. 		
  74. 		engine = new Engine(configName);
  75. 		engine.setDevMode(devMode);
  76. 		engine.addDirective("key", KeyDirective.class);
  77. 		engine.addDirective("keys", KeysDirective.class);
  78. 		engine.addSharedMethod(new StrKit());
  79. 		
  80. 		
  81. 		keyKitMap.put(configName, this);
  82. 	}
  83.  
  84. 	public KeyKit(String configName) {
  85. 		this(configName, false);
  86. 	}
  87.  
  88. 	public Engine getEngine() {
  89. 		return engine;
  90. 	}
  91.  
  92. 	public void setDevMode(boolean devMode) {
  93. 		this.devMode = devMode;
  94. 		engine.setDevMode(devMode);
  95. 	}
  96.  
  97. 	public KeyKit setBaseKeyTemplatePath(String baseKeyTemplatePath) {
  98. 		engine.setBaseTemplatePath(baseKeyTemplatePath);
  99. 		return this;
  100. 	}
  101.  
  102. 	public KeyKit addTemplate(String KeyTemplate) {
  103. 		if (StrKit.isBlank(KeyTemplate)) {
  104. 			throw new IllegalArgumentException("keyTemplate can not be blank");
  105. 		}
  106. 		keySourceList.add(new KeySource(KeyTemplate));
  107. 		return this;
  108. 	}
  109.  
  110. 	public void addTemplate(ISource keyTemplate) {
  111. 		if (keyTemplate == null) {
  112. 			throw new IllegalArgumentException("keyTemplate can not be null");
  113. 		}
  114. 		keySourceList.add(new KeySource(keyTemplate));
  115. 	}
  116.  
  117. 	public synchronized KeyKit parseKeysTemplate() {
  118. 		Map<String, Template> keyTemplateMap = new HashMap<String, Template>(512, 0.5F);
  119. 		for (KeySource ss : keySourceList) {
  120. 			Template template = ss.isFile() ? engine.getTemplate(ss.file) : engine.getTemplate(ss.source);
  121. 			Map<Object, Object> data = new HashMap<Object, Object>();
  122. 			data.put(KEY_TEMPLATE_MAP_KEY, keyTemplateMap);
  123. 			template.renderToString(data);
  124. 		}
  125. 		this.keyTemplateMap = keyTemplateMap;
  126. 		return this;
  127. 	}
  128.  
  129. 	private void reloadModifiedKeyTemplate() {
  130. 		engine.removeAllTemplateCache(); // 去除 Engine 中的缓存，以免 get 出来后重新判断 isModified
  131. 		parseKeysTemplate();
  132. 	}
  133.  
  134. 	private boolean isKeyTemplateModified() {
  135. 		for (Template template : keyTemplateMap.values()) {
  136. 			if (template.isModified()) {
  137. 				return true;
  138. 			}
  139. 		}
  140. 		return false;
  141. 	}
  142.  
  143. 	private Template getKeyTemplate(String key) {
  144. 		Template template = keyTemplateMap.get(key);
  145. 		if (template == null) { // 此 if 分支，处理起初没有定义，但后续不断追加 key 的情况
  146. 			if (!devMode) {
  147. 				return null;
  148. 			}
  149. 			if (isKeyTemplateModified()) {
  150. 				synchronized (this) {
  151. 					if (isKeyTemplateModified()) {
  152. 						reloadModifiedKeyTemplate();
  153. 						template = keyTemplateMap.get(key);
  154. 					}
  155. 				}
  156. 			}
  157. 			return template;
  158. 		}
  159.  
  160. 		if (devMode && template.isModified()) {
  161. 			synchronized (this) {
  162. 				template = keyTemplateMap.get(key);
  163. 				if (template.isModified()) {
  164. 					reloadModifiedKeyTemplate();
  165. 					template = keyTemplateMap.get(key);
  166. 				}
  167. 			}
  168. 		}
  169. 		return template;
  170. 	}
  171.  
  172. 	
  173. 	/**
  174. 	 * 示例： 1：模板 定义 #key("key")
  175. 	 * 
  176. 	 * #end
  177. 	 *
  178. 	 * 2：java 代码 getContent("key", Kv);
  179. 	 */
  180. 	public String getContent(String key, Kv kv) {
  181. 		Template template = getKeyTemplate(key);
  182. 		if (template == null) {
  183. 			return null;
  184. 		}
  185. 		return template.renderToString(kv);
  186. 	}
  187.  
  188. 	
  189. 	public java.util.Set<java.util.Map.Entry<String, Template>> getKeyMapEntrySet() {
  190. 		return keyTemplateMap.entrySet();
  191. 	}
  192.  
  193. 	public String toString() {
  194. 		return "KeyTplKit for config : " + configName;
  195. 	}
  196. }

2.模板文件

image.png

    3.1 all_emails.tpl

  1. #keys("comment")
  2. 	#include("innerKeys.tpl")
  3. #end

    3.2 comment.tpl

  1. #key("comment_title")
  2. [#(config.title)评论通知] Re:#(title)
  3. #end

    3.3 inner.tpl

  1. #keys("inner")
  2.    #include("comment.tpl")
  3. #end

3.创建管理工具

  1. KeyKit.load(p.getBoolean("devMode", false))
  2.     .setBaseKeyTemplatePath(PathKit.getRootClassPath() + "/email")
  3.     .addTemplate("all_emails.tpl")
  4.     .parseKeysTemplate();

4.使用

  1.    String keyContent=	KeyKit.use().getContent("comment.inner.comment_title", 
  2. 	    		Kv.by("config",new Config().setTitle("test")).set("title", "title1"));
  3. 		System.out.println(keyContent);

输出结果

  1.   [test评论通知] Re:title1

5.说明

    此处演示的为多层嵌套keys的使用,单层和jfinal的sql管理一样使用

项目：JFinal
29 13

评论区

JFinal

2019-03-04 12:56

对于 enjoy 的扩展十分深入，赞一个

对于一般的需求还有更简单的使用方式，例如，先将所有模板通过 #define 事先全部定义好，假定文件名为 template_define.txt：

#define comment()
[#(config.title)评论] Re:#(title)
#end

#define commnetReply()
[#(config.title)评论回复] Re:#(reply)
#end

然后通过 engine.addSharedFunction("template_define.txt") 将其添加为共享函数，然后就可以在任意地方使用了：
Engine engine = Engine.use();
Kv kv = kv.by("config", config).set(...);
String ret = engine.getTemplateByString("#@comment()").renderToString(kv);
System.out.print(ret);

好多好玩、简单、方便的用法呢
 回复

JFinal

2019-03-04 13:01

如果觉得下面这行代码的代码量比较大：
String ret = engine.getTemplateByString("#@comment()").renderToString(kv);

可以做个工具类：
public class TemplateKit {
public static String renderToString(String functionName, Kv kv) {
String fn = "#@" + functionName + "()";
return Engine.use().getTemplateByString(fn).renderToString(kv);
}

上面的 functionName 参数只需要传一个在 template_define.txt 中通过 #define 定义的函数名就可以了，如： "comment"

那么使用的时候就变成了：
Kv kv = kv.by("config", config).set(...);
String ret = TemplateKit.renderToString("comment", kv);
System.out.print(ret);

是不是超级爽？
 回复

正负余

2019-03-04 13:04

@JFinal 可以的，单层用这种方法很方便，扩展的指令主要是为了方便xx.xx.xx以及sql管理这种多层级的需求
 回复

JFinal

2019-03-04 13:13

@正负余 多层需求扩展一下为好
 回复

maxwade

2019-03-04 22:11

之前一直在想jfinal有什么好用的邮件模板，总算出来了。收藏！
 回复

正负余

2019-03-05 09:43

@maxwade 哈哈哈 有用就很odk
 回复

laofa

2020-04-19 20:35

engine.addSharedFunction("template_define.txt") template_define.txt这个文件要放在哪里呢？
 回复
我要分享

热门分享

扫码入社