第四章 INI配置——《跟我學Shiro》[張開濤]

之前章節我們已經接觸過一些INI配置規則了，如果大家使用過如Spring之類的IoC/DI容器的話，Shiro提供的INI配置也是非常類似的，即可以理解爲是一個IoC/DI容器，但是區別在於它從一個根對象securityManager開始。

 

4.1 根對象SecurityManager

從之前的Shiro架構圖可以看出，Shiro是從根對象SecurityManager進行身份驗證和授權的；也就是所有操作都是自它開始的，這個對象是線程安全且真個應用只需要一個即可，因此Shiro提供了SecurityUtils讓我們綁定它爲全局的，方便後續操作。

 

因爲Shiro的類都是POJO的，因此都很容易放到任何IoC容器管理。但是和一般的IoC容器的區別在於，Shiro從根對象securityManager開始導航；Shiro支持的依賴注入：public空參構造器對象的創建、setter依賴注入。

 

1、純Java代碼寫法（com.github.zhangkaitao.shiro.chapter4.NonConfigurationCreateTest）： 

Java代碼  

1. DefaultSecurityManager securityManager = new DefaultSecurityManager();  
2. //設置authenticator  
3. ModularRealmAuthenticator authenticator = new ModularRealmAuthenticator();  
4. authenticator.setAuthenticationStrategy(new AtLeastOneSuccessfulStrategy());  
5. securityManager.setAuthenticator(authenticator);  
6.   
7. //設置authorizer  
8. ModularRealmAuthorizer authorizer = new ModularRealmAuthorizer();  
9. authorizer.setPermissionResolver(new WildcardPermissionResolver());  
10. securityManager.setAuthorizer(authorizer);  
11.   
12. //設置Realm  
13. DruidDataSource ds = new DruidDataSource();  
14. ds.setDriverClassName("com.mysql.jdbc.Driver");  
15. ds.setUrl("jdbc:mysql://localhost:3306/shiro");  
16. ds.setUsername("root");  
17. ds.setPassword("");  
18.   
19. JdbcRealm jdbcRealm = new JdbcRealm();  
20. jdbcRealm.setDataSource(ds);  
21. jdbcRealm.setPermissionsLookupEnabled(true);  
22. securityManager.setRealms(Arrays.asList((Realm) jdbcRealm));  
23.   
24. //將SecurityManager設置到SecurityUtils 方便全局使用  
25. SecurityUtils.setSecurityManager(securityManager);  
26.   
27. Subject subject = SecurityUtils.getSubject();  
28. UsernamePasswordToken token = new UsernamePasswordToken("zhang", "123");  
29. subject.login(token);  
30. Assert.assertTrue(subject.isAuthenticated());  
31.   
32.    

 

2.1、等價的INI配置（shiro-config.ini） 

Java代碼  

1. [main]  
2. #authenticator  
3. authenticator=org.apache.shiro.authc.pam.ModularRealmAuthenticator  
4. authenticationStrategy=org.apache.shiro.authc.pam.AtLeastOneSuccessfulStrategy  
5. authenticator.authenticationStrategy=$authenticationStrategy  
6. securityManager.authenticator=$authenticator  
7.   
8. #authorizer  
9. authorizer=org.apache.shiro.authz.ModularRealmAuthorizer  
10. permissionResolver=org.apache.shiro.authz.permission.WildcardPermissionResolver  
11. authorizer.permissionResolver=$permissionResolver  
12. securityManager.authorizer=$authorizer  
13.   
14. #realm  
15. dataSource=com.alibaba.druid.pool.DruidDataSource  
16. dataSource.driverClassName=com.mysql.jdbc.Driver  
17. dataSource.url=jdbc:mysql://localhost:3306/shiro  
18. dataSource.username=root  
19. #dataSource.password=  
20. jdbcRealm=org.apache.shiro.realm.jdbc.JdbcRealm  
21. jdbcRealm.dataSource=$dataSource  
22. jdbcRealm.permissionsLookupEnabled=true  
23. securityManager.realms=$jdbcRealm   

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

1、對象名=全限定類名  相對於調用public無參構造器創建對象

