登錄、註冊、用戶信息等接口文檔與示例

原本寫在數據庫的接口示例裏面，想了想感受不太穩當，因此新開博客。

目錄

登錄、註冊
用戶信息

登錄、註冊

使用com.example.dell.auth.ServerAuthenticator類

接口：

static public boolean signIn(String username, String password, Bundle bundle)：登錄。參數中username與password爲用戶名與密碼，bundle用於返回服務器的結果；返回值表示可否與服務器通訊，爲true表示與服務器通訊，爲false表示不能與服務器通訊；假如返回值爲true，bundle中有屬性boolean success表示是否成功登錄，String msg表示服務器返回的信息，若屬性boolean success爲true，bundle中還有屬性String token表示token（詳見Example）

static public boolean signUp(String username, String password, Bundle bundle)：註冊。參數中username與password爲用戶名與密碼，bundle用於返回服務器的結果；返回值表示可否與服務器通訊，爲true表示與服務器通訊，爲false表示不能與服務器通訊；假如返回值爲true，bundle中有屬性boolean success表示是否成功註冊，String msg表示服務器返回的信息（詳見Example）。

Example. 登錄

前提：name passwd是已有的字符串

Bundle bundle = new Bundle();
        boolean status = ServerAuthenticator.signIn(name, passwd, bundle);
        if(status == false) {
                // 接口錯誤或者網絡錯誤
        }
        else {
                boolean success = bundle.getBoolean("success");
                String msg = bundle.getString("msg");
                // success表示操做成功與否；msg表示服務器返回信息
                if(success) {
                        // 只有success時纔有token
                        String token = bundle.getString("token");
                }
        }

Example. 註冊

前提：name passwd是已有的字符串

Bundle bundle = new Bundle();
        boolean status = ServerAuthenticator.signUp(name, passwd, bundle);
        if(status == false) {
                // 接口錯誤或者網絡錯誤
        }
        else {
                boolean success = bundle.getBoolean("success");
                String msg = bundle.getString("msg");
                // success表示操做成功與否；msg表示服務器返回信息
        }

用戶信息

使用com.example.dell.auth.MyAccount類

字段：

• String name（用戶名）
• String token（token）
• String nickname（暱稱）
• String gender（性別）
• String birthday（生日）
• String email（郵箱）
• String school（學校）
• String signature（個性簽名）
• int image（頭像）

接口：

static public MyAccount get(Context context)：用於得到一個MyAccount對象。因爲帳戶有惟一性，這個類不容許直接new，只能經過這個方法得到惟一的一個對象。即，無論在什麼地方，調用這個函數得到的都是同一個對象。

getter and setter：上面那些字段的getter和setter。詳略。

save：爲了減小文件操做，若是修改了字段，只有調用這個函數纔會保存當前的全部屬性，不然不會保存。

Example. 獲取用戶信息

MyAccount myAccount = MyAccount.get(getContext());
        String name = myAccount.getName();    // 相似能夠調用其餘getter方法獲取其餘屬性

Example. 編輯用戶信息

MyAccount myAccount = MyAccount.get(getContext());
        myAccount.setName("hello");
        myAccount.setSchool("USTC");
        myAccount.save();    // 假如不save，這些信息不會保存，即本次仍是可以獲得設置的值，但下次打開app時不會獲得設置的值