jeecms 2012源码分析（五）-----标签的配置流程

标签的配置流程，以cms_content_list为例
首先，每一个标签的声明都是在jeecms-context.xml中进行的，
<?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-lazy-init="true">
……
<bean id="cms_content_list" class="com.jeecms.cms.action.directive.ContentListDirective"/>(声明标签对应的类)
<bean id="staticPageSvc" class="com.jeecms.cms.staticpage.StaticPageSvcImpl">
<property name="freeMarkerConfigurer">
<bean class="org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer">
<property name="freemarkerVariables">
<map>
……
<entry key="cms_content_list" value-ref="cms_content_list"/>
……
</map>
</property>
<property name="templateLoaderPath" value=""/>
……
</bean>
</property>
</bean>
</beans>
此外，在配置文件jeecms-servlet-front.xml中，还有一段对标签的配置
<bean id="freemarkerConfig" class="org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer">
<property name="freemarkerVariables">
<map>
……
<entry key="cms_content_list" value-ref="cms_content_list"/>
……
   </map>
</property>
         ……
</bean>

</bean>类ContentListDirective继承自AbstractContentDirective，最主要的是execute方法
public class ContentListDirective extends AbstractContentDirective {
/**
 * 模板名称
 */
public static final String TPL_NAME = "content_list";

/**
 * 输入参数，文章ID。允许多个文章ID，用","分开。排斥其他所有筛选参数。
 */
public static final String PARAM_IDS = "ids";

@SuppressWarnings("unchecked")
public void execute(Environment env, Map params, TemplateModel[] loopVars,
TemplateDirectiveBody body) throws TemplateException, IOException {
//获取站点
CmsSite site = FrontUtils.getSite(env);
//获取内容列表，可以通过此处进行更改，获取自己数据库中的数据
List<Content> list = getList(params, env);

Map<String, TemplateModel> paramWrap = new HashMap<String, TemplateModel>(
params);
//OUT_LIST值为tag_list，在类DirectiveUtils中声明，将内容列表放入其中
paramWrap.put(OUT_LIST, DEFAULT_WRAPPER.wrap(list));
//将params的值复制到variable中
Map<String, TemplateModel> origMap = DirectiveUtils
.addParamsToVariable(env, paramWrap);
//获取的是参数PARAM_TPL，是否调用模板以及调用的模板类型
InvokeType type = DirectiveUtils.getInvokeType(params);
//获取传入参数，列表样式，根据不同的参数获取不同的样式列表
String listStyle = DirectiveUtils.getString(PARAM_STYLE_LIST, params);
if (InvokeType.sysDefined == type) {
if (StringUtils.isBlank(listStyle)) {
throw new ParamsRequiredException(PARAM_STYLE_LIST);
}
//列表样式模板
env.include(TPL_STYLE_LIST + listStyle + TPL_SUFFIX, UTF8, true);
} else if (InvokeType.userDefined == type) {
if (StringUtils.isBlank(listStyle)) {
throw new ParamsRequiredException(PARAM_STYLE_LIST);
}
//列表样式模板路径 WEB-INF\t\cms_sys_defined\style_list\style_2-1.html
FrontUtils.includeTpl(TPL_STYLE_LIST, site, env);
} else if (InvokeType.custom == type) {
//这个模板就是自己声明的，即content_list.html，如果采用自定义模板的话，页面中可以只写上标签，并添加上标签内需要的几个参数，不需要写标签体的内容，会去自动调用模板中的标签体。
FrontUtils.includeTpl(TPL_NAME, site, params, env);
} else if (InvokeType.body == type) {
body.render(env.getOut());
} else {
throw new RuntimeException("invoke type not handled: " + type);
}
//将variable中的params值移除
DirectiveUtils.removeParamsFromVariable(env, paramWrap, origMap);
}

@SuppressWarnings("unchecked")
protected List<Content> getList(Map<String, TemplateModel> params,
Environment env) throws TemplateException {
Integer[] ids = DirectiveUtils.getIntArray(PARAM_IDS, params);
if (ids != null) {
//根据内容ID数组获取文章列表
return contentMng.getListByIdsForTag(ids, getOrderBy(params));
} else {
return (List<Content>) super.getData(params, env);
}
}

@Override
protected boolean isPage() {
return false;
}
}

