wx.getUserInfo ¶

wx.getUserInfo({[withCredentials][, lang][, success][, fail][, complete]})¶

调用前需要用户授权 scope.userInfo 。

获取用户信息。

参数

withCredentials (boolean()) –
是否带上登录态信息。
- true 要求此前有调用过 wx.login() 且登录态尚未过期，此时返回的数据会包含 encryptedData, iv 等敏感信息；
- false 不要求有登录态，返回的数据不包含 encryptedData, iv 等敏感信息。
lang (string()) –
en 显示用户信息的语言
- en 英文
- zh_CN 简体中文
- zh_TW 繁体中文
cloudID}) (function success({userInfo, rawData, signature, encryptedData, iv,()) –
接口调用成功的回调函数
- userInfo UserInfo - 用户信息对象，不包含 openid 等敏感信息
- rawData (string) - 不包括敏感信息的原始数据字符串，用于计算签名
- signature (string) - 使用 sha1( rawData + sessionkey ) 得到字符串，用于校验用户信息，详见用户数据的签名验证和加解密
- encryptedData (string) - 包括敏感数据在内的完整用户信息的加密数据，详见用户数据的签名验证和加解密
- iv (string) - 加密算法的初始向量，详见用户数据的签名验证和加解密
- cloudID (string) - 敏感数据对应的云 ID，开通云开发的小程序才会返回，可通过云调用直接获取开放数据，详细见云调用直接获取开放数据
  
  2.7.0 新版功能.
fail (function()) – 接口调用失败的回调函数
complete (function()) – 接口调用结束的回调函数（调用成功、失败都会执行）

示例

// 必须是在用户已经授权的情况下调用
wx.getUserInfo({
  success(res) {
    const userInfo = res.userInfo
    const nickName = userInfo.nickName
    const avatarUrl = userInfo.avatarUrl
    const gender = userInfo.gender // 性别 0：未知、1：男、2：女
    const province = userInfo.province
    const city = userInfo.city
    const country = userInfo.country
  }
})

敏感数据

使用加密数据解密算法将 encryptedData 在开发者后台解密，
使用云调用直接通过 cloudID 获取开放数据。获取得到的开放数据为以下 json 结构：

{
  "openId": "OPENID",
  "nickName": "NICKNAME",
  "gender": GENDER,
  "city": "CITY",
  "province": "PROVINCE",
  "country": "COUNTRY",
  "avatarUrl": "AVATARURL",
  "unionId": "UNIONID",
  "watermark": {
    "appid": "APPID",
    "timestamp": TIMESTAMP
  }
}

组件示例

<!-- 如果只是展示用户头像昵称，可以使用 <open-data /> 组件 -->
<open-data type="userAvatarUrl"></open-data>
<open-data type="userNickName"></open-data>
<!-- 需要使用 button 来授权登录 -->
<button
  wx:if="{{canIUse}}"
  open-type="getUserInfo"
  bindgetuserinfo="bindGetUserInfo"
>
  授权登录
</button>
<view wx:else>请升级微信版本</view>

Page({
  data: {
    canIUse: wx.canIUse('button.open-type.getUserInfo')
  },
  onLoad() {
    // 查看是否授权
    wx.getSetting({
      success(res) {
        if (res.authSetting['scope.userInfo']) {
          // 已经授权，可以直接调用 getUserInfo 获取头像昵称
          wx.getUserInfo({
            success(res) {
              console.log(res.userInfo)
            }
          })
        }
      }
    })
  },
  bindGetUserInfo(e) {
    console.log(e.detail.userInfo)
  }
})

wx.getUserInfo¶

wx.getUserInfo ¶