SmartFoxServer 2X開發文件

前一陣子因為公司專案順便學的Java Server framework,以下是如何安裝跟如何使用一些內建framework API

/*******************************************************************************************************
SmartFox安裝
    到官方下載SmartFox安裝檔,安裝即可,免費上線人數為100人,如果要公開使用要在畫面show Power by SmartFox Server 2X

SmartFox更新
    下載SmartFox更新檔,並將檔案放置到SmartFox安裝的目錄執行install.bat進行安裝
   
SmartFox Extension更新
  使用eclipse:
          1.匯出Jar:使用Export功能匯出jar檔,並將檔案放置到 SmartFox安裝的目錄/SFS2X/extensions/zone name/
          2.設定SmartFox Extensions:
              1.開啟SmartFox admin tool,並登入admin tool
              2.選擇zone configurator分頁,並選擇要加入extension的zone選擇編輯功能
              3.選擇Zone Extension分頁
                  1.選擇Name選項,選取要使用的extension name
                  2.選擇Main class選項,選取要設定為Main class的class name             
          3.重新啟動smartfox server
         
SmartFox 設定:
  1.socket allow ip address:
    設定允許IP名單:
    開啟 SmartFox安裝的目錄/SFS2X/config/server.xml
    以下為允許清單,IP address ,port ,type = TCP or UDP
    <socketAddresses>
        <socket address="127.0.0.1" port="9933" type="TCP"/>
        <socket address="127.0.0.1" port="18881" type="TCP"/>
        <socket address="127.0.0.1" port="18881" type="UDP"/>
        <socket address="192.168.1.42" port="9933" type="TCP"/>
        <socket address="192.168.1.42" port="9933" type="UDP"/>
        <socket address="192.168.1.42" port="18881" type="UDP"/>
      </socketAddresses>
SmartFox Room Variables設定
    1.GroupID必須設定成預設跟公開
    2.Variables必須設定成global
    code:
        //宣告roomVarList
        List<RoomVariable> roomVarList = new ArrayList<RoomVariable>();
        //設定roomVar參數       
        SFSRoomVariable roomVar = new SFSRoomVariable("Test", "Test",false, true, true);
        //新增至roomVarList陣列
        roomVarList.add(roomVar);           
        //將Room variables 加入Room settings參數
    roomSettings.setRoomVariables(roomVarList);
SmartFox User Variables設定
    1.設定User variables必須使用getApi().setUserVariables,才能觸發USER_VARIABLES_UPDATE SFSEvent事件
    2.admin tool可設定user variables的數量,預設為5
    code:
        //宣告userVarList
        List<UserVariable> userVarList = new ArrayList<UserVariable>();
        //設定userVar參數   
        UserVariable userVar = new SFSUserVariable("TestUserVar", "userVars");
        //新增至userVarList陣列
        userVarList.add(userVar);       
        //更新使用者variables           
        getApi().setUserVariables(user, userVarList, true, true);
SmartFox DataBase 設定
    1.admin tool設定使用Database manager,選擇Database manager分頁
        //啟動Database manager
            1.Activate = true
        //設定Database Driver
            2.Database driver class = org.gjt.mm.mysql.Driver
        //Database IP及要使用的database name
            3.connection string = jdbc:mysql://localhost:3306/db name
        //Database user name
            4.username = dbUser
        //Database user password
            5.password = dbPassword
        //測試Database Server的Test SQL
            7.Test SQL = SELECT COUNT(*) FROM members
        //最多可以使用的連線數
            8.Maximun # of active connections
        //最多可以失效的連線數
            9.Maximun # of idle connections
        //當可用連線都用完的處理方式
            10.Exhausted pool action
                1.FAIL  傳送連線失敗
                2.BLOCK    直接阻擋
                3.GROW    追加新連線到連線池
        //阻檔連線時間
            11.Block time
    code:
        //建立連線及取得資訊
        try {
            //建立IDBManager
         IDBManager dbManager = getParentExtension().getParentZone().getDBManager();
        
         //建立連線資源
      Connection connection = dbManager.getConnection();
     
         //建立靜態SQL
         PreparedStatement stmt = connection.prepareStatement("SELECT * FROM members WHERE name = ?");
         //設定SQL name = String(name)
         stmt.setString(1, name);
                
         //執行SQL查詢
         ResultSet res = stmt.executeQuery();
        
         //如果查詢資源沒有資料,輸出例外
         if (!res.first()){
            //對Client發出例外錯誤
            SFSErrorData errData = new SFSErrorData(SFSErrorCode.LOGIN_BAD_USERNAME);
            errData.addParameter(name);                   
           
            //記錄錯誤情況到 Server Log
            throw new SFSLoginException("Bad user name: " + name, errData);
        }
        //輸出UID欄位資訊
         trace("RES:" + res.getString("uid"));                
        
    } catch (SQLException e) {
         // TODO Auto-generated catch block
         e.printStackTrace();
    }
   
    Sample 2 code:
     IDBManager dbManager = getParentExtension().getParentZone().getDBManager();
        String sql = "SELECT * FROM people";
        
        try
        {
            // Obtain a resultset
            ISFSArray res = dbManager.executeQuery(sql);
            
            // Populate the response parameters
            ISFSObject response = new SFSObject();
            response.putSFSArray("people", res);
            
            // Send back to requester
            send("getPeople", response, sender);
        }
        catch (SQLException e)
        {
            trace(ExtensionLogLevel.WARN, "SQL Failed: " + e.toString());
        }
SmartFox buddy 設定
        1.使用admin tool,進入zone 設定,選擇buddy list 分頁
        2.Activate = true
        3.Maximum # of buddyies per user
        4.Maximum # of Buddy Variables
        5.Allow offline Buddy Variables
        6.Offline Budy variables cache size
        7.Custom Buddy List storage class
        8.Custom states
        9.Allow temportary buddies
        10.Enables bad words filter
       
        要設定成可下線依然可以取得資訊的buddy variables的話,必須在variable name前面加上$號
        code:
            SFSBuddyVariable buddyVar = new SFSBuddyVariable("$TestBuddyVars","Buddy " + buddyObj.getName());
       
        設定Buddy variables方式:
        code:
            //當A玩家對另一線上玩家B,加入buddy時,寫入buddy variables
            Buddy buddy = (Buddy) event.getParameter(SFSBuddyEventParam.BUDDY);       
            User AddUser = this.getParentExtension().getParentZone().getUserByName(buddy.getName());
            ISFSBuddyApi buddyApi = SmartFoxServer.getInstance().getAPIManager().getBuddyApi();       
            List<BuddyVariable> buddyVars = new ArrayList<BuddyVariable>();
            SFSBuddyVariable buddyVar = new SFSBuddyVariable("$OffLineVars","BuddyOffTest");
            buddyVars.add(buddyVar);
            buddyApi.setBuddyVariables(AddUser, buddyVars, true, true);

SmartFox 使用Invitation邀請API
        1.邀請的玩家跟被邀請的玩家必須在同一個room下
        2.Invitation必須額外用一支ExtensionAPI做觸發事件
            like:
            addRequestHandler("User.inviteUser",InviteUserHandler.class);
        3.Extension API要處理以下事情
            1.建立新的Invitation
            2.要設定Invitation返回類別
            3.使用GameAPI送出Invitation
        4.Client會收到SFSEvent.INVITATION的Event,然後再由Client發送answer
       
        備註:Invitation可以攜帶SFSObject傳送
       
        code:
            /*----------------------------------
            InviteUserHandler.class
            ----------------------------------*/
            User buddy = getParentExtension().getParentZone().getUserByName(params.getUtfString("buddyName"));
        if(buddy != null){
            trace("send invite request" + sender.getName() + ',' + buddy.getName());
            ISFSObject SFSObj = SFSObject.newInstance();
            SFSObj.putUtfString("Test",sender.getName());
            //建立新的Invitation
            Invitation invitation = new SFSInvitation(sender, buddy, (int) 30, SFSObj);
            //設定Invitation返回類別
                InvitationCallback cb = new InviteSensor();
                //使用GameAPI送出Invitation
                SmartFoxServer.getInstance().getAPIManager().getGameApi().sendInvitation(invitation, cb);
        }
        /*----------------------------------
            InviteSensor.class
            ----------------------------------*/
            public class InviteSensor implements InvitationCallback {
                @Override
                public void onAccepted(Invitation arg0, ISFSObject arg1) {
                    // TODO Auto-generated method stub
                    //玩家接受
                    System.out.println("onAccepted");
                }           
                @Override
                public void onExpired(Invitation arg0) {
                    // TODO Auto-generated method stub
                    //過期沒回應或是玩家斷線
                    System.out.println("onExpired");
                }           
                @Override
                public void onRefused(Invitation arg0, ISFSObject arg1) {
                    // TODO Auto-generated method stub
                    //玩家拒絕
                    System.out.println("onRefused");
                }           
            }