¶ Vue 快速开始

你可以使用 Authing 快速为新开发的或已有的 Vue 应用集成认证能力。本教程讲述如何使用 Authing Browser SDK 为你的 Vue 应用添加认证能力。

如果你只需登录组件，可参考 登录组件文档

¶ 配置 Authing

¶ 创建自建应用

也可以使用现有应用

在控制台的「自建应用」页面，点击「创建自建应用」，应用类型选择「单页 Web 应用」，并填入以下信息：

应用名称：你的应用名称；
认证地址：选择一个二级域名，必须为合法的域名格式，例如 my-spa-app；

¶ 配置应用

在「自建应用」列表中，找到上一步创建好的应用，点击应用卡片进入「应用配置」页面，修改如下配置项并保存：

认证配置：配置 登录回调 URL
授权配置：授权模式开启 authorization_code、refresh_token
授权配置：返回类型开启 code

至此，配置完成。

¶ 记录应用信息

为了下面方便顺利地使用 Authing Browser SDK，你需要记下该应用的这几个信息：

App ID
认证地址
登录回调 URL

¶ 集成 Authing

Authing Browser SDK 支持通过包管理器安装、script 标签引入的方式的方式集成到你的前端业务软件。

¶ 安装 SDK

¶ 使用 NPM 安装

$ npm install @authing/web

¶ 使用 Yarn 安装

$ yarn add @authing/web

¶ 使用 script 标签直接引入

<head>
  <script src="//cdn.jsdelivr.net/npm/@authing/web"></script>
</head>

¶ 初始化 SDK

可以根据上面步骤中记录的 App ID、认证地址、登录回调 URL 等信息，进行 SDK 的初始化，如下示例：

import { Authing } from '@authing/web';

const sdk = new Authing({
  // 应用的认证地址，例如：https://domain.authing.cn
  domain: '认证地址',
  appId: 'AUTHING_APP_ID',
  // 登录回调地址，需要在控制台『应用配置 - 登录回调 URL』中指定
  redirectUri: '登录回调地址',
});

¶ 发起登录

Authing Browser SDK 可以向 Authing 发起认证授权请求，目前支持下面两种登录方式：

在当前窗口转到 Authing 托管的登录页
弹出一个窗口，在弹出的窗口中加载 Authing 托管的登录页

¶ 跳转登录

如果你想自定义参数，也可以对以下参数进行自定义传参，如不传参将使用默认参数

¶ 弹出窗口登录

你也可以在你的业务软件页面使用下面的方法，通过弹出一个新窗口的方式让用户在新窗口登录：

如果你想自定义参数，也可以对以下参数进行自定义传参，如不传参将使用默认参数

¶ 高级使用

每次发起登录本质是访问一个携带许多参数的 URL 地址，Authing Browser SDK 默认会使用缺省参数。如果你需要精细控制登录请求参数，可以参考本示例。

import { Authing } from '@authing/web';

const sdk = new Authing({
  // 很重要，请仔细填写！
  // 如果应用开启 SSO，这儿就要写单点登录的“应用面板地址”；否则填写应用的“认证地址”。
  domain: '认证域名',
  appId: 'AUTHING_APP_ID',
  // 登录回调地址，需要在控制台『应用配置 - 登录回调 URL』中指定
  redirectUri: '登录回调地址',

  // 登出回调地址，需要在控制台『应用配置 - 登出回调 URL』中指定
  // 如果为空，登出流程会在 Authing 中止，不会进行后续的回调
  logoutRedirectUri: '',

  // 应用侧向 Authing 请求的权限，以空格分隔，默认为 'openid profile'
  scope: 'openid email phone profile',

  // 在回调端点处，是否重定向回最初发起登录的 URL
  redirectToOriginalUri: false,

  // 回调时在何处携带身份凭据，默认为 fragment
  // fragment: 在 URL hash 中携带
  // query: 在查询参数中携带
  redirectResponseMode: 'fragment',

  // 是否使用 OIDC implicit 模式替代默认的 PKCE 模式
  // 由于 implicit 模式安全性较低，不推荐使用，只用于兼容不支持 crypto 的浏览器
  useImplicitMode: false,

  // implicit 模式返回的凭据种类，默认为 'token id_token'
  // token: 返回 Access Token
  // id_token: 返回 ID Token
  implicitResponseType: 'token id_token',

  // 是否在每次获取登录态时请求 Authing 检查 Access Token 有效性，
  // 可用于单点登出场景，默认为 false 如果设为 true，需要在控制台中将
  // 『应用配置』-『其他配置』-『检验 token 身份验证方式』设为 none
  introspectAccessToken: false,

  // 弹出窗口的宽度
  popupWidth: 500,

  // 弹出窗口的高度
  popupHeight: 600,
});

