qaz13177_58_

Struts-menu源码分析

好的代码读起来让人如饮醍醐，读完以后神清气爽。如果你想提高你的编程水平，如果你想提高你的设计能力，如果你也想成为大师，那么就去阅读代码吧。以本人十几年来的编程经验，阅读代码能让你得到的比阅读文章(那怕是大师的文章)得到的更多。优秀而且实用的代码有很多，比如Junit,比如Jive，比如petStore，甚至是tomcat的Example、Log4j的Example。

一段广告完毕，下面就为大家分析一下struts-menu的源码，作为送给大家的圣诞礼物吧。Struts-Menu也来自一位大师的作品， Matt Raible。有很多优秀的作品，比如使用struts和hibernate的struts-resume。官方网站是http://raibledesigns.com/wiki/Wiki.jsp?page=Main。Struts-Menu的最新版本是2.1。功能是使用struts技术，构建树形菜单。应该说是一个非常实用的技术，极大的方便了广大的开发人员。与此同时，个人认为它的作用还不止于些。比如，同时它也是一个使用Maven和velocity的一个很好的例子。

首先，我们去看一下它的效果。http://www.raibledesigns.com/struts-menu/。可以看到，如此丰富多彩的菜单效果，都是在演示一个配置文件里的内容。这是一个非常好的数据与表示相分离的实现。我们打开它的源码来看。首先看一下它的包图

共有五个包，其中menu自然是完成数据组织功能，是核心之一，displayer是显示方式包，完成数据显示大部分功能。也是核心之一。taglib意义明显。example自然是一些example。util是读取资源文件的包。因些，我们重点研究的包只有三个menu,displayer和taglib。

首先我们来看menu包的类图

首先是MenuPlugIn这个类。这个类的功能很明显，就是一个struts的plug-in。可以看到，它只有一个参数menuConfig，就是menu的配置文件路径。果然，在struts-conf文件中有这么一段

<plug-in className="net.sf.navigator.menu.MenuPlugIn">
<set-property property="menuConfig" value="/WEB-INF/menu-config.xml"/>
</plug-in>

说明配置文件来自于/WEB-INF/menu-config.xml，当然，我们可以找到相应路径下找到这个文件。如果你以前没有做过struts的plug-in，现在该知道怎么做了吧，就这么简单。通过阅读初始化函数，知道它的功能就是调用MenuRepository来建立菜单。因此。我们知道MenuRepository必然是一个组织管理管理菜单的组织类。

public void init(ActionServlet servlet, ModuleConfig config)

throws ServletException {

if (log.isDebugEnabled()) {

log.debug("Starting struts-menu initialization");

}

this.servlet = servlet;

repository = new MenuRepository();

repository.setLoadParam(menuConfig);

repository.setServlet(servlet);

try {

repository.load();

servlet.getServletContext().setAttribute(

MenuRepository.MENU_REPOSITORY_KEY,

repository);

if (log.isDebugEnabled()) {

log.debug("struts-menu initialization successfull");

}

} catch (LoadableResourceException lre) {

throw new ServletException(

"Failure initializing struts-menu: " + lre.getMessage());

}

打开MenuRepository类，我们可以看到这个类也很简单，不过已经有少可以学习的了。首先是FastHashMap，可以看到，这个类里有三个FastHashMap。顾名思议，是快速HashMap了，再看一下，它来自org.apache.commons.collections.FastHashMap;。看到org.apache.commons这个著名的包了?如果你以前从没使用过它，那么建议你花上一段时间去研究使用它，我保证物有所值。

protected FastHashMap menus = new FastHashMap();
protected FastHashMap displayers = new FastHashMap();
protected FastHashMap templates = new FastHashMap();

接下来我们看到log的定义。对了，log，调试的核心之一。而下面这一句则是commons log的最常用的使用方法。快快让你的程序使用上commons log吧，第一，它功能强大，第二，它使用简单，就是这么简单。

private Log log = LogFactory.getLog(getClass().getName());

下面看一个的函数

protected Digester initDigester() {

Digester digester = new Digester();

digester.setClassLoader(Thread.currentThread().getContextClassLoader());

digester.push(this);

//digester.setDebug(getDebug());

// 1

digester.addObjectCreate("MenuConfig/Menus/Menu",