分享一个jfinal引擎的自定义CMS标签

要制作一个下面这样的CMS标签,可以实现 多个自定义参数,带参数名和参数值

#articlelist(channelid=10,pagenumber=1,pagesize=10)

<li> <a href="#(article.getArticleUrl())">#(article.title)</a></li>

#end

---------------------------------------------------

第一步,修改一下jfinal源码 (最新版本不用修改,波总改过了)


package com.jfinal.template.expr.ast;


import java.util.List;

import java.util.Map;

import com.jfinal.template.TemplateException;

import com.jfinal.template.stat.Location;

import com.jfinal.template.stat.ParseException;

import com.jfinal.template.stat.Scope;


/**

 * Assign

 * 

 * 支持三种赋值,其中第二种如果括号中是 ID 或 STR 则演变为第三种是对 map 赋值:

 * 1:ID = expr

 * 2:ID [ expr ] = expr

 *   如果 expr 为 int 或 long 型,则是对 array 赋值

 *   如果 expr 为 ID、STR 型,则是对 map 进行赋值

 *   否则抛异常出来

 * 3:ID [ ID ] = expr 或者 ID [ STR ] = expr

 * 4:支持无限连:id = array[ i = 0 ] = array[1] = 123

 */

public class Assign extends Expr {

private String id;

private Expr index; // index 用于支持 ID [ expr ] = expr 这种形式

private Expr right;

/**

* 数组赋值表达式

*/

public Assign(String id, Expr index, Expr right, Location location) {

if (index == null) {

throw new ParseException("The index expression of array assignment can not be null", location);

}

if (right == null) {

throw new ParseException("The expression on the right side of an assignment expression can not be null", location);

}

this.id = id;

this.index = index;

this.right = right;

this.location = location;

}

/**

* 普通赋值表达式

*/

public Assign(String id, Expr right, Location location) {

if (right == null) {

throw new ParseException("The expression on the right side of an assignment expression can not be null", location);

}

this.id = id;

this.index = null;

this.right = right;

this.location = location;

}

/**

* 获取 assign 表达式左侧标识符 id

* 在自定义指令中得到 id 值,可以得知该赋值表达式是针对哪个变量在操作,有助于扩展

* 需求来源:http://www.jfinal.com/share/379

*/

public String getId() {

return id;

}

public Expr getIndex() {

return index;

}

public Expr getRight() {

return right;

}

/**

* 赋值语句有返回值,可以用于表达式计算

*/

public Object eval(Scope scope) {

if (index == null) {

return assignVariable(scope);

} else {

return assignElement(scope);

}

}

Object assignVariable(Scope scope) {

Object rightValue = right.eval(scope);

if (scope.getCtrl().isWisdomAssignment()) {

scope.set(id, rightValue);

} else if (scope.getCtrl().isLocalAssignment()) {

scope.setLocal(id, rightValue);

} else {

scope.setGlobal(id, rightValue);

}

return rightValue;

}

/**

* 数组或 Map 赋值

*/

@SuppressWarnings({"unchecked", "rawtypes"})

Object assignElement(Scope scope) {

Object target = scope.get(id);

if (target == null) {

throw new TemplateException("The assigned targets \"" + id + "\" can not be null", location);

}

Object idx = index.eval(scope);

if (idx == null) {

throw new TemplateException("The index of list/array and the key of map can not be null", location);

}

Object value;

if (target instanceof Map) {

value = right.eval(scope);

((Map)target).put(idx, value);

return value;

}

if ( !(idx instanceof Integer) ) {

throw new TemplateException("The index of list/array can only be integer", location);

}

if (target instanceof List) {

value = right.eval(scope);

((List)target).set((Integer)idx, value);

return value;

}

if (target.getClass().isArray()) {

value = right.eval(scope);

java.lang.reflect.Array.set(target, (Integer)idx, value);

return value;

}

throw new TemplateException("Only the list array and map is supported by index assignment", location);

}

}


-----------------------------------------------------------------

第二步

