將shiro做爲插件整合到jfinal,在jfinal裏讀取shiro的註解

時間 2019-12-05

原文原文鏈接

學習了shiro的一些身份驗證和受權知識，那麼如今主要學習大飛怎麼把shiro結合到jfinal,怎麼在jfinal裏使用shiro的註解的。java

1、首先，要先了解一下jfinal啓動插件的流程，才能好的理解jfinal怎麼使用shiro，jfinal使用其餘框架都採用Plugins的形式，在啓動jfinal的時候，會依次啓動在configPlugin裏配置的插件，這個插件要實現接口IPlugin就能夠，如public class ShiroPlugin implements IPlugin。 jfinal啓動繼承了IPlugin的插件的流程以下：git

一、啓動jfinal，會將web.xml的內容都初始化並加載到web容器，即會經過反射給每一個類建立一個實例，以下所示：web

<?xml version="1.0" encoding="utf-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" id="WebApp_ID" version="2.5">
  <listener>
    <listener-class>org.apache.shiro.web.env.EnvironmentLoaderListener</listener-class>
  </listener>
  <filter>
    <filter-name>ShiroFilter</filter-name>
    <filter-class>org.apache.shiro.web.servlet.ShiroFilter</filter-class>
  </filter>
  <filter-mapping>
    <filter-name>ShiroFilter</filter-name>
    <url-pattern>/*</url-pattern>
  </filter-mapping>
  <filter>
    <filter-name>jfinal</filter-name>
    <filter-class>com.jfinal.core.JFinalFilter</filter-class>
    <init-param>
      <param-name>configClass</param-name>
      <param-value>com.learnging.system.LearngingConfig</param-value>
    </init-param>
  </filter>
  <filter-mapping>
    <filter-name>jfinal</filter-name>
    <url-pattern>/*</url-pattern>
  </filter-mapping>
</web-app>

這裏它會生成JFinalFilter的實例，並調用JFinalFilter的init方法，這裏init又委託給JFinal的init方法，以下：apache

void init(JFinalConfig jfinalConfig, ServletContext servletContext)
{
    this.servletContext = servletContext;
    this.contextPath = servletContext.getContextPath();

    initPathKit();

    Config.configJFinal(jfinalConfig);	// start plugin, init log factory and init engine in this method
    constants = Config.getConstants();

    initActionMapping();
    initHandler();
    initRender();
    initOreillyCos();
    initTokenManager();
}

JFinal的init方法又調用Config.configJFinal（）方法，以下：app

static void configJFinal(JFinalConfig jfinalConfig)
{
    jfinalConfig.configConstant(constants);
    initLogFactory();
    initEngine();
    jfinalConfig.configRoute(routes);
    jfinalConfig.configEngine(engine);
    jfinalConfig.configPlugin(plugins);
    startPlugins();		// very important!!!
    jfinalConfig.configInterceptor(interceptors);
    jfinalConfig.configHandler(handlers);
}

private static void startPlugins()
{
    List<IPlugin> pluginList = plugins.getPluginList();
    if (pluginList == null)
    {
        return ;
    }
    for (IPlugin plugin : pluginList)
    {
        try
        {
            // process ActiveRecordPlugin devMode
            if (plugin instanceof com.jfinal.plugin.activerecord.ActiveRecordPlugin)
            {
                com.jfinal.plugin.activerecord.ActiveRecordPlugin arp = (com.jfinal.plugin.activerecord.ActiveRecordPlugin)plugin;
                if (arp.getDevMode() == null)
                {
                    arp.setDevMode(constants.getDevMode());
                }
            }

            if (plugin.start() == false)
            {
                String message = "Plugin start error: " + plugin.getClass().getName();
                log.error(message);
                throw new RuntimeException(message);
            }
        }
        catch (Exception e)
        {
            String message = "Plugin start error: " + plugin.getClass().getName() + ". \n" + e.getMessage();
            log.error(message, e);
            throw new RuntimeException(message, e);
        }
    }
}

至此，啓動完全部插件，只要一個插件啓動失敗，就會都失敗。框架

二接下來就是將一個框架作成一個插件，整合到jfinal。大飛寫的ShiroPlugin插件最主要的start方法，以下所示：函數

public boolean start()
{
    Set<String> excludedMethodName = buildExcludedMethodName();
    ConcurrentMap<String, AuthzHandler> authzMaps = new ConcurrentHashMap<String, AuthzHandler>();
    //逐個訪問全部註冊的Controller，解析Controller及action上的全部Shiro註解。
    //並依據這些註解，actionKey提早構建好權限檢查處理器。
    for (Route route : routes.getRouteItemList())
    {
        Class <? extends Controller > controllerClass = route.getControllerClass();

        String controllerKey = route.getControllerKey();

        // 獲取Controller的全部Shiro註解。
        List<Annotation> controllerAnnotations = getAuthzAnnotations(controllerClass);
        // 逐個遍歷方法。
        Method[] methods = controllerClass.getMethods();
        for (Method method : methods)
        {
            //排除掉Controller基類的全部方法，而且只關注沒有參數的Action方法。
            if (!excludedMethodName.contains(method.getName())
                    && method.getParameterTypes().length == 0)
            {
                //若該方法上存在ClearShiro註解，則對該action不進行訪問控制檢查。
                if(isClearShiroAnnotationPresent(method))
                {
                    continue;
                }
                //獲取方法的全部Shiro註解。
                List<Annotation> methodAnnotations = getAuthzAnnotations(method);
                //依據Controller的註解和方法的註解來生成訪問控制處理器。
                AuthzHandler authzHandler = createAuthzHandler(
                                                controllerAnnotations, methodAnnotations);
                //生成訪問控制處理器成功。
                if (authzHandler != null)
                {
                    //構建ActionKey，參考ActionMapping中實現
                    String actionKey = createActionKey(controllerClass, method, controllerKey);
                    //添加映射
                    authzMaps.put(actionKey, authzHandler);
                }
            }
        }
    }
    //注入到ShiroKit類中。ShiroKit類以單例模式運行。
    ShiroKit.init(authzMaps);
    /**
     * 設定登陸，登陸成功，未受權等url地址
     */
    ShiroKit.setLoginUrl(loginUrl);
    ShiroKit.setSuccessUrl(successUrl);
    ShiroKit.setUnauthorizedUrl(unauthorizedUrl);
    ShiroKit.setExtName(extName);
    return true;
}

