1. Development Integration
  2. /
  3. Single Page Web Application
  4. /
  5. React

React 登录组件

Update time: 2025-07-23 07:34:21
Edit

GenAuth 登录组件（Guard）是一种可嵌入的登录表单，可根据你的需求进行配置，建议用于单页面应用程序。它使你可以轻松添加各种社会化登录方式，以便你的用户可以无缝登录，并且在不同平台拥有一致的登录体验。Guard 为开发者屏蔽了很多底层认证的实现细节，同时也包括繁琐的 UI 开发。

Guard 可以通过组件化的形式集成到你的 React 项目中，你可以借助此组件快速实现登录认证流程。

查看旧版 react 文档

快速开始

使用 npm

安装

$ yarn add @authing/react-ui-components

# OR

$ npm install @authing/react-ui-components --save

初始化

在 React 项目中初始化：

import React from "react";
import ReactDOM from "react-dom";
import { Guard } from "@authing/react-ui-components";
// 引入 css 文件
import "@authing/react-ui-components/lib/index.min.css";

const App = () => {
  const appId = "GEN_AUTH_APP_ID";
  const onLogin = (userInfo) => {
    console.log(userInfo);
  };
  return <Guard appId={appId} onLogin={onLogin} />;
};

ReactDOM.render(<App />, document.getElementById("root"));

使用 CDN

使用 CDN 引入

<!-- 引入 babel，支持 jsx -->
<script src="https://cdn.jsdelivr.net/npm/babel-standalone@6.26.0/babel.min.js"></script>

<!-- 引入 React -->
<script src="https://cdn.jsdelivr.net/npm/react@16.14.0/umd/react.production.min.js" crossorigin></script>
<script src="https://cdn.jsdelivr.net/npm/react-dom@16.14.0/umd/react-dom.production.min.js" crossorigin></script>

<!-- JavaScript 代码 -->
<script>
  window.react = React
  window['react-dom']  = ReactDOM
</script>
<script src="https://cdn.jsdelivr.net/npm/@authing/react-ui-components"></script>

<!-- CSS 文件 -->
<link href="https://cdn.jsdelivr.net/npm/@authing/react-ui-components/lib/index.min.css" rel="stylesheet"></link>

在 Script 代码块中初始化

<script>
  var App = () => {
    const appId = "GEN_AUTH_APP_ID";
    const onLogin = (userInfo) => {
      console.log(userInfo);
    };
    return <AuthingReactUIComponents.Guard appId={appId} />;
  };

  ReactDOM.render(<App />, document.getElementById("root"));
</script>

监听登录事件

Guard 组件传入 onLogin 事件回调函数，当用户成功登录时回调用此函数，你可以在此获取当前用户的用户信息。查看完整事件列表。

import { Guard } from "@authing/react-ui-components";
import "@authing/react-ui-components/lib/index.min.css";

function App() {
  return (
    <div className="App">
      <Guard
        appId="GEN_AUTH_APP_ID"
        onLogin={(userinfo) => {
          console.log(userinfo);
        }}
      />
    </div>
  );
}
了解获取用户信息之后该怎么做？

After obtaining the user information, you can get the user's identity credentials (the token field of the user information). You can carry this token in the subsequent request sent by the client to the backend server. Take axios as an example:

const axios = require("axios");
axios
  .get({
    url: "https://yourdomain.com/api/v1/your/resources",
    headers: {
      Authorization: "Bearer ID_TOKEN",
    },
  })
  .then((res) => {
    // custom codes
  });

In the backend interface, you need to check the legitimacy of this token to verify the user's identity. For details on the verification method, please see Verify User Identity Credentials (token). After identifying the user, you may also need to manage permissions for the user to determine whether the user has permission to operate the API.

添加社会化登录

在初始化参数 config 中传入 socialConnections 列表指定需要显示的社会化登录（默认显示该应用配置的所有社会化登录）。

import { Guard, SocialConnections } from "@authing/react-ui-components";

function App() {
  return (
    <div className="App">
      <Guard
        appId="GEN_AUTH_APP_ID"
        onLogin={(userinfo) => {
          console.log(userinfo);
        }}
        config={{
          socialConnections: [SocialConnections.Github],
        }}
      />
    </div>
  );
}
查看支持的社会化登录列表及接入流程

GenAuth 目前一共支持国内外将近 20 余种社会化登录，如微信、GitHub、Sign in with Apple、支付宝等，以下是完整的列表：

Social Login MethodUsage ScenarioDocumentation
PC WeChat QR CodePC WebsiteDocumentation
WeChat MobileMobile APPDocumentation
WeChat Web AuthorizationWeChat Web PageDocumentation
WeChat Official Account ScanningPC WebsiteDocumentation
WeChat Mini ProgramWeChat Mini ProgramDocumentation (opens new window)
WeChat PC Mini Program QR CodePC WebsiteDocumentation
WeChat Mini Program App LaunchMobile APPDocumentation
Tencent QQPC WebsiteDocumentation
Tencent QQ MobileMobile APPDocumentation
Sina WeiboPC WebsiteDocumentation
Sina Weibo MobileMobile APPDocumentation
GitHubPC WebsiteDocumentation
GitHub MobileMobile APPDocumentation
FacebookPC WebsiteDocumentation
Facebook MobileMobile APPDocumentation
TwitterPC WebsiteDocumentation
Twitter MobileMobile APPDocumentation
Google WebPC WebsiteDocumentation
Google MobileMobile APPDocumentation
Apple WebPC WebsiteDocumentation
Apple MobileMobile APPDocumentation
Alipay WebPC WebsiteDocumentation
Alipay MobileMobile APPDocumentation
SlackPC WebsiteDocumentation
Slack MobileMobile APPDocumentation
GiteePC WebsiteDocumentation
GitLabPC WebsiteDocumentation
GitLab MobileMobile APPDocumentation
BaiduPC WebsiteDocumentation
Baidu MobileMobile APPDocumentation
LinkedInPC WebsiteDocumentation
LinkedIn MobileMobile APPDocumentation
NetEase Yidun (One-click Login)Mobile APPDocumentation
QingCloudPC WebsiteDocumentation
InstagramPC WebsiteDocumentation
Douyin MobileMobile APPDocumentation
Douyin Mini ProgramMobile APPDocumentation (opens new window)
Kuaishou MobileMobile APPDocumentation
Xiaomi MobileMobile APPDocumentation
Line MobileMobile APPDocumentation

