shiro 快速入门详解。

package com.aaa.lee.shiro;


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):
        /**
         * 1.使用最简单的方式创建Shiro安全框架，需要通过配置INI配置文件进行配置realm，users，roles，permissions
         *      使用Factory<SecurityManager>工厂类加载根目录下的shiro.ini文件来构建SecurityManager对象
         *      SecurityManager:认证，授权，加密，session管理
         *      以下的所有操作都必须使用SecurityManager对象进行完整，也就是说都需要使用SecurityManager对象爱获取
         *
         */
        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.
        /**
         *
         * 2.已经把SecurityManager对象创建出来，这个对象在JVM中是一个单例
         *      如果在真实的web环境中，需要在容器中配置web.xml/application.xml
         *
         *
         */
        SecurityUtils.setSecurityManager(securityManager);

        /**
         * shiro所需要的环境已经搭建完毕
         */
        // Now that a simple Shiro environment is set up, let's see what you can do:

        /**
         *
         * 3.通过securityManager获取到Subject对象
         *      Subject中封装了表单所提交的属性(User信息:按照官方要求不能存入密码)
         *
         *
         */
        // get the currently executing user:
        Subject currentUser = SecurityUtils.getSubject();

        /**
         *
         * 4.测试session
         *      通过Subject对象获取session对象然后进行测试
         *
         */
        // 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:
        /**
         *
         * 5.认证阶段
         *      currentUser.isAuthenticated():返回true/false 查看当前对象是否已经处于认证创建
         *          如果是返回true，否则返回false
         *
         *
         */
        System.out.println("认证前-------->"+currentUser.isAuthenticated());
        if (!currentUser.isAuthenticated()) {
            /**
             * 用户未处于登录状态
             * 6.创建出UsernamePasswordToken对象，该对象拥有两个参数username,password
             */
            UsernamePasswordToken token = new UsernamePasswordToken("lonestarr", "vespa");
            // token.setRememberMe(true);
            try {
                /**
                 * 7.真正的认证方法
                 *      调用了login方法
                 */
                currentUser.login(token);
            } catch (UnknownAccountException uae) {
                System.out.println("UnknownAccountException---->表示用户不存在");
                log.info("There is no user with username of " + token.getPrincipal());
                return;
            } catch (IncorrectCredentialsException ice) {
                System.out.println("IncorrectCredentialsException------>表示密码错误");
                log.info("Password for account " + token.getPrincipal() + " was incorrect!");
                return;
            } catch (LockedAccountException lae) {
                System.out.println("LockedAccountException------>表示所登录的账号被锁定");
                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) {
                /**
                 * AuthenticationException是以上三个异常父类
                 */
                //unexpected condition?  error?
            }
        }

        //say who they are:
        //print their identifying principal (in this case, a username):
        System.out.println("用户登录成功");
        System.out.println("认证成功-------->"+currentUser.isAuthenticated());
        /**
         * currentUser.getPrincipal():获取的是用户名
         */
        log.info("User [" + currentUser.getPrincipal() + "] logged in successfully.");

        //test a role:
        /**
         * 8.测试角色
         *      currentUser.hasRole("schwartz"):返回值为true/false
         *          如果当前登录用户拥有该角色则返回true，否则返回false
         */
        if (currentUser.hasRole("book_manager")) {
            System.out.println("拥有schwartz角色");
            log.info("May the Schwartz be with you!");
            //return;
        } else {
            System.out.println("没有schwartz角色");
            log.info("Hello, mere mortal.");
        }

        /**
         * 9.测试权限
         *      currentUser.isPermitted("lightsaber:wield"):返回true/false
         *          如果拥有权限返回true，否则返回false
         */
        //test a typed permission (not instance-level)
        if (currentUser.isPermitted("book:delete")) {
            System.out.println("可以对图书进行删除操作");
            log.info("You may use a lightsaber ring.  Use it wisely.");
            //return;
        } else {
            System.out.println("没有对图书操作权限");
            log.info("Sorry, lightsaber rings are for schwartz masters only.");
        }

        //a (very powerful) Instance Level permission:
        if (currentUser.isPermitted("bookUser:query:book")) {
            System.out.println("拥有操作！！！！");
            log.info("You are permitted to 'drive' the winnebago with license plate (id) 'eagle5'.  " +
                    "Here are the keys - have fun!");
           // return;
        } else {
            log.info("Sorry, you aren't allowed to drive the 'eagle5' winnebago!");
        }

        /**
         * 10.Subjct主体对象调用logout()方法执行退出操作
         */
        //all done - log out!
        currentUser.logout();
        System.out.println("退出后-------->"+currentUser.isAuthenticated());

        System.exit(0);
    }
}