¶ 检查登录态并获取 Token

如果你想检查用户的登录态，并获取用户的 Access Token、ID Token，可以调用 getLoginState 方法，如果用户没有在 Authing 登录，该方法会抛出错误：

¶ 获取用户信息

你需要使用 Access Token 获取用户的个人信息：

用户初次登录成功时可以在回调函数中拿到用户的 Access Token，然后使用 Access Token 获取用户信息；
如果用户已经登录，你可以先获取用户的 Access Token 然后使用 Access Token 获取用户信息。

<template>
  <div id="app">
    <p>
      <button @click="login">loginWithRedirect</button>
      <button @click="getUserInfo">getUserInfo</button>
    </p>
    <p v-if="loginState">
      <textarea
        cols="100"
        rows="20"
        readOnly
        :value="JSON.stringify(loginState, null, 2)"
      ></textarea>
    </p>
    <p v-if="userInfo">
      <textarea
        cols="100"
        rows="20"
        readOnly
        :value="JSON.stringify(userInfo, null, 2)"
      ></textarea>
    </p>
  </div>
</template>

<script>
import { Authing } from "@authing/web";

export default {
  name: "App",
  data() {
    return {
      sdk: null,
      loginState: null,
      userInfo: null,
    };
  },
  created() {
    this.sdk = new Authing({
      // 应用的认证地址，例如：https://domain.authing.cn
      domain: "认证地址",
      appId: "应用 ID",
      // 登录回调地址，需要在控制台『应用配置 - 登录回调 URL』中指定
      redirectUri: "登录回调地址",
    });
  },
  mounted() {
    // 校验当前 url 是否是登录回调地址
    if (this.sdk.isRedirectCallback()) {
      console.log("redirect");

      /**
       * 以跳转方式打开 Authing 托管的登录页，认证成功后，
       * 需要配合 handleRedirectCallback 方法，在回调端点处理 Authing 发送
       * 的授权码或 token，获取用户登录态
       */
      this.sdk.handleRedirectCallback().then((res) => {
        this.loginState = res;
        window.location.replace("/");
      });
    } else {
      console.log("normal");

      this.getLoginState();
    }
  },
  methods: {
    /**
     * 用 Access Token 获取用户身份信息
     */
    async getUserInfo() {
      if (!this.loginState) {
        alert("用户未登录");
        return;
      }
      const userInfo = await this.sdk.getUserInfo({
        accessToken: this.loginState.accessToken,
      });
      this.userInfo = userInfo;
    },
    /**
     * 获取用户的登录状态
     */
    async getLoginState() {
      const state = await this.sdk.getLoginState();
      this.loginState = state;
    },
    /**
     * 以跳转方式打开 Authing 托管的登录页
     */
    login() {
      this.sdk.loginWithRedirect();
    },
  },
};
</script>

<template>
  <div>
    <p>
      <button @click="login">loginWithRedirect</button>
      <button @click="getUserInfo">getUserInfo</button>
    </p>
    <p v-if="loginState">
      <textarea
        cols="100"
        rows="20"
        readOnly
        :value="JSON.stringify(loginState, null, 2)"
      ></textarea>
    </p>
    <p v-if="userInfo">
      <textarea
        cols="100"
        rows="15"
        readOnly
        :value="JSON.stringify(userInfo, null, 2)"
      ></textarea>
    </p>
  </div>
</template>

<script>
import { defineComponent, onMounted, reactive, toRefs } from "vue";
import { Authing } from "@authing/web";

