UCenter在JAVA項目中實現的單點登錄應用實例


Comsenz(康盛)的UCenter當前在國內的單點登錄領域占據絕對份額,其完整的產品線令UCenter成為了賬號集成方面事實上的標准。

基於UCenter,可以將Comsenz旗下的Discuz!(社區論壇系統)、SupeSite(門戶CMS系統)、X-Space(博客系統)從用戶資源層面進行無縫整合,使得賬號實現統一管理,在任何一個系統中進行注冊、登錄、注銷等操作時,該賬號在其他系統中的會話狀態也將同步更新,最終實現一號通的單點登錄模式。

UCenter具備良好的擴展性,除了完美兼容自家的各種系統外,還支持其他項目的集成。

我現在准備做的,就是要在一個JAVA項目中,將會員賬號部分與UCenter保持同步,以便將來可以順利的嵌入Discuz!社區論壇系統。

幸好,已經有人為我們寫好了一個面向JAVA的UCenter接口方案,其項目地址為:http://code.google.com/p/discuz-ucenter-api-for-java

我本次也是基於這個名叫discuz-ucenter-api-for-java的API來實現,感謝作者ping.china


 

一、准備工作

1、下載UCenter:http://www.comsenz.com/downloads/install/ucenter

2、將UCenter部署到支持PHP腳本的服務器上,然后按照向導進行安裝即可。

3、訪問UCenter控制台,添加新應用,其中:

安裝方式:自定義

應用類型:其他

應用名稱:JAVA項目名稱,可隨意

應用主URL:JAVA項目的訪問地址,例如:http://localhost:8080/javaTest

通信密鑰:任意字符,例如:123456

應用接口文件名稱:uc.php,這個不要改,前面也不要加/api/,UCenter在與其通信時會自動轉換為:http://localhost:8080/javaTest/api/uc.php

是否開啟同步登錄:是

是否接受通知:是

以上的配置項必填,其他保持為空即可

點擊“提交”,保存成功后,記下該JAVA應用的APPID,下面的配置中會需要。

此時返回應用列表,UCenter會自動進行通信驗證,不出意外肯定會出現“通信失敗”的字樣,先不必管它

二、JAVA項目配置

1、從“discuz-ucenter-api-for-java”的開源項目網站中下載相關的API文件,也可以從這里下載:JAVA_UCenter.zip

2、將JAVA_UCenter.zip解壓、覆蓋到你的JAVA項目中,其中的新文件有:

src/config.properties:本地的JAVA項目與UCenter的接口配置文件(需要根據實際環境進行配置

src/api/ucenter/Base64.java

src/api/ucenter/Client.java:將常用的UCenter操作封裝成的客戶端對象,我們在項目中主要用它來與UCenter打交道

src/api/ucenter/PHPFunctions.java

src/api/ucenter/UC.java:本地的JAVA項目用來接收UCenter同步命令的Servlet接口,其訪問地址必須為:/api/uc.php

src/api/ucenter/XMLHelper.java

WebRoot/WEB-INF/web.xml:主要就是將src/api/ucenter/UC.java定義為Servlet

 

注意:

(1) src/config.properties中的代碼如下:

# ================================================
# Ucenter API for JAVA
# ================================================
UC_API = http://localhost:9201
UC_IP =
UC_KEY = 123456
UC_APPID = 2
UC_CONNECT =

其中,UC_API表示UCenter的訪問地址,UC_KEY就是在UCenter中添加新應用時定義的通信密鑰,UC_APPID表示新應用的APPID,就是剛才記下的那個。

除這三項外,其他的配置保持為空即可。

(2) WebRoot/WEB-INF/web.xml中的代碼如下:

<?xml version="1.0" encoding="UTF-8"?>
<web-app version="2.4"
    xmlns="http://java.sun.com/xml/ns/j2ee"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee
    http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd">
    
  <servlet>
    <display-name>同步UC Server發出的操作指令</display-name>
    <servlet-name>UC</servlet-name>
    <servlet-class>api.ucenter.UC</servlet-class>
    <load-on-startup>2</load-on-startup>
  </servlet>
  <servlet-mapping>
    <servlet-name>UC</servlet-name>
    <url-pattern>/api/uc.php</url-pattern>
  </servlet-mapping>
 
</web-app>

別的無所謂,只需注意這一行:<url-pattern>/api/uc.php</url-pattern>

3、JAVA端配置完成,在eclipse中啟動調試模式

4、再次返回到UCenter的控制台,點擊應用管理,此時應該會看到綠色的“通信成功”字樣

三、在JAVA項目中如何具體與UCenter進行通信

做到這里,JAVA項目與UCenter的基本集成工作已經圓滿完成。

至於在JAVA中如何使用Client對象與UCenter進行同步通信,就很簡單了, 具體可以到discuz-ucenter-api-for-java的開源項目中查看

四、讓JAVA項目與Discuz!進行會話狀態同步

1、在JAVA項目中登錄、退出,同步到Discuz!

在JAVA項目中,用戶登錄成功之后,需要執行以下代碼:

        Client uc = new Client();
        String $ucsynlogin = uc.uc_user_synlogin($uid);
        out.println($ucsynlogin);

其中的$ucsynlogin其實是一段JavaScript代碼,這段代碼是從UCenter返回的

目的就是向已經在UCenter中注冊的應用發送狀態同步請求,保持會話狀態一致性

所以,就要保證$ucsynlogin中的JS代碼必須輸出到瀏覽器,並且成功執行

2、在Discuz!中登錄、退出,同步到JAVA項目

首先,要注意一個配置選項,位於Discuz!管理控制台的:站長 - UCenter設置中

UCenter 連接方式:必須選擇“接口方式”,如果選擇“數據庫方式”,則不會向其他應用發送同步請求

然后,在我們JAVA項目中,作為與UCenter對話的窗口,src/api/ucenter/UC.java就會負責接收其他應用通過UCenter發送過來的會話狀態同步請求

其中的$action.equals("synlogin")為登錄同步,修改其中對Cookie的賦值代碼,實現本地系統的會話也保持登錄狀態

其中的$action.equals("synlogout")為登出同步,同樣,修改代碼,實現本地的登出同步。

注意其中的一行代碼:

response.addHeader("P3P","CP=\"CURa ADMa DEVa PSAo PSDo OUR BUS UNI PUR INT DEM STA PRE COM NAV OTC NOI DSP COR\"");

意思是要求瀏覽器對當前的Cookie操作寬容對待,如果涉及跨域操作也不要阻止。所以,這行代碼原樣保留,可以使狀態同步更加穩定。

五、已知問題

貌似使用中文注冊的賬號,在同步時可能會因為Base64解碼不一致的原因發生問題,具體我還沒有測試,等到發生時再詳細記載。

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM