Shiro：介绍及快速入门

1、shiro简介

1.1 、什么是Shiro？

• Apache Shiro 是一个Java的安全(权限)框架
• shiro 可以非常容易的开发出足够好的应用，其不仅可以用在JavaSE环境，也可以用在JavaEE环境。
• Shiro可以完成，认证，授权，加密，会话管理，Web继承，缓存等。
• 下载jar包地址：http://shiro.apache.org/
  

1.2、有哪些功能

• Authentication：身份认证，登录，验证用户是不是拥有相应的身份;
• Authorization：授权，及权限验证，验证某个已认证的用户是否拥有每个权限，及判断用户能否进行什么操作，如：验证某个用户是否拥有某个角色，或者细粒度的验证某个用户对某个资源是否具有每个权限！
• Session Manager：会话管理，及用户登陆后就是一次会话，在没有退出之前，他的所有信息都会在会话中;会话可以是普通的JavaSE环境，也可以是Web环境;
• Cryptography：加密，保护数据的安全性，如密码加密存储到数据库中，而不是明文存储;
• Web Support：Web支持，可以非常容易地集成到Web环境中;
• Caching：缓存，比如用户登录后，其用户信息，拥有的角色、权限不必每次去查看，这样可以提高效率
• Concurrency：Shiro支持多线程应用的并发验证，即，如在一个线程中开启另一个线程，能把权限自动的传播过去
• Testing：提供测试支持;
• Run As：允许一个用户假装为另一个用户(如果他们允许)的身份进行访问;
• Remember Me：记住我，这个是非常常见的功能，即一次登陆后，下次再来的话不用登陆了

1.3、Shiro架构(外部)

