自定义Realm

doGetAuthenticationInfo
身份验证,主要是在登录时的逻辑处理。
doGetAuthorizationInfo
登录认证成功后,赋予用户角色与权限。
用户进行权限验证时,shiro会去缓存中找,如果查不到数据,会执行 doGetAuthorizationInfo 这个方法去查权限,并放入缓存中。

Shiro配置类

基础配置

自定义过滤器,并存入 filterMap

  1. // 自定义过滤器
  2. Map<String, Filter> filtersMap = new LinkedHashMap<>();
  3. // 定义过滤器名称 【注:map里面key值对于的value要为authc才能使用自定义的过滤器】
  4. filtersMap.put( "zqPerms", new MyPermissionsAuthorizationFilter() );
  5. filtersMap.put( "zqRoles", new MyRolesAuthorizationFilter() );
  6. filtersMap.put( "token", new TokenCheckFilter() );
  7. shiroFilterFactoryBean.setFilters(filtersMap);

身份验证器

新建自定义Realm对象,并通过 @Bean 注入Spring容器,交由Spring容器管理。

  1. /**
  2. * 身份验证器
  3. */
  4. @Bean
  5. public ShiroRealm shiroRealm() {
  6. ShiroRealm shiroRealm = new ShiroRealm();
  7. shiroRealm.setCredentialsMatcher(hashedCredentialsMatcher());
  8. return shiroRealm;
  9. }

安全管理器

自定义session管理、自定义Cache管理、自定义Realm验证

  1. /**
  2. * 安全管理器
  3. */
  4. @Bean
  5. public SecurityManager securityManager() {
  6. DefaultWebSecurityManager securityManager = new DefaultWebSecurityManager();
  7. // 自定义session管理
  8. securityManager.setSessionManager(sessionManager());
  9. // 自定义Cache实现缓存管理
  10. securityManager.setCacheManager(cacheManager());
  11. // 自定义Realm验证
  12. securityManager.setRealm(shiroRealm());
  13. return securityManager;
  14. }

自定义Realm加密规则

  1. /**
  2. * 自定义Realm的加密规则 ->
  3. * 凭证匹配器:将密码校验交给Shiro的SimpleAuthenticationInfo进行处理,在这里做匹配配置
  4. */
  5. @Bean
  6. public HashedCredentialsMatcher hashedCredentialsMatcher() {
  7. HashedCredentialsMatcher shaCredentialsMatcher = new HashedCredentialsMatcher();
  8. // 散列算法:这里使用SHA256算法;
  9. shaCredentialsMatcher.setHashAlgorithmName(SHA256Util.HASH_ALGORITHM_NAME);
  10. // 散列的次数,比如散列两次,相当于 md5(md5(""));
  11. shaCredentialsMatcher.setHashIterations(SHA256Util.HASH_ITERATIONS);
  12. return shaCredentialsMatcher;
  13. }

