Shiro入门案例之HelloWorld

首先我们创建一个Java工程，并且导入以下jar包。

然后找到Shiro的源码，在samples\quickstart\src\main\resources找到
log4j.properties和shiro.ini复制到src下
在samples\quickstart\src\main\java找到
Quickstart.java复制到我们的工程src下
至此，我们的骨架搭建完毕

先运行一下Quickstart.java，看看能不能跑起来。

接下来我们来解释解释Quickstart的源码

package cn.edou.shiro.helloworld;

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:weild")) {
            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!
        System.out.println("--->"+currentUser.isAuthenticated());
        currentUser.logout();
        System.out.println("--->"+currentUser.isAuthenticated());
        System.exit(0);
    }
}

Factory<SecurityManager> factory = new IniSecurityManagerFactory("classpath:shiro.ini");
初始化shiro.ini，创建一个Factory以获取SecurityManager

SecurityManager securityManager = factory.getInstance();
通过Factory获取SecurityManager

SecurityUtils.setSecurityManager(securityManager);
注入我们的securityManager

 Subject currentUser = SecurityUtils.getSubject();
 获取当前Subject，也就是主题（用户）

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 + "]");
        }
        测试Session，设置一个Session，并且获取它的值。
        如果获取到的session值和设置的一样，则日志输出。

if (!currentUser.isAuthenticated()) {
            UsernamePasswordToken token = new UsernamePasswordToken("lonestarr", "vespa");
            //封装一个token，根据token我们可以获取用户名，密码，主机，是否记住我等信息
            token.setRememberMe(true);
            //其实这里可以直接写
            //UsernamePasswordToken token1 = new UsernamePasswordToken("lonestarr","vespa",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?
            }
        }

大家可能疑惑UsernamePasswordToken是个什么鬼，其实打开这个类，我们就知道它其实就是个封装了各种用户信息的一个类，有不同参数数目与类型的构造函数，以及相应的属性的get和set方法。

上面执行login的时候，其实做了一个用户名和密码的验证。

 if (currentUser.hasRole("schwartz")) {
            log.info("--->May the Schwartz be with you!");
        } else {
            log.info("Hello, mere mortal.");
        }
        //是否有schwartz这个角色

这些信息（realms, users, roles and permissions ）在shiro.ini里面
用户名密码以及对应的角色

角色对应的权限

测试该subject有没有对应的权限

if (currentUser.isPermitted("lightsaber:weild")) {
            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!");
        }

currentUser.logout(); //登出

可以在登出代码前后测试一下是否登出成功

		System.out.println("--->"+currentUser.isAuthenticated());
        currentUser.logout();
        System.out.println("--->"+currentUser.isAuthenticated());

打印结果

--->true
.....
--->false

至此，Shiro官方提供的HelloWorld讲解完毕，大家可以仔细研究这个Quickstart.java,当然还有很多细微的点，需要在后面一一讲解，大家可以看我的Shiro专栏。