Apache Shiro Web应用整合-标签库

╰+哭是因爲堅強的太久メ 2022-03-19 05:20 459阅读 0赞

Apache Shiro 提供了一个JSP/GSP 标签库，它允许你控制你的JSP，JSTL 或GSP 页面基于当前Subject的状态进行输出。这对于根据用户身份和当前用户的授权状态来提供个性化视图是相当有用的。

标签库的描述文件（TLD）保存在shiro-web.jar里的META-INF/shiro.tld文件。要使用任何标签，需要在你JSP 页面（或任何你定义的页面指令）的顶部添加下面一行：

<table> 
 <tbody> 
  <tr> 
   <td> <p>&lt;%@&nbsp;taglib&nbsp;prefix="shiro"&nbsp;uri="http://shiro.apache.org/tags"&nbsp;%&gt;</p> </td> 
  </tr> 
 </tbody> 
</table>

我们使用shiro 前缀用以表明shiro 标签库命名空间，当然你可以指定任何你喜欢的名字。

下面将分别介绍每一个标签，并展示它是如何用来渲染页面的。

**The guest tag**

guest 标签将显示它包含的内容，仅当当前的Subject 被认为是'guest'时。'guest'是指没有身份ID 的任何Subject。也就是说，我们并不知道用户是谁，因为他们没有登录并且他们没有在上一次的访问中被记住（RememberMe 服务）。例如：

<table> 
 <tbody> 
  <tr> 
   <td> <p>&lt;shiro:guest&gt;</p> <p>Hi&nbsp;there!&nbsp;Please&nbsp;&lt;a&nbsp;href="login.jsp"&gt;Login&lt;/a&gt;&nbsp;or&nbsp;&lt;a&nbsp;href="signup.jsp"&gt;Signup&lt;/a&gt;today!</p> <p>&lt;/shiro:guest&gt;</p> </td> 
  </tr> 
 </tbody> 
</table>

guest 标签与user 标签逻辑相反。

**The user tag**

user 标签将显示它包含的内容，仅当当前的Subject 被认为是'user'时。'user'在上下文中被定义为一个已知身份ID的Subject，或是成功通过身份验证及通过'RememberMe'服务的。请注意这个标签在语义上与authenticated 标签是不同的，authenticated 标签更为严格。例如：

<table> 
 <tbody> 
  <tr> 
   <td> <p>&lt;shiro:user&gt;</p> <p>Welcome&nbsp;back&nbsp;John!&nbsp;Not&nbsp;John?&nbsp;Click&nbsp;&lt;a&nbsp;href="login.jsp"&gt;here&lt;a&gt;&nbsp;to&nbsp;login.</p> <p>&lt;/shiro:user&gt;</p> </td> 
  </tr> 
 </tbody> 
</table>

usre 标签与guest 标签逻辑相反。

**The authenticated tag**

仅仅只当当前用户在当前会话中成功地通过了身份验证authenticated 标签才会显示包含的内容。它比'user'标签更为严格。它在逻辑上与'notAuthenticated'标签相反。

authenticated 标签只有当当前Subject 在其当前的会话中成功地通过了身份验证才会显示包含的内容。它比user 标签更为严格，authenticated 标签通常在敏感的工作流中用来确保身份ID 是可靠的。例如：

<table> 
 <tbody> 
  <tr> 
   <td> <p>&lt;shiro:authenticated&gt;</p> <p>&lt;a&nbsp;href="updateAccount.jsp"&gt;Update&nbsp;your&nbsp;contact&nbsp;information&lt;/a&gt;.</p> <p>&lt;/shiro:authenticated&gt;</p> </td> 
  </tr> 
 </tbody> 
</table>

authenticated 标签与notAuthenticated 标签逻辑相反。

**The notAuthenticated tag**

notAuthenticated 标签将会显示它所包含的内容，如果当前Subject 还没有在其当前会话中成功地通过验证。例如：

<table> 
 <tbody> 
  <tr> 
   <td> <p>&lt;shiro:notAuthenticated&gt;</p> <p>Please&nbsp;&lt;a&nbsp;href="login.jsp"&gt;login&lt;/a&gt;&nbsp;in&nbsp;order&nbsp;to&nbsp;update&nbsp;your&nbsp;credit&nbsp;card&nbsp;information.</p> <p>&lt;/shiro:notAuthenticated&gt;</p> </td> 
  </tr> 
 </tbody> 
</table>

notAuthenticated 标签与Authenticated 标签逻辑相反。

**The principal tag**

principal 标签将会输出Subject 的主体（标识属性）或主要的属性。

若没有任何标签属性，则标签将使用principal 的toString()值来呈现页面。例如（假设principal 是一个字符串的用户名）：

<table> 
 <tbody> 
  <tr> 
   <td> <p>Hello,&nbsp;&lt;shiro:principal/&gt;,&nbsp;how&nbsp;are&nbsp;you&nbsp;today?</p> </td> 
  </tr> 
 </tbody> 
</table>

这一般等价于下面：

<table> 
 <tbody> 
  <tr> 
   <td> <p>Hello,&nbsp;&lt;%=&nbsp;SecurityUtils.getSubject().getPrincipal().toString()&nbsp;%&gt;,&nbsp;how&nbsp;are&nbsp;you&nbsp;today?</p> </td> 
  </tr> 
 </tbody> 
</table>

principal 标签默认情况下，假定该principal 输出的是subject.getPrincipal()的值。但若你想输出一个不是主要principal的值，而是属于另一个Subject 的principal collection，你可以通过类型来获取该principal 并输出该值。

例如，输出Subject 的用户ID（并不是username），假设该ID 属于principal collection：

