在velocity使用toolbox.xml

柔光的暖阳◎ 2022-08-04 16:50 143阅读 0赞

首先必须在web.xml中添加：   
<init-param>   
<param-name>org.apache.velocity.toolbox</param-name>   
<param-value>/WEB-INF/toolbox.xml</param-value>        
</init-param>   
才可以使用toolbox.xml中定义的变量。   
  
举例说明用法   
比如我要使用日期，可以如下定义：   
<toolbox>   
<tool>   
   <key>date</key>   
   <scope>application</scope>   
   <class>org.apache.velocity.tools.generic.DateTool</class>   
   <parameter name="format" value="yyyy-M-d"/>   
</tool>   
</toolbox>   
这里DateTool是velocity为我们预定义的工具类，还有很多其他工具类（比如：MathTool，ListTool，SortTool...）  
date是这个类的实例，这样我们就可以在.vm中使用$date来引用DateTool中的方法了，如  $date.get('yyyy-M-d H:m:s')   
  
如果我们要使用自己的类，只需要把org.apache.velocity.tools.generic.DateTool这部分替换成自己定义的类，然后再初始化该类的实例，比如<key>class</key>   
在.vm中这样用$class.getXXX()   
  
toolbox.xml典型配置：

Java代码   ![收藏代码][icon_star.png]

