如何使用 Android (Kotlin / Java) 构建 Naver 登录

给我们的新朋友:

Logto 是一个为现代应用和 SaaS 产品设计的 Auth0 替代方案。它提供 Cloud 和开源服务，帮助你快速启动身份和管理 (IAM) 系统。享受认证 (Authentication)、授权 (Authorization) 和多租户管理一体化。

我们建议从 Logto Cloud 上的免费开发租户开始。这可以让你轻松探索所有功能。

在本文中，我们将介绍使用 Android (Kotlin / Java) 和 Logto 快速构建 Naver 登录体验（用户认证 (Authentication)）的步骤。

先决条件

一个正在运行的 Logto 实例。查看介绍页面以开始。
Android (Kotlin / Java) 的基本知识。
一个可用的 Naver 账户。

在 Logto 中创建一个应用程序

Logto 基于 OpenID Connect (OIDC) 认证 (Authentication) 和 OAuth 2.0 授权 (Authorization)。它支持跨多个应用程序的联合身份管理，通常称为单点登录 (SSO)。

要创建你的 Native app 应用程序，只需按照以下步骤操作：

打开 Logto Console。在“开始使用”部分，点击“查看全部”链接以打开应用程序框架列表。或者，你可以导航到 Logto Console > Applications，然后点击“创建应用程序”按钮。
在打开的模态窗口中，点击“Native app”部分，或使用左侧的快速过滤复选框过滤所有可用的“Native app”框架。点击 "Android (Kotlin)" / "Android (Java)" 框架卡片以开始创建你的应用程序。
输入应用程序名称，例如“Bookstore”，然后点击“创建应用程序”。

🎉 太棒了！你刚刚在 Logto 中创建了你的第一个应用程序。你将看到一个祝贺页面，其中包含详细的集成指南。按照指南查看你的应用程序中的体验将会是什么样的。

集成 Android (Kotlin) / Android (Java) SDK

提示:

示例基于 View system 和 View Model，但在使用 Jetpack Compose 时，概念是相同的。
示例是用 Kotlin 编写的，但对于 Java 来说，概念是相同的。
我们的 SDK repository 上提供了 Kotlin 和 Java 示例项目。
教程视频可以在我们的 YouTube channel 上观看。

安装

备注:

Logto Android SDK 支持的最低 Android API 级别是 24。

在安装 Logto Android SDK 之前，确保在 Gradle 项目的构建文件中将 mavenCentral() 添加到你的仓库配置中：

settings.gradle.kts
dependencyResolutionManagement {
  repositories {
    mavenCentral()
  }
}

将 Logto Android SDK 添加到你的依赖项中：

Kotlin
Groovy

build.gradle.kts
dependencies {
  implementation("io.logto.sdk:android:1.1.3")
}

build.gradle
dependencies {
  implementation 'io.logto.sdk:android:1.1.3'
}

由于 SDK 需要访问互联网，你需要在 AndroidManifest.xml 文件中添加以下权限：

AndroidManifest.xml
<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
  xmlns:tools="http://schemas.android.com/tools">

  <!-- 添加互联网权限 -->
  <uses-permission android:name="android.permission.INTERNET" />

  <!-- 其他配置... -->
</manifest>

初始化 LogtoClient

创建一个 LogtoViewModel.kt 并在此视图模型中初始化 LogtoClient：

LogtoViewModel.kt
//...with other imports
import io.logto.sdk.android.LogtoClient
import io.logto.sdk.android.type.LogtoConfig

class LogtoViewModel(application: Application) : AndroidViewModel(application) {
    private val logtoConfig = LogtoConfig(
          endpoint = "<your-logto-endpoint>",
          appId = "<your-app-id>",
          scopes = null,
          resources = null,
          usingPersistStorage = true,
    )

    private val logtoClient = LogtoClient(logtoConfig, application)

    companion object {
        val Factory: ViewModelProvider.Factory = object : ViewModelProvider.Factory {
            @Suppress("UNCHECKED_CAST")
            override fun <T : ViewModel> create(
                modelClass: Class<T>,
                extras: CreationExtras
            ): T {
                // 从 extras 中获取 Application 对象
                val application = checkNotNull(extras[APPLICATION_KEY])
                return LogtoViewModel(application) as T
            }
        }
    }
}

