Shiro InI 配置

2022-10-17 11:01 更新

INI 配置

之前章節(jié)我們已經(jīng)接觸過一些 INI 配置規(guī)則了,如果大家使用過如 Spring 之類的 IoC/DI 容器的話,Shiro 提供的 INI 配置也是非常類似的,即可以理解為是一個 IoC/DI 容器,但是區(qū)別在于它從一個根對象 securityManager 開始。

根對象 SecurityManager

從之前的 Shiro 架構(gòu)圖可以看出,Shiro 是從根對象 SecurityManager 進行身份驗證和授權(quán)的;也就是所有操作都是自它開始的,這個對象是線程安全且整個應(yīng)用只需要一個即可,因此 Shiro 提供了 SecurityUtils 讓我們綁定它為全局的,方便后續(xù)操作。

因為 Shiro 的類都是 POJO 的,因此都很容易放到任何 IoC 容器管理。但是和一般的 IoC 容器的區(qū)別在于,Shiro 從根對象 securityManager 開始導(dǎo)航;Shiro 支持的依賴注入:public 空參構(gòu)造器對象的創(chuàng)建、setter 依賴注入。

1、純 Java 代碼寫法(com.github.zhangkaitao.shiro.chapter4.NonConfigurationCreateTest):

DefaultSecurityManager securityManager = new DefaultSecurityManager();
//設(shè)置authenticator
ModularRealmAuthenticator authenticator = new ModularRealmAuthenticator();
authenticator.setAuthenticationStrategy(new AtLeastOneSuccessfulStrategy());
securityManager.setAuthenticator(authenticator);
//設(shè)置authorizer
ModularRealmAuthorizer authorizer = new ModularRealmAuthorizer();
authorizer.setPermissionResolver(new WildcardPermissionResolver());
securityManager.setAuthorizer(authorizer);
//設(shè)置Realm
DruidDataSource ds = new DruidDataSource();
ds.setDriverClassName("com.mysql.jdbc.Driver");
ds.setUrl("jdbc:mysql://localhost:3306/shiro");
ds.setUsername("root");
ds.setPassword("");
JdbcRealm jdbcRealm = new JdbcRealm();
jdbcRealm.setDataSource(ds);
jdbcRealm.setPermissionsLookupEnabled(true);
securityManager.setRealms(Arrays.asList((Realm) jdbcRealm));
//將SecurityManager設(shè)置到SecurityUtils 方便全局使用
SecurityUtils.setSecurityManager(securityManager);
Subject subject = SecurityUtils.getSubject();
UsernamePasswordToken token = new UsernamePasswordToken("zhang", "123");
subject.login(token);
Assert.assertTrue(subject.isAuthenticated());

2、等價的 INI 配置(shiro-config.ini)

[main]
\#authenticator
authenticator=org.apache.shiro.authc.pam.ModularRealmAuthenticator
authenticationStrategy=org.apache.shiro.authc.pam.AtLeastOneSuccessfulStrategy
authenticator.authenticationStrategy=$authenticationStrategy
securityManager.authenticator=$authenticator
\#authorizer
authorizer=org.apache.shiro.authz.ModularRealmAuthorizer
permissionResolver=org.apache.shiro.authz.permission.WildcardPermissionResolver
authorizer.permissionResolver=$permissionResolver
securityManager.authorizer=$authorizer
\#realm
dataSource=com.alibaba.druid.pool.DruidDataSource
dataSource.driverClassName=com.mysql.jdbc.Driver
dataSource.url=jdbc:mysql://localhost:3306/shiro
dataSource.username=root
\#dataSource.password=
jdbcRealm=org.apache.shiro.realm.jdbc.JdbcRealm
jdbcRealm.dataSource=$dataSource
jdbcRealm.permissionsLookupEnabled=true
securityManager.realms=$jdbcRealm

即使沒接觸過 IoC 容器的知識,如上配置也是很容易理解的:

  1. 對象名 = 全限定類名 相對于調(diào)用 public 無參構(gòu)造器創(chuàng)建對象
  2. 對象名. 屬性名 = 值 相當于調(diào)用 setter 方法設(shè)置常量值
  3. 對象名. 屬性名 =$ 對象引用 相當于調(diào)用 setter 方法設(shè)置對象引用

3、Java 代碼(com.github.zhangkaitao.shiro.chapter4.ConfigurationCreateTest)

Factory<org.apache.shiro.mgt.SecurityManager> factory =
         new IniSecurityManagerFactory("classpath:shiro-config.ini");
org.apache.shiro.mgt.SecurityManager securityManager = factory.getInstance();
//將SecurityManager設(shè)置到SecurityUtils 方便全局使用
SecurityUtils.setSecurityManager(securityManager);
Subject subject = SecurityUtils.getSubject();
UsernamePasswordToken token = new UsernamePasswordToken("zhang", "123");
subject.login(token);
Assert.assertTrue(subject.isAuthenticated());

