# uni.login(OBJECT)

登录

平台差异说明

App H5 微信小程序 支付宝小程序 百度小程序 字节跳动小程序、飞书小程序 QQ小程序 快手小程序 京东小程序
x

H5平台登录注意事项:

  • 微信内嵌浏览器运行H5版时,可通过js sdk实现微信登录,需要引入一个单独的js,详见 (opens new window)
  • 普通浏览器上实现微信登录,并非开放API,需要向微信申请,仅个别开发者有此权限
  • H5平台的其他登录,比如QQ登录、微博登录,uni-app未封装,请在条件编译里按普通H5写法编写。

注意事项:

  • 百度小程序平台需要在button组件的@login事件后再调用 uni.login ,详见 (opens new window),否则会返回“请登录”的错误信息,建议在@login事件中调用。
  • 京东小程序IDE 暂时不支持此uni.login(),请用真机查看;IDE调用,只能返回模拟数据 code为200。

OBJECT 参数说明

参数名 类型 必填 说明 平台差异说明
provider String 登录服务提供商,通过 uni.getProvider 获取,如果不设置则弹出登录列表选择界面
scopes String/Array 见平台差异说明 授权类型,默认 auth_base。支持 auth_base(静默授权)/ auth_user(主动授权) / auth_zhima(芝麻信用) 支付宝小程序
timeout Number 超时时间,单位ms 微信小程序、百度小程序、京东小程序
univerifyStyle Object 一键登录页面样式 App 3.0.0+
onlyAuthorize Boolean 微信登录仅请求授权认证 App 3.2.6+
success Function 接口调用成功的回调
fail Function 接口调用失败的回调函数
complete Function 接口调用结束的回调函数(调用成功、失败都会执行)

# onlyAuthorize说明

微信登录在未配置onlyAuthorize的情况下,调用uni.login接口用户登录凭证(code)不返回,用以换取登录信息(authResult);需要在项目manifest.json中配置的appsecret,此参数云端打包后会保存在apk/ipa中,存在参数泄露的风险;HBuilderX3.4.18+ 不再提供此参数的可视化配置。对于安全性要求较低的开发者,可以通过manifest.json -> 源码视图 -> app-plus -> distribute -> sdkConfigs -> oauth -> weixin -> 添加appsecret 配置。

success 返回参数说明

参数名 说明 平台差异说明
authResult 登录服务商提供的登录信息,服务商不同返回的结果不完全相同 微信登录配置onlyAuthorize:true则此项为空,App 3.2.6+
code 用户登录凭证。开发者需要在开发者服务器后台,使用 code 换取 openid 和 session_key 等信息 微信登录配置onlyAuthorize:true才会返回,App 3.2.6+、京东小程序
appleInfo Object
errMsg 描述信息

各个平台的登录流程存在差异,详细请参考相关平台的文档说明:

如果服务端使用uniCloud,那么官方提供了uni-id云端统一登录服务,把微信登录、短信验证码登录及角色权限管理等服务端登录开发,进行了统一的封装。

前端统一的uni.login和云端统一的uni-id搭配,可以极大提升登录业务的开发效率,强烈推荐给开发者使用。uni-id的文档另见:https://uniapp.dcloud.net.cn/uniCloud/uni-id

示例

uni.login({
  provider: 'weixin',
  success: function (loginRes) {
    console.log(loginRes.authResult);
  }
});

# uni.checkSession

检查登录状态是否过期

1.6.0 新增

平台差异说明

App H5 微信小程序 支付宝小程序 百度小程序 字节跳动小程序、飞书小程序 QQ小程序 快手小程序 快手小程序 京东小程序
x x x x
属性 类型 必填 说明
success function 接口调用成功的回调函数
fail function 接口调用失败的回调函数
complete function 接口调用结束的回调函数(调用成功、失败都会执行)

# uni.getUserInfo(OBJECT)

获取用户信息。

平台差异说明

App H5 微信小程序 支付宝小程序 百度小程序 字节跳动小程序、飞书小程序 QQ小程序 快手小程序 京东小程序
x

注意:

  • 微信小程序端,在用户未授权过的情况下调用此接口,不会出现授权弹窗,会直接进入 fail 回调(详见《微信小程序公告》 (opens new window))。在用户已授权的情况下调用此接口,可成功获取用户信息。
  • 京东小程序端,在用户未授权,调用该接口将直接报错。用户已经授权过,可使用该接口直接获取用户信息,不会弹二次授权框

OBJECT 参数说明

参数名 类型 必填 说明 平台差异说明
provider String 登录服务提供商,通过 uni.getProvider 获取
withCredentials Boolean 是否带上登录态信息。 微信小程序、字节跳动小程序、飞书小程序、快手小程序
lang String 指定返回用户信息的语言,默认为 en。更多值请参考下面的说明。 微信小程序
timeout Number 超时时间,单位 ms。 微信小程序
success Function 接口调用成功的回调
fail Function 接口调用失败的回调函数
complete Function 接口调用结束的回调函数(调用成功、失败都会执行)