完整代码

  1. @Configuration
  2. public class ShiroConfig {
  3. private final String CACHE_KEY = "shiro:cache:";
  4. private final String SESSION_KEY = "shiro:session:";
  5. /**
  6. * 默认过期时间30分钟,即在30分钟内不进行操作则清空缓存信息,页面即会提醒重新登录
  7. */
  8. private final int EXPIRE = 1800;
  9. /**
  10. * Redis配置
  11. */
  12. @Value("${redis.host}")
  13. private String host;
  14. @Value("${redis.port}")
  15. private int port;
  16. @Value("${redis.password}")
  17. private String password;
  18. /**
  19. * 开启Shiro-aop注解支持:使用代理方式所以需要开启代码支持
  20. */
  21. @Bean
  22. public AuthorizationAttributeSourceAdvisor authorizationAttributeSourceAdvisor(SecurityManager securityManager) {
  23. AuthorizationAttributeSourceAdvisor authorizationAttributeSourceAdvisor = new AuthorizationAttributeSourceAdvisor();
  24. authorizationAttributeSourceAdvisor.setSecurityManager(securityManager);
  25. return authorizationAttributeSourceAdvisor;
  26. }
  27. /**
  28. * Shiro生命周期处理器
  29. * 此方法需要用static作为修饰词,否则无法通过@Value()注解的方式获取配置文件的值
  30. *
  31. */
  32. @Bean
  33. public static LifecycleBeanPostProcessor getLifecycleBeanPostProcessor() {
  34. return new LifecycleBeanPostProcessor();
  35. }
  36. /**
  37. * Shiro基础配置
  38. */
  39. @Bean
  40. public ShiroFilterFactoryBean shiroFilterFactory(SecurityManager securityManager, ShiroServiceImpl shiroService){
  41. ShiroFilterFactoryBean shiroFilterFactoryBean = new ShiroFilterFactoryBean();
  42. shiroFilterFactoryBean.setSecurityManager(securityManager);
  43. // 自定义过滤器
  44. Map<String, Filter> filtersMap = new LinkedHashMap<>();
  45. // 定义过滤器名称 【注:map里面key值对应的value要有authc才能使用自定义的过滤器】
  46. filtersMap.put( "zqPerms", new CustomizePermissionsAuthFilter() );
  47. filtersMap.put( "zqRoles", new CustomizeRolesAuthFilter() );
  48. // filtersMap.put( "token", new TokenCheckFilter() );
  49. shiroFilterFactoryBean.setFilters(filtersMap);
  50. // 登录成功后跳转的主页面 (这里没用,前端vue控制了跳转)
  51. // shiroFilterFactoryBean.setSuccessUrl("/index");
  52. // 登录的路径: 如果你没有登录则会跳到这个页面中
  53. // 如果没有设置值则会默认跳转到工程根目录下的"/login.jsp"页面 或 "/login" 映射
  54. shiroFilterFactoryBean.setLoginUrl(Constants.LOGIN_URL);
  55. // 设置没有权限时跳转的url
  56. shiroFilterFactoryBean.setUnauthorizedUrl(Constants.UN_AUTH_URL);
  57. shiroFilterFactoryBean.setFilterChainDefinitionMap( shiroService.loadFilterChainDefinitionMap() );
  58. return shiroFilterFactoryBean;
  59. }
  60. /**
  61. * 配置Redis管理器:使用的是shiro-redis开源插件
  62. */
  63. @Bean
  64. public RedisManager redisManager() {
  65. RedisManager redisManager = new RedisManager();
  66. redisManager.setHost(host + ":" + port);
  67. redisManager.setTimeout(6000);
  68. redisManager.setPassword(password);
  69. return redisManager;
  70. }
  71. /**
  72. * 配置Cache管理器:用于往Redis存储权限和角色标识 (使用的是shiro-redis开源插件)
  73. */
  74. @Bean
  75. public RedisCacheManager cacheManager() {
  76. RedisCacheManager redisCacheManager = new RedisCacheManager();
  77. redisCacheManager.setRedisManager(redisManager());
  78. redisCacheManager.setKeyPrefix(CACHE_KEY);
  79. // 配置缓存的话要求放在session里面的实体类必须有个id标识 注:这里id为用户表中的主键,否-> 报:User must has getter for field: xx
  80. redisCacheManager.setPrincipalIdFieldName("userId");
  81. return redisCacheManager;
  82. }
  83. /**
  84. * SessionID生成器
  85. */
  86. @Bean
  87. public ShiroSessionIdGenerator sessionIdGenerator(){
  88. return new ShiroSessionIdGenerator();
  89. }
  90. /**
  91. * 配置RedisSessionDAO (使用的是shiro-redis开源插件)
  92. */
  93. @Bean
  94. public RedisSessionDAO redisSessionDAO() {
  95. RedisSessionDAO redisSessionDAO = new RedisSessionDAO();
  96. redisSessionDAO.setRedisManager(redisManager());
  97. redisSessionDAO.setSessionIdGenerator(sessionIdGenerator());
  98. redisSessionDAO.setKeyPrefix(SESSION_KEY);
  99. redisSessionDAO.setExpire(EXPIRE);
  100. return redisSessionDAO;
  101. }
  102. /**
  103. * 配置Session管理器
  104. */
  105. @Bean
  106. public SessionManager sessionManager() {
  107. SimpleCookie simpleCookie = new SimpleCookie(Constants.SHIRO_TOKEN);
  108. simpleCookie.setPath("/");
  109. simpleCookie.setHttpOnly(false);
  110. ShiroSessionManager shiroSessionManager = new ShiroSessionManager();
  111. shiroSessionManager.setSessionDAO(redisSessionDAO());
  112. return shiroSessionManager;
  113. }
  114. }