一、buildExcludedMethodName()取得controller裏沒有參數的方法，即action方法。學習

二、authzMaps用於保存cotroller和action及其上面對應的註解。ui

三、逐個訪問全部註冊的Controller，解析Controller及action上的全部Shiro註解。並依據這些註解，actionKey提早構建好權限檢查處理器。this

四、用controllerAnnotations保存Controller的全部Shiro註解。

五、用methodAnnotations保存不是基類，又沒有參數的，又沒有ClearShiro的方法的全部Shiro註解。

六、調用方法createAuthzHandler依據Controller的註解和方法的註解來生成訪問控制處理器。以上authzHandlers.add(null);是由於註解的處理是有順序的，依次爲RequiresRoles，RequiresPermissions， RequiresAuthentication，RequiresUser，RequiresGuest。

/**
 * 依據Controller的註解和方法的註解來生成訪問控制處理器。
 * @param controllerAnnotations  Controller的註解
 * @param methodAnnotations 方法的註解
 * @return 訪問控制處理器
 */
private AuthzHandler createAuthzHandler(
    List<Annotation> controllerAnnotations,
    List<Annotation> methodAnnotations)
{

    //沒有註解
    if (controllerAnnotations.size() == 0 && methodAnnotations.size() == 0)
    {
        return null;
    }
    //至少有一個註解
    List<AuthzHandler> authzHandlers = new ArrayList<AuthzHandler>(AUTHZ_ANNOTATION_CLASSES.length);
    for (int index = 0; index < AUTHZ_ANNOTATION_CLASSES.length; index++)
    {
        authzHandlers.add(null);
    }

    // 逐個掃描註解，如果相應的註解則在相應的位置賦值。
    scanAnnotation(authzHandlers, controllerAnnotations);
    // 逐個掃描註解，如果相應的註解則在相應的位置賦值。函數的註解優先級高於Controller
    scanAnnotation(authzHandlers, methodAnnotations);

    // 去除空值
    List<AuthzHandler> finalAuthzHandlers = new ArrayList<AuthzHandler>();
    for (AuthzHandler a : authzHandlers)
    {
        if (a != null)
        {
            finalAuthzHandlers.add(a);
        }
    }
    authzHandlers = null;
    // 存在多個，則構建組合AuthzHandler
    if (finalAuthzHandlers.size() > 1)
    {
        return new CompositeAuthzHandler(finalAuthzHandlers);
    }
    // 一個的話直接返回
    return finalAuthzHandlers.get(0);
}

七、生成訪問控制處理器成功，構建ActionKey，參考ActionMapping中實現，添加映射，大飛實現以下：

/**
 * 構建actionkey，參考ActionMapping中的實現。
 *
 * @param controllerClass
 * @param method
 * @param controllerKey
 * @return
 */
private String createActionKey(Class <? extends Controller > controllerClass,
                               Method method, String controllerKey)
{
    String methodName = method.getName();
    String actionKey = "";

    ActionKey ak = method.getAnnotation(ActionKey.class);
    if (ak != null)
    {
        actionKey = ak.value().trim();
        if ("".equals(actionKey))
            throw new IllegalArgumentException(controllerClass.getName() + "." + methodName + "(): The argument of ActionKey can not be blank.");
        if (!actionKey.startsWith(SLASH))
            actionKey = SLASH + actionKey;
    }
    else if (methodName.equals("index"))
    {
        actionKey = controllerKey;
    }
    else
    {
        actionKey = controllerKey.equals(SLASH) ? SLASH + methodName : controllerKey + SLASH + methodName;
    }
    return actionKey;
}

本博客代碼主要來源於jfinal源碼和大飛的開源代碼。主要目的是學習.

JFinalShiroPlugin下載地址：http://git.oschina.net/myaniu/jfinalshiroplugin