Content_list.html中的内容
[#list tag_list as a]
<li><a href="${a.url}" target="_blank">${a.title}</a></li>
[/#list]
就是简单的将tag_list中的内容，即“paramWrap.put(OUT_LIST, DEFAULT_WRAPPER.wrap(list));”中放入的数据遍历出来

style_2-1.html中的内容 主要是对图文列表或标题列表向上滚动的样式的，其中包含两个同样为样式的文件
style_2-1_core.html(图文列表或标题列表向上滚动)和style_1-1_core.html(图文列表或标题列表向上滚动)，在此就不做赘述了。

Jeecms是基于Spring注解，在自定义标签时对于实体类和dao service等注意注解的问题。

下面是我自己定义的标签mycontent_list的实现过程

首先，在数据库里创建了一个jc_mycontent的表，其中有id,title,content三个字段
其次，创建了一个实体类
public class MyContent {
private static final long serialVersionUID = 1L;
private Integer id;
private String title;
private String content;
public MyContent () {
super();
}
……get set方法
}
接下来是配置hibernate中jc_mycontent表的配置文件
<?xml version="1.0"?>
<!DOCTYPE hibernate-mapping PUBLIC "-//Hibernate/Hibernate Mapping DTD//EN" "http://hibernate.sourceforge.net/hibernate-mapping-3.0.dtd">
<hibernate-mapping package="com.jeecms.cms.entity.main">
<class name="MyContent" table="jc_mycontent">
<meta attribute="sync-DAO">false</meta>
<cache usage="read-write"/>
<id name="id" type="java.lang.Integer" column="id"><generator class="identity"/></id>
<property name="title" column="title" type="java.lang.String" not-null="true" />
<property name="content" column="content" type="java.lang.String" not-null="true" />
</class>
</hibernate-mapping>

与数据库交互的持久层接口
public interface MyContentDao {
public List<MyContent> getList();
}
持久层实现类
@Repository//持久层
public class MyContentDaoImpl extends HibernateBaseDao<MyContent, Integer>
implements MyContentDao {
@SuppressWarnings("unchecked")
public List<MyContent> getList(){
return find(byNothing());
}
private Finder byNothing(){
Finder f = Finder.create();
f.append("from MyContent");//可以在此处添加查询条件或者添加各种方法进行动态查询
f.setCacheable(true);
return f;
}

@Override
protected Class<MyContent> getEntityClass() {
return MyContent.class;
}
}
业务层接口
public interface MyContentMng {
public List<MyContent> getList();
}
业务层实现类
@Service//业务层
@Transactional
public class MyContentMngImpl implements MyContentMng {

@Transactional(readOnly = true)//配置事务为只读
public List<MyContent> getList(){
return myContentDao.getList();
}
private MyContentDao myContentDao;
@Autowired//自动绑定
public void setMyContentDao(MyContentDao myContentDao) {
this.myContentDao = myContentDao;
}
private List<ContentListener> listenerList;
@Autowired
public void setListenerList(List<ContentListener> listenerList) {
this.listenerList = listenerList;
}
}
标签类的抽象类，最主要的就是getData这个方法，以及绑定业务层，其中可以添加多种查询方法。可参考类AbstractContentDirective
public abstract class AbstractMyContentDirective implements
TemplateDirectiveModel {
protected Object getData(Map<String, TemplateModel> params, Environment env)
throws TemplateException {
return myContentMng.getList();
}
@Autowired
protected MyContentMng myContentMng;
}
自定义标签中最重要的类继承上边的抽象类
public class MyContentListDirective extends AbstractMyContentDirective {
/**
 * 模板名称
 */

public static final String TPL_NAME = "mycontent_list";

public static final String MYOUT_LIST = " mytag_list";

@SuppressWarnings("unchecked")
public void execute(Environment env, Map params, TemplateModel[] loopVars,
TemplateDirectiveBody body) throws TemplateException, IOException {
//获取站点
CmsSite site = FrontUtils.getSite(env);
//获取内容列表
List<MyContent> list = getList(params, env);
Map<String, TemplateModel> paramWrap = new HashMap<String, TemplateModel>(params);
//OUT_LIST值为tag_list，将内容列表放入其中
paramWrap.put(MYOUT_LIST, DEFAULT_WRAPPER.wrap(list));
//将params的值复制到variable中
Map<String, TemplateModel> origMap = DirectiveUtils.addParamsToVariable(env, paramWrap);
//没有采用默认的模板，直接采用自己写的简单的模板（mycontent_list.html）
FrontUtils.includeTpl(TPL_NAME, site, params, env);
//将variable中的params值移除
DirectiveUtils.removeParamsFromVariable(env, paramWrap, origMap);
}
protected List<MyContent> getList(Map<String, TemplateModel> params,
Environment env) throws TemplateException {
return myContentMng.getList();
}
}
样式模板mycontent_list.html内容,里边可以自己添加一些样式(放在WEB-INF\t\cms\www\red\tag文件夹下），可参考\t\cms_sys_defined\style_list下样式文件
[#list mytag_list as a]
<li><a href="${a.title}"><font color='blue'>"${a.content}"</font></a></li>
[/#list]

首页里加入如下代码
[@cms_mycontent_list]
   <ul class="topnews">
   </ul>
[/@cms_mycontent_list]

通过以上这些代码，可以实现将自己的表jc_mycontent中的数据查询并显示在页面上

（不要忘记配置文件将自己的dao  service   和标签的配置上。。）

................

<bean id="myContentDao" class="com.jeecms.cms.dao.main.impl.MyContentDaoImpl"/>

    <bean id="myContentMng" class="com.jeecms.cms.manager.main.impl.MyContentMngImpl"/>

......................

<bean id="cms_mycontent_list" class="com.jeecms.cms.action.directive.MyContentListDirective"/>

.................................

<bean class="org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer">
                <property name="freemarkerVariables">
                    <map>
              ..........
                        
                        <entry key="cms_mycontent_list" value-ref="cms_mycontent_list"/>
                        ....
                    </map>