shiro动态权限处理方法

1、初始化权限信息
loadFilterChainDefinitionMap
在shiro基础配置里 shiroFilterFactory 方法里,需要调用此方法从数据库中配置所有uri权限全部加载进去,以及放行的接口和配置权限过滤器等。
2、动态刷新加载数据库中的uri权限
updatePermission
页面在新增uri路径到数据库中,也就是在配置新的权限时就可以调用此方法实现动态加载uri权限。
3、shiro动态权限加载
updatePermissionByRoleId
在分配给指定用户权限时,可以调用此方法删除shiro缓存,重新执行 doAuthizationInfo 方法授权角色和权限。

  1. @Slf4j
  2. @Service
  3. public class ShiroServiceImpl implements ShiroService {
  4. @Autowired
  5. private PermMenuService permMenuService;
  6. @Autowired
  7. private RoleService roleService;
  8. @Autowired
  9. private UserService userService;
  10. private static final String ANONYMOUS = "anon";
  11. @Override
  12. public Map<String, String> loadFilterChainDefinitionMap() {
  13. // 权限控制map
  14. Map<String, String> filterChainDefinitionMap = new LinkedHashMap<>();
  15. // 配置过滤: 不会被拦截的链接
  16. // --------------- 放行 start ---------------
  17. // 放行Swagger2页面
  18. filterChainDefinitionMap.put("/doc.html", ANONYMOUS);
  19. filterChainDefinitionMap.put("/api-docs-ext", ANONYMOUS);
  20. filterChainDefinitionMap.put("/api-docs", ANONYMOUS);
  21. filterChainDefinitionMap.put("/swagger-ui.html", ANONYMOUS);
  22. filterChainDefinitionMap.put("/swagger/**", ANONYMOUS);
  23. filterChainDefinitionMap.put("/webjars/**", ANONYMOUS);
  24. filterChainDefinitionMap.put("/swagger-resources/**", ANONYMOUS);
  25. filterChainDefinitionMap.put("/v2/**", ANONYMOUS);
  26. filterChainDefinitionMap.put("/static/**", ANONYMOUS);
  27. // 登录
  28. filterChainDefinitionMap.put("/open/auth/api/**", ANONYMOUS);
  29. // 退出
  30. filterChainDefinitionMap.put(Constants.LOGIN_URL, ANONYMOUS);
  31. // 放行未授权接口,重定向使用
  32. filterChainDefinitionMap.put(Constants.UN_AUTH_URL, ANONYMOUS);
  33. // token过期接口
  34. filterChainDefinitionMap.put(Constants.TOKEN_EXPIRED_URL, ANONYMOUS);
  35. // 被挤下线
  36. filterChainDefinitionMap.put(Constants.DOWN_LINE_URL, ANONYMOUS);
  37. // --------------- 放行 end --------------------
  38. // 从数据库或缓存中查找出来的url与resources对应则不会被拦截,放行
  39. List<PermMenuPo> permList = permMenuService.selectList(null);
  40. if (!CollectionUtils.isEmpty(permList)) {
  41. permList.forEach(perm -> {
  42. if (StringUtils.isNotBlank(perm.getApiPath())) {
  43. // 根据url查询相关联的角色名,拼接自定义的角色权限
  44. List<RoleVo> roleList = roleService.queryByPermId(perm.getPermId());
  45. StringJoiner zqRoles = new StringJoiner(",", "zqRoles[", "]");
  46. if (!CollectionUtils.isEmpty(roleList)) {
  47. roleList.forEach(role -> {
  48. zqRoles.add(role.getRoleId());
  49. });
  50. }
  51. // 注意过滤器配置顺序不能颠倒
  52. // (1) 认证登录
  53. // (2) 认证自定义的token过滤器 - 判断token是否有效
  54. // (3) 角色权限 zqRoles: 自定义的只需要满足其中一个角色即可访问
  55. // roles[admin, guest] : 默认需要每个参数满足才算通过,相当于hasAllRoles()方法
  56. // (4) 操作权限 zqPerms: 认证自定义的url过滤器拦截权限
  57. // filterChainDefinitionMap.put(perm.getApiPath(), "authc,token," + zqRoles.toString() + ",zqPerms[" + perm.getPermId() + "]");
  58. filterChainDefinitionMap.put(perm.getApiPath(), "authc," + zqRoles.toString() + ",zqPerms[" + perm.getResource() + "]");
  59. // filterChainDefinitionMap.put("/api/system/user/listPage", "authc,token,zqPerms[user1]"); // 写死的一种用法
  60. }
  61. });
  62. }
  63. // (5) 认证登录
  64. filterChainDefinitionMap.put("/**", "authc");
  65. return filterChainDefinitionMap;
  66. }
  67. @Override
  68. public void updatePermission(ShiroFilterFactoryBean shiroFilterFactoryBean, String roleId, Boolean isRemoveSession) {
  69. synchronized (this) {
  70. AbstractShiroFilter shiroFilter;
  71. try {
  72. shiroFilter = (AbstractShiroFilter) shiroFilterFactoryBean.getObject();
  73. } catch (Exception e) {
  74. e.printStackTrace();
  75. log.error("get ShiroFilter from shiroFilterFactoryBean error!");
  76. return;
  77. }
  78. PathMatchingFilterChainResolver filterChainResolver = (PathMatchingFilterChainResolver) shiroFilter.getFilterChainResolver();
  79. DefaultFilterChainManager manager = (DefaultFilterChainManager) filterChainResolver.getFilterChainManager();
  80. // 清空拦截管理器中的存储
  81. manager.getFilterChains().clear();
  82. // 清空拦截工厂中的存储,如果不清空这里,还会把之前的带进去
  83. // ps:如果仅仅是更新的话,可以根据这里的 map 遍历数据修改,重新整理好权限再一起添加
  84. shiroFilterFactoryBean.getFilterChainDefinitionMap().clear();
  85. // 动态查询数据库中所有权限
  86. shiroFilterFactoryBean.setFilterChainDefinitionMap(loadFilterChainDefinitionMap());
  87. // 重新构建生成拦截
  88. Map<String, String> chains = shiroFilterFactoryBean.getFilterChainDefinitionMap();
  89. for (Map.Entry<String, String> entry : chains.entrySet()) {
  90. manager.createChain(entry.getKey(), entry.getValue());
  91. }
  92. log.info("--------------- 动态生成url权限成功!------------------");
  93. // 动态更新该角色关联的用户shiro权限
  94. if (roleId != null) {
  95. updatePermissionByRoleId(roleId, isRemoveSession);
  96. }
  97. }
  98. }
  99. @Override
  100. public void updatePermissionByRoleId(String roleId, Boolean isRemoveSession) {
  101. // 查询当前角色的shiro缓存信息 -> 实现动态权限
  102. List<UserVo> userList = userService.queryByRoleId(roleId);
  103. // 删除当前角色关联的用户缓存信息,用户再次访问接口时会重新授权, isRemoveSession为true时删除Session->即强制用户退出
  104. if (!CollectionUtils.isEmpty(userList)) {
  105. for (UserVo user : userList) {
  106. ShiroUtils.deleteCache(user.getUserAccount(), isRemoveSession);
  107. }
  108. }
  109. log.info("------------------ 动态修改用户权限成功! ------------------");
  110. }
  111. @Override
  112. public void updatePermissionByUserId(String userId, Boolean isRemoveSession) {
  113. UserPo userPo = userService.selectById(userId);
  114. ShiroUtils.deleteCache(userPo.getUserAccount(), isRemoveSession);
  115. log.info("------------------ 动态修改用户权限成功! ------------------");
  116. }
  117. @Override
  118. public void updatePermissionByUserId(List<String> userIdList, Boolean isRemoveSession) {
  119. List<UserPo> userPoList = userService.selectBatchIds(userIdList);
  120. if (!userPoList.isEmpty()) {
  121. for (UserPo userPo : userPoList) {
  122. ShiroUtils.deleteCache(userPo.getUserAccount(), isRemoveSession);
  123. }
  124. }
  125. log.info("------------------ 动态修改用户权限成功! ------------------");
  126. }
  127. }

