【安全框架】浅谈Shiro在项目中的应用

  Shiro是什么？简单来说它是Apache的一个Java安全框架（Apache是一个很牛的团体，除了Shiro，还有Lucene、Elasticsearch、Activiti等等也是Apache的，后续博主可能会讲到），具体这里就不详细赘述了，请大家自行查看百度百科。这里博主只介绍怎么使用。
  博主是java后台开发的研发经理，平时不怎么写Web端代码，所以代码是博主照着“java知识分享网”上面的一个商品管理系统来敲的，也算是“现炒现卖”，和大家一起学习。
  第一步，在pom.xml文件里面添加Shiro依赖，如下。

<dependency>
    <groupId>org.apache.shiro</groupId>
    <artifactId>shiro-core</artifactId>
    <version>1.4.0</version>
</dependency>
<dependency>
    <groupId>org.apache.shiro</groupId>
    <artifactId>shiro-spring</artifactId>
    <version>1.4.0</version>
</dependency>

  第二步，编写MyRealm类，这个类要继承AuthorizingRealm，首先要重写doGetAuthorizationInfo方法，这个方法是用来授权的，即把当前用户拥有的所有角色和菜单权限加载到subject里面。然后要重写doGetAuthenticationInfo方法，这个方法是用来身份验证的，如果验证不通过，会向上抛AuthenticationException异常。下面我直接贴代码。

package com.zznode.realm;

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

import javax.annotation.Resource;

import org.apache.shiro.SecurityUtils;
import org.apache.shiro.authc.AuthenticationException;
import org.apache.shiro.authc.AuthenticationInfo;
import org.apache.shiro.authc.AuthenticationToken;
import org.apache.shiro.authc.SimpleAuthenticationInfo;
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 com.zznode.entity.Menu;
import com.zznode.entity.Role;
import com.zznode.entity.User;
import com.zznode.repository.MenuRepository;
import com.zznode.repository.RoleRepository;
import com.zznode.repository.UserRepository;

/**
 * 自定义Realm
 * 
 * @author Administrator
 *
 */
public class MyRealm extends AuthorizingRealm {

	@Resource
	private UserRepository userRepository;

	@Resource
	private RoleRepository roleRepository;

	@Resource
	private MenuRepository menuRepository;

	/**
	 * 授权，这个方法是懒加载，第一次使用权限的时候才会执行此方法
	 * 比如在遇到@RequiresPermissions和@RequiresRoles注解的时候会执行此方法
	 * 
	 */
	@Override
	protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principals) {
		String userName = (String) SecurityUtils.getSubject().getPrincipal();
		User user = userRepository.findByUserName(userName);
		SimpleAuthorizationInfo info = new SimpleAuthorizationInfo();
		List<Role> roleList = roleRepository.findByUserId(user.getId());
		Set<String> roles = new HashSet<String>();
		for (Role role : roleList) {
			roles.add(role.getName());
			List<Menu> menuList = menuRepository.findByRoleId(role.getId());
			for (Menu menu : menuList) {
				// 把每个菜单名称都放到subject里面，与@RequiresPermissions等注解配合使用，来进行权限验证
				info.addStringPermission(menu.getName());
			}
		}
		info.setRoles(roles);
		return info;
	}

	/**
	 * 身份认证
	 * 
	 */
	@Override
	protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken token) throws AuthenticationException {
		// 获取token中的用户名
		String userName = (String) token.getPrincipal();
		// 根据token中的用户名从数据库中查出用户实体
		User user = userRepository.findByUserName(userName);
		if (user != null) {
			// 将token中的用户名密码与数据库查出的用户名密码进行比较，如果不一致，则向上抛AuthenticationException异常
			AuthenticationInfo authcInfo = new SimpleAuthenticationInfo(user.getUserName(), user.getPassword(), "xxx");
			return authcInfo;
		} else {
			// 如果用户实体为null，直接向上抛AuthenticationException异常
			throw new AuthenticationException("用户名不存在");
		}
	}

}

  第三步，编写ShiroConfig类，这个类定义了可以匿名访问的url，其他的代码都是固定套路的，以后开发中基本不用改，我还是直接贴代码，注释写的很详细，大家都能看懂。

package com.zznode.config;

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

import org.apache.shiro.mgt.SecurityManager;
import org.apache.shiro.spring.LifecycleBeanPostProcessor;
import org.apache.shiro.spring.security.interceptor.AuthorizationAttributeSourceAdvisor;
import org.apache.shiro.spring.web.ShiroFilterFactoryBean;
import org.apache.shiro.web.mgt.DefaultWebSecurityManager;
import org.springframework.aop.framework.autoproxy.DefaultAdvisorAutoProxyCreator;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.DependsOn;

import com.zznode.realm.MyRealm;

/**
 * Shiro配置类
 * 
 * @author Administrator
 *
 */
@Configuration
public class ShiroConfig {

