Springboot 整合 shiro

第一步、引入 pom

<!--springboot 整合 shiro -->
<dependency>
   <groupId>org.apache.shiro</groupId>
   <artifactId>shiro-spring</artifactId>
   <version>1.3.2</version>
</dependency>

 

第二步、定义 shiroConfig

import org.apache.shiro.mgt.SecurityManager;
import org.apache.shiro.spring.web.ShiroFilterFactoryBean;
import org.apache.shiro.web.mgt.DefaultWebSecurityManager;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import java.util.LinkedHashMap;
import java.util.Map;

 
@Configuration
public class ShiroConfig {
    @Bean
    public ShiroFilterFactoryBean shirFilter(SecurityManager securityManager) {
        ShiroFilterFactoryBean shiroFilterFactoryBean = new ShiroFilterFactoryBean();
        // 必须设置 SecurityManager
        shiroFilterFactoryBean.setSecurityManager(securityManager);
        // setLoginUrl 若是不设置值，默认会自动寻找Web工程根目录下的"/login.jsp"页面 或 "/login" 映射
        shiroFilterFactoryBean.setLoginUrl("/login");
        // 设置无权限时跳转的 url;
        shiroFilterFactoryBean.setUnauthorizedUrl("/notRole");

        // 设置拦截器
        Map<String, String> filterChainDefinitionMap = new LinkedHashMap<>();
        //游客，开发权限
        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拦截器工厂类注入成功");
        return shiroFilterFactoryBean;
    }

    /**
     * 注入 securityManager
     */
    @Bean
    public SecurityManager securityManager() {
        DefaultWebSecurityManager securityManager = new DefaultWebSecurityManager();
        // 设置realm.
        securityManager.setRealm(customRealm());
        return securityManager;
    }

    /**
     * 自定义身份认证 realm;
     * <p>
     * 必须写这个类，并加上 @Bean 注解，目的是注入 CustomRealm，
     * 不然会影响 CustomRealm类 中其余类的依赖注入
     */
    @Bean
    public CustomRealm customRealm() {
        return new CustomRealm();
    }
}

 

• anon    无参，开放权限，能够理解为匿名用户或游客
• authc    无参，须要认证
• logout    无参，注销，执行后会直接跳转到shiroFilterFactoryBean.setLoginUrl(); 设置的 url
• authcBasic    无参，表示 httpBasic 认证
• user    无参，表示必须存在用户，当登入操做时不作检查
• ssl    无参，表示安全的URL请求，协议为 https
• perms[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, authcBasic, user 是第一组认证过滤器，perms, port, rest, roles, ssl 是第二组受权过滤器，要经过受权过滤器，就先要完成登录认证操做（即先要完成认证才能前去寻找受权) 才能走第二组受权器（例如访问须要 roles 权限的 url，若是尚未登录的话，会直接跳转到 shiroFilterFactoryBean.setLoginUrl(); 设置的 url ）
 

第三步、定义 realm  

继承 AuthorizingRealm 类，重写 doGetAuthenticationInfo 和 doGetAuthorizationInfo 两个方法

import org.apache.shiro.SecurityUtils;
import org.apache.shiro.authc.*;
import org.apache.shiro.authz.AuthorizationInfo;
import org.apache.shiro.authz.SimpleAuthorizationInfo;
import org.apache.shiro.realm.AuthorizingRealm;
import org.apache.shiro.subject.PrincipalCollection;
import org.springframework.beans.factory.annotation.Autowired;

import java.util.HashSet;
import java.util.Set;

public class CustomRealm extends AuthorizingRealm {

    @Autowired
    private UserService userService;

    /**
     * 获取身份验证信息
     * Shiro中，最终是经过 Realm 来获取应用程序中的用户、角色及权限信息的。
     *
     * @param authenticationToken 用户身份信息 token
     * @return 返回封装了用户信息的 AuthenticationInfo 实例
     */
    @Override
    protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken authenticationToken) throws AuthenticationException {
        System.out.println("————身份认证方法————");
        UsernamePasswordToken token = (UsernamePasswordToken) authenticationToken;
        // 从数据库获取对应用户名密码的用户
        String password = "123456";
        //password=userService.findPassword(...);
        String userName= token.getUsername();
        String loinPassword=new String(token.getPassword());
        System.out.println("userName="+userName+" password="+password);
        if (null == password) {
            throw new AccountException("用户名不正确");
        } else if (!password.equals(loinPassword)) {
            throw new AccountException("密码不正确");
        }
        return new SimpleAuthenticationInfo(token.getPrincipal(), password, getName());
    }

    /**
     * 获取受权信息
     *
     * @param principalCollection
     * @return
     */
    @Override
    protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principalCollection) {
        System.out.println("————权限认证————");
        String username = (String) SecurityUtils.getSubject().getPrincipal();
        SimpleAuthorizationInfo info = new SimpleAuthorizationInfo();
        //得到该用户角色
        String role = "admin";
        //role=userService.getRole(...);
        Set<String> set = new HashSet<>();
        //须要将 role 封装到 Set 做为 info.setRoles() 的参数
        set.add(role);
        //设置该用户拥有的角色
        info.setRoles(set);
        return info;
    }
}

 

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