export default defineComponent({
  name: "App",
  setup() {
    const sdk = new Authing({
      // 应用的认证地址，例如：https://domain.authing.cn
      domain: "认证地址",
      appId: "应用 ID",
      // 登录回调地址，需要在控制台『应用配置 - 登录回调 URL』中指定
      redirectUri: "登录回调地址",
    });

    const state = reactive({
      loginState: null,
      userInfo: null,
    });

    /**
     * 获取用户的登录状态
     */
    const getLoginState = async () => {
      const res = await sdk.getLoginState();
      state.loginState = res;

      if (!res) {
        sdk.loginWithRedirect();
      }
    };

    /**
     * 以跳转方式打开 Authing 托管的登录页
     */
    const login = () => {
      sdk.loginWithRedirect();
    };

    /**
     * 用 Access Token 获取用户身份信息
     */
    const getUserInfo = async () => {
      if (!state.loginState) {
        alert("用户未登录");
        return;
      }
      const userInfo = await sdk.getUserInfo({
        accessToken: state.loginState.accessToken,
      });
      state.userInfo = userInfo;
    };

    onMounted(() => {
      // 校验当前 url 是否是登录回调地址
      if (sdk.isRedirectCallback()) {
        console.log("redirect");

        /**
         * 以跳转方式打开 Authing 托管的登录页，认证成功后，
         * 需要配合 handleRedirectCallback 方法，在回调端点处理 Authing 发送
         * 的授权码或 token，获取用户登录态
         */
        sdk.handleRedirectCallback().then((res) => {
          state.loginState = res;
          window.location.replace("/");
        });
      } else {
        console.log("normal");

        // 静默登录，直接获取到用户信息
        getLoginState();
      }
    });

    return {
      ...toRefs(state),
      login,
      getUserInfo,
    };
  },
});
</script>

¶ 退出登录

可以调用 SDK 的 logoutWithRedirect 方法退出登录

如果你想自定义参数，也可以对以下参数进行自定义传参，如不传参将使用默认参数

¶ 调用资源 API

接下来讲述如何从 Vue 应用请求外部资源服务器的 API。

如果你跟随之前的步骤为你的 Vue 应用集成了认证功能，需要先登出，我们需要一个新的 Access Token。

¶ 搭建服务端 API

首先需要搭建服务端 API 接口，供 Vue 应用调用。本教程我们使用一个现成的 API Server。

克隆 API Server 仓库：

$ git clone git@github.com:Authing/m2m-demo-express.git

进入项目目录，安装依赖：

$ npm install

在 /app.js 第 12 行，修改配置为你的应用配置：

// 授权中间件，Access Token 必须存在，并且能被 Authing 应用公钥验签
const checkJwt = jwt({
	// 从 Authing 应用服务发现地址动态获取验签公钥
	secret: jwksRsa.expressJwtSecret({
		cache: true,
		rateLimit: true,
		jwksRequestsPerMinute: 5,
		jwksUri: `https://{应用域名}.authing.cn/oidc/.well-known/jwks.json`
	}),

	// 验证受众和颁发者
	audience: 'APP_ID',
	issuer: [`https://{应用域名}.authing.cn/oidc`],
	algorithms: ['RS256']
});

启动 API Server：

$ npm start

更多详情请参考 Node.js Express API Server 快速开始。

¶ 设置资源权限

为了获取一个具备资源权限的 Access Token，首先需要在 Authing 定义谁具备什么资源的什么权限。

¶ 创建一个用户

在用户管理 > 用户列表，点击右侧的「创建」按钮。

创建一个测试用户。

¶ 创建资源

在应用详情页面，点击「授权」选项卡，在「API 资源」卡片点击添加。

填写资源名称：order，资源描述：订单，API 接口的 URL 地址：http://localhost:5000/api/protected，为资源定义一个操作，本教程为订单资源定义一个读取操作，点击添加操作，操作类型填 read，描述填读取订单。最后点击保存。

¶ 资源授权

在「资源授权」选项卡，点击添加。

「被授权主体类型」选择「用户」，「被授权主体」搜索刚才创建的测试用户，「授权作用」选择允许，「资源类型」选择刚刚定义的订单资源，「资源标识符」保留默认，「操作」选择特定操作，选择读取订单操作。最后点击确定。

¶ 使用 Access Token 调用资源 API

接下来我们在 Vue 应用中调用后端接口。你可以在请求头中携带 Access Token，API 服务器会检查 Access Token 合法性和具备的权限，然后返回数据。

API 服务器 http://localhost:5000/api/protected 要求 order:read 权限 scope。

<template>
  <div id="app">
    <h2>Vue 快速集成 Authing Demo</h2>
    <p>
      <button @click="loginWithRedirect">loginWithRedirect</button>
      <button @click="handleResource">handleResource</button>
    </p>
    <p v-if="resource">{{ resource }}</p>
  </div>
</template>

<script>
import { Authing } from "@authing/web";

