飞书登录

更新时间: 2023-03-19 15:57:17
编辑

准备工作

企业自建应用在飞书开发者后台 (opens new window) 及 Authing Console 控制台 (opens new window)进行配置，请参阅飞书企业自建应用 (opens new window)。


集成飞书登录步骤

第一步：添加依赖

implementation 'cn.authing:guard:+'
implementation files ('libs/larksso-3.0.8.aar')
implementation 'com.alibaba:fastjson:1.1.58.android'

Guard 只是 compileOnly 依赖飞书，这样可以让 App 按需引入，防止 Guard aar 包随着支持的第三方登录增加而越来越大。所以每增加一个第三方身份源，都需要 App 手动加上该身份源的依赖

第二步：初始化 Guard Android SDK

在应用启动的时候初始化：

// context is application or initial activity
// ”AUTHING_APP_ID“ is obtained from the Authing console
Authing.init(context, "AUTHING_APP_ID");
Authing.setAuthProtocol(Authing.AuthProtocol.EOIDC)

通过以上步骤即可简单快速的通过 Authing 管理控制台配置后自动获取飞书身份源，登录入口会在 Guard 内置登录界面的社会化登录按钮列表中体现

  • 接下来，如果使用我们提供的飞书登录按钮，则在布局文件里面加上（或者代码初始化添加）
<cn.authing.guard.social.view.LarkLoginButton
    android:id="@+id/btn_lark_login"
    android:layout_width="48dp"
    android:layout_height="48dp" />

然后在 java 代码里面处理事件

LarkLoginButton button = findViewById(R.id.btn_lark_login);
button.setOnLoginListener(new AuthCallback<UserInfo>() {
    @Override
    public void call(int code, String message, UserInfo data) {
      	if (code == 200) {
        	// 登录成功，data 是用户信息
       	} else {
        	// 登录失败
      	}
    }
});

  • 如果不想使用我们内置的按钮，则可以在自己按钮的点击事件里面调用 Authing 飞书登录授权类
Lark lark = new Lark();
lark.login(appContext, new AuthCallback<UserInfo>() {
    @Override
    public void call(int code, String message, UserInfo data) {
        if (code == 200) {
          // 登录成功，data 是用户信息
        } else {
          // 登录失败
        }
    }
});

data 包含 idToken 以及用户信息（用户名、昵称、姓名等）。

注意：使用飞书登录按钮或者飞书登录授权类时，需要在 Activity 的 onResume、onNewIntent、onActivityResult 函数中加入如下代码：

@Override
protected void onResume() {
    super.onResume();
    try {
        Class.forName("com.ss.android.larksso.LarkSSO");
        LarkSSO.inst().parseIntent(this, getIntent());
    } catch( ClassNotFoundException e ) {
    }
}

@Override
protected void onNewIntent(Intent intent) {
    super.onNewIntent(intent);
    try {
        Class.forName("com.ss.android.larksso.LarkSSO");
        LarkSSO.inst().parseIntent(this, intent);
    } catch( ClassNotFoundException e ) {
    }
}

@Override
protected void onActivityResult(int requestCode, int resultCode, @Nullable Intent data) {
    super.onActivityResult(requestCode, resultCode, data);
    try {
        Class.forName("com.ss.android.larksso.LarkSSO");
        LarkSSO.inst().parseIntent(this, data);
    } catch( ClassNotFoundException e ) {
    }
}

  • 如果想完全自己实现飞书登录，拿到授权码后，可以调用下面 API 换取用户信息
public static void loginByLark(String authCode, @NotNull AuthCallback<UserInfo> callback)

参数

authCode 飞书授权码

示例

如果你只需要获取到用户信息（用户名、昵称、姓名等）和 idToken，调用：

AuthClient.loginByLark(authCode, new AuthCallback<UserInfo>() {
    @Override
    public void call(int code, String message, UserInfo data) {
        if (code == 200) {
          // 登录成功，data 是用户信息, 包含 idToken。
        } else {
          // 登录失败
        }
    }
});

如果你需要获取到用户信息（用户名、昵称、姓名等）、idToken、accessToken 和 refreshToken，调用：

OIDCClient oidcClient = new OIDCClient();
oidcClient.loginByLark(authCode, new AuthCallback<UserInfo>() {
    @Override
    public void call(int code, String message, UserInfo data) {
        if (code == 200) {
          // 登录成功，data 是用户信息, 包含 idToken、accessToke and refreshToken。
        } else {
          // 登录失败
        }
    }
});