退出登录

使用 Guard 组件，组件加载完成后回触发的 onLoad 事件与登录成功触发的 onLogin 事件都会返回 AuthClient。获取到 AuthClient 进行手动单例保存，可以在需要调用退出登录的时候使用。

import { Guard, SocialConnections } from "@authing/react-ui-components";

function App() {
  let guardAuthClient;

  return (
    <div className="App">
      <Guard
        appId="GEN_AUTH_APP_ID"
        onLogin={(userinfo, authClient) => {
          console.log(authClient);
        }}
        onLoad={(authClient) => {
          console.log(authClient);
          guardAuthClient = authClient;
        }}
      />

      {guardAuthClient && (
        <button onClick={() => guardAuthClient.logout()}>退出</button>
      )}
    </div>
  );
}

实现单点登录

使用 Guard 进行单点登录需要在初始化的时候设置 isSSO 为 true：

import React from "react";
import ReactDOM from "react-dom";
import { Guard } from "@authing/react-ui-components";
// 引入 css 文件
import "@authing/react-ui-components/lib/index.min.css";

const App = () => {
  const appId = "GEN_AUTH_APP_ID";
  const onLogin = (userInfo) => {
    console.log(userInfo);
  };
  return (
    <Guard
      appId={appId}
      onLogin={onLogin}
      config={{
        isSSO: true,
      }}
    />
  );
};

ReactDOM.render(<App />, document.getElementById("root"));

导出 authing-js-sdk

Guard 组件本身基于 GenAuth JavaScript SDK 进行封装，当你需要进行一些更高级的操作（如管理用户自定义数据、修改用户资料、退出登录）时：

  1. 调用 initAuthClient 初始化 AuthenticationClient，多次调用此函数只会初始化一次。
import { initAuthClient } from "@authing/react-ui-components";

initAuthClient({
  appId: "GEN_AUTH_APP_ID",
});
  1. 之后使用 getAuthClient 获取 AuthenticationClient 实例。
import { getAuthClient } from "@authing/react-ui-components";

const authClient = getAuthClient();
  1. 调用 AuthenticationClient 实例的方法，完整方法列表请见 AuthenticationClient 方法列表。
authClient.getCurrentUser().then((user) => console.log(user));

完整参数

GenAuth 登录组件（Guard）提供了很多高级配置，如自定义 UI，使用特定登录方式等。详细请见完整参数列表。

事件列表

注意在 React 中，事件监听应采用小驼峰命名，如：onLogin, onLoginError。

事件名事件说明事件参数事件参数说明
loadGenAuth appId 验证通过，加载完成authClientAuthenticationClient 对象，可直接操作 login， register，详情请查看 authing-js-sdk
load-errorGenAuth appId 验证失败，加载失败error错误信息
login用户登录成功user, authClient

user: 用户信息

authClient 同上

login-error用户登录失败error错误信息，包含字段缺失／非法或服务器错误等信息
register用户注册成功user, authClient

user: 用户信息

authClient 同上

register-error用户注册失败error错误信息，包含字段缺失／非法或服务器错误等信息
pwd-email-send忘记密码邮件发送成功--
pwd-email-send-error忘记密码邮件发送失败error错误信息
pwd-phone-send忘记密码手机验证码发送成功--
pwd-phone-send-error忘记密码手机验证码发送失败error错误信息
pwd-reset重置密码成功--
pwd-reset-error重置密码失败error错误信息
closemodal 模式中 guard 关闭事件--
login-tab-change登录 tab 切换事件activeTab切换后的 tab
register-tab-change注册 tab 切换事件activeTab切换后的 tab
register-info-completed注册补充成功事件user, udfs, authClient

user: 用户信息

udfs: 补充的自定义字段信息

authClient 同上

register-info-completed-error注册补充失败事件error, udfs, authClient

error: 错误信息

udfs: 补充的自定义字段信息

authClient 同上

私有化部署

私有化部署场景需要指定你私有化的 GenAuth 服务的 GraphQL 端点（不带协议头和 Path），如果你不清楚可以联系 GenAuth IDaaS 服务管理员。

import React from "react";
import { Guard } from "@authing/react-ui-components";
import "@authing/react-ui-components/lib/index.min.css";

const App = () => {
  const appId = "GEN_AUTH_APP_ID";
  const config = {
    host: "https://core.you-authing-service.com",
  };
  return <Guard appId={appId} />;
};

获取帮助

请访问 GenAuth 论坛 (opens new window)。