...
The best way to explain wildcards is to show an example and walk through how it works. This example modifies a conventional mapping to use wildcards to match all pages that start with /edit:
Code Block |
---|
<!-- Generic edit* mapping --> <action name="/edit*" class="org.apache.struts.webapp.example.Edit{1}Action"> <result name="failure" path=">/mainMenu.jsp"jsp</>result> <result path="/<result>{1}.jsp"jsp</>result> </action> |
The "*" in the path name attribute allows the mapping to match the request URIs /editSubscription, editRegistration, or any other URI that starts with /edit, however /editSubscription/add would not be matched. The part of the URI matched by the wildcard will then be substituted into various attributes of the action mapping and its action results replacing {1}. For the rest of the request, the framework will see the action mapping and its action results containing the new values.
Mappings are matched against the request in the order they appear in the framework's configuration file. If more than one pattern matches the last one wins, so less specific patterns must appear before more specific ones. However, if the request URL can be matched against a path without any wildcards in it, no wildcard matching is performed and order is not important. Also, note that wildcards are not greedy, meaning they only match until the first occurrence of the following string pattern. For example, consider the following mapping:
...
* | Matches zero or more characters excluding the slash ('/') character. | ||||
** | Matches zero or more characters including the slash ('/') character. | ||||
\character | The backslash character is used as an escape sequence. Thus
matches the character asterisk ('*'), and
matches the character backslash ('\'). |
Note |
---|
Patterns can optionally be matched "loosely". When the end of the pattern matches *[^*]*$ (wildcard, no wildcard, wildcard), if the pattern fails, it is also matched as if the last two characters didn't exist. The goal is to support the legacy "*!*" syntax, where the "!*" is optional. |
In the action mapping and action results, the wildcard-matched values can be accessed with the token {N} where N is a number from 1 to 9 indicating which wildcard-matched value to substitute. The whole request URI can be accessed with the {0} token.
...
Code Block | ||
---|---|---|
| ||
<action name="/edit/*" class="org.apache.struts.webapp.example.Edit{1}Action"> <param name="id">{1}</param> <result> <result<param name="failure" path="/mainMenu.jsp"/>location">/mainMenu.jsp</param> <param name="id">{1}</param> </result> </action> |
See also Wildcard Method
...
Note |
---|
Similar functionality can also be implemented using a custom ActionMapper. The ActionMapper will need to parse the namespace and request itself to set parameters on the matched action. The default ActonMapper is responsible for invoking the PatternMatcher. |
Parameters after the action name
To use parameters in the URL, after the action name, make sure this is set:
...
Code Block | ||||
---|---|---|---|---|
| ||||
<package name="edit" extends="struts-default" namespace="/edit"> <action name="/person/*" class="org.apache.struts.webapp.example.EditAction"> <param name="id">{1}</param> <result name="failure" path="<result>/mainMenu.jsp"jsp</>result> </action> </package> |
When a URL like /edit/person/123
is requested, EditAction will be called, and its "id" field will be set to 123.
Advanced Wildcards
From 2.1.9+ regular expressions can be defined defined in the action name. To use this form of wild card, the following constants must be set:
Code Block | ||||
---|---|---|---|---|
| ||||
<constant name="struts.enable.SlashesInActionNames" value="true"/>
<constant name="struts.mapper.alwaysSelectFullNamespace" value="false"/>
<constant name="struts.patternMatcher" value="regex" />
|
The regular expressions can be in two forms, the simplest one is {FIELD_NAME}, in which case the field with the FIELD_NAME in the action will be populated with the matched text, for example:
Code Block | ||||
---|---|---|---|---|
| ||||
<package name="books" extends="struts-default" namespace="/">
<action name="/{type}/content/{title}" class="example.BookAction">
<result>/books/content.jsp</result>
</action>
</package>
|
In this example, if the url /fiction/content/Frankenstein
is requested, BookAction's field "type" will be set to "fiction", and the field "title" will be set to "Frankenstein".
The regular expression can also be in the form {FIELD_NAME:REGULAR_EXPRESSION}. The regular expression is a normal Java regular expression. For example:
Code Block | ||||
---|---|---|---|---|
| ||||
<package name="books" extends="struts-default" namespace="/"> <action name="/{type}/{author:.+}/list" class="example.ListBooksAction"> <result>/books/list.jsp</result> </action> </package> |
In this example, if the url /philosophy/AynRand/list
is requested, ListBooksAction's field "type" will be set to "philosophy" and "author" to "AynRand".
The matched groups can still be accessed using the {X} notation, like:
Code Block | ||||
---|---|---|---|---|
| ||||
<package name="books" extends="struts-default" namespace="/">
<action name="/books/{ISBN}/content" class="example.BookAction">
<result>/books/{1}.jsp</result>
</action>
</package>
|