lang 值说明

说明
zh_CN 简体中文
zh_TW 繁体中文
en 英文

**注意:**在小程序 withCredentials 为 true 时或是在 App 调用 uni.getUserInfo,要求此前有调用过 uni.login 且登录态尚未过期。微信基础库2.10.4版本对用户信息相关接口进行了调整,使用 uni.getUserInfo 获取得到的 userInfo 为匿名数据,建议使用 uni.getUserProfile 获取用户信息。

success 返回参数说明

参数 类型 说明 平台差异说明
userInfo OBJECT 用户信息对象
rawData String 不包括敏感信息的原始数据字符串,用于计算签名。
signature String 使用 sha1( rawData + sessionkey ) 得到字符串,用于校验用户信息。 微信小程序、字节跳动小程序、飞书小程序、快手小程序、京东小程序
encryptedData String 包括敏感数据在内的完整用户信息的加密数据,详细见加密数据解密算法。 微信小程序、字节跳动小程序、飞书小程序、快手小程序
iv String 加密算法的初始向量,详细见加密数据解密算法。 微信小程序、字节跳动小程序、飞书小程序、快手小程序
errMsg String 描述信息

userInfo 参数说明

参数 类型 说明 平台差异说明
nickName String 用户昵称
openId String 该服务商唯一用户标识 App
avatarUrl String 用户头像
gender String 用户性别:0-男,1-女,2-保密 京东小程序

除了以上三个必有的信息外,不同服务供应商返回的其它信息会存在差异。

# App端登录的扩展说明

App端还支持更多登录相关API,如logout详见 (opens new window)

App端登录相关的SDK需要在manifest中配置:

  1. 打开 manifest.json -> App模块权限配置,勾选 OAuth(登录鉴权)。
  2. 打开 manifest.json -> App SDK配置,查看到登录鉴权。在说明中有蓝色链接,其中包括向微信、QQ、微博等平台申请sdk的链接。
  3. 向微信、QQ、微博等平台申请到sdk的信息后,回填到manifest里。
  4. 这些配置需要打包生效,真机运行仍然是HBuilder基座的设置,可使用自定义基座包 (opens new window)。离线打包请参考离线打包文档在原生工程中配置。
  5. 配置并打包后,通过uni.getProvider可以得到配置的结果列表,注意这里返回的是manifest配置的,与手机端是否安装微信、QQ、微博无关。

如果手机端未安装QQ、微博,调用时会启动这些平台的wap页面登录,如果已安装相应客户端,会启动它们的客户端登录。

示例

uni.login({
  provider: 'weixin',
  success: function (loginRes) {
    console.log(loginRes.authResult);
    // 获取用户信息
    uni.getUserInfo({
      provider: 'weixin',
      success: function (infoRes) {
        console.log('用户昵称为:' + infoRes.userInfo.nickName);
      }
    });
  }
});

# App端集成其他登录SDK如支付宝、淘宝、facebook登录的说明

  1. 支付宝登录 (opens new window)淘宝登录 (opens new window)抖音登录 (opens new window)等在插件市场均已有插件,还有sharesdk (opens new window)等专业集成多家登录分享的插件。
  2. 现已支持登录:
  1. 也可以内嵌web-view组件,使用web登录模式集成这些三方登录

# uni.getUserProfile(OBJECT)

获取用户信息。每次请求都会弹出授权窗口,用户同意后返回 userInfo。

平台差异说明

App H5 微信小程序 支付宝小程序 百度小程序 字节跳动小程序、飞书小程序 QQ小程序 快手小程序 京东小程序
x x √(基础库2.10.4) x x x x x x