<table> 
 <tbody> 
  <tr> 
   <td> <p>User&nbsp;ID:&nbsp;&lt;principal&nbsp;type="java.lang.Integer"/&gt;</p> </td> 
  </tr> 
 </tbody> 
</table>

这一般等价于下面：

<table> 
 <tbody> 
  <tr> 
   <td> <p>User&nbsp;ID:&nbsp;&lt;%=&nbsp;SecurityUtils.getSubject().getPrincipals().oneByType(Integer.class).toString()&nbsp;%&gt;</p> </td> 
  </tr> 
 </tbody> 
</table>

但如果该principal是一个复杂的对象而不是一个简单的字符串，而且你希望引用该principal 上的一个属性该怎么办呢？你可以使用property 属性来来表示property 的名称来理解（必须通过JavaBeans 兼容的getter 方法访问）。例如（假设principal 是一个User 对象）：

<table> 
 <tbody> 
  <tr> 
   <td> <p>Hello,&nbsp;&lt;shiro:principal&nbsp;property="firstName"/&gt;,&nbsp;how&nbsp;are&nbsp;you&nbsp;today?</p> </td> 
  </tr> 
 </tbody> 
</table>

这一般等价于下面：

<table> 
 <tbody> 
  <tr> 
   <td> <p>Hello,&nbsp;&lt;%=&nbsp;SecurityUtils.getSubject().getPrincipal().getFirstName().toString()&nbsp;%&gt;,&nbsp;how&nbsp;are&nbsp;you&nbsp;today?</p> </td> 
  </tr> 
 </tbody> 
</table>

如果结合属性类型如下：

<table> 
 <tbody> 
  <tr> 
   <td> <p>Hello,&nbsp;&lt;shiro:principal&nbsp;type="com.foo.User"&nbsp;property="firstName"/&gt;,&nbsp;how&nbsp;are&nbsp;you&nbsp;today?</p> </td> 
  </tr> 
 </tbody> 
</table>

这一般等价于下面：

<table> 
 <tbody> 
  <tr> 
   <td> <p>Hello,&nbsp;&lt;%=&nbsp;SecurityUtils.getSubject().getPrincipals.oneByType(com.foo.User.class).getFirstName().toString()&nbsp;%&gt;,&nbsp;how&nbsp;are&nbsp;you&nbsp;today?</p> </td> 
  </tr> 
 </tbody> 
</table>

**The hasRole tag**

hasRole 标签将会显示它所包含的内容，仅当当前Subject 被分配了具体的角色。例如：

<table> 
 <tbody> 
  <tr> 
   <td> <p>&lt;shiro:hasRole&nbsp;name="administrator"&gt;</p> <p>&lt;a&nbsp;href="admin.jsp"&gt;Administer&nbsp;the&nbsp;system&lt;/a&gt;</p> <p>&lt;/shiro:hasRole&gt;</p> </td> 
  </tr> 
 </tbody> 
</table>

hasRole 标签与lacksRole 标签逻辑相反。

**The lacksRole tag**

lacksRole 标签将会显示它所包含的内容，仅当当前Subject 未被分配具体的角色。例如：

<table> 
 <tbody> 
  <tr> 
   <td> <p>&lt;shiro:lacksRole&nbsp;name="administrator"&gt;</p> <p>Sorry,&nbsp;you&nbsp;are&nbsp;not&nbsp;allowed&nbsp;to&nbsp;administer&nbsp;the&nbsp;system.</p> <p>&lt;/shiro:lacksRole&gt;</p> </td> 
  </tr> 
 </tbody> 
</table>

lacksRole 标签与hasRole 标签逻辑相反。

**The hasAnyRole tag**

hasAnyRole 标签将会显示它所包含的内容，如果当前的Subject 被分配了任意一个来自于逗号分隔的角色名列表中的具体角色。例如：

<table> 
 <tbody> 
  <tr> 
   <td> <p>&lt;shiro:hasAnyRole&nbsp;name="developer,&nbsp;project&nbsp;manager,&nbsp;administrator"&gt;</p> <p>You&nbsp;are&nbsp;either&nbsp;a&nbsp;developer,&nbsp;project&nbsp;manager,&nbsp;or&nbsp;administrater.</p> <p>&lt;/shiro:hasAnyRole&gt;</p> </td> 
  </tr> 
 </tbody> 
</table>

hasAnyRole 标签目前还没有与之逻辑相反的标签。

**The hasPermission tag**

hasPermission 标签将会显示它所包含的内容，仅当当前Subject“拥有”（蕴含）特定的权限。也就是说，用户具有特定的能力。例如：

<table> 
 <tbody> 
  <tr> 
   <td> <p>&lt;shiro:hasPermission&nbsp;name="user:create"&gt;</p> <p>&lt;a&nbsp;href="createUser.jsp"&gt;Create&nbsp;a&nbsp;new&nbsp;User&lt;/a&gt;</p> <p>&lt;/shiro:hasPermission&gt;</p> </td> 
  </tr> 
 </tbody> 
</table>

hasPermission 标签与lacksPermission 标签逻辑相反。

**The lacksPermission tag**

lacksPermission 标签将会显示它所包含的内容，仅当当前Subject 没有拥有（蕴含）特定的权限。也就是说，用户没有特定的能力。例如：

<table> 
 <tbody> 
  <tr> 
   <td> <p>&lt;shiro:lacksPermission&nbsp;name="user:delete"&gt;</p> <p>Sorry,&nbsp;you&nbsp;are&nbsp;not&nbsp;allowed&nbsp;to&nbsp;deleted&nbsp;user&nbsp;accounts.</p> <p>&lt;/shiro:hasPermission&gt;</p> </td> 
  </tr> 
 </tbody> 
</table>

lacksPermission 标签与hasPermission 标签逻辑相反。