Shiro工具类

  1. public class ShiroUtils {
  2. /** 私有构造器 **/
  3. private ShiroUtils(){ }
  4. private static RedisSessionDAO redisSessionDAO = SpringUtil.getBean(RedisSessionDAO.class);
  5. /**
  6. * 获取当前用户Session
  7. * @Return SysUserEntity 用户信息
  8. */
  9. public static Session getSession() {
  10. return SecurityUtils.getSubject().getSession();
  11. }
  12. /**
  13. * 用户登出
  14. */
  15. public static void logout() {
  16. SecurityUtils.getSubject().logout();
  17. }
  18. /**
  19. * 获取当前用户信息
  20. * @Return SysUserEntity 用户信息
  21. */
  22. public static User getUserInfo() {
  23. return (User) SecurityUtils.getSubject().getPrincipal();
  24. }
  25. /**
  26. * 删除用户缓存信息
  27. * @Param username 用户名称
  28. * @Param isRemoveSession 是否删除Session,删除后用户需重新登录
  29. */
  30. public static void deleteCache(String username, boolean isRemoveSession){
  31. //从缓存中获取Session
  32. Session session = null;
  33. // 获取当前已登录的用户session列表
  34. Collection<Session> sessions = redisSessionDAO.getActiveSessions();
  35. User sysUserEntity;
  36. Object attribute = null;
  37. // 遍历Session,找到该用户名称对应的Session
  38. for(Session sessionInfo : sessions){
  39. attribute = sessionInfo.getAttribute(DefaultSubjectContext.PRINCIPALS_SESSION_KEY);
  40. if (attribute == null) {
  41. continue;
  42. }
  43. sysUserEntity = (User) ((SimplePrincipalCollection) attribute).getPrimaryPrincipal();
  44. if (sysUserEntity == null) {
  45. continue;
  46. }
  47. if (Objects.equals(sysUserEntity.getUsername(), username)) {
  48. session=sessionInfo;
  49. // 清除该用户以前登录时保存的session,强制退出 -> 单用户登录处理
  50. if (isRemoveSession) {
  51. redisSessionDAO.delete(session);
  52. }
  53. }
  54. }
  55. if (session == null||attribute == null) {
  56. return;
  57. }
  58. //删除session
  59. if (isRemoveSession) {
  60. redisSessionDAO.delete(session);
  61. }
  62. //删除Cache,再访问受限接口时会重新授权
  63. DefaultWebSecurityManager securityManager = (DefaultWebSecurityManager) SecurityUtils.getSecurityManager();
  64. Authenticator authc = securityManager.getAuthenticator();
  65. ((LogoutAware) authc).onLogout((SimplePrincipalCollection) attribute);
  66. }
  67. /**
  68. * 从缓存中获取指定用户名的Session
  69. * @param username
  70. */
  71. private static Session getSessionByUsername(String username){
  72. // 获取当前已登录的用户session列表
  73. Collection<Session> sessions = redisSessionDAO.getActiveSessions();
  74. User user;
  75. Object attribute;
  76. // 遍历Session,找到该用户名称对应的Session
  77. for(Session session : sessions){
  78. attribute = session.getAttribute(DefaultSubjectContext.PRINCIPALS_SESSION_KEY);
  79. if (attribute == null) {
  80. continue;
  81. }
  82. user = (User) ((SimplePrincipalCollection) attribute).getPrimaryPrincipal();
  83. if (user == null) {
  84. continue;
  85. }
  86. if (Objects.equals(user.getUsername(), username)) {
  87. return session;
  88. }
  89. }
  90. return null;
  91. }
  92. }