注意: 该API仅支持微信小程序端,微信小程序调整了相关接口(详见《小程序登录、用户信息相关接口调整说明》 (opens new window))。每次触发 uni.getUserProfile 均会弹出授权窗口,用户授权后可成功获取用户信息。该API暂不支持在事件中使用异步操作,否则会触发错误:{errMsg: "getUserProfile:fail can only be invoked by user TAP gesture."} 抖音从基础库 2.30.0 开始支持本方法,低版本需做兼容处理(详见:https://microapp.bytedance.com/docs/zh-CN/mini-app/develop/api/open-interface/user-information/tt-get-user-profile/).

OBJECT 参数说明

参数名 类型 必填 说明
desc String 声明获取用户个人信息后的用途,不超过30个字符
lang String 指定返回用户信息的语言,默认为 en。更多值请参考下面的说明。
success Function 接口调用成功的回调
fail Function 接口调用失败的回调函数
complete Function 接口调用结束的回调函数(调用成功、失败都会执行)

lang 值说明

说明
zh_CN 简体中文
zh_TW 繁体中文
en 英文

**注意:**可以使用 if(uni.getUserProfile) 判断uni.getUserProfile是否可用。

success 返回参数说明

参数 类型 说明
userInfo OBJECT 用户信息对象
rawData String 不包括敏感信息的原始数据字符串,用于计算签名。
signature String 使用 sha1( rawData + sessionkey ) 得到字符串,用于校验用户信息。
encryptedData String 包括敏感数据在内的完整用户信息的加密数据,详细见加密数据解密算法。
iv String 加密算法的初始向量,详细见加密数据解密算法。
cloudID String 敏感数据对应的云 ID,开通云开发的小程序才会返回,可通过云调用直接获取开放数据,详细见云调用直接获取开放数据
errMsg String 描述信息

userInfo 参数说明

参数 类型 说明
nickName String 用户昵称
avatarUrl String 用户头像
gender Number 用户性别
country String 用户所在国家
province String 用户所在省份
city String 用户所在城市
language String 显示 country,province,city 所用的语言

gender 的合法值

说明
0 未知
1 男性
2 女性

language 的合法值

说明
en 英文
zh_CN 简体中文
zh_TW 繁体中文

# uni.preLogin(OBJECT)

预登录。

平台差异说明

App H5 微信小程序 支付宝小程序 百度小程序 字节跳动小程序、飞书小程序 QQ小程序 快手小程序 京东小程序
3.0.0+ x x x x x x x x

OBJECT 参数说明

参数名 类型 必填 说明
provider String 登录服务提供商,通过 uni.getProvider 获取,目前仅支持一键登录
success Function 接口调用成功的回调
fail Function 接口调用失败的回调函数
complete Function 接口调用结束的回调函数(调用成功、失败都会执行)

# uni.closeAuthView()

关闭一键登录页面。

平台差异说明

App H5 微信小程序 支付宝小程序 百度小程序 字节跳动小程序、飞书小程序 QQ小程序 快手小程序 京东小程序
3.0.0+ x x x x x x x x

# uni.getCheckBoxState(OBJECT)

获取一键登录条款勾选框状态。

平台差异说明

App H5 微信小程序 支付宝小程序 百度小程序 字节跳动小程序、飞书小程序 QQ小程序 快手小程序 京东小程序
3.2.3+ x x x x x x x x

OBJECT 参数说明

参数名 类型 必填 说明
success Function 接口调用成功的回调
fail Function 接口调用失败的回调函数
complete Function 接口调用结束的回调函数(调用成功、失败都会执行)

success 返回参数说明

参数 类型 说明
state Boolean 一键登录条款勾选框状态
errMsg String 描述信息

# uni.getUniverifyManager(OBJECT)

获取全局唯一的一键登录管理器 univerifyManager

平台差异说明

App H5 微信小程序 支付宝小程序 百度小程序 字节跳动小程序、飞书小程序 QQ小程序 快手小程序 京东小程序
√ (3.2.13+) x x x x x x x x

univerifyManager 方法说明

方法名 类型 说明
login Function 一键登录
preLogin Function 一键登录预登录
close Function 关闭一键登陆页面
getCheckBoxState Function 获取一键登录条款勾选框状态
onButtonsClick Function 订阅一键登录自定义按钮点击事件
offButtonsClick Function 取消订阅一键登录自定义按钮点击事件

使用示例

// 使用时不需要传递 provider 
const univerifyManager = uni.getUniverifyManager()

// 预登录
// 参数和 uni.preLogin 相同
univerifyManager.preLogin()

// 调用一键登录弹框
// 仅需传参 univerifyStyle 即可
univerifyManager.login({
  univerifyStyle: {
    "fullScreen": true,
    "buttons": {
        "iconWidth": "45px",
        "list": [
            {
                "provider": "apple",
                "iconPath": "/static/apple.png"
            }, 
            {
                "provider": "weixin",
                "iconPath": "/static/wechat.png"
            }
        ]
    }
  },
  success (res) {
    console.log('login success', res)
  }
})

const callback = (res) => {
  // 获取一键登录弹框协议勾选状态
  // 参数和 uni.getCheckBoxState 相同
  univerifyManager.getCheckBoxState({
    success(res) {
      console.log("getCheckBoxState res: ", res);
      if (res.state) {
        // 关闭一键登录弹框
        // 参数和 uni.closeAuthView 相同
        univerifyManager.close()
      }
    }
  })
}

// 订阅自定义按钮点击事件
univerifyManager.onButtonsClick(callback)
// 取消订阅自定义按钮点击事件
univerifyManager.offButtonsClick(callback)