个人公众号: MarkerHub,网站: https://markerhub.com更多精选文章请点击:Java笔记大全.md前端
有源码的教程,不会的同窗下载源码,根据教程学一下哈~java
做者:Sans_juejin.im/post/5d087d605188256de9779e64mysql
Shiro 是一个安全框架, 项目中主要用它作认证, 受权, 加密, 以及用户的会话管理, 虽然 Shiro 没有 SpringSecurity 功能更丰富, 可是它轻量, 简单, 在项目中一般业务需求 Shiro 也都能胜任.react
数据表 (SQL 文件在项目中): 数据库中测试号的密码进行了加密, 密码皆为 123456git
Maven 依赖以下:github
<dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <scope>runtime</scope> </dependency> <!-- AOP依赖,必定要加,不然权限拦截验证不生效 --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-aop</artifactId> </dependency> <!-- lombok插件 --> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <optional>true</optional> </dependency> <!-- Redis --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-redis-reactive</artifactId> </dependency> <!-- mybatisPlus 核心库 --> <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>3.1.0</version> </dependency> <!-- 引入阿里数据库链接池 --> <dependency> <groupId>com.alibaba</groupId> <artifactId>druid</artifactId> <version>1.1.6</version> </dependency> <!-- Shiro 核心依赖 --> <dependency> <groupId>org.apache.shiro</groupId> <artifactId>shiro-spring</artifactId> <version>1.4.0</version> </dependency> <!-- Shiro-redis插件 --> <dependency> <groupId>org.crazycake</groupId> <artifactId>shiro-redis</artifactId> <version>3.1.0</version> </dependency> <!-- StringUitlS工具 --> <dependency> <groupId>org.apache.commons</groupId> <artifactId>commons-lang3</artifactId> <version>3.5</version> </dependency> </dependencies>
配置以下:web
# 配置端口 server: port: 8764 spring: # 配置数据源 datasource: driver-class-name: com.mysql.cj.jdbc.Driver url: jdbc:mysql://localhost:3306/my_shiro?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8&zeroDateTimeBehavior=convertToNull&useSSL=false username: root password: root type: com.alibaba.druid.pool.DruidDataSource # Redis数据源 redis: host: localhost port: 6379 timeout: 6000 password: 123456 jedis: pool: max-active: 1000 # 链接池最大链接数(使用负值表示没有限制) max-wait: -1 # 链接池最大阻塞等待时间(使用负值表示没有限制) max-idle: 10 # 链接池中的最大空闲链接 min-idle: 5 # 链接池中的最小空闲链接 # mybatis-plus相关配置 mybatis-plus: # xml扫描,多个目录用逗号或者分号分隔(告诉 Mapper 所对应的 XML 文件位置) mapper-locations: classpath:mapper/*.xml # 如下配置均有默认值,能够不设置 global-config: db-config: #主键类型 AUTO:"数据库ID自增" INPUT:"用户输入ID",ID_WORKER:"全局惟一ID (数字类型惟一ID)", UUID:"全局惟一ID UUID"; id-type: auto #字段策略 IGNORED:"忽略判断" NOT_NULL:"非 NULL 判断") NOT_EMPTY:"非空判断" field-strategy: NOT_EMPTY #数据库类型 db-type: MYSQL configuration: # 是否开启自动驼峰命名规则映射:从数据库列名到Java属性驼峰命名的相似映射 map-underscore-to-camel-case: true # 若是查询结果中包含空值的列,则 MyBatis 在映射的时候,不会映射这个字段 call-setters-on-nulls: true # 这个配置会将执行的sql打印出来,在开发或测试的时候能够用 log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
用户实体, Dao,Service 等在这里省略, 请参考源码redis
编写 Exception 类来处理 Shiro 权限拦截异常算法
建立 SHA256Util 加密工具spring
建立 Spring 工具
/** * @Description Spring上下文工具类 * @Author Sans * @CreateTime 2019/6/17 13:40 */ @Component public class SpringUtil implements ApplicationContextAware { private static ApplicationContext context; /** * Spring在bean初始化后会判断是否是ApplicationContextAware的子类 * 若是该类是,setApplicationContext()方法,会将容器中ApplicationContext做为参数传入进去 * @Author Sans * @CreateTime 2019/6/17 16:58 */ @Override public void setApplicationContext(ApplicationContext applicationContext) throws BeansException { context = applicationContext; } /** * 经过Name返回指定的Bean * @Author Sans * @CreateTime 2019/6/17 16:03 */ public static <T> T getBean(Class<T> beanClass) { return context.getBean(beanClass); } }
建立 Shiro 工具
/** * @Description Shiro工具类 * @Author Sans * @CreateTime 2019/6/15 16:11 */ public class ShiroUtils { /** 私有构造器 **/ private ShiroUtils(){} private static RedisSessionDAO redisSessionDAO = SpringUtil.getBean(RedisSessionDAO.class); /** * 获取当前用户Session * @Author Sans * @CreateTime 2019/6/17 17:03 * @Return SysUserEntity 用户信息 */ public static Session getSession() { return SecurityUtils.getSubject().getSession(); } /** * 用户登出 * @Author Sans * @CreateTime 2019/6/17 17:23 */ public static void logout() { SecurityUtils.getSubject().logout(); } /** * 获取当前用户信息 * @Author Sans * @CreateTime 2019/6/17 17:03 * @Return SysUserEntity 用户信息 */ public static SysUserEntity getUserInfo() { return (SysUserEntity) SecurityUtils.getSubject().getPrincipal(); } /** * 删除用户缓存信息 * @Author Sans * @CreateTime 2019/6/17 13:57 * @Param username 用户名称 * @Param isRemoveSession 是否删除Session * @Return void */ public static void deleteCache(String username, boolean isRemoveSession){ //从缓存中获取Session Session session = null; Collection<Session> sessions = redisSessionDAO.getActiveSessions(); SysUserEntity sysUserEntity; Object attribute = null; for(Session sessionInfo : sessions){ //遍历Session,找到该用户名称对应的Session attribute = sessionInfo.getAttribute(DefaultSubjectContext.PRINCIPALS_SESSION_KEY); if (attribute == null) { continue; } sysUserEntity = (SysUserEntity) ((SimplePrincipalCollection) attribute).getPrimaryPrincipal(); if (sysUserEntity == null) { continue; } if (Objects.equals(sysUserEntity.getUsername(), username)) { session=sessionInfo; } } if (session == null||attribute == null) { return; } //删除session if (isRemoveSession) { redisSessionDAO.delete(session); } //删除Cache,在访问受限接口时会从新受权 DefaultWebSecurityManager securityManager = (DefaultWebSecurityManager) SecurityUtils.getSecurityManager(); Authenticator authc = securityManager.getAuthenticator(); ((LogoutAware) authc).onLogout((SimplePrincipalCollection) attribute); } }
建立 Shiro 的 SessionId 生成器
建立 Realm 用于受权和认证
/** * @Description Shiro权限匹配和帐号密码匹配 * @Author Sans * @CreateTime 2019/6/15 11:27 */ public class ShiroRealm extends AuthorizingRealm { @Autowired private SysUserService sysUserService; @Autowired private SysRoleService sysRoleService; @Autowired private SysMenuService sysMenuService; /** * 受权权限 * 用户进行权限验证时候Shiro会去缓存中找,若是查不到数据,会执行这个方法去查权限,并放入缓存中 * @Author Sans * @CreateTime 2019/6/12 11:44 */ @Override protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principalCollection) { SimpleAuthorizationInfo authorizationInfo = new SimpleAuthorizationInfo(); SysUserEntity sysUserEntity = (SysUserEntity) principalCollection.getPrimaryPrincipal(); //获取用户ID Long userId =sysUserEntity.getUserId(); //这里能够进行受权和处理 Set<String> rolesSet = new HashSet<>(); Set<String> permsSet = new HashSet<>(); //查询角色和权限(这里根据业务自行查询) List<SysRoleEntity> sysRoleEntityList = sysRoleService.selectSysRoleByUserId(userId); for (SysRoleEntity sysRoleEntity:sysRoleEntityList) { rolesSet.add(sysRoleEntity.getRoleName()); List<SysMenuEntity> sysMenuEntityList = sysMenuService.selectSysMenuByRoleId(sysRoleEntity.getRoleId()); for (SysMenuEntity sysMenuEntity :sysMenuEntityList) { permsSet.add(sysMenuEntity.getPerms()); } } //将查到的权限和角色分别传入authorizationInfo中 authorizationInfo.setStringPermissions(permsSet); authorizationInfo.setRoles(rolesSet); return authorizationInfo; } /** * 身份认证 * @Author Sans * @CreateTime 2019/6/12 12:36 */ @Override protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken authenticationToken) throws AuthenticationException { //获取用户的输入的帐号. String username = (String) authenticationToken.getPrincipal(); //经过username从数据库中查找 User对象,若是找到进行验证 //实际项目中,这里能够根据实际状况作缓存,若是不作,Shiro本身也是有时间间隔机制,2分钟内不会重复执行该方法 SysUserEntity user = sysUserService.selectUserByName(username); //判断帐号是否存在 if (user == null) { throw new AuthenticationException(); } //判断帐号是否被冻结 if (user.getState()==null||user.getState().equals("PROHIBIT")){ throw new LockedAccountException(); } //进行验证 SimpleAuthenticationInfo authenticationInfo = new SimpleAuthenticationInfo( user, //用户名 user.getPassword(), //密码 ByteSource.Util.bytes(user.getSalt()), //设置盐值 getName() ); //验证成功开始踢人(清除缓存和Session) ShiroUtils.deleteCache(username,true); return authenticationInfo; } }
建立 SessionManager 类
建立 ShiroConfig 配置类
/** * @Description Shiro配置类 * @Author Sans * @CreateTime 2019/6/10 17:42 */ @Configuration public class ShiroConfig { private final String CACHE_KEY = "shiro:cache:"; private final String SESSION_KEY = "shiro:session:"; private final int EXPIRE = 1800; //Redis配置 @Value("${spring.redis.host}") private String host; @Value("${spring.redis.port}") private int port; @Value("${spring.redis.timeout}") private int timeout; @Value("${spring.redis.password}") private String password; /** * 开启Shiro-aop注解支持 * @Attention 使用代理方式因此须要开启代码支持 * @Author Sans * @CreateTime 2019/6/12 8:38 */ @Bean public AuthorizationAttributeSourceAdvisor authorizationAttributeSourceAdvisor(SecurityManager securityManager) { AuthorizationAttributeSourceAdvisor authorizationAttributeSourceAdvisor = new AuthorizationAttributeSourceAdvisor(); authorizationAttributeSourceAdvisor.setSecurityManager(securityManager); return authorizationAttributeSourceAdvisor; } /** * Shiro基础配置 * @Author Sans * @CreateTime 2019/6/12 8:42 */ @Bean public ShiroFilterFactoryBean shiroFilterFactory(SecurityManager securityManager){ ShiroFilterFactoryBean shiroFilterFactoryBean = new ShiroFilterFactoryBean(); shiroFilterFactoryBean.setSecurityManager(securityManager); Map<String, String> filterChainDefinitionMap = new LinkedHashMap<>(); // 注意过滤器配置顺序不能颠倒 // 配置过滤:不会被拦截的连接 filterChainDefinitionMap.put("/static/**", "anon"); filterChainDefinitionMap.put("/userLogin/**", "anon"); filterChainDefinitionMap.put("/**", "authc"); // 配置shiro默认登陆界面地址,先后端分离中登陆界面跳转应由前端路由控制,后台仅返回json数据 shiroFilterFactoryBean.setLoginUrl("/userLogin/unauth"); shiroFilterFactoryBean.setFilterChainDefinitionMap(filterChainDefinitionMap); return shiroFilterFactoryBean; } /** * 安全管理器 * @Author Sans * @CreateTime 2019/6/12 10:34 */ @Bean public SecurityManager securityManager() { DefaultWebSecurityManager securityManager = new DefaultWebSecurityManager(); // 自定义Ssession管理 securityManager.setSessionManager(sessionManager()); // 自定义Cache实现 securityManager.setCacheManager(cacheManager()); // 自定义Realm验证 securityManager.setRealm(shiroRealm()); return securityManager; } /** * 身份验证器 * @Author Sans * @CreateTime 2019/6/12 10:37 */ @Bean public ShiroRealm shiroRealm() { ShiroRealm shiroRealm = new ShiroRealm(); shiroRealm.setCredentialsMatcher(hashedCredentialsMatcher()); return shiroRealm; } /** * 凭证匹配器 * 将密码校验交给Shiro的SimpleAuthenticationInfo进行处理,在这里作匹配配置 * @Author Sans * @CreateTime 2019/6/12 10:48 */ @Bean public HashedCredentialsMatcher hashedCredentialsMatcher() { HashedCredentialsMatcher shaCredentialsMatcher = new HashedCredentialsMatcher(); // 散列算法:这里使用SHA256算法; shaCredentialsMatcher.setHashAlgorithmName(SHA256Util.HASH_ALGORITHM_NAME); // 散列的次数,好比散列两次,至关于 md5(md5("")); shaCredentialsMatcher.setHashIterations(SHA256Util.HASH_ITERATIONS); return shaCredentialsMatcher; } /** * 配置Redis管理器 * @Attention 使用的是shiro-redis开源插件 * @Author Sans * @CreateTime 2019/6/12 11:06 */ @Bean public RedisManager redisManager() { RedisManager redisManager = new RedisManager(); redisManager.setHost(host); redisManager.setPort(port); redisManager.setTimeout(timeout); redisManager.setPassword(password); return redisManager; } /** * 配置Cache管理器 * 用于往Redis存储权限和角色标识 * @Attention 使用的是shiro-redis开源插件 * @Author Sans * @CreateTime 2019/6/12 12:37 */ @Bean public RedisCacheManager cacheManager() { RedisCacheManager redisCacheManager = new RedisCacheManager(); redisCacheManager.setRedisManager(redisManager()); redisCacheManager.setKeyPrefix(CACHE_KEY); // 配置缓存的话要求放在session里面的实体类必须有个id标识 redisCacheManager.setPrincipalIdFieldName("userId"); return redisCacheManager; } /** * SessionID生成器 * @Author Sans * @CreateTime 2019/6/12 13:12 */ @Bean public ShiroSessionIdGenerator sessionIdGenerator(){ return new ShiroSessionIdGenerator(); } /** * 配置RedisSessionDAO * @Attention 使用的是shiro-redis开源插件 * @Author Sans * @CreateTime 2019/6/12 13:44 */ @Bean public RedisSessionDAO redisSessionDAO() { RedisSessionDAO redisSessionDAO = new RedisSessionDAO(); redisSessionDAO.setRedisManager(redisManager()); redisSessionDAO.setSessionIdGenerator(sessionIdGenerator()); redisSessionDAO.setKeyPrefix(SESSION_KEY); redisSessionDAO.setExpire(expire); return redisSessionDAO; } /** * 配置Session管理器 * @Author Sans * @CreateTime 2019/6/12 14:25 */ @Bean public SessionManager sessionManager() { ShiroSessionManager shiroSessionManager = new ShiroSessionManager(); shiroSessionManager.setSessionDAO(redisSessionDAO()); return shiroSessionManager; } }
Shiro 能够用代码或者注解来控制权限, 一般咱们使用注解控制, 不只简单方便, 并且更加灵活. Shiro 注解一共有五个:
通常状况下咱们在项目中作权限控制, 使用最多的是 RequiresPermissions 和 RequiresRoles, 容许存在多个角色和权限, 默认逻辑是 AND, 也就是同时拥有这些才能够访问方法, 能够在注解中以参数的形式设置成 OR
示例
使用顺序: Shiro 注解是存在顺序的, 当多个注解在一个方法上的时候, 会逐个检查, 知道所有经过为止, 默认拦截顺序是: RequiresRoles->RequiresPermissions->RequiresAuthentication->
RequiresUser->RequiresGuest
示例
建立 UserRoleController 角色拦截测试类
/** * @Description 角色测试 * @Author Sans * @CreateTime 2019/6/19 11:38 */ @RestController @RequestMapping("/role") public class UserRoleController { @Autowired private SysUserService sysUserService; @Autowired private SysRoleService sysRoleService; @Autowired private SysMenuService sysMenuService; @Autowired private SysRoleMenuService sysRoleMenuService; /** * 管理员角色测试接口 * @Author Sans * @CreateTime 2019/6/19 10:38 * @Return Map<String,Object> 返回结果 */ @RequestMapping("/getAdminInfo") @RequiresRoles("ADMIN") public Map<String,Object> getAdminInfo(){ Map<String,Object> map = new HashMap<>(); map.put("code",200); map.put("msg","这里是只有管理员角色能访问的接口"); return map; } /** * 用户角色测试接口 * @Author Sans * @CreateTime 2019/6/19 10:38 * @Return Map<String,Object> 返回结果 */ @RequestMapping("/getUserInfo") @RequiresRoles("USER") public Map<String,Object> getUserInfo(){ Map<String,Object> map = new HashMap<>(); map.put("code",200); map.put("msg","这里是只有用户角色能访问的接口"); return map; } /** * 角色测试接口 * @Author Sans * @CreateTime 2019/6/19 10:38 * @Return Map<String,Object> 返回结果 */ @RequestMapping("/getRoleInfo") @RequiresRoles(value={"ADMIN","USER"},logical = Logical.OR) @RequiresUser public Map<String,Object> getRoleInfo(){ Map<String,Object> map = new HashMap<>(); map.put("code",200); map.put("msg","这里是只要有ADMIN或者USER角色能访问的接口"); return map; } /** * 登出(测试登出) * @Author Sans * @CreateTime 2019/6/19 10:38 * @Return Map<String,Object> 返回结果 */ @RequestMapping("/getLogout") @RequiresUser public Map<String,Object> getLogout(){ ShiroUtils.logout(); Map<String,Object> map = new HashMap<>(); map.put("code",200); map.put("msg","登出"); return map; } }
建立 UserMenuController 权限拦截测试类
/** * @Description 权限测试 * @Author Sans * @CreateTime 2019/6/19 11:38 */ @RestController @RequestMapping("/menu") public class UserMenuController { @Autowired private SysUserService sysUserService; @Autowired private SysRoleService sysRoleService; @Autowired private SysMenuService sysMenuService; @Autowired private SysRoleMenuService sysRoleMenuService; /** * 获取用户信息集合 * @Author Sans * @CreateTime 2019/6/19 10:36 * @Return Map<String,Object> 返回结果 */ @RequestMapping("/getUserInfoList") @RequiresPermissions("sys:user:info") public Map<String,Object> getUserInfoList(){ Map<String,Object> map = new HashMap<>(); List<SysUserEntity> sysUserEntityList = sysUserService.list(); map.put("sysUserEntityList",sysUserEntityList); return map; } /** * 获取角色信息集合 * @Author Sans * @CreateTime 2019/6/19 10:37 * @Return Map<String,Object> 返回结果 */ @RequestMapping("/getRoleInfoList") @RequiresPermissions("sys:role:info") public Map<String,Object> getRoleInfoList(){ Map<String,Object> map = new HashMap<>(); List<SysRoleEntity> sysRoleEntityList = sysRoleService.list(); map.put("sysRoleEntityList",sysRoleEntityList); return map; } /** * 获取权限信息集合 * @Author Sans * @CreateTime 2019/6/19 10:38 * @Return Map<String,Object> 返回结果 */ @RequestMapping("/getMenuInfoList") @RequiresPermissions("sys:menu:info") public Map<String,Object> getMenuInfoList(){ Map<String,Object> map = new HashMap<>(); List<SysMenuEntity> sysMenuEntityList = sysMenuService.list(); map.put("sysMenuEntityList",sysMenuEntityList); return map; } /** * 获取全部数据 * @Author Sans * @CreateTime 2019/6/19 10:38 * @Return Map<String,Object> 返回结果 */ @RequestMapping("/getInfoAll") @RequiresPermissions("sys:info:all") public Map<String,Object> getInfoAll(){ Map<String,Object> map = new HashMap<>(); List<SysUserEntity> sysUserEntityList = sysUserService.list(); map.put("sysUserEntityList",sysUserEntityList); List<SysRoleEntity> sysRoleEntityList = sysRoleService.list(); map.put("sysRoleEntityList",sysRoleEntityList); List<SysMenuEntity> sysMenuEntityList = sysMenuService.list(); map.put("sysMenuEntityList",sysMenuEntityList); return map; } /** * 添加管理员角色权限(测试动态权限更新) * @Author Sans * @CreateTime 2019/6/19 10:39 * @Param username 用户ID * @Return Map<String,Object> 返回结果 */ @RequestMapping("/addMenu") public Map<String,Object> addMenu(){ //添加管理员角色权限 SysRoleMenuEntity sysRoleMenuEntity = new SysRoleMenuEntity(); sysRoleMenuEntity.setMenuId(4L); sysRoleMenuEntity.setRoleId(1L); sysRoleMenuService.save(sysRoleMenuEntity); //清除缓存 String username = "admin"; ShiroUtils.deleteCache(username,false); Map<String,Object> map = new HashMap<>(); map.put("code",200); map.put("msg","权限添加成功"); return map; } }
建立 UserLoginController 登陆类
/** * @Description 用户登陆 * @Author Sans * @CreateTime 2019/6/17 15:21 */ @RestController @RequestMapping("/userLogin") public class UserLoginController { @Autowired private SysUserService sysUserService; /** * 登陆 * @Author Sans * @CreateTime 2019/6/20 9:21 */ @RequestMapping("/login") public Map<String,Object> login(@RequestBody SysUserEntity sysUserEntity){ Map<String,Object> map = new HashMap<>(); //进行身份验证 try{ //验证身份和登录 Subject subject = SecurityUtils.getSubject(); UsernamePasswordToken token = new UsernamePasswordToken(sysUserEntity.getUsername(), sysUserEntity.getPassword()); //验证成功进行登陆操做 subject.login(token); }catch (IncorrectCredentialsException e) { map.put("code",500); map.put("msg","用户不存在或者密码错误"); return map; } catch (LockedAccountException e) { map.put("code",500); map.put("msg","登陆失败,该用户已被冻结"); return map; } catch (AuthenticationException e) { map.put("code",500); map.put("msg","该用户不存在"); return map; } catch (Exception e) { map.put("code",500); map.put("msg","未知异常"); return map; } map.put("code",0); map.put("msg","登陆成功"); map.put("token",ShiroUtils.getSession().getId().toString()); return map; } /** * 未登陆 * @Author Sans * @CreateTime 2019/6/20 9:22 */ @RequestMapping("/unauth") public Map<String,Object> unauth(){ Map<String,Object> map = new HashMap<>(); map.put("code",500); map.put("msg","未登陆"); return map; } }
登陆成功后会返回 TOKEN, 由于是单点登陆, 再次登录的话会返回新的 TOKEN, 以前 Redis 的 TOKEN 就会失效了
当第一次访问接口后咱们能够看到缓存中已经有权限数据了, 在次访问接口的时候, Shiro 会直接去缓存中拿取权限, 注意访问接口时候要设置请求头.
ADMIN 这个号如今没有 sys:info:all 这个权限的, 因此没法访问 getInfoAll 接口, 咱们要动态分配权限后, 要清掉缓存, 在访问接口时候, Shiro 会去从新执行受权方法, 以后再次把权限和角色数据放入缓存中
访问添加权限测试接口, 由于是测试, 我把增长权限的用户 ADMIN 写死在里面了, 权限添加后, 调用工具类清掉缓存, 咱们能够发现, Redis 中已经没有缓存了
再次访问 getInfoAll 接口, 由于缓存中没有数据, Shiro 会从新受权查询权限, 拦截经过
https://gitee.com/liselotte/s...
(完)