2、對象名.屬性名=值    相當於調用setter方法設置常量值

3、對象名.屬性名=$對象引用    相當於調用setter方法設置對象引用

 

2.2、Java代碼（com.github.zhangkaitao.shiro.chapter4.ConfigurationCreateTest） 

Java代碼  

1. Factory<org.apache.shiro.mgt.SecurityManager> factory =  
2.          new IniSecurityManagerFactory("classpath:shiro-config.ini");  
3.   
4. org.apache.shiro.mgt.SecurityManager securityManager = factory.getInstance();  
5.   
6. //將SecurityManager設置到SecurityUtils 方便全局使用  
7. SecurityUtils.setSecurityManager(securityManager);  
8. Subject subject = SecurityUtils.getSubject();  
9. UsernamePasswordToken token = new UsernamePasswordToken("zhang", "123");  
10. subject.login(token);  
11.   
12. 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這個根對象開始導航。   

 

4.2 INI配置

ini配置文件類似於Java中的properties（key=value），不過提供了將key/value分類的特性，key是每個部分不重複即可，而不是整個配置文件。如下是INI配置分類： 

Java代碼  

1. [main]  
2. #提供了對根對象securityManager及其依賴的配置  
3. securityManager=org.apache.shiro.mgt.DefaultSecurityManager  
4. …………  
5. securityManager.realms=$jdbcRealm  
6.   
7. [users]  
8. #提供了對用戶/密碼及其角色的配置，用戶名=密碼，角色1，角色2  
9. username=password,role1,role2  
10.   
11. [roles]  
12. #提供了角色及權限之間關係的配置，角色=權限1，權限2  
13. role1=permission1,permission2  
14.   
15. [urls]  
16. #用於web，提供了對web url攔截相關的配置，url=攔截器[參數]，攔截器  
17. /index.html = anon  
18. /admin/** = authc, roles[admin], perms["permission1"]  

 

[main]部分

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

創建對象 

Java代碼  

1. securityManager=org.apache.shiro.mgt.DefaultSecurityManager  

其構造器必須是public空參構造器，通過反射創建相應的實例。

 

常量值setter注入 

Java代碼  

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

會自動調用jdbcRealm.setPermissionsLookupEnabled(true)，對於這種常量值會自動類型轉換。

 

對象引用setter注入 

Java代碼  

1. authenticator=org.apache.shiro.authc.pam.ModularRealmAuthenticator  
2. authenticationStrategy=org.apache.shiro.authc.pam.AtLeastOneSuccessfulStrategy  
3. authenticator.authenticationStrategy=$authenticationStrategy  
4. securityManager.authenticator=$authenticator   

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

 

嵌套屬性setter注入 

Java代碼  

1. securityManager.authenticator.authenticationStrategy=$authenticationStrategy   

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

 

byte數組setter注入 

Java代碼  

1. #base64 byte[]  
2. authenticator.bytes=aGVsbG8=  
3. #hex byte[]  
4. authenticator.bytes=0x68656c6c6f   

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

 

Array/Set/List setter注入 

Java代碼  

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

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

 

Map setter注入

Java代碼  

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

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

 

實例化/注入順序 

Java代碼  

1. realm=Realm1  
2. realm=Realm12  
3.   
4. authenticator.bytes=aGVsbG8=  
5. authenticator.bytes=0x68656c6c6f   

後邊的覆蓋前邊的注入。

 

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

 

[users]部分

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

Java代碼  

1. [users]  
2. zhang=123,role1,role2  
3. wang=123   

密碼一般生成其摘要/加密存儲，後續章節介紹。

 

[roles]部分

配置角色及權限之間的關係，格式：“角色=權限1，權限2”；如：

Java代碼  

1. [roles]  
2. role1=user:create,user:update  
3. role2=*   

如果只有角色沒有對應的權限，可以不配roles，具體規則請參考授權章節。

 

[urls]部分

配置url及相應的攔截器之間的關係，格式：“url=攔截器[參數]，攔截器[參數]，如：  

Java代碼  

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

具體規則參見web相關章節。 

 

示例源代碼：https://github.com/zhangkaitao/shiro-example；可加羣134755960探討Spring/Shiro技術。