如上代碼是從 Shiro INI 配置中獲取相應(yīng)的 securityManager 實例:

  1. 默認情況先創(chuàng)建一個名字為 securityManager,類型為 org.apache.shiro.mgt.DefaultSecurityManager 的默認的 SecurityManager,如果想自定義,只需要在 ini 配置文件中指定 “securityManager=SecurityManager 實現(xiàn)類” 即可,名字必須為 securityManager,它是起始的根;
  2. IniSecurityManagerFactory 是創(chuàng)建 securityManager 的工廠,其需要一個 ini 配置文件路徑,其支持 “classpath:”(類路徑)、“file:”(文件系統(tǒng))、“url:”(網(wǎng)絡(luò))三種路徑格式,默認是文件系統(tǒng);
  3. 接著獲取 SecuriyManager 實例,后續(xù)步驟和之前的一樣。

從如上可以看出 Shiro INI 配置方式本身提供了一個簡單的 IoC/DI 機制方便在配置文件配置,但是是從 securityManager 這個根對象開始導(dǎo)航。

INI 配置

ini 配置文件類似于 Java 中的 properties(key=value),不過提供了將 key/value 分類的特性,key 是每個部分不重復(fù)即可,而不是整個配置文件。如下是 INI 配置分類:

[main]
\#提供了對根對象securityManager及其依賴的配置
securityManager=org.apache.shiro.mgt.DefaultSecurityManager
…………
securityManager.realms=$jdbcRealm
[users]
\#提供了對用戶/密碼及其角色的配置,用戶名=密碼,角色1,角色2
username=password,role1,role2
[roles]
\#提供了角色及權(quán)限之間關(guān)系的配置,角色=權(quán)限1,權(quán)限2
role1=permission1,permission2
[urls]
\#用于web,提供了對web url攔截相關(guān)的配置,url=攔截器[參數(shù)],攔截器
/index.html = anon
/admin/** = authc, roles[admin], perms["permission1"]

[main] 部分

提供了對根對象 securityManager 及其依賴對象的配置。

創(chuàng)建對象

securityManager=org.apache.shiro.mgt.DefaultSecurityManager

其構(gòu)造器必須是 public 空參構(gòu)造器,通過反射創(chuàng)建相應(yīng)的實例。

常量值 setter 注入

dataSource.driverClassName=com.mysql.jdbc.Driver
jdbcRealm.permissionsLookupEnabled=true

會自動調(diào)用 jdbcRealm.setPermissionsLookupEnabled(true),對于這種常量值會自動類型轉(zhuǎn)換。

對象引用 setter 注入

authenticator=org.apache.shiro.authc.pam.ModularRealmAuthenticator
authenticationStrategy=org.apache.shiro.authc.pam.AtLeastOneSuccessfulStrategy
authenticator.authenticationStrategy=$authenticationStrategy
securityManager.authenticator=$authenticator

會自動通過 securityManager.setAuthenticator(authenticator) 注入引用依賴。

嵌套屬性 setter 注入

securityManager.authenticator.authenticationStrategy=$authenticationStrategy

也支持這種嵌套方式的 setter 注入。

byte 數(shù)組 setter 注入

\#base64 byte[]
authenticator.bytes=aGVsbG8=
\#hex byte[]
authenticator.bytes=0x68656c6c6f&nbsp;

默認需要使用 Base64 進行編碼,也可以使用 0x 十六進制。

Array/Set/List setter 注入

authenticator.array=1,2,3
authenticator.set=$jdbcRealm,$jdbcRealm

多個之間通過 “,” 分割。

Map setter 注入

authenticator.map=$jdbcRealm:$jdbcRealm,1:1,key:abc

即格式是:map=key:value,key:value,可以注入常量及引用值,常量的話都看作字符串(即使有泛型也不會自動造型)。

實例化 / 注入順序

realm=Realm1
realm=Realm12
authenticator.bytes=aGVsbG8=
authenticator.bytes=0x68656c6c6f&nbsp; 

后邊的覆蓋前邊的注入。

測試用例請參考配置文件 shiro-config-main.ini。

[users] 部分

配置用戶名 / 密碼及其角色,格式:“用戶名 = 密碼,角色 1,角色 2”,角色部分可省略。如:

[users]
zhang=123,role1,role2
wang=123

密碼一般生成其摘要 / 加密存儲,后續(xù)章節(jié)介紹。

[roles] 部分

配置角色及權(quán)限之間的關(guān)系,格式:“角色 = 權(quán)限 1,權(quán)限 2”;如:

[roles]
role1=user:create,user:update
role2=*

如果只有角色沒有對應(yīng)的權(quán)限,可以不配 roles,具體規(guī)則請參考授權(quán)章節(jié)。

[urls] 部分

配置 url 及相應(yīng)的攔截器之間的關(guān)系,格式:“url = 攔截器 [參數(shù)],攔截器 [參數(shù)],如:

[urls]
/admin/** = authc, roles[admin], perms["permission1"]

具體規(guī)則參見 web 相關(guān)章節(jié)。

以上內(nèi)容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號