从外部看来Shiro，即从应用程序的角度来观察如何使用shiro完成工作：
![在这里插入图片描

• subject：应用代码直接交互的对象是subject，也就是说Shiro的对外API核心就是Subject，Subject代表了当前的用户，这个用户不一定是一个具体的人，与当前应用交互的任何东西都是Subject，如网络爬虫，机器人等，与Subject的所有交互都会委托给SecurityManager;Subject其实是一个门面，SecurityManager才是实际的执行者
• SecurityManager：安全管理器，及所有与安全有关的操作都会与SercurityManager交互，并且他管理着所有的Subject，可以看出他是Shiro的核心，她负责与Shiro的其他组件进行交互，他相当于SpringMVC的DispatcherServlet的角色
• Realm：Shiro从Realm获取安全数据(如用户，角色，权限)，就是说SecurityManager要验证用户身份，那么它需要从Realm获取相应的用户进行比较，来确定用户的身份是否合法;也需要从Realm得到用会相应的角色、权限，进行验证用户的操作是否能够进行，可以把Realm堪称DataSource;

1.4、Shiro架构(内部)

• Subject：任何可以与应用交互的’用户’
• Security Manager：相当于SpringMVC中的DispatcherServlet;是Shiro的心脏，所有具体的交互都通过Security Manager进行控制，他管理者所有的Sybject，且负责进行认证，授权，会话，及缓存的管理。
• Authenticator：负责Subject认证，是一个扩展点，可以自定义实现;可以使用认证策略(Authentication Strategy)，即什么情况下算用户认证通过了;
• Authorizer：授权其，及访问控制器，用来决定主题是否有权限进行相应的操作;及控制着用户能访问应用中的那些功能;
• Realm：可以有一个或者多个的realm，可以认为是安全实体数据源，及用于获取安全实体的，可以用JDBC来实现，也可以是内存实现等扽给，由用户提供;所以一般在应用中都需要实现自己的realm
• SessionManager：管理Session生命周期的组件，二Shiro并不仅仅可以用在Web环境，也可以用在普通的JavaSE环境中
• CacheManager：缓存控制器，来管理如用户，角色，权限等等缓存的;因为这些数据基本上很少改变，放到缓存中后可以提高访问的性能;
• Cryptography：密码模块，Shiro提高了一些常见的加密组件用于密码加密，解密等等

2、HelloWorld

2.1、快速实践

查看官方文档：http://shiro.apache.org/documentation.html
官方的quickstart：https://github.com/apache/shiro/tree/master/samples/quickstart

1. 创建一个父工程，用于学习Shiro，删掉不必要的东西
2. 在父工程中创建子模块
3. 导入依赖

<dependencies>
        <dependency>
            <groupId>org.apache.shiro</groupId>
            <artifactId>shiro-core</artifactId>
            <version>1.4.1</version>
        </dependency>
        <!-- Shiro uses SLF4J for logging.  We'll use the 'simple' binding
             in this example app.  See http://www.slf4j.org for more info. -->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-simple</artifactId>
            <version>1.7.21</version>
        </dependency>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>jcl-over-slf4j</artifactId>
            <version>1.7.21</version>
        </dependency>
        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.17</version>
        </dependency>
    </dependencies>

4. 配置文件
   
   log4j.properties

log4j.rootLogger=INFO, stdout

log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d %p [%c] - %m %n

# General Apache libraries
log4j.logger.org.apache=WARN

# Spring
log4j.logger.org.springframework=WARN

# Default Shiro logging
log4j.logger.org.apache.shiro=INFO

# Disable verbose logging
log4j.logger.org.apache.shiro.util.ThreadContext=WARN
log4j.logger.org.apache.shiro.cache.ehcache.EhCache=WARN

shiro.ini

[users]
# user 'root' with password 'secret' and the 'admin' role
root = secret, admin
# user 'guest' with the password 'guest' and the 'guest' role
guest = guest, guest
# user 'presidentskroob' with password '12345' ("That's the same combination on
# my luggage!!!" ;)), and role 'president'
presidentskroob = 12345, president
# user 'darkhelmet' with password 'ludicrousspeed' and roles 'darklord' and 'schwartz'
darkhelmet = ludicrousspeed, darklord, schwartz
# user 'lonestarr' with password 'vespa' and roles 'goodguy' and 'schwartz'
lonestarr = vespa, goodguy, schwartz

# -----------------------------------------------------------------------------
# Roles with assigned permissions
#
# Each line conforms to the format defined in the
# org.apache.shiro.realm.text.TextConfigurationRealm#setRoleDefinitions JavaDoc
# -----------------------------------------------------------------------------
[roles]
# 'admin' role has all permissions, indicated by the wildcard '*'
admin = *
# The 'schwartz' role can do anything (*) with any lightsaber:
schwartz = lightsaber:*
# The 'goodguy' role is allowed to 'drive' (action) the winnebago (type) with
# license plate 'eagle5' (instance specific id)
goodguy = winnebago:drive:eagle5

5. Controller里面的Quickstart.java

import org.apache.shiro.SecurityUtils;
import org.apache.shiro.authc.*;
import org.apache.shiro.config.IniSecurityManagerFactory;
import org.apache.shiro.mgt.SecurityManager;
import org.apache.shiro.session.Session;
import org.apache.shiro.subject.Subject;
import org.apache.shiro.util.Factory;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;


/**
 * Simple Quickstart application showing how to use Shiro's API.
 *
 * @since 0.9 RC2
 */
public class Quickstart {

    private static final transient Logger log = LoggerFactory.getLogger(Quickstart.class);


    public static void main(String[] args) {

        // The easiest way to create a Shiro SecurityManager with configured
        // realms, users, roles and permissions is to use the simple INI config.
        // We'll do that by using a factory that can ingest a .ini file and
        // return a SecurityManager instance:

        // Use the shiro.ini file at the root of the classpath
        // (file: and url: prefixes load from files and urls respectively):
        Factory<SecurityManager> factory = new IniSecurityManagerFactory("classpath:shiro.ini");
        SecurityManager securityManager = factory.getInstance();

        // for this simple example quickstart, make the SecurityManager
        // accessible as a JVM singleton.  Most applications wouldn't do this
        // and instead rely on their container configuration or web.xml for
        // webapps.  That is outside the scope of this simple quickstart, so
        // we'll just do the bare minimum so you can continue to get a feel
        // for things.
        SecurityUtils.setSecurityManager(securityManager);

        // Now that a simple Shiro environment is set up, let's see what you can do:

        // get the currently executing user:
        Subject currentUser = SecurityUtils.getSubject();

        // Do some stuff with a Session (no need for a web or EJB container!!!)
        Session session = currentUser.getSession();
        session.setAttribute("someKey", "aValue");
        String value = (String) session.getAttribute("someKey");
        if (value.equals("aValue")) {
            log.info("Retrieved the correct value! [" + value + "]");
        }

        // let's login the current user so we can check against roles and permissions:
        if (!currentUser.isAuthenticated()) {
            UsernamePasswordToken token = new UsernamePasswordToken("lonestarr", "vespa");
            token.setRememberMe(true);
            try {
                currentUser.login(token);
            } catch (UnknownAccountException uae) {
                log.info("There is no user with username of " + token.getPrincipal());
            } catch (IncorrectCredentialsException ice) {
                log.info("Password for account " + token.getPrincipal() + " was incorrect!");
            } catch (LockedAccountException lae) {
                log.info("The account for username " + token.getPrincipal() + " is locked.  " +
                        "Please contact your administrator to unlock it.");
            }
            // ... catch more exceptions here (maybe custom ones specific to your application?
            catch (AuthenticationException ae) {
                //unexpected condition?  error?
            }
        }

        //say who they are:
        //print their identifying principal (in this case, a username):
        log.info("User [" + currentUser.getPrincipal() + "] logged in successfully.");

        //test a role:
        if (currentUser.hasRole("schwartz")) {
            log.info("May the Schwartz be with you!");
        } else {
            log.info("Hello, mere mortal.");
        }

        //test a typed permission (not instance-level)
        if (currentUser.isPermitted("lightsaber:wield")) {
            log.info("You may use a lightsaber ring.  Use it wisely.");
        } else {
            log.info("Sorry, lightsaber rings are for schwartz masters only.");
        }

        //a (very powerful) Instance Level permission:
        if (currentUser.isPermitted("winnebago:drive:eagle5")) {
            log.info("You are permitted to 'drive' the winnebago with license plate (id) 'eagle5'.  " +
                    "Here are the keys - have fun!");
        } else {
            log.info("Sorry, you aren't allowed to drive the 'eagle5' winnebago!");
        }

        //all done - log out!
        currentUser.logout();

        System.exit(0);
    }
}

运行controller/main方法，出现这样的日志信息即为：入门成功！

注意点：按照官网十分钟入门，你的默认日志走的是commons/logging日志门面，不是我们定制的log4j，所以会报错，只要加上commons/logging日志对应的pom配置即可

必须要引入commons/logging

 <dependency>
    <groupId>commons-logging</groupId>
    <artifactId>commons-logging</artifactId>
    <version>1.2</version>
 </dependency>

核心代码

 private static final transient Logger log = LoggerFactory.getLogger(Quickstart.class);//提供了日志输出信息
Factory<SecurityManager> factory = new IniSecurityManagerFactory("classpath:shiro.ini");//通过Factory工厂与对应的ini配置文件链接
Subject currentUser = SecurityUtils.getSubject();//获取当前用户对象，Subject
Session session = currentUser.getSession();//通过当前用户Subject，拿到Session
!currentUser.isAuthenticated()//判断当前用户是否被认证
currentUser.getPrincipal()//获取用户信息
currentUser.hasRole("schwartz")//是否拥有xxx角色
currentUser.isPermitted("lightsaber:wield")//获得用户权限
currentUser.logout();//注销