1. Overview
Struts Menu应用是一个JSP标记的集合,支持从XML文件生成各种不同菜单系统。Struts Menu 2.0进行了重构,使用Velocity Templates定义菜单。
2. User Guide
2.1. 从1.x迁移到2.x
要从Struts Menu1.x升级到2.x,需要做如下改变:
l 修改标记库声明的URI,去掉“1.2”
<%@ taglib uri="http://struts-menu.sf.net/tag" prefix="menu" %>
l 修改<plug-in>,使用新的包名“net.sf.navigator”
<plug-in className="net.sf.navigator.menu.MenuPlugIn">
l 修改menu-config.xml文件,使用新的包名“net.sf.navigator”
<Displayer name="Simple" type="net.sf.navigator.displayer.SimpleMenuDisplayer"/>
2.2. 快速启动
l 下载struts-menu分发包
l 解压缩到本地目录
l 下载并安装Tomcat或其它Java Servlet容器
l 将struts-menu.war文件拷贝到Tomcat服务器的webapps目录下,启动服务器
l 浏览http://localhost:8080/struts-menu
2.3. 将Struts Menu集成到应用中
Struts Menu可以很方便得集成到Struts应用中,也将能够集成到其它非struts的应用中。下面是继承标记库的步骤。
你所需要做的就是将struts-menu.jar文件拷贝到WEB-INF/lib目录下,并在JSP页面中使用标记的URI以声明标记库。
对于Struts Menu 2.1,还需要将Jakarta的Standard Tag Library Jar拷贝到WEB-INF/lib目录下。
l 将struts-menu.jar文件拷贝到WEB-INF/lib目录下
l 在struts-config.xml文件中添加<plug-in>设置
<plug-in className="net.sf.navigator.menu.MenuPlugIn">
<set-property property="menuConfig" value="/WEB-INF/menu-config.xml"/>
</plug-in>
l 在WEB-INF/menu-config.xml文件中声明菜单属性。下面是一个示例:
<Menu name="contactMenu" title="Contact" location="?Contact">
<Item name="email" title="E-Mail" location="?EMail"/>
<Item name="phone" title="Phone" location="?Phone"/>
</Menu>
详细情况请参考例子应用的WEB-INF目录下的menu-config.xml文件,并修改该文件以适应自己的应用。如果要了解所有相关属性,请参考MenuBase类的标准文档。
l 在JSP页面中添加标记库的声明
<%@ taglib uri="http://struts-menu.sf.net/tag" prefix="menu" %>
l 在JSP页面中添加标记库代码以生成菜单
<menu:useMenuDisplayer name="TabbedMenu"
bundle="org.apache.struts.action.MESSAGE">
<menu:displayMenu name="Home"/>
<menu:displayMenu name="About"/>
</menu:useMenuDisplayer>
其中,name="TabbedMenu"是在menu-config.xml文件中定义的。如下:
<Displayer name="TabbedMenu" type="net.sf.navigator.displayer.TabbedMenuDisplayer"/>
要使用可定制的Velocity模板生成菜单,需要将Velocity集成到web应用中。具体步骤如下:
l 确保menu-config.xml文件有如下定义:
<Displayer name="Velocity" type="net.sf.navigator.displayer.VelocityMenuDisplayer"/>
l 将Velocity的相关jar文件拷贝到WEB-INF/lib目录下
l 将globalMacros.vm文件添加到WEB-INF/classes目录下
l 在JSP页面中,修改为name="Velocity",并将config属性指到一个文件(如config="/templates/tabs.html"),如果文件在WEB-INF/classes目录下,就是config="tabs.html"。
3. FAQ
3.1. 在使用菜单访问JSP时抛出异常:
org.apache.jasper.JasperException: Could not obtain the menu repository
解决方法:
检查struts-config.xml文件,确保添加如下plug-in设置
<plug-in className="net.sf.navigator.menu.MenuPlugIn">
<set-property property="menuConfig" value="/WEB-INF/menu-config.xml"/>
</plug-in>
<!-- The menuConfig property is an optional attribute. It is set to /WEB-INF/menu-config.xml by default. -->
3.2. 如何基于角色隐藏/显示菜单项
先在JSP页面中添加属性permissions="rolesAdapter"到<menu:useMenuDisplayer>标记中;然后在menu-config.xml文件中加入允许看到此菜单项的角色列表,角色之间以逗号分隔。