	/**
	 * ShiroFilterFactoryBean 处理拦截资源文件问题。 
	 * 注意：单独一个ShiroFilterFactoryBean配置是或报错的
	 * 因为在初始化ShiroFilterFactoryBean的时候需要注入SecurityManager
	 *
	 * Filter Chain定义说明 ： 
	 * 1、一个URL可以配置多个Filter，使用逗号分隔 
	 * 2、当设置多个过滤器时，全部验证通过，才视为通过
	 * 3、部分过滤器可指定参数，如perms、roles
	 *
	 */
	@Bean
	public ShiroFilterFactoryBean shirFilter(SecurityManager securityManager) {
		ShiroFilterFactoryBean shiroFilterFactoryBean = new ShiroFilterFactoryBean();

		// 必须设置 SecurityManager
		shiroFilterFactoryBean.setSecurityManager(securityManager);

		// 如果不设置默认会自动寻找Web工程根目录下的"/login.jsp"页面
		shiroFilterFactoryBean.setLoginUrl("/login.html");

		// 拦截器.
		Map<String, String> filterChainDefinitionMap = new LinkedHashMap<String, String>();
		// 配置不会被拦截的链接，顺序判断，anon:所有url都都可以匿名访问
		filterChainDefinitionMap.put("/static/**", "anon");
		filterChainDefinitionMap.put("/user/login", "anon");
		filterChainDefinitionMap.put("/drawImage", "anon");

		// 配置退出过滤器，其中的具体的退出代码Shiro已经替我们实现了
		filterChainDefinitionMap.put("/logout", "logout");

		// 配置会被拦截的链接，一般将这句话放在最为下边，authc:所有url都必须认证通过才可以访问
		filterChainDefinitionMap.put("/**", "authc");

		shiroFilterFactoryBean.setFilterChainDefinitionMap(filterChainDefinitionMap);
		return shiroFilterFactoryBean;
	}

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

	/**
	 * realm实现类
	 * 
	 * @return
	 */
	@Bean
	public MyRealm myRealm() {
		MyRealm myRealm = new MyRealm();
		return myRealm;
	}

	/**
	 * Shiro生命周期处理器
	 * 
	 * @return
	 */
	@Bean
	public LifecycleBeanPostProcessor lifecycleBeanPostProcessor() {
		return new LifecycleBeanPostProcessor();
	}

	/**
	 * 开启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;
	}

}

  下面，我们看一个controller的login方法的例子，代码如下。在执行subject.login方法的时候，会自动调用MyRealm类里面的doGetAuthenticationInfo方法，并且可以catch到这个方法的异常。

    @ResponseBody
	@RequestMapping("/login")
	public Map<String, Object> login(String imageCode, @Valid User user, BindingResult bindingResult,
			HttpSession session) {
		Map<String, Object> map = new HashMap<String, Object>();
		if (StringUtil.isEmpty(imageCode)) {
			map.put("success", false);
			map.put("errorInfo", "请输入验证码!");
			return map;
		}
		if (!session.getAttribute("checkcode").equals(imageCode)) {
			map.put("success", false);
			map.put("errorInfo", "验证码输入错误!");
			return map;
		}
		if (bindingResult.hasErrors()) {
			map.put("success", false);
			map.put("errorInfo", bindingResult.getFieldError().getDefaultMessage());
			return map;
		}
		Subject subject = SecurityUtils.getSubject();
		UsernamePasswordToken token = new UsernamePasswordToken(user.getUserName(), user.getPassword());
		try {
			// 下面这句话，会调用MyRealm类里面的doGetAuthenticationInfo方法，并且可以catch到这个方法的异常
			subject.login(token);
			// 如果上面这句话执行没有异常，则说明登陆成功
			// 从subject里获得当前的用户名
			String userName = (String) SecurityUtils.getSubject().getPrincipal();
			// 根据当前用户名查出用户实体信息
			User currentUser = userService.findByUserName(userName);
			// 将用户实体信息放入HttpSession
			session.setAttribute("currentUser", currentUser);
			// 根据用户实体id查出角色列表（一个用户可以对应多个角色）
			List<Role> roleList = roleService.findByUserId(currentUser.getId());
			map.put("roleList", roleList);
			map.put("roleSize", roleList.size());
			map.put("success", true);
			// 记录操作日志
			logService.save(new Log(Log.LOGIN_ACTION, "用户登录"));
			return map;
		} catch (Exception e) {
			e.printStackTrace();
			map.put("success", false);
			map.put("errorInfo", "用户名或者密码错误!");
			return map;
		}
	}

  最后我们再看一个controller的save方法的例子，这个比较简单易懂，代码如下。@RequiresPermissions(value = “商品管理”)这个注解的意思是，判断subject里面有没有“商品管理”这个菜单权限，如果有，才允许执行save这个方法，否则会向上抛出AuthorizationException异常。

    @RequestMapping("/save")
	@RequiresPermissions(value = "商品管理")
	public Map<String, Object> save(GoodsUnit goodsUnit) throws Exception {
		Map<String, Object> resultMap = new HashMap<>();
		goodsUnitService.save(goodsUnit);
		logService.save(new Log(Log.ADD_ACTION, "添加商品单位信息"));
		resultMap.put("success", true);
		return resultMap;
	}

  至此，Shiro就介绍完了，掌握这些基本就够了。