wx.getUserInfo · 微信小游戏开发API官方文档

# wx.getUserInfo ### wx.getUserInfo(Object object) > 调用前需要 [用户授权](https://developers.weixin.qq.com/minigame/dev/tutorial/open-ability/authorize.html) scope.userInfo。获取用户信息。 #### 参数 ##### Object object 属性类型默认值是否必填说明支持版本withCredentialsboolean否是否带上登录态信息。当 withCredentials 为 true 时，要求此前有调用过 wx.login 且登录态尚未过期，此时返回的数据会包含 encryptedData, iv 等敏感信息；当 withCredentials 为 false 时，不要求有登录态，返回的数据不包含 encryptedData, iv 等敏感信息。langstringen否显示用户信息的语言successfunction否接口调用成功的回调函数failfunction否接口调用失败的回调函数completefunction否接口调用结束的回调函数（调用成功、失败都会执行）**object.lang 的合法值** 值说明en英文zh\_CN简体中文zh\_TW繁体中文###### object.success 回调函数 **参数** **Object res** 属性类型说明支持版本userInfo[UserInfo](/read/wechat-game-api/254.md)用户信息对象，不包含 openid 等敏感信息rawDatastring不包括敏感信息的原始数据字符串，用于计算签名signaturestring使用 sha1( rawData + sessionkey ) 得到字符串，用于校验用户信息，详见 [用户数据的签名验证和加解密](https://developers.weixin.qq.com/minigame/dev/tutorial/open-ability/signature.html)encryptedDatastring包括敏感数据在内的完整用户信息的加密数据，详见 [用户数据的签名验证和加解密](https://developers.weixin.qq.com/minigame/dev/tutorial/open-ability/signature.html#%E5%8A%A0%E5%AF%86%E6%95%B0%E6%8D%AE%E8%A7%A3%E5%AF%86%E7%AE%97%E6%B3%95)ivstring加密算法的初始向量，详见 [用户数据的签名验证和加解密](https://developers.weixin.qq.com/minigame/dev/tutorial/open-ability/signature.html#%E5%8A%A0%E5%AF%86%E6%95%B0%E6%8D%AE%E8%A7%A3%E5%AF%86%E7%AE%97%E6%B3%95)#### 示例代码 ``` <pre class="prettyprint"><ol class="linenums"><li class="l"><code class="pcalibre9 pcalibre8 pcalibre7">// 必须是在用户已经授权的情况下调用</code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7">wx.getUserInfo({</code></li> <li class="l"><code class="pcalibre9 pcalibre8 pcalibre7"> success: function(res) {</code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7"> var userInfo = res.userInfo</code></li> <li class="l"><code class="pcalibre9 pcalibre8 pcalibre7"> var nickName = userInfo.nickName</code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7"> var avatarUrl = userInfo.avatarUrl</code></li> <li class="l"><code class="pcalibre9 pcalibre8 pcalibre7"> var gender = userInfo.gender //性别 0：未知、1：男、2：女</code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7"> var province = userInfo.province</code></li> <li class="l"><code class="pcalibre9 pcalibre8 pcalibre7"> var city = userInfo.city</code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7"> var country = userInfo.country</code></li> <li class="l"><code class="pcalibre9 pcalibre8 pcalibre7"> }</code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7">})</code></li> </ol> ``` encryptedData 解密后为以下 json 结构，详见[加密数据解密算法](https://developers.weixin.qq.com/minigame/dev/tutorial/open-ability/signature.html#%E5%8A%A0%E5%AF%86%E6%95%B0%E6%8D%AE%E8%A7%A3%E5%AF%86%E7%AE%97%E6%B3%95) ``` <pre class="prettyprint"><ol class="linenums"><li class="l"><code class="pcalibre9 pcalibre8 pcalibre7">{</code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7"> "openId": "OPENID",</code></li> <li class="l"><code class="pcalibre9 pcalibre8 pcalibre7"> "nickName": "NICKNAME",</code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7"> "gender": GENDER,</code></li> <li class="l"><code class="pcalibre9 pcalibre8 pcalibre7"> "city": "CITY",</code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7"> "province": "PROVINCE",</code></li> <li class="l"><code class="pcalibre9 pcalibre8 pcalibre7"> "country": "COUNTRY",</code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7"> "avatarUrl": "AVATARURL",</code></li> <li class="l"><code class="pcalibre9 pcalibre8 pcalibre7"> "unionId": "UNIONID",</code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7"> "watermark": {</code></li> <li class="l"><code class="pcalibre9 pcalibre8 pcalibre7"> "appid": "APPID",</code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7"> "timestamp": TIMESTAMP</code></li> <li class="l"><code class="pcalibre9 pcalibre8 pcalibre7"> }</code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7">}</code></li> </ol> ``` #### 接口调整说明在用户未授权过的情况下调用此接口，将不再出现授权弹窗，会直接进入 fail 回调（详见[《公告》](https://developers.weixin.qq.com/community/develop/doc/0000a26e1aca6012e896a517556c01))。在用户已授权的情况下调用此接口，可成功获取用户信息。 #### 示例代码 ``` <pre class="prettyprint"><ol class="linenums"><li class="l"><code class="pcalibre9 pcalibre8 pcalibre7"></code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7"><open-data type="userAvatarUrl"></open-data></code></li> <li class="l"><code class="pcalibre9 pcalibre8 pcalibre7"><open-data type="userNickName"></open-data></code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7"></code></li> <li class="l"><code class="pcalibre9 pcalibre8 pcalibre7"><button wx:if="{{canIUse}}" open-type="getUserInfo" bindgetuserinfo="bindGetUserInfo">授权登录</button></code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7"><view wx:else>请升级微信版本</view></code></li> </ol> ``` ``` <pre class="prettyprint"><ol class="linenums"><li class="l"><code class="pcalibre9 pcalibre8 pcalibre7">Page({</code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7"> data: {</code></li> <li class="l"><code class="pcalibre9 pcalibre8 pcalibre7"> canIUse: wx.canIUse('button.open-type.getUserInfo')</code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7"> },</code></li> <li class="l"><code class="pcalibre9 pcalibre8 pcalibre7"> onLoad: function() {</code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7"> // 查看是否授权</code></li> <li class="l"><code class="pcalibre9 pcalibre8 pcalibre7"> wx.getSetting({</code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7"> success (res){</code></li> <li class="l"><code class="pcalibre9 pcalibre8 pcalibre7"> if (res.authSetting['scope.userInfo']) {</code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7"> // 已经授权，可以直接调用 getUserInfo 获取头像昵称</code></li> <li class="l"><code class="pcalibre9 pcalibre8 pcalibre7"> wx.getUserInfo({</code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7"> success: function(res) {</code></li> <li class="l"><code class="pcalibre9 pcalibre8 pcalibre7"> console.log(res.userInfo)</code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7"> }</code></li> <li class="l"><code class="pcalibre9 pcalibre8 pcalibre7"> })</code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7"> }</code></li> <li class="l"><code class="pcalibre9 pcalibre8 pcalibre7"> }</code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7"> })</code></li> <li class="l"><code class="pcalibre9 pcalibre8 pcalibre7"> },</code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7"> bindGetUserInfo (e) {</code></li> <li class="l"><code class="pcalibre9 pcalibre8 pcalibre7"> console.log(e.detail.userInfo)</code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7"> }</code></li> <li class="l"><code class="pcalibre9 pcalibre8 pcalibre7">})</code></li> </ol> ``` > 原文: <https://developers.weixin.qq.com/minigame/dev/api/open-api/user-info/wx.getUserInfo.html>