然后，为你的 MainActivity.kt 创建一个 LogtoViewModel：

MainActivity.kt
//...with other imports
class MainActivity : AppCompatActivity() {
    private val logtoViewModel: LogtoViewModel by viewModels { LogtoViewModel.Factory }
    //...other codes
}

配置重定向 URI

让我们切换到 Logto Console 的应用详情页面。添加一个重定向 URI io.logto.android://io.logto.sample/callback 并点击“保存更改”。

备注:

在调用 logtoClient.signIn 之前，请确保你已在管理控制台中正确配置了重定向 URI。

你可以使用 logtoClient.signIn 来让用户登录，并使用 logtoClient.signOut 来让用户登出。

例如，在 Android 应用中：

LogtoModelView.kt
//...with other imports
class LogtoViewModel(application: Application) : AndroidViewModel(application) {
    // ...other codes

    // 添加一个 live data 来观察认证状态
    private val _authenticated = MutableLiveData(logtoClient.isAuthenticated)
    val authenticated: LiveData<Boolean>
        get() = _authenticated

    fun signIn(context: Activity) {
        logtoClient.signIn(context, "io.logto.android://io.logto.sample/callback") { logtoException ->
            logtoException?.let { println(it) }
            // 更新 live data
            _authenticated.postValue(logtoClient.isAuthenticated)
        }
    }

    fun signOut() {
        logtoClient.signOut { logtoException ->
            logtoException?.let { println(it) }
            // 更新 live data
            _authenticated.postValue(logtoClient.isAuthenticated)
        }
    }
}

然后在你的 activity 中调用 signIn 和 signOut 方法：

MainActivity.kt
class MainActivity : AppCompatActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        //...other codes

        // 假设你的布局中有一个 id 为 "sign_in_button" 的按钮
        val signInButton = findViewById<Button>(R.id.sign_in_button)
        signInButton.setOnClickListener {
            logtoViewModel.signIn(this)
        }

        // 假设你的布局中有一个 id 为 "sign_out_button" 的按钮
        val signOutButton = findViewById<Button>(R.id.sign_out_button)
        signOutButton.setOnClickListener {
            if (logtoViewModel.authenticated) { // 检查用户是否已认证
                logtoViewModel.signOut()
            }
        }

        // 观察认证状态以更新 UI
        logtoViewModel.authenticated.observe(this) { authenticated ->
            if (authenticated) {
                // 用户已认证
                signInButton.visibility = View.GONE
                signOutButton.visibility = View.VISIBLE
            } else {
                // 用户未认证
                signInButton.visibility = View.VISIBLE
                signOutButton.visibility = View.GONE
            }
        }

    }
}

检查点：测试你的应用程序

现在，你可以测试你的应用程序：

运行你的应用程序，你将看到登录按钮。
点击登录按钮，SDK 将初始化登录过程并将你重定向到 Logto 登录页面。
登录后，你将被重定向回你的应用程序，并看到登出按钮。
点击登出按钮以清除令牌存储并登出。

添加 Naver 连接器

要实现快速登录并提高用户转化率，请将 Android (Kotlin) / Android (Java) 作为身份提供商 (IdP) 进行连接。Logto 社交连接器可以帮助你在几分钟内通过允许输入多个参数来建立此连接。

要添加社交连接器，只需按照以下步骤操作：

导航到 Console > Connectors > Social Connectors。
点击“添加社交连接器”并选择“Naver”。
按照 README 指南完成必填字段并自定义设置。

备注:

如果你正在按照现场连接器指南进行操作，可以跳过下一部分。

设置 Naver 登录

仅开发者网站支持韩语

目前 Naver Developers 网站仅支持韩语。请考虑使用翻译工具。

用于生产环境

对于生产环境，你必须获得 Naver 团队的审核。否则，只有注册用户可以登录。
- 你可以从 맴버관리(Member Manage) 菜单中添加测试人员。
要获得审核，请检查应用程序项目设置中的 API 설정(API Setting) 下的 애플리케이션 개발 상태(Application Devlopment Status)。

在 Naver Developers 中设置项目

