钉钉登录

更新时间: 2024-10-10 07:28:40
编辑

准备工作

在 钉钉开放平台 (opens new window) 及 Authing Console 控制台 (opens new window)进行配置，请参阅 钉钉接入准备、钉钉官方文档 (opens new window)。

此功能在 android guard sdk 1.5.1 版本新增。


集成步骤

第一步：添加依赖

implementation 'cn.authing:guard:+'
implementation 'com.alibaba.android:ddopenauth:1.5.0.8'
implementation 'com.alibaba.android:ddsharesdk:1.1.0'

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

注意事项

如果需要混淆代码，为了保证 sdk 的正常使用，需要在 proguard.cfg 加上下面配置：

-keep class com.android.dingtalk.openauth.**{*;}

第二步：初始化

在应用启动的时候初始化 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)

第三步：创建 DDAuthActivity

  1. 在包名相应目录下新建 ddauth 文件夹，并新增 DDAuthActivity，假设你的包名为 com.example.myapp，其内容只需要继承我们的实现类：
package com.example.myapp.ddauth;

import cn.authing.guard.social.callback.ddauth.DDCallBackActivity;

public class DDAuthActivity extends DDCallBackActivity {
}

  1. 在工程 AndroidManifest.xml 中添加声明：

    <activity android:name=".ddauth.DDAuthActivity"
    android:exported="true"/>

第四步：分场景使用

  • 使用托管页

    在需要登录认证的地方启动托管页：
// this is the activity context
AuthFlow.start(this);

通过以上步骤即可简单快速地通过配置 Authing 管理控制台后自动拥有钉钉登录功能，登录入口会在 Guard 内置登录界面的社会化登录按钮列表中体现。

  • 使用钉钉登录按钮

    如果使用我们提供的钉钉登录按钮。

​ 1. 布局文件里面加上如下代码：

 <cn.authing.guard.social.view.DingTalkLoginButton
    android:id="@+id/btn_login"
    android:background="@drawable/authing_button_background"
    android:textColor="@color/white"
    android:layout_width="match_parent"
    android:layout_height="wrap_content" />

​ 2. 然后在代码里面处理事件：

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

  • 使用钉钉登录授权类

    如果不想使用我们内置的按钮，想完全自己实现 UI，则可以在按钮的点击事件里面调用 DingTalk 类的授权函数，此类集成了拉起钉钉授权登录的业务逻辑：
DingTalk.getInstance().login(appContext, new AuthCallback<UserInfo>() {
    @Override
    public void call(int code, String message, UserInfo data) {
        if (code == 200) {
          // 登录成功，data 是用户信息
        } else {
          // 登录失败
        }
    }
});

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

  • 使用钉钉登录 API

    如果想完全自己实现钉钉登录 UI 以及获取授权码逻辑，拿到授权码后，可以调用下面 API 换取用户信息：

public static void loginByDingTalk(String authCode, @NotNull AuthCallback<UserInfo> callback)

参数

authCode 钉钉 code

示例

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

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