其中 doGetAuthorizationInfo 方法只有在须要权限认证时才会进去，好比前面配置类中配置了 filterChainDefinitionMap.put("/admin/**", "roles[admin]"); 的管理员角色，这时访问 /admin/**  时就会进入 doGetAuthorizationInfo 方法来检查权限；

而 doGetAuthenticationInfo 方法则是须要身份认证时（好比前面的 Subject.login() 方法）才会进入

 2.UsernamePasswordToken 类，咱们能够从该对象拿到登录时的用户名和密码（由于登录时会使用 new UsernamePasswordToken(username, password)）

注意

有不少人会发现，UserService 等类，接口没法经过 @Autowired 注入进来，跑程序的时候会报 NullPointerException，网上说了不少诸如是 Spring 加载顺序等缘由，但其实有一个很重要的地方要你们注意，CustomRealm 这个类是在 shiro 配置类的 securityManager.setRealm() 方法中设置进去的，而不少人直接写securityManager.setRealm(new CustomRealm()); ,这样是不行的，必需要使用 @Bean 注入 MyRealm，不能直接 new 对象

 

第四步、测试类
 

@RestController
public class LoginController {
    @Autowired    
    private ResultMap resultMap;
    @Autowired   
    private UserMapper userMapper;

    @RequestMapping(value = "/notLogin", method = RequestMethod.GET)
    public ResultMap notLogin() {
        return resultMap.success().message("您还没有登录！");
    }

    @RequestMapping(value = "/notRole", method = RequestMethod.GET)
    public ResultMap notRole() {
        return resultMap.success().message("您没有权限！");
    }

    @RequestMapping(value = "/logout", method = RequestMethod.GET)
    public ResultMap logout() {
        Subject subject = SecurityUtils.getSubject();
        //注销
        subject.logout();
        return resultMap.success().message("成功注销！");
    }

    /**
     * 登录
     *
     * @param username 用户名
     * @param password 密码
     */
    @RequestMapping(value = "/login", method = RequestMethod.POST)
    public ResultMap login(String username, String password) {
        // 从SecurityUtils里边建立一个 subject
        Subject subject = SecurityUtils.getSubject();
        // 在认证提交前准备 token（令牌）
        UsernamePasswordToken token = new UsernamePasswordToken(username, password);
        // 执行认证登录
        subject.login(token);
        //根据权限，指定返回数据
        String role = userMapper.getRole(username);
        if ("user".equals(role)) {
            return resultMap.success().message("欢迎登录");
        }
        if ("admin".equals(role)) {
            return resultMap.success().message("欢迎来到管理员页面");
        } 
        return resultMap.fail().message("权限错误！");
    }
}

普通登录用户
@RestController
@RequestMapping("/user")
public class UserController{
    @Autowired    
    private final ResultMap resultMap;

    @RequestMapping(value = "/getMessage", method = RequestMethod.GET)
    public ResultMap getMessage() {
        return resultMap.success().message("您拥有用户权限，能够得到该接口的信息！");
    }
}

问题：

(1)@RequiresPermissions注解失效

在shiroConfig中加入以下内容

/**
 * 开启Shiro的注解(如@RequiresRoles,@RequiresPermissions),需借助SpringAOP扫描使用Shiro注解的类,并在必要时进行安全逻辑验证
 * 配置如下两个bean(DefaultAdvisorAutoProxyCreator(可选)和AuthorizationAttributeSourceAdvisor)便可实现此功能
 *
 * @return
 */
@Bean
@DependsOn({"lifecycleBeanPostProcessor"})
public DefaultAdvisorAutoProxyCreator advisorAutoProxyCreator() {
    DefaultAdvisorAutoProxyCreator advisorAutoProxyCreator = new DefaultAdvisorAutoProxyCreator();
    advisorAutoProxyCreator.setProxyTargetClass(true);
    return advisorAutoProxyCreator;
}

@Bean
public AuthorizationAttributeSourceAdvisor authorizationAttributeSourceAdvisor() {
    AuthorizationAttributeSourceAdvisor authorizationAttributeSourceAdvisor = new AuthorizationAttributeSourceAdvisor();
    authorizationAttributeSourceAdvisor.setSecurityManager(securityManager());
    return authorizationAttributeSourceAdvisor;
}

@Bean
public LifecycleBeanPostProcessor lifecycleBeanPostProcessor() {
    return new LifecycleBeanPostProcessor();
}

(2)获取当前登陆用户的信息

修改 CustomRealm.doGetAuthenticationInfo( ) 最后一行代码

return new SimpleAuthenticationInfo(new Principal(id+"",userName,password), password, getName());

此处 Principal 是咱们自定义的类，以下：

public static class Principal implements Serializable {

    private String id;
    private String userName;
    private String passWord;

    public Principal(String id, String userName, String passWord) {
        this.id = id;
        this.userName = userName;
        this.passWord = passWord;
    }

   //.....省略set..get..

再封装一个 UserUtil，用于获取用户信息

public class UserUtil {
    public static boolean isLogin(){
        CustomRealm.Principal principal=getPrincipal();
        if(principal==null|| StringUtils.isEmpty(principal.getId())){
            return false;
        }
        return true;
    }

    public static  User getUser(){
        if(isLogin()==false){
            return null;
        }
        CustomRealm.Principal principal=getPrincipal();
        User user=new User();
        user.setId(principal.getId());
        user.setUserName(principal.getUserName());
        user.setPassWord(principal.getPassWord());
        return user;
    }

    public  static CustomRealm.Principal getPrincipal(){
        org.apache.shiro.subject.Subject subject= SecurityUtils.getSubject();
        CustomRealm.Principal principal= (CustomRealm.Principal) subject.getPrincipal();
        return  principal;
    }
}

(3)更新当前登陆用户的信息

拿到咱们自定义的Principal对象，直接修改其中的属性就能够

CustomRealm.Principal principal= (CustomRealm.Principal) SecurityUtils.getSubject().getPrincipal();
principal.setUserName("张三丰");