轉載跟我學Shiro
之前章節我們已經接觸過一些INI配置規則了,如果大家使用過如Spring之類的IoC/DI容器的話,Shiro提供的INI配置也是非常類似的,即可以理解爲是一個IoC/DI容器,但是區別在於它從一個根對象securityManager開始。
一、根對象SecurityManager
從之前的Shiro架構圖可以看出,Shiro是從根對象SecurityManager進行身份驗證和授權的;也就是所有操作都是自它開始的,這個對象是線程安全且真個應用只需要一個即可,因此Shiro提供了SecurityUtils讓我們綁定它爲全局的,方便後續操作。
因爲Shiro的類都是POJO的,因此都很容易放到任何IoC容器管理。但是和一般的IoC容器的區別在於,Shiro從根對象securityManager開始導航;Shiro支持的依賴注入:public空參構造器對象的創建、setter依賴注入。
1.1 純Java代碼寫法(com.github.crystal.chapter04.NonConfigurationCreateTest)
@Test
public void test() {
DefaultSecurityManager securityManager = new DefaultSecurityManager();
//設置authenticator
ModularRealmAuthenticator authenticator = new ModularRealmAuthenticator();
authenticator.setAuthenticationStrategy(new AtLeastOneSuccessfulStrategy());
securityManager.setAuthenticator(authenticator);
//設置authorizer
ModularRealmAuthorizer authorizer = new ModularRealmAuthorizer();
authorizer.setPermissionResolver(new BitAndWildPermissionResolver());
securityManager.setAuthorizer(authorizer);
//設置realm
DruidDataSource ds = new DruidDataSource();
ds.setDriverClassName("com.mysql.jdbc.Driver");
ds.setUrl("jdbc:mysql://localhost:3306/shiro");
ds.setUsername("root");
ds.setPassword("12345");
JdbcRealm jdbc = new JdbcRealm();
jdbc.setDataSource(ds);
securityManager.setRealm(jdbc);
//將SecurityManager設置到SecurityUtils 方便全局使用
SecurityUtils.setSecurityManager(securityManager);
Subject subject = SecurityUtils.getSubject();
UsernamePasswordToken token = new UsernamePasswordToken("crystal", "123");
subject.login(token);
Assert.assertTrue(subject.isAuthenticated());
}
1.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
permissionResolver=com.github.crystal.chapter03.permission.BitAndWildPermissionResolver
authorizer.permissionResolver=$permissionResolver
securityManager.authorizer=$authorizer
#自定義realm 一定要放在securityManager.authorizer賦值之後(因爲調用setRealms會將realms設置給authorizer,並給各個Realm設置permissionResolver和rolePermissionResolver)
jdbcRealm=org.apache.shiro.realm.jdbc.JdbcRealm
dataSource=com.alibaba.druid.pool.DruidDataSource
dataSource.driverClassName=com.mysql.jdbc.Driver
dataSource.url=jdbc:mysql://localhost:3306/shiro
dataSource.username=root
dataSource.password=12345
jdbcRealm.dataSource=$dataSource
jdbcRealm.permissionsLookupEnabled=true
securityManager.realms=$jdbcRealm
即使沒接觸過IoC容器的知識,如上配置也是很容易理解的:
1、對象名=全限定類名 相對於調用public無參構造器創建對象
2、對象名.屬性名=值 相當於調用setter方法設置常量值
3、對象名.屬性名=$對象引用 相當於調用setter方法設置對象引用
2.3 Java代碼(com.github.crystal.chapter04.ConfigurationCreateTest)
@Test
public void test() {
Factory<SecurityManager> factory = new IniSecurityManagerFactory("classpath:chapter04/shiro-config.ini");
SecurityManager securityManager = factory.getInstance();
//將SecurityManager設置到SecurityUtils 方便全局使用
SecurityUtils.setSecurityManager(securityManager);
Subject subject = SecurityUtils.getSubject();
UsernamePasswordToken token = new UsernamePasswordToken("crystal", "123");
subject.login(token);
Assert.assertTrue(subject.isAuthenticated());
}
如上代碼是從Shiro INI配置中獲取相應的securityManager實例:
1、默認情況先創建一個名字爲securityManager,類型爲org.apache.shiro.mgt.DefaultSecurityManager的默認的SecurityManager,如果想自定義,只需要在ini配置文件中指定“securityManager=SecurityManager實現類”即可,名字必須爲securityManager,它是起始的根;
2、IniSecurityManagerFactory是創建securityManager的工廠,其需要一個ini配置文件路徑,其支持“classpath:”(類路徑)、“file:”(文件系統)、“url:”(網絡)三種路徑格式,默認是文件系統;
3、接着獲取SecuriyManager實例,後續步驟和之前的一樣。
從如上可以看出Shiro INI配置方式本身提供了一個簡單的IoC/DI機制方便在配置文件配置,但是是從securityManager這個根對象開始導航。
二、INI配置
ini配置文件類似於Java中的properties(key=value),不過提供了將key/value分類的特性,key是每個部分不重複即可,而不是整個配置文件。如下是INI配置分類:
[main]
#提供了對根對象securityManager及其依賴的配置
securityManager=org.apache.shiro.mgt.DefaultSecurityManager
…………
securityManager.realms=$jdbcRealm
[users]
#提供了對用戶/密碼及其角色的配置,用戶名=密碼,角色1,角色2
username=password,role1,role2
[roles]
#提供了角色及權限之間關係的配置,角色=權限1,權限2
role1=permission1,permission2
[urls]
#用於web,提供了對web url攔截相關的配置,url=攔截器[參數],攔截器
/index.html = anon
/admin/** = authc, roles[admin], perms["permission1"]
2.1 [main]部分
提供了對根對象securityManager及其依賴對象的配置。
securityManager=org.apache.shiro.mgt.DefaultSecurityManager
其構造器必須是public空參構造器,通過反射創建相應的實例。
常量值setter注入
dataSource.driverClassName=com.mysql.jdbc.Driver
jdbcRealm.permissionsLookupEnabled=true
會自動調用jdbcRealm.setPermissionsLookupEnabled(true),對於這種常量值會自動類型轉換。
對象引用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數組setter注入
#base64 byte[]
authenticator.bytes=aGVsbG8=
#hex byte[]
authenticator.bytes=0x68656c6c6f
默認需要使用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
後邊的覆蓋前邊的注入。
測試用例請參考配置文件shiro-config-main.ini。
2.2 [users]部分
配置用戶名/密碼及其角色,格式:“用戶名=密碼,角色1,角色2”,角色部分可省略。如:
[users]
zhang=123,role1,role2
wang=123
密碼一般生成其摘要/加密存儲,後續章節介紹。
2.3 [roles]部分
配置角色及權限之間的關係,格式:“角色=權限1,權限2”;如:
[roles]
role1=user:create,user:update
role2=*
如果只有角色沒有對應的權限,可以不配roles,具體規則請參考授權章節。
2.4 [urls]部分
配置url及相應的攔截器之間的關係,格式:“url=攔截器[參數],攔截器[參數],如:
[urls]
/admin/** = authc, roles[admin], perms["permission1"]
具體規則參見web相關章節。
示例代碼:shiro-learn