SSO-CAS之自定义登陆界面异常提示信息

1. 概要

对于CAS登陆过程中，异常信息的准确提示非常重要，CAS源码业已封装了丰富的异常登陆信息，如下；但对于要求更精确的系统来说，很多时候都需要自己定义提示。很多博客对此也有过介绍，但是大都解释片面或者只求大概的步骤而没有详细的解析。本文在CAS4.1.*版本的基础上，介绍CAS的异常提示机制，并提供自定义异常信息的添加方法。

CAS提供的默认异常提示信息：

	#CAS提供的默认异常提示信息
		AccountDisabledException;
		AccountLockedException;
		CredentialExpiredException;
		InvalidLoginLocationException;
		InvalidLoginTimeException;
		AccountNotFoundException;
		FailedLoginException;
		UNKNOWN;

2. CAS的异常提示机制

我们在进行登陆时，若登陆名或者密码错误的情况下，CAS时怎么进行错误提示的呢？主要步骤如下：

1. 首先，如下面的代码，身份验证类开发中，发现数据库并不能匹配到输入的登陆名，抛出一个用户未找到的异常；

        if (null == loginUser){
            throw new AccountNotFoundException();
        }

2. 在login-web-flow.xml中发现这个异常信息最终会被authenticationFailure捕捉，从而交给handleAuthenticationFailure处理，即身份鉴定异常处理类AuthenticationExceptionHandler。

    <action-state id="realSubmit">
        <evaluate expression="authenticationViaFormAction.submit(flowRequestContext, flowScope.credential, messageContext)"/>
        <transition on="warn" to="warn"/>
        <!--登陆返回的状态不同，对应的处理方式也不同-->
        <transition on="success" to="sendTicketGrantingTicket"/>
        <transition on="successWithWarnings" to="showMessages"/>
        <!--捕捉异常-->
        <transition on="authenticationFailure" to="handleAuthenticationFailure"/>
        <transition on="error" to="generateLoginTicket"/>
    </action-state>

异常处理类就是CAS中全权处理异常的地方。CAS在处理异常时，涉及到两个问题：
– 1. 异常抛出之后，系统界面跳转；
– 2. 异常抛出之后，生成具体异常提示信息。

针对第一个问题，还是在login-web-flow.xml中给出设置，我们可以看到handleAuthenticationFailure地方，在标签中定义了异常发生之后的去处，如AccountDisabledException被捕捉到之后就去到casAccountDisabledView界面中；而一般情况下，若登陆失败，更希望系统能够停留在登陆页面，并给出异常，就设置为 ‘generateLoginTicket’,其最终还是指向登陆界面。

    <action-state id="handleAuthenticationFailure">
        <evaluate expression="authenticationExceptionHandler.handle(currentEvent.attributes.error, messageContext)"/>
        <transition on="AccountDisabledException" to="casAccountDisabledView"/>
        <transition on="AccountNotFoundException" to="generateLoginTicket"/>
    </action-state>
    <!----------------------------------Line to div ------------------------>
    <!--生成票根-->
    <action-state id="generateLoginTicket">
        <evaluate expression="generateLoginTicketAction.generate(flowRequestContext)"/>
        <transition on="generated" to="viewLoginForm"/>
    </action-state>

针对第二个问题，在确定页面发生异常的展示界面之后，那么异常的具体提示信息是怎么产生的呢？
AuthenticationExceptionHandler类，通过源码可以发现它的handle方法是根据抛出的异常类的类名来组装异常信息，组装的格式如下：
‘authenticationFailure.’ + 类名；
如 authenticationFailure.AccountDisabledException，这也是CAS系统在messages.properity国际化文件中定义的变量。前端页面就是解析出这个异常提示。具体生成的逻辑方法，可以翻看源码。

国际化messages.properity文件：

在国际化文件中定义变量authenticationFailure.AccountDisabledException及对应的值，就是具体出现的内容了。页面的Spring标签就可以解析定义的值。

 <form:errors path="*" id="msg" cssClass="errors" element="div" htmlEscape="false"/>

总结：以上就是CAS异常提示信息的机制。

自定义异常提示信息

通过上面的介绍，对CAS的异常其实提示机制大概思路应该很清楚了，那么改造起来就手到擒来了。

首先定义一个自定义异常类，建议在cas-server-core的项目中建此异常类，和AuthenticationExceptionHandler放在一个项目下面。

import javax.security.auth.login.LoginException;
public class BadPasswordException extends LoginException {
    /**
     * Constructs a BadPasswordException with no detail message. A detail
     * message is a String that describes this particular exception.
     */
    public BadPasswordException() {
        super();
    }
    /**
     * Constructs a BadPasswordException with the specified detail
     * message.  A detail message is a String that describes this particular
     * exception
     * @param msg the detail message.
     */
    public BadPasswordException(String msg) {
        super(msg);
    }
}

将该异常类添加到AuthenticationExceptionHandler处理列表中；

在login-web-flow.xml中的handleAuthenticationFailure添加跳转界面，一般情况下我们都是在登陆界面给出提示，所以此处填写generateLoginTicket，因为其还有其他的处理，最终还是流向login界面。

最后，在国际化文件messages.properity中添加提示。在各个国际化文件中都应该给出这个相应的提示。注意格式是authenticationFailure+类名。

到这里一个，CAS自定义异常信息就可以了。如果对此有兴趣和疑问的小伙伴，可以QQ深入探讨(QQ: 370731702)。