export default {
  name: "App",
  data() {
    return {
      sdk: null,
      loginState: null,
      resource: null,
    };
  },
  created() {
    this.sdk = new Authing({
      // 应用的认证地址，例如：https://domain.authing.cn
      domain: "认证地址",
      appId: "应用 ID",
      // 登录回调地址，需要在控制台『应用配置 - 登录回调 URL』中指定
      redirectUri: "登录回调地址",
      // scope 授权范围
      scope: "profile openid order:read",
    });
  },
  mounted() {
    // 校验当前 url 是否是登录回调地址
    if (this.sdk.isRedirectCallback()) {
      console.log("redirect");

      /**
       * 以跳转方式打开 Authing 托管的登录页，认证成功后，需要配合 
       * handleRedirectCallback 方法，在回调端点处理 Authing 发送的
       * 授权码或 token，获取用户登录态
       */
      this.sdk.handleRedirectCallback().then((res) => {
        this.loginState = res;
        window.location.replace("/");
      });
    } else {
      this.getLoginState();
    }
  },
  methods: {
    /**
     * 以跳转方式打开 Authing 托管的登录页
     */
    loginWithRedirect() {
      this.sdk.loginWithRedirect();
    },
    /**
     * 获取用户的登录状态
     */
    async getLoginState() {
      const state = await this.sdk.getLoginState();
      this.loginState = state;
    },
    /**
     * 使用 Access Token 调用资源 API
     */
    async handleResource() {
      try {
        let res = await fetch('http://localhost:5000/api/protected', {
          headers: {
            Authorization: `Bearer ${this.loginState.accessToken}`,
          },
          method: "GET",
        });
        let data = await res.json();
        this.resource = data;
      } catch (err) {
        alert("无权访问接口");
      }
    },
  },
};
</script>

<template>
  <h2>Vue 快速集成 Authing Demo</h2>
  <p>
    <button @click="loginWithRedirect">loginWithRedirect</button>
    <button @click="handleResource">handleResource</button>
  </p>
  <p v-if="resource">{{ resource }}</p>
</template>

<script>
import { defineComponent, onMounted, reactive, toRefs } from "vue";
import { Authing } from "@authing/web";

export default defineComponent({
  name: "App",
  setup() {
    const sdk = new Authing({
      // 应用的认证地址，例如：https://domain.authing.cn
      domain: "认证地址",
      appId: "应用 ID",
      // 登录回调地址，需要在控制台『应用配置 - 登录回调 URL』中指定
      redirectUri: "登录回调地址",
      // scope 授权范围
      scope: "profile openid order:read",
    });

    const state = reactive({
      loginState: null,
      resource: null,
    });

    /**
     * 获取用户的登录状态
     */
    const getLoginState = async () => {
      const res = await sdk.getLoginState();
      state.loginState = res;
    };

    /**
     * 以跳转方式打开 Authing 托管的登录页
     */
    const loginWithRedirect = () => {
      sdk.loginWithRedirect();
    };

    /**
     * 使用 Access Token 调用资源 API
     */
    const handleResource = async () => {
      try {
        let res = await fetch('http://localhost:5000/api/protected', {
          headers: {
            Authorization: `Bearer ${state.loginState.accessToken}`,
          },
          method: "GET",
        });
        let data = await res.json();
        state.resource = data;
      } catch (err) {
        alert("无权访问接口");
      }
    };

    onMounted(() => {
      // 校验当前 url 是否是登录回调地址
      if (sdk.isRedirectCallback()) {
        console.log("redirect");

        /**
         * 以跳转方式打开 Authing 托管的登录页，认证成功后，需要配合 
         * handleRedirectCallback 方法， 在回调端点处理 Authing 发送的
         * 授权码或 token，获取用户登录态
         */
        sdk.handleRedirectCallback().then((res) => {
          state.loginState = res;
          window.location.replace("/");
        });
      } else {
        getLoginState();
      }
    });

    return {
      ...toRefs(state),
      loginWithRedirect,
      handleResource,
    };
  },
});
</script>

恭喜 🎉，到此你学会了在 Vue 单页 Web 应用中集成 Authing 认证授权，并调用外部的资源服务器接口。

¶ 接下来你可能需要

使用 Authing 保护 API 接口：

Node.js Express API Server 快速开始

学习资源、角色、权限管理内容：

对用户进行权限管理

自建应用 SSO 方案：

单点登录 SSO 综述

下载在 GitHub 查看

本页资源下载一个 Vue 快速开始的示例程序或在 GitHub 查看。下载在 GitHub 查看