美文网首页互联网科技Java 杂谈微服务架构和实践
教你 Shiro 整合 SpringBoot,避开各种坑

教你 Shiro 整合 SpringBoot,避开各种坑

作者: Java黎先生 | 来源:发表于2018-09-20 21:40 被阅读43次

    最近搞了下 Shiro 安全框架,找了一些网上的博客文章,但是一到自己实现的时候就遇到了各种坑,需要各种查资料看源码以及各种测试。 那么这篇文章就教大家如何将 Shiro 整合到 SpringBoot 中,并避开一些小坑,这次实现了基本的登陆以及角色权限。

    附上源码:github.com/HowieYuan/s…

    依赖包

    org.apache.shiroshiro-spring1.3.2复制代码

    数据库表

    一切从简,用户 user 表,以及角色 role 表

    Shiro 相关类

    Shiro 配置类

    @Configurationpublicclass ShiroConfig { @BeanpublicShiroFilterFactoryBean shirFilter(SecurityManager securityManager) { ShiroFilterFactoryBean shiroFilterFactoryBean =newShiroFilterFactoryBean();// 必须设置 SecurityManagershiroFilterFactoryBean.setSecurityManager(securityManager);// setLoginUrl 如果不设置值,默认会自动寻找Web工程根目录下的"/login.jsp"页面 或 "/login" 映射shiroFilterFactoryBean.setLoginUrl("/notLogin");// 设置无权限时跳转的 url;shiroFilterFactoryBean.setUnauthorizedUrl("/notRole");// 设置拦截器Map filterChainDefinitionMap =newLinkedHashMap<>();//游客,开发权限filterChainDefinitionMap.put("/guest/**","anon");//用户,需要角色权限 “user”filterChainDefinitionMap.put("/user/**","roles[user]");//管理员,需要角色权限 “admin”filterChainDefinitionMap.put("/admin/**","roles[admin]");//开放登陆接口filterChainDefinitionMap.put("/login","anon");//其余接口一律拦截//主要这行代码必须放在所有权限设置的最后,不然会导致所有 url 都被拦截filterChainDefinitionMap.put("/**","authc"); shiroFilterFactoryBean.setFilterChainDefinitionMap(filterChainDefinitionMap); System.out.println("Shiro拦截器工厂类注入成功");returnshiroFilterFactoryBean; }/**

    * 注入 securityManager

    */@BeanpublicSecurityManager securityManager() { DefaultWebSecurityManager securityManager =newDefaultWebSecurityManager();// 设置realm.securityManager.setRealm(customRealm());returnsecurityManager; }/**

    * 自定义身份认证 realm;

    * <p>

    * 必须写这个类,并加上 @Bean 注解,目的是注入 CustomRealm,

    * 否则会影响 CustomRealm类 中其他类的依赖注入

    */@BeanpublicCustomRealm customRealm() {returnnewCustomRealm(); }}

    注意:里面的 SecurityManager 类导入的应该是 import org.apache.shiro.mgt.SecurityManager; 但是,如果你是复制代码过来的话,会默认导入 java.lang.SecurityManager 这里也稍稍有点坑,其他的类的话,也是都属于 shiro 包里面的类

    shirFilter 方法中主要是设置了一些重要的跳转 url,比如未登陆时,无权限时的跳转;以及设置了各类 url 的权限拦截,比如 /user 开始的 url 需要 user 权限,/admin 开始的 url 需要 admin 权限等

    权限拦截 Filter

    当运行一个Web应用程序时,Shiro将会创建一些有用的默认 Filter 实例,并自动地将它们置为可用,而这些默认的 Filter 实例是被 DefaultFilter 枚举类定义的,当然我们也可以自定义 Filter 实例,这些在以后的文章中会讲到

    Filter解释anon无参,开放权限,可以理解为匿名用户或游客authc无参,需要认证logout无参,注销,执行后会直接跳转到shiroFilterFactoryBean.setLoginUrl(); 设置的 urlauthcBasic无参,表示 httpBasic 认证user无参,表示必须存在用户,当登入操作时不做检查ssl无参,表示安全的URL请求,协议为 httpsperms[user]参数可写多个,表示需要某个或某些权限才能通过,多个参数时写 perms["user, admin"],当有多个参数时必须每个参数都通过才算通过roles[admin]参数可写多个,表示是某个或某些角色才能通过,多个参数时写 roles["admin,user"],当有多个参数时必须每个参数都通过才算通过rest[user]根据请求的方法,相当于 perms[user:method],其中 method 为 post,get,delete 等port[8081]当请求的URL端口不是8081时,跳转到schemal://serverName:8081?queryString 其中 schmal 是协议 http 或 https 等等,serverName 是你访问的 Host,8081 是 Port 端口,queryString 是你访问的 URL 里的 ? 后面的参数

    常用的主要就是 anon,authc,user,roles,perms 等

    注意:anon, authc, authcBasic, user 是第一组认证过滤器,perms, port, rest, roles, ssl 是第二组授权过滤器,要通过授权过滤器,就先要完成登陆认证操作(即先要完成认证才能前去寻找授权) 才能走第二组授权器(例如访问需要 roles 权限的 url,如果还没有登陆的话,会直接跳转到 shiroFilterFactoryBean.setLoginUrl(); 设置的 url )

    自定义 realm 类

    我们首先要继承 AuthorizingRealm 类来自定义我们自己的 realm 以进行我们自定义的身份,权限认证操作。 记得要 Override 重写 doGetAuthenticationInfo 和 doGetAuthorizationInfo 两个方法(两个方法名很相似,不要搞错)

    publicclassCustomRealmextendsAuthorizingRealm{privateUserMapperuserMapper;@Autowiredprivatevoid setUserMapper(UserMapperuserMapper) {this.userMapper = userMapper; }/**

    * 获取身份验证信息

    * Shiro中,最终是通过 Realm 来获取应用程序中的用户、角色及权限信息的。

    *

    * @param authenticationToken 用户身份信息 token

    * @return 返回封装了用户信息的 AuthenticationInfo 实例

    */@OverrideprotectedAuthenticationInfodoGetAuthenticationInfo(AuthenticationTokenauthenticationToken)throwsAuthenticationException{System.out.println("————身份认证方法————");UsernamePasswordTokentoken = (UsernamePasswordToken) authenticationToken;// 从数据库获取对应用户名密码的用户Stringpassword = userMapper.getPassword(token.getUsername());if(null== password) {thrownewAccountException("用户名不正确"); }elseif(!password.equals(newString((char[]) token.getCredentials()))) {thrownewAccountException("密码不正确"); }returnnewSimpleAuthenticationInfo(token.getPrincipal(), password, getName()); }/**

    * 获取授权信息

    *

    * @param principalCollection

    * @return

    */@OverrideprotectedAuthorizationInfodoGetAuthorizationInfo(PrincipalCollectionprincipalCollection) {System.out.println("————权限认证————");Stringusername = (String)SecurityUtils.getSubject().getPrincipal();SimpleAuthorizationInfoinfo =newSimpleAuthorizationInfo();//获得该用户角色Stringrole = userMapper.getRole(username);Set set =newHashSet<>();//需要将 role 封装到 Set 作为 info.setRoles() 的参数set.add(role);//设置该用户拥有的角色info.setRoles(set);returninfo; }}

    重写的两个方法分别是实现身份认证以及权限认证,shiro 中有个作登陆操作的 Subject.login()方法,当我们把封装了用户名,密码的 token 作为参数传入,便会跑进这两个方法里面(不一定两个方法都会进入)

    其中 doGetAuthorizationInfo 方法只有在需要权限认证时才会进去,比如前面配置类中配置了 filterChainDefinitionMap.put("/admin/**", "roles[admin]"); 的管理员角色,这时进入 /admin 时就会进入 doGetAuthorizationInfo 方法来检查权限;而 doGetAuthenticationInfo 方法则是需要身份认证时(比如前面的 Subject.login() 方法)才会进入

    再说下 UsernamePasswordToken 类,我们可以从该对象拿到登陆时的用户名和密码(登陆时会使用 new UsernamePasswordToken(username, password);),而 get 用户名或密码有以下几个方法

    token.getUsername()//获得用户名 Stringtoken.getPrincipal()//获得用户名 Object token.getPassword()//获得密码 char[]token.getCredentials()//获得密码 Object

    注意:有很多人会发现,UserMapper 等类,接口无法通过 @Autowired 注入进来,跑程序的时候会报 NullPointerException,网上说了很多诸如是 Spring 加载顺序等原因,但其实有一个很重要的地方要大家注意,CustomRealm 这个类是在 shiro 配置类的 securityManager.setRealm()方法中设置进去的,而很多人直接写securityManager.setRealm(new CustomRealm()); ,这样是不行的,必须要使用 @Bean 注入 MyRealm,不能直接 new 对象:

    @BeanpublicSecurityManagersecurityManager(){ DefaultWebSecurityManager securityManager =newDefaultWebSecurityManager();// 设置realm.securityManager.setRealm(customRealm());returnsecurityManager; }@BeanpublicCustomRealmcustomRealm(){returnnewCustomRealm(); }

    道理也很简单,和 Controller 中调用 Service 一样,都是 SpringBean,不能自己 new

    当然,同样的道理也可以这样写:

    @BeanpublicSecurityManagersecurityManager(CustomRealm customRealm){ DefaultWebSecurityManager securityManager =newDefaultWebSecurityManager();// 设置realm.securityManager.setRealm(customRealm);returnsecurityManager; }

    然后只要在 CustomRealm 类加上个类似 @Component 的注解即可

    功能实现

    本文的功能全部以接口返回 json 数据的方式实现

    根据 url 权限分配 controller

    游客@RestController@RequestMapping("/guest")publicclassGuestController{@AutowiredprivatefinalResultMap resultMap;@RequestMapping(value ="/enter", method = RequestMethod.GET)publicResultMap login() {returnresultMap.success().message("欢迎进入,您的身份是游客"); }@RequestMapping(value ="/getMessage", method = RequestMethod.GET)publicResultMap submitLogin() {returnresultMap.success().message("您拥有获得该接口的信息的权限!"); }}普通登陆用户@RestController@RequestMapping("/user")publicclassUserController{@AutowiredprivatefinalResultMap resultMap;@RequestMapping(value ="/getMessage", method = RequestMethod.GET)publicResultMap getMessage() {returnresultMap.success().message("您拥有用户权限,可以获得该接口的信息!"); }}管理员@RestController@RequestMapping("/admin")publicclassAdminController{@AutowiredprivatefinalResultMap resultMap;@RequestMapping(value ="/getMessage", method = RequestMethod.GET)publicResultMap getMessage() {returnresultMap.success().message("您拥有管理员权限,可以获得该接口的信息!"); }}

    突然注意到 CustomRealm 类那里抛出了 AccountException 异常,现在建个类进行异常捕获

    @RestControllerAdvicepublicclassExceptionController{privatefinalResultMap resultMap;@AutowiredpublicExceptionController(ResultMap resultMap) {this.resultMap = resultMap; }// 捕捉 CustomRealm 抛出的异常@ExceptionHandler(AccountException.class)publicResultMap handleShiroException(Exception ex) {returnresultMap.fail().message(ex.getMessage()); }}

    当然还有进行登陆等处理的 LoginController

    @RestControllerpublicclassLoginController{@AutowiredprivateResultMap resultMap;privateUserMapper userMapper;@RequestMapping(value ="/notLogin", method = RequestMethod.GET)publicResultMap notLogin() {returnresultMap.success().message("您尚未登陆!"); }@RequestMapping(value ="/notRole", method = RequestMethod.GET)publicResultMap notRole() {returnresultMap.success().message("您没有权限!"); }@RequestMapping(value ="/logout", method = RequestMethod.GET)publicResultMap logout() { Subject subject = SecurityUtils.getSubject();//注销subject.logout();returnresultMap.success().message("成功注销!"); }/** * 登陆 * *@paramusername 用户名 *@parampassword 密码 */@RequestMapping(value ="/login", method = RequestMethod.POST)publicResultMap login(String username, String password) {// 从SecurityUtils里边创建一个 subjectSubject subject = SecurityUtils.getSubject();// 在认证提交前准备 token(令牌)UsernamePasswordToken token = new UsernamePasswordToken(username, password);// 执行认证登陆subject.login(token);//根据权限,指定返回数据String role = userMapper.getRole(username);if("user".equals(role)) {returnresultMap.success().message("欢迎登陆"); }if("admin".equals(role)) {returnresultMap.success().message("欢迎来到管理员页面"); }returnresultMap.fail().message("权限错误!"); }}

    测试


    进群:可以领取免费的架构师学习资料。

    进群:了解最新的学习动态

    进群:了解最新的阿里,京东招聘资讯

    进群:获取更多的面试资料

    1、具有1-5工作经验的,面对目前流行的技术不知从何下手,需要突破技术瓶颈的可以加群。

    2、在公司待久了,过得很安逸,但跳槽时面试碰壁。需要在短时间内进修、跳槽拿高薪的可以加群。

    3、如果没有工作经验,但基础非常扎实,对java工作机制,常用设计思想,常用java开发框架掌握熟练的,可以加群。

    4、觉得自己很牛B,一般需求都能搞定。但是所学的知识点没有系统化,很难在技术领域继续突破的可以加群。

    5. 群号:835638062 点击链接加入群:https://jq.qq.com/?_wv=1027&k=5S3kL3v

    6.阿里Java高级大牛直播讲解知识点,分享知识,上面五大专题都是各位老师多年工作经验的梳理和总结,带着大家全面、科学地建立自己的技术体系和技术认知!

    相关文章

      网友评论

      • 追逐丶:你写代码没有排版,你用markdown写文章啊ヽ(・_・;)ノ……

      本文标题:教你 Shiro 整合 SpringBoot,避开各种坑

      本文链接:https://www.haomeiwen.com/subject/duhonftx.html