访问 Naver Developers 并使用你的 Naver 账户登录。
从菜单中点击 Application -> 어플리케이션 등록 来创建新项目。
按照以下说明创建应用程序。

应用程序名称 (어플리케이션 이름)

在 어플리케이션 이름 中输入你的应用程序名称（此名称将在用户登录时显示）。

API 使用 (사용 API)

为 사용 API(API Usage) 选择 네이버 로그인(Naver Login)
从 권한(Role) 中将 이메일 주소(Email Address), 별명(Nickname), 프로필 사진(Profile Image) 勾选为 필수(Neccessary)（你可以将这些选项勾选为 추가(Add) 作为可选项，但你无法从用户那里获取信息。）

对于 로그인 오픈 API 서비스 환경(Sign in Open API Service Environment)，添加两个环境 PC웹(PC Web) 和 모바일웹(Mobile Web)。

PC Web (PC 웹)

对于 서비스 URL(Service URL)，输入 http(s)://YOUR_URL（例如：https://logto.io）
对于 네이버 로그인(Naver Login) Callback URL，输入 http(s)://YOUR_URL/callback/${connector_id}（例如：https://logto.io/callback/${connector_id}）

Mobile Web (Mobile 웹)

对于 서비스 URL(Service URL)，输入 http(s)://YOUR_URL（例如：https://logto.io）
对于 네이버 로그인(Naver Login) Callback URL，输入 http(s)://YOUR_URL/callback/${connector_id}（例如：https://logto.io/callback/${connector_id}）

警告:

connector_id 可以在 Logto 管理控制台连接器详情页面的顶部栏找到。

配置 Logto

配置类型

名称	类型
clientId	string
clientSecret	string

clientId

clientId 是你项目的 Client ID。（你可以在 Naver developers 的项目 애플리케이션 정보(Application Info) 中找到。）

clientSecret

clientSecret 是你项目的 Client Secret。（你可以在 Naver developers 的项目 애플리케이션 정보(Application Info) 中找到。）

保存你的配置

仔细检查你是否在 Logto 连接器配置区域填写了必要的值。点击“保存并完成”（或“保存更改”），Naver 连接器现在应该可用了。

一旦你成功创建了一个社交连接器，你可以在登录体验中将其启用为“继续使用 Naver”按钮。

导航到 Console > 登录体验 > 注册和登录。
（可选）如果只需要社交登录，选择“无”作为注册标识符。
将配置好的 Naver 连接器添加到“社交登录”部分。

登录体验选项卡

测试和验证

返回到你的 Android (Kotlin / Java) 应用。你现在应该可以使用 Naver 登录了。享受吧！

拓展阅读

终端用户流程：Logto 提供开箱即用的认证 (Authentication) 流程，包括多因素认证 (MFA) 和企业单点登录 (SSO)，以及强大的 API，用于灵活实现账户设置、安全验证和多租户体验。

授权 (Authorization)：授权 (Authorization) 定义了用户在被认证 (Authentication) 后可以执行的操作或访问的资源。探索如何保护你的 API 以用于原生和单页应用程序，并实现基于角色的访问控制 (RBAC)。

组织 (Organizations)：在多租户 SaaS 和 B2B 应用中特别有效，组织功能支持租户创建、成员管理、组织级 RBAC 和即时供应。

客户 IAM 系列：我们关于客户（或消费者）身份和访问管理的系列博客文章，从 101 到高级主题及更深入的内容。

在 Logto 中创建一个应用程序​

集成 Android (Kotlin) / Android (Java) SDK​

安装​

初始化 LogtoClient​

配置重定向 URI​

实现登录和登出​

检查点：测试你的应用程序​

添加 Naver 连接器​

设置 Naver 登录​

仅开发者网站支持韩语​

用于生产环境​

在 Naver Developers 中设置项目​

应用程序名称 (어플리케이션 이름)​

API 使用 (사용 API)​

登录开放 API 服务环境 (로그인 오픈 API 서비스 환경)​

PC Web (PC 웹)​

Mobile Web (Mobile 웹)​

配置 Logto​

配置类型​

clientId​

clientSecret​

保存你的配置​

在登录体验中启用 Naver 连接器​

测试和验证​

拓展阅读​