16. Guice

Shiro Guice 集成是在 Shiro 1.2 添加的。 这个页面覆盖了 Shiro 融入 基于 Guice 的应用程序使用标准方法 Guice 的约定和机制。 阅读这个集成文档之前,你应该至少有点熟悉 Guice。

Overview 概述

shiro-guice 提供了三个 Guice 模块可以包含在您的应用程序。

  • ShiroModule
    • 提供基本的集成设置 SecurityManager ,任何 Realms 和任何其他配置 Shiro。
    • 使用这个模块通过扩展它并添加您自己的自定义配置。
  • ShiroWebModule
    • 的延伸 ShiroModule 设置网络环境,还允许过滤器链配置。 这使用 Guice Servlet Module 配置过滤器,因此要求设置。
    • 就像 ShiroModule 使用这个模块,通过扩展它并添加您自己的自定义配置。
  • ShiroAopModule
    • 使用 Guice AOP 实现Shiro AOP 注释。 这个模块主要是关心适应Shiro AnnotationMethodInterceptors 到 Guice 方法拦截器模型。
    • 通常使用这个模块通过简单地安装它。 然而,如果你有你自己的 Shiro AnnotationMethodInterceptors ,他们可以很容易地注册通过扩展它。

Getting Started 开始

最简单的配置是扩展 ShiroModule 安装您自己的 Realm 。

  1.  class MyShiroModule extends ShiroModule {
  2.         protected void configureShiro() {
  3.             try {
  4.                 bindRealm().toConstructor(IniRealm.class.getConstructor(Ini.class));
  5.             } catch (NoSuchMethodException e) {
  6.                 addError(e);
  7.             }
  8.         }
  10.         @Provides
  11.         Ini loadShiroIni() {
  12.             return Ini.fromResourcePath("classpath:shiro.ini");
  13.         }
  14.     }

在这种情况下,会在用户和角色配置 shiro.ini 文件。

Shiro.ini 使用 Guice

重要的是要注意,在上面的配置,只有 用户 和 角色 部分使用ini文件。

然后,Guice 模块是用来创建一个注射器,注射器是用来获得一个 SecurityManager 。 下面的例子具有同样目的的前三行 快速入门 的例子。

  1.  Injector injector = Guice.createInjector(new MyShiroModule());
  2.  SecurityManager securityManager = injector.getInstance(SecurityManager.class);
  3.  SecurityUtils.setSecurityManager(securityManager);

AOP

Shiro 包括几个注释和执行授权对于通过 AOP 方法拦截器非常有用。 它还提供了一个简单的 API 编写 Shiro-specific 方法拦截器。 shiro-guice 支持这个的 ShiroAopModule 。

要使用它,只需实例化并安装模块和应用程序模块和你 ShiroModule 。

  1. Injector injector = Guice.createInjector(new MyShiroModule(), new ShiroAopModule(), new MyApplicationModule());

如果你有写自定义拦截器,符合 Shiro 的 api,您可能会发现它有用的扩展 ShiroAopModule 。

  1. class MyShiroAopModule extends ShiroAopModule {
  2.         protected void configureInterceptors(AnnotationResolver resolver)
  3.         {
  4.             bindShiroInterceptor(new MyCustomAnnotationMethodInterceptor(resolver));
  5.         }

Web

shiro-guice 的网络集成设计集成 Shiro 及其过滤范式与 Guice servlet 模块。 如果您正在使用 Shiro 在 web 环境中,并使用 Guice servlet 模块,那么你应该延长 ShiroWebModule 而不是 ShiroModule。 你的网络。 xml 应该设置 Guice servlet 模块的建议。

  1.  class MyShiroWebModule extends ShiroWebModule {
  2.         MyShiroWebModule(ServletContext sc) {
  3.             super(sc);
  4.         }
  6.         protected void configureShiroWeb() {
  7.             try {
  8.                 bindRealm().toConstructor(IniRealm.class.getConstructor(Ini.class));
  9.             } catch (NoSuchMethodException e) {
  10.                 addError(e);
  11.             }
  13.             addFilterChain("/public/**", ANON);
  14.             addFilterChain("/stuff/allowed/**", AUTHC_BASIC, config(PERMS, "yes"));
  15.             addFilterChain("/stuff/forbidden/**", AUTHC_BASIC, config(PERMS, "no"));
  16.             addFilterChain("/**", AUTHC_BASIC);
  17.         }
  19.         @Provides
  20.         Ini loadShiroIni() {
  21.             return Ini.fromResourcePath("classpath:shiro.ini");
  22.         }
  23.     }

在前面的代码中,我们已经绑定的 IniRealm 和设置四个过滤器链。 这些链相当于以下 ini 配置。

  1. [urls]
  2. /public/** = anon
  3. /stuff/allowed/** = authcBasic, perms["yes"]
  4. /stuff/forbidden/** = authcBasic, perms["no"]
  5. /** = authcBasic

shiro-guice,过滤器名称 Guice 的钥匙。 所有可用默认的 Shiro 过滤器是常量,但是你并不仅限于这些。 为了使用一个自定义过滤器过滤器链,你要做的事情

  1. Key customFilter = Key.get(MyCustomFilter.class);
  3. addFilterChain("/custom/**", customFilter);

我们仍然需要告诉 guice-servlets Shiro 过滤器。 自 ShiroWebModule 是私人的,guice-servlets 不给我们揭露一个过滤器映射的方法,我们必须手动绑定它。

  1. ShiroWebModule.guiceFilterModule()

或者,在一个应用程序模块,

  1. ShiroWebModule.bindGuiceFilter(binder())

Properties 属性

许多 Shiro 类暴露通过 setter 方法配置参数。 shiro-guice 注入这些如果找到一个绑定 @Named(“shiro.{propName}”)。 例如,设置会话超时,你可以做以下的事情。

  1. bindConstant().annotatedWith(Names.named("shiro.globalSessionTimeout")).to(30000L);

如果这个范式对你不起作用,你也可以考虑使用提供者直接实例化对象和调用setter。

Injection of Shiro Objects 注入对象

shiro-guice 使用 Guice TypeListener 对本地执行注射 Shiro 类(类的子目录 org.apache.shiro 但不是 org.apache.shiro.guice )。 然而, Guice 只考虑显式绑定类型作为候选人 TypeListeners ,所以如果你有一 个Shiro 对象,你想要注射,你必须显式声明它。 例如,设置 credentialsmatcher 领域,我们需要添加以下绑定:

  1.   bind(CredentialsMatcher.class).to(HashedCredentialsMatcher.class);
  2.   bind(HashedCredentialsMatcher.class);
  3.   bindConstant().annotatedWith(Names.named("shiro.hashAlgorithmName")).to(Md5Hash.ALGORITHM_NAME);

为文档加把手

我们希望这篇文档可以帮助你使用 Apache Shiro 进行工作，社区一直在不断地完善和扩展文档，如果你希望帮助 Shiro 项目，请在你认为需要的地方考虑更正、扩展或添加文档，你提供的任何点滴帮助都将扩充社区并且提升 Shiro。

提供你的文档的最简单的途径是将它发送到用户论坛或邮件列表

译者注：如果对本中文翻译有疑议的或发现勘误欢迎指正，点此提问。