1.  <?xml version="1.0" encoding="UTF-8"?>  
2.    
9.    
10. <toolbox>  
11.   
12.       
17.     <tool>  
18.         <key>date</key>  
19.         <scope>application</scope>  
20.         <**class**>org.apache.velocity.tools.generic.DateTool</**class**>  
21.     </tool>  
22.       
23.       
28.     <tool>  
29.         <key>math</key>  
30.         <scope>application</scope>  
31.         <**class**>org.apache.velocity.tools.generic.MathTool</**class**>  
32.     </tool>  
33.       
34.       
38.     <tool>  
39.         <key>number</key>  
40.         <scope>application</scope>  
41.         <**class**>org.apache.velocity.tools.generic.NumberTool</**class**>  
42.     </tool>  
43.       
44.       
54.       
55.       
59.     <tool>  
60.         <key>esc</key>  
61.         <scope>application</scope>  
62.         <**class**>org.apache.velocity.tools.generic.EscapeTool</**class**>  
63.     </tool>  
64.       
65.       
75.       
76.       
81.     <tool>  
82.         <key>alternator</key>  
83.         <scope>application</scope>  
84.         <**class**>org.apache.velocity.tools.generic.AlternatorTool</**class**>  
85.     </tool>  
86.       
87.       
92.     <tool>  
93.         <key>parser</key>  
94.         <scope>application</scope>  
95.         <**class**>org.apache.velocity.tools.generic.ValueParser</**class**>  
96.     </tool>  
97.       
98.       
103.     <tool>  
104.         <key>list</key>  
105.         <scope>application</scope>  
106.         <**class**>org.apache.velocity.tools.generic.ListTool</**class**>  
107.     </tool>  
108.       
109.       
114.     <tool>  
115.         <key>sorter</key>  
116.         <scope>application</scope>  
117.         <**class**>org.apache.velocity.tools.generic.SortTool</**class**>  
118.     </tool>  
119.       
120.       
124.     <tool>  
125.         <key>mill</key>  
126.         <scope>request</scope>  
127.         <**class**>org.apache.velocity.tools.generic.IteratorTool</**class**>  
128.     </tool>  
129.           
130.   
135.       
140.     <tool>  
141.         <key>messages</key>  
142.         <scope>request</scope>  
143.         <**class**>org.apache.velocity.tools.struts.ActionMessagesTool</**class**>  
144.     </tool>  
145.       
146.       
151.     <tool>  
152.         <key>errors</key>  
153.         <scope>request</scope>  
154.         <**class**>org.apache.velocity.tools.struts.ErrorsTool</**class**>  
155.     </tool>  
156.       
157.       
162.     <tool>  
163.         <key>form</key>  
164.         <scope>request</scope>  
165.         <**class**>org.apache.velocity.tools.struts.FormTool</**class**>  
166.     </tool>  
167.       
168.       
173.     <tool>  
174.         <key>resource</key>  
175.         <scope>request</scope>  
176.         <**class**>org.apache.velocity.tools.struts.MessageTool</**class**>  
177.     </tool>  
178.       
179.       
185.     <tool>  
186.         <key>slink</key>  
187.         <scope>request</scope>  
188.         <**class**>org.apache.velocity.tools.struts.StrutsLinkTool</**class**>  
189.     </tool>  
190.       
191.       
197.     <tool>  
198.         <key>sslink</key>  
199.         <scope>request</scope>  
200.         <**class**>org.apache.velocity.tools.struts.SecureLinkTool</**class**>  
201.     </tool>  
202.       
203.       
209.     <tool>  
210.         <key>tiles</key>  
211.         <scope>request</scope>  
212.         <**class**>org.apache.velocity.tools.struts.TilesTool</**class**>  
213.     </tool>  
214.       
215.       
221.     <tool>  
222.         <key>validator</key>  
223.         <scope>request</scope>  
224.         <**class**>org.apache.velocity.tools.struts.ValidatorTool</**class**>  
225.     </tool>  
226.   
227.   
228.     <data type="string">  
229.         <scope>request</scope>  
230.         <key>app\_version</key><value>3.0</value>  
231.     </data>  
232.     <data type="string">  
233.         <scope>request</scope>  
234.         <key>app\_name</key><value>Patrasche</value>  
235.     </data>  
236.       
237.     <data type="string">  
238.         <scope>request</scope>  
239.         <key>next</key><value>/images/icon/next.jpg</value>  
240.     </data>  
241.     <data type="string">  
242.         <scope>request</scope>  
243.         <key>prev</key><value>/images/icon/prev.jpg</value>  
244.     </data>  
245.     <data type="string">  
246.         <scope>request</scope>  
247.         <key>top-page</key><value>/images/icon/top-page.jpg</value>  
248.     </data>  
249.     <data type="string">  
250.         <scope>request</scope>  
251.         <key>last-page</key><value>/images/icon/last-page.jpg</value>  
252.     </data>  
253.     <data type="string">  
254.         <scope>request</scope>  
255.         <key>pageIcon</key><value>/images/icon/page.png</value>  
256.     </data>  
257.     <data type="string">  
258.         <scope>request</scope>  
259.         <key>bookIcon</key><value>/images/icon/book.png</value>  
260.     </data>  
261.     <data type="string">  
262.         <scope>request</scope>  
263.         <key>defaultStyle</key><value>./web/**default**.css</value>  
264.     </data>  
265.     <data type="string">  
266.         <scope>request</scope>  
267.        <key>errorMetaHeader</key><value>/error/default\_header.vm</value>  
268.     </data>  
269.     <data type="string">  
270.         <scope>request</scope>  
271.         <key>errorStyle</key><value>/error/error.css</value>  
272.     </data>  
273.     <data type="string">  
274.         <scope>request</scope>  
275.         <key>detailOfHTTP</key><value>./error/detail\_HttpError.vm</value>  
276.     </data>  
277.     <data type="string">  
278.         <scope>request</scope>  
279.         <key>detailOfSERV</key><value>./error/detail\_ServerError.vm</value>  
280.     </data>  
281.     <data type="string">  
282.         <scope>request</scope>  
283.         <key>multiPart</key><value>enctype='multipart/form-data'</value>  
284.     </data>  
285.     <data type="string">  
286.         <scope>request</scope>  
287.         <key>parentMark</key><value>..</value>  
288.     </data>  
289.     <data type="string">  
290.         <scope>request</scope>  
291.         <key>chartToolTips</key><value>toolTips</value>  
292.     </data>  
293.     <data type="string">  
294.         <scope>request</scope>  
295.         <key>chartClickable</key><value>isClickable</value>  
296.     </data>  
297.       
298.       
300.     <tool>  
301.         <key>**null**</key>  
302.         <scope>application</scope>  
303.         <**class**>com.company.util.velocity.NullTool</**class**>  
304.     </tool>  
305.   
306.       
309.     <tool>  
310.         <key>words</key>  
311.         <scope>application</scope>  
312.         <**class**>com.company.util.velocity.StringTool</**class**>  
313.     </tool>  
314.       
315.       
318.     <tool>  
319.         <key>pager</key>  
320.         <scope>session</scope>  
321.         <**class**>com.company.util.velocity.PageScrollTool</**class**>  
322.     </tool>  
323.   
324.       
326.     <tool>  
327.         <key>loginuser</key>  
328.         <scope>request</scope>  
329.         <**class**>com.company.util.velocity.LoginUserTool</**class**>  
330.     </tool>  
331.   
332.       
334.     <tool>  
335.         <key>menuviewer</key>  
336.         <scope>request</scope>  
337.         <**class**>com.company.util.velocity.MenuTool</**class**>  
338.     </tool>  
339.       
340.       
343.     <tool>  
344.         <key>filesys</key>  
345.         <scope>request</scope>  
346.        <**class**>com.company.util.velocity.contrib.FileSystemTool</**class**>  
347.     </tool>  
348.       
349.       
352.     <tool>  
353.         <key>exception</key>  
354.         <scope>request</scope>  
355.         <**class**>com.company.util.velocity.ExceptionTool</**class**>  
356.     </tool>  
357.       
358.       
361.     <tool>  
362.         <key>poi</key>  
363.         <scope>request</scope>  
364.         <**class**>com.company.util.velocity.POITool</**class**>  
365.     </tool>  
366.   
367.       
370.     <tool>  
371.         <key>constant</key>  
372.         <scope>application</scope>  
373.         <**class**>com.company.Constant</**class**>  
374.     </tool>  
375.       
376. </toolbox>

[icon_star.png]: /images/20220805/a95af7f299ff4161a5f9f19c0e043ed8.png