public class ArticleListDirective extends Directive {


Expr[] exprArray=null;


@Override

public void setExprList(ExprList exprList) {

// TODO Auto-generated method stub

super.setExprList(exprList);

this.exprArray = exprList.getExprArray();


}

@Override

public void exec(Env env, Scope scope, Writer writer) {

Kv kv=Kv.create();//存放各个参数

for (int i=0;i<exprArray.length;i++)

{  //循环参数列表,并把参数放到 Kv 里面

Assign obj= (Assign)exprArray[i];

//System.out.println(obj.id+"   "+obj.right.eval(scope));

kv.set(obj.getId().toLowerCase(), obj.eval(scope));

}

//  获取到的参数名和参数值 ,都在KV里面,该干啥干啥吧,这里省略了


Page<Article> page = Article.dao.paginateByCache(xxxxxxxxxx);//根据上面得到的参数,自行组合SQL查询 

List list=page.getList();

for (int i=0;i<list.size();i++)

{

   scope.set("article",list.get(i));

       stat.exec(env, scope, writer);//执行自定义标签中包围的 html

 

}

}

@Override

public boolean hasEnd() {

 

return true;

}


}


----------------------------------------------------------------

第三步


 @Override

    public void configEngine(Engine me) {

       

            me.setBaseTemplatePath(PathKit.getWebRootPath());

            me.addDirective("articlelist", new ArticleListDirective());

}


-----------------------------------------------------------------------

结束 

评论区

JFinal

2017-08-02 11:01

思路相当不错,是这么来玩的,赞一个 ^_^

有个小建议,Assign.java 源代码其实不需要改变,在面对任何表达式的时候,只需要调用它的 eval 方法就可以获取到值了,例如对于 Assign 来说获取 Assign.right 这个 right 变量表达式的值可以是这样:
Object value = assign.eval(scope);

因为 assign 表达式整体的值就等于 assign.right 的值

大龙

2017-08-02 12:31

@JFinal Assign.id 如何获得?

JFinal

2017-08-02 15:43

@大龙 这倒真被挖掘出了一个新需求,刚刚已经为 Assign 添加了 getId()、getIndex()、getRight() 三个方法,新版本已经提交至 git:https://git.oschina.net/jfinal/jfinal

JFinal

2017-08-02 15:45

@guang 刚刚还看到一个问题,Kv kv = Kv.create() 这个属性需要挪到 exec() 方法里面去创建,因为模板中的指令节点是一次性建好以后,多线程重用的,所以需要保持线程安全

大龙

2017-08-02 15:53

@JFinal 手动点赞

JFinal

2017-08-02 15:59

@大龙 jfinal 的很多打磨与改进就是这样发生的,大家的应用场景千变万化,只有通过大家的反馈,才能让项目变得越来越好,这就是为啥这个频道叫“反馈”不叫“问答”的根本原因

感谢你的反馈 ^_^

北流家园网

2017-08-03 06:51

@JFinal 怎么是src源码的?怎么下载jar?

guang

2017-08-03 16:55

@JFinal 多谢提醒

JFinal

2017-08-03 16:55

@guang 最重要就是 Kv 的创建,其它的都好说

海哥

2017-08-04 10:04

@JFinal 现在支持 #articlelist(channelid=10,pagenumber=1,pagesize=10) 这样赋值了?我记得3.1是不可以, 我是通过一个map来赋值的。

例如:
#articlelist({channelid=10,pagenumber=1,pagesize=10})

JFinal

2017-08-04 11:57

@海哥 传参是不限制表达式的, 你可以为参数传入赋值表达式,这个从来都是支持的

楼主的代码是想在扩展指令中知道传入的参数名称是什么,而不是通过约定的方式限定参数名是什么

jfinal 3.2 已经添加了 Assign.getId() 方法,这样就可以在扩展指令中通过 assign.getId() 知道传入的形参名是啥了

烂苹果

2017-11-12 09:41

还要修改jfinal框架的源码,不好吧??

guang

2017-11-22 16:38

@烂苹果 不用改了。新版本jfinal已经改过了

小松

2018-01-12 10:46

大神,我想问一下如果标签里的参数是动态的该怎么弄了?#articlelist(channelid=10,pagenumber=1,pagesize=10)

热门分享

扫码入社