# 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"><span class="com">// 必須是在用戶已經授權的情況下調用</span></code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="pln">wx</span><span class="pun">.</span><span class="pln">getUserInfo</span><span class="pun">({</span></code></li> <li class="l"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="pln"> success</span><span class="pun">:</span><span class="pln"> </span><span class="hljs-params"><span class="kwd">function</span></span><span class="pun">(</span><span class="hljs-params"><span class="pln">res</span></span><span class="pun">)</span><span class="pln"> </span><span class="pun">{</span></code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="pln"> </span><span class="kwd">var</span><span class="pln"> userInfo </span><span class="pun">=</span><span class="pln"> res</span><span class="pun">.</span><span class="pln">userInfo</span></code></li> <li class="l"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="pln"> </span><span class="kwd">var</span><span class="pln"> nickName </span><span class="pun">=</span><span class="pln"> userInfo</span><span class="pun">.</span><span class="pln">nickName</span></code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="pln"> </span><span class="kwd">var</span><span class="pln"> avatarUrl </span><span class="pun">=</span><span class="pln"> userInfo</span><span class="pun">.</span><span class="pln">avatarUrl</span></code></li> <li class="l"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="pln"> </span><span class="kwd">var</span><span class="pln"> gender </span><span class="pun">=</span><span class="pln"> userInfo</span><span class="pun">.</span><span class="pln">gender </span><span class="com">//性別 0：未知、1：男、2：女</span></code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="pln"> </span><span class="kwd">var</span><span class="pln"> province </span><span class="pun">=</span><span class="pln"> userInfo</span><span class="pun">.</span><span class="pln">province</span></code></li> <li class="l"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="pln"> </span><span class="kwd">var</span><span class="pln"> city </span><span class="pun">=</span><span class="pln"> userInfo</span><span class="pun">.</span><span class="pln">city</span></code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="pln"> </span><span class="kwd">var</span><span class="pln"> country </span><span class="pun">=</span><span class="pln"> userInfo</span><span class="pun">.</span><span class="pln">country</span></code></li> <li class="l"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="pln"> </span><span class="pun">}</span></code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="pun">})</span></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"><span class="pun">{</span></code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="pln"> </span><span class="str">"openId"</span><span class="pun">:</span><span class="pln"> </span><span class="str">"OPENID"</span><span class="pun">,</span></code></li> <li class="l"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="pln"> </span><span class="str">"nickName"</span><span class="pun">:</span><span class="pln"> </span><span class="str">"NICKNAME"</span><span class="pun">,</span></code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="pln"> </span><span class="str">"gender"</span><span class="pun">:</span><span class="pln"> GENDER</span><span class="pun">,</span></code></li> <li class="l"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="pln"> </span><span class="str">"city"</span><span class="pun">:</span><span class="pln"> </span><span class="str">"CITY"</span><span class="pun">,</span></code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="pln"> </span><span class="str">"province"</span><span class="pun">:</span><span class="pln"> </span><span class="str">"PROVINCE"</span><span class="pun">,</span></code></li> <li class="l"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="pln"> </span><span class="str">"country"</span><span class="pun">:</span><span class="pln"> </span><span class="str">"COUNTRY"</span><span class="pun">,</span></code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="pln"> </span><span class="str">"avatarUrl"</span><span class="pun">:</span><span class="pln"> </span><span class="str">"AVATARURL"</span><span class="pun">,</span></code></li> <li class="l"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="pln"> </span><span class="str">"unionId"</span><span class="pun">:</span><span class="pln"> </span><span class="str">"UNIONID"</span><span class="pun">,</span></code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="pln"> </span><span class="str">"watermark"</span><span class="pun">:</span><span class="pln"> </span><span class="pun">{</span></code></li> <li class="l"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="pln"> </span><span class="str">"appid"</span><span class="pun">:</span><span class="pln"> </span><span class="str">"APPID"</span><span class="pun">,</span></code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="pln"> </span><span class="str">"timestamp"</span><span class="pun">:</span><span class="pln"> TIMESTAMP</span></code></li> <li class="l"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="pln"> </span><span class="pun">}</span></code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="pun">}</span></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"><span class="com"><!-- 如果只是展示用戶頭像昵稱，可以使用 <open-data /> 組件 --></span></code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="kwd"><</span><span class="hljs-params"><span class="kwd">open-data</span></span><span class="pln"> </span><span class="hljs-params"><span class="typ">type</span></span><span class="pun">=</span><span class="hljs-params"><span class="str">"userAvatarUrl"</span></span><span class="kwd">></</span><span class="hljs-params"><span class="kwd">open-data</span></span><span class="kwd">></span></code></li> <li class="l"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="kwd"><</span><span class="hljs-params"><span class="kwd">open-data</span></span><span class="pln"> </span><span class="hljs-params"><span class="typ">type</span></span><span class="pun">=</span><span class="hljs-params"><span class="str">"userNickName"</span></span><span class="kwd">></</span><span class="hljs-params"><span class="kwd">open-data</span></span><span class="kwd">></span></code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="com"><!-- 需要使用 button 來授權登錄 --></span></code></li> <li class="l"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="kwd"><</span><span class="hljs-params"><span class="kwd">button</span></span><span class="pln"> </span><span class="hljs-params"><span class="typ">wx:if</span></span><span class="pun">=</span><span class="hljs-params"><span class="str">"{{canIUse}}"</span></span><span class="pln"> </span><span class="hljs-params"><span class="typ">open-type</span></span><span class="pun">=</span><span class="hljs-params"><span class="str">"getUserInfo"</span></span><span class="pln"> </span><span class="hljs-params"><span class="typ">bindgetuserinfo</span></span><span class="pun">=</span><span class="hljs-params"><span class="str">"bindGetUserInfo"</span></span><span class="kwd">></span><span class="pln">授權登錄</span><span class="kwd"></</span><span class="hljs-params"><span class="kwd">button</span></span><span class="kwd">></span></code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="kwd"><</span><span class="hljs-params"><span class="kwd">view</span></span><span class="pln"> </span><span class="hljs-params"><span class="typ">wx:else</span></span><span class="kwd">></span><span class="pln">請升級微信版本</span><span class="kwd"></</span><span class="hljs-params"><span class="kwd">view</span></span><span class="kwd">></span></code></li> </ol> ``` ``` <pre class="prettyprint"><ol class="linenums"><li class="l"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="typ">Page</span><span class="pun">({</span></code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="pln"> data</span><span class="pun">:</span><span class="pln"> </span><span class="pun">{</span></code></li> <li class="l"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="pln"> canIUse</span><span class="pun">:</span><span class="pln"> wx</span><span class="pun">.</span><span class="pln">canIUse</span><span class="pun">(</span><span class="str">'button.open-type.getUserInfo'</span><span class="pun">)</span></code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="pln"> </span><span class="pun">},</span></code></li> <li class="l"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="pln"> onLoad</span><span class="pun">:</span><span class="pln"> </span><span class="hljs-params"><span class="kwd">function</span></span><span class="pun">(</span><span class="hljs-params"></span><span class="pun">)</span><span class="pln"> </span><span class="pun">{</span></code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="pln"> </span><span class="com">// 查看是否授權</span></code></li> <li class="l"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="pln"> wx</span><span class="pun">.</span><span class="pln">getSetting</span><span class="pun">({</span></code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="pln"> success </span><span class="pun">(</span><span class="pln">res</span><span class="pun">){</span></code></li> <li class="l"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="pln"> </span><span class="kwd">if</span><span class="pln"> </span><span class="pun">(</span><span class="pln">res</span><span class="pun">.</span><span class="pln">authSetting</span><span class="pun">[</span><span class="str">'scope.userInfo'</span><span class="pun">])</span><span class="pln"> </span><span class="pun">{</span></code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="pln"> </span><span class="com">// 已經授權，可以直接調用 getUserInfo 獲取頭像昵稱</span></code></li> <li class="l"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="pln"> wx</span><span class="pun">.</span><span class="pln">getUserInfo</span><span class="pun">({</span></code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="pln"> success</span><span class="pun">:</span><span class="pln"> </span><span class="hljs-params"><span class="kwd">function</span></span><span class="pun">(</span><span class="hljs-params"><span class="pln">res</span></span><span class="pun">)</span><span class="pln"> </span><span class="pun">{</span></code></li> <li class="l"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="pln"> console</span><span class="pun">.</span><span class="pln">log</span><span class="pun">(</span><span class="pln">res</span><span class="pun">.</span><span class="pln">userInfo</span><span class="pun">)</span></code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="pln"> </span><span class="pun">}</span></code></li> <li class="l"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="pln"> </span><span class="pun">})</span></code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="pln"> </span><span class="pun">}</span></code></li> <li class="l"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="pln"> </span><span class="pun">}</span></code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="pln"> </span><span class="pun">})</span></code></li> <li class="l"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="pln"> </span><span class="pun">},</span></code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="pln"> bindGetUserInfo </span><span class="pun">(</span><span class="pln">e</span><span class="pun">)</span><span class="pln"> </span><span class="pun">{</span></code></li> <li class="l"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="pln"> console</span><span class="pun">.</span><span class="pln">log</span><span class="pun">(</span><span class="pln">e</span><span class="pun">.</span><span class="pln">detail</span><span class="pun">.</span><span class="pln">userInfo</span><span class="pun">)</span></code></li> <li class="l1"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="pln"> </span><span class="pun">}</span></code></li> <li class="l"><code class="pcalibre9 pcalibre8 pcalibre7"><span class="pun">})</span></code></li> </ol> ``` > 原文: <https://developers.weixin.qq.com/minigame/dev/api/open-api/user-info/wx.getUserInfo.html>