微信公众平台 微信网页授权
Posted 天才小小布
tags:
篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了微信公众平台 微信网页授权相关的知识,希望对你有一定的参考价值。
前言:最近处心积虑的把微信网页授权弄了一下,感觉对微信公众号的认知还是太肤浅,以后要多总结学习微信公众号的开发,这里简单总结一下微信网页授权的java接口开发。在开发微信公众平台的时候建议使用测试号,毕竟不是每个人都能微信认证。
微信网页授权的作用:如果用户在微信客户端中访问第三方网页,公众号可以通过微信网页授权机制,来获取用户基本信息,进而实现业务逻辑。
官方文档:微信网页授权
注:部分内容摘抄子微信公众平台开发文档
一、用户同意授权,获取code
1 参考链接
在确保微信公众账号拥有授权作用域(scope参数)的权限的前提下(服务号获得高级接口后,默认拥有scope参数中的snsapi_base和snsapi_userinfo),引导关注者打开如下页面:
https://open.weixin.qq.com/connect/oauth2/authorize?appid=APPID&redirect_uri=REDIRECT_URI&response_type=code&scope=SCOPE&state=STATE#wechat_redirect
若提示“该链接无法访问”,请检查参数是否填写错误,是否拥有scope参数对应的授权作用域权限。
尤其注意:由于授权操作安全等级较高,所以在发起授权请求时,微信会对授权链接做正则强匹配校验,如果链接的参数顺序不对,授权页面将无法正常访问
参考链接(请在微信客户端中打开此链接体验):
scope为snsapi_base
https://open.weixin.qq.com/connect/oauth2/authorize?appid=wx520c15f417810387&redirect_uri=https%3A%2F%2Fchong.qq.com%2Fphp%2Findex.php%3Fd%3D%26c%3DwxAdapter%26m%3DmobileDeal%26showwxpaytitle%3D1%26vb2ctag%3D4_2030_5_1194_60&response_type=code&scope=snsapi_base&state=123#wechat_redirect
scope为snsapi_userinfo
https://open.weixin.qq.com/connect/oauth2/authorize?appid=wxf0e81c3bee622d60&redirect_uri=http%3A%2F%2Fnba.bluewebgame.com%2Foauth_response.php&response_type=code&scope=snsapi_userinfo&state=STATE#wechat_redirect
尤其注意:跳转回调redirect_uri,应当使用https链接来确保授权code的安全性。
2 参数说明
参数 | 是否必须 | 说明 |
---|---|---|
appid | 是 | 公众号的唯一标识 |
redirect_uri | 是 | 授权后重定向的回调链接地址,请使用urlEncode对链接进行处理 |
response_type | 是 | 返回类型,请填写code |
scope | 是 | 应用授权作用域,snsapi_base (不弹出授权页面,直接跳转,只能获取用户openid),snsapi_userinfo (弹出授权页面,可通过openid拿到昵称、性别、所在地。并且,即使在未关注的情况下,只要用户授权,也能获取其信息) |
state | 否 | 重定向后会带上state参数,开发者可以填写a-zA-Z0-9的参数值,最多128字节 |
#wechat_redirect | 是 | 无论直接打开还是做页面302重定向时候,必须带此参数 |
如果用户同意授权,页面将跳转至 redirect_uri/?code=CODE&state=STATE。
code说明 : code作为换取access_token的票据,每次用户授权带上的code将不一样,code只能使用一次,5分钟未被使用自动过期。
3 实践开发
3.1 redirect_uri回调地址
(1)配置微信授权回调地址
在微信公共平台的开发->接口权限->网页服务->网页授权->网页授权获取用户基本信息
因为我的公众号没有认证过,所以我们可以采用开发者工具的公众平台测试账号进行测试。测试账号的接口体验权限可以让我尽情的去开发。
在网页授权获取用户基本信息选择修改,在回调地址中输入你需要回调的地址,我的测试地址是www.baidu.com。
(2)对redirect_uri使用urlEncode对链接进行处理
java代码
public static void main(String[] args)
String result = "";
try
result = URLEncoder.encode("https://www.baidu.com","utf-8");
System.out.println(result);
catch (UnsupportedEncodingException e)
e.printStackTrace();
执行结果
https%3A%2F%2Fwww.baidu.com
(3)关于网页授权回调域名的说明
1、在微信公众号请求用户网页授权之前,开发者需要先到公众平台官网中的“开发 - 接口权限 - 网页服务 - 网页帐号 - 网页授权获取用户基本信息”的配置选项中,修改授权回调域名。请注意,这里填写的是域名(是一个字符串),而不是URL,因此请勿加 http:// 等协议头。
2、授权回调域名配置规范为全域名,比如需要网页授权的域名为:www.qq.com,配置以后此域名下面的页面http://www.qq.com/music.html 、 http://www.qq.com/login.html 都可以进行OAuth2.0鉴权。但http://pay.qq.com 、 http://music.qq.com 、 http://qq.com无法进行OAuth2.0鉴权。
3、如果公众号登录授权给了第三方开发者来进行管理,则不必做任何设置,由第三方代替公众号实现网页授权即可。
3.2 测试链接
给大家安利一个工具,微信web开发者工具。选择微信公众号开发。
如果我们直接请求链接会提示请在微信客户端打开,直接用微信提供的工具测试直接提高了自己的逼格,主要是很好用。
(1) 拼接请求
https://open.weixin.qq.com/connect/oauth2/authorize?appid=wxa8***07444b***&redirect_uri=https%3A%2F%2Fwww.baidu.com&response_type=code&scope=snsapi_base&state=STATE#wechat_redirect
(2)请求测试结果
请求之后微信会回调地址加上code和status返回给我们。这样子我们就能拿到code值了。code的有效性只要5分钟,超时再请求会提示错误。
二、通过code换取网页授权access_token
首先请注意,这里通过code换取的是一个特殊的网页授权access_token,与基础支持中的access_token(该access_token用于调用其他接口)不同。公众号可通过下述接口来获取网页授权access_token。如果网页授权的作用域为snsapi_base,则本步骤中获取到网页授权access_token的同时,也获取到了openid,snsapi_base式的网页授权流程即到此为止。
尤其注意:由于公众号的secret和获取到的access_token安全级别都非常高,必须只保存在服务器,不允许传给客户端。后续刷新access_token、通过access_token获取用户信息等步骤,也必须从服务器发起。
1 请求方法
获取code后,请求以下链接获取access_token: https://api.weixin.qq.com/sns/oauth2/access_token?appid=APPID&secret=SECRET&code=CODE&grant_type=authorization_code
2 参数说明
参数 | 是否必须 | 说明 |
---|---|---|
appid | 是 | 公众号的唯一标识 |
secret | 是 | 公众号的appsecret |
code | 是 | 填写第一步获取的code参数 |
grant_type | 是 | 填写为authorization_code |
3 java接口开发
(1)返回参数实体类
/**
* 类名: WeixinOauth2Token.java</br>
* 描述: 网页授权信息</br>
*/
public class WeixinOauth2Token
// 网页授权接口调用凭证
private String accessToken;
// 凭证有效时长
private int expiresIn;
// 用于刷新凭证
private String refreshToken;
// 用户标识
private String openId;
// 用户授权作用域
private String scope;
public String getAccessToken()
return accessToken;
public void setAccessToken(String accessToken)
this.accessToken = accessToken;
public int getExpiresIn()
return expiresIn;
public void setExpiresIn(int expiresIn)
this.expiresIn = expiresIn;
public String getRefreshToken()
return refreshToken;
public void setRefreshToken(String refreshToken)
this.refreshToken = refreshToken;
public String getOpenId()
return openId;
public void setOpenId(String openId)
this.openId = openId;
public String getScope()
return scope;
public void setScope(String scope)
this.scope = scope;
(2)请求方法类
/**
* 获取网页授权凭证
* @param appId 公众账号的唯一标识
* @param appSecret 公众账号的密钥
* @param code
* @return WeixinAouth2Token
*/
public static WeixinOauth2Token getOauth2AccessToken(String appId, String appSecret, String code)
WeixinOauth2Token wat = null;
// 拼接请求地址
String requestUrl = WeixinConstants.OAUTH2_URL;
requestUrl = requestUrl.replace("APPID", appId);
requestUrl = requestUrl.replace("SECRET", appSecret);
requestUrl = requestUrl.replace("CODE", code);
// 获取网页授权凭证
JSONObject jsonObject = CommonUtil.httpsRequest(requestUrl, "GET", null);
if (null != jsonObject)
try
wat = new WeixinOauth2Token();
wat.setAccessToken(jsonObject.getString("access_token"));
wat.setExpiresIn(jsonObject.getInt("expires_in"));
wat.setRefreshToken(jsonObject.getString("refresh_token"));
wat.setOpenId(jsonObject.getString("openid"));
wat.setScope(jsonObject.getString("scope"));
catch (Exception e)
wat = null;
int errorCode = jsonObject.getInt("errcode");
String errorMsg = jsonObject.getString("errmsg");
log.error("获取网页授权凭证失败 errcode: errmsg:", errorCode, errorMsg);
return wat;
(3)发送http请求工具类
/**
* 发送https请求
* @param requestUrl 请求地址
* @param requestMethod 请求方式(GET、POST)
* @param outputStr 提交的数据
* @return JSONObject(通过JSONObject.get(key)的方式获取json对象的属性值)
*/
public static JSONObject httpsRequest(String requestUrl, String requestMethod, String outputStr)
JSONObject jsonObject = null;
try
// 创建SSLContext对象,并使用我们指定的信任管理器初始化
TrustManager[] tm = new MyX509TrustManager() ;
SSLContext sslContext = SSLContext.getInstance("SSL", "SunJSSE");
sslContext.init(null, tm, new java.security.SecureRandom());
// 从上述SSLContext对象中得到SSLSocketFactory对象
SSLSocketFactory ssf = sslContext.getSocketFactory();
URL url = new URL(requestUrl);
HttpsURLConnection conn = (HttpsURLConnection) url.openConnection();
conn.setSSLSocketFactory(ssf);
conn.setDoOutput(true);
conn.setDoInput(true);
conn.setUseCaches(false);
// 设置请求方式(GET/POST)
conn.setRequestMethod(requestMethod);
// 当outputStr不为null时向输出流写数据
if (null != outputStr)
OutputStream outputStream = conn.getOutputStream();
// 注意编码格式
outputStream.write(outputStr.getBytes("UTF-8"));
outputStream.close();
// 从输入流读取返回内容
InputStream inputStream = conn.getInputStream();
InputStreamReader inputStreamReader = new InputStreamReader(inputStream, "utf-8");
BufferedReader bufferedReader = new BufferedReader(inputStreamReader);
String str = null;
StringBuffer buffer = new StringBuffer();
while ((str = bufferedReader.readLine()) != null)
buffer.append(str);
// 释放资源
bufferedReader.close();
inputStreamReader.close();
inputStream.close();
inputStream = null;
conn.disconnect();
jsonObject = JSONObject.fromObject(buffer.toString());
catch (ConnectException ce)
log.error("连接超时:", ce);
catch (Exception e)
log.error("https请求异常:", e);
return jsonObject;
(4)信任管理器工具类
/**
* 类名: MyX509TrustManager.java</br>
* 描述: 信任管理器</br>
*/
public class MyX509TrustManager implements X509TrustManager
// 检查客户端证书
public void checkClientTrusted(X509Certificate[] chain, String authType) throws CertificateException
// 检查服务器端证书
public void checkServerTrusted(X509Certificate[] chain, String authType) throws CertificateException
// 返回受信任的X509证书数组
public X509Certificate[] getAcceptedIssuers()
return null;
4 返回说明
正确时返回的JSON数据包如下:
"access_token":"ACCESS_TOKEN",
"expires_in":7200,
"refresh_token":"REFRESH_TOKEN",
"openid":"OPENID",
"scope":"SCOPE"
参数 | 描述 |
---|---|
access_token | 网页授权接口调用凭证,注意:此access_token与基础支持的access_token不同 |
expires_in | access_token接口调用凭证超时时间,单位(秒) |
refresh_token | 用户刷新access_token |
openid | 用户唯一标识,请注意,在未关注公众号时,用户访问公众号的网页,也会产生一个用户和公众号唯一的OpenID |
scope | 用户授权的作用域,使用逗号(,)分隔 |
错误时微信会返回JSON数据包如下(示例为Code无效错误):
"errcode":40029,"errmsg":"invalid code"
三、刷新access_token(如果需要)
由于access_token拥有较短的有效期,当access_token超时后,可以使用refresh_token进行刷新,refresh_token有效期为30天,当refresh_token失效之后,需要用户重新授权。
1 请求方法
获取第二步的refresh_token后,请求以下链接获取access_token:
https://api.weixin.qq.com/sns/oauth2/refresh_token?appid=APPID&grant_type=refresh_token&refresh_token=REFRESH_TOKEN
2 参数说明
参数 | 是否必须 | 说明 |
---|---|---|
appid | 是 | 公众号的唯一标识 |
grant_type | 是 | 填写为refresh_token |
refresh_token | 是 | 填写通过access_token获取到的refresh_token参数 |
3 java接口
(1)请求方法类
/**
* 刷新网页授权凭证
* @param appId 公众账号的唯一标识
* @param refreshToken
* @return WeixinAouth2Token
*/
public static WeixinOauth2Token refreshOauth2AccessToken(String appId, String refreshToken)
WeixinOauth2Token wat = null;
// 拼接请求地址
String requestUrl = WeixinConstants.REFRESH_TOKEN_URL;
requestUrl = requestUrl.replace("APPID", appId);
requestUrl = requestUrl.replace("REFRESH_TOKEN", refreshToken);
// 刷新网页授权凭证
JSONObject jsonObject = CommonUtil.httpsRequest(requestUrl, "GET", null);
if (null != jsonObject)
try
wat = new WeixinOauth2Token();
wat.setAccessToken(jsonObject.getString("access_token"));
wat.setExpiresIn(jsonObject.getInt("expires_in"));
wat.setRefreshToken(jsonObject.getString("refresh_token"));
wat.setOpenId(jsonObject.getString("openid"));
wat.setScope(jsonObject.getString("scope"));
catch (Exception e)
wat = null;
int errorCode = jsonObject.getInt("errcode");
String errorMsg = jsonObject.getString("errmsg");
log.error("刷新网页授权凭证失败 errcode: errmsg:", errorCode, errorMsg);
return wat;
其他方法同上。
四、拉取用户信息(需scope为 snsapi_userinfo)
如果网页授权作用域为snsapi_userinfo,则此时开发者可以通过access_token和openid拉取用户信息了。
注:还有一个获取用户信息的接口直接传入appid和openid就可以了,这里的接口与另一个接口不同,请注意。
1 请求方法
http:GET(请使用https协议)
https://api.weixin.qq.com/sns/userinfo?access_token=ACCESS_TOKEN&openid=OPENID&lang=zh_CN
2 参数说明
参数 | 描述 |
---|---|
access_token | 网页授权接口调用凭证,注意:此access_token与基础支持的access_token不同 |
openid | 用户的唯一标识 |
lang | 返回国家地区语言版本,zh_CN 简体,zh_TW 繁体,en 英语 |
3 java接口
(1)返回参数实体类
/**
* 类名: SNSUserInfo.java</br>
* 描述: 通过网页授权获取的用户信息</br>
*/
public class SNSUserInfo
// 用户标识
private String openId;
// 用户昵称
private String nickname;
// 性别(1是男性,2是女性,0是未知)
private int sex;
// 国家
private String country;
// 省份
private String province;
// 城市
private String city;
// 用户头像链接
private String headImgUrl;
// 用户特权信息
private List<String> privilegeList;
public String getOpenId()
return openId;
public void setOpenId(String openId)
this.openId = openId;
public String getNickname()
return nickname;
public void setNickname(String nickname)
this.nickname = nickname;
public int getSex()
return sex;
public void setSex(int sex)
this.sex = sex;
public String getCountry()
return country;
public void setCountry(String country)
this.country = country;
public String getProvince()
return province;
public void setProvince(String province)
this.province = province;
public String getCity()
return city;
public void setCity(String city)
this.city = city;
public String getHeadImgUrl()
return headImgUrl;
public void setHeadImgUrl(String headImgUrl)
this.headImgUrl = headImgUrl;
public List<String> getPrivilegeList()
return privilegeList;
public void setPrivilegeList(List<String> privilegeList)
this.privilegeList = privilegeList;
(2)请求方法类
/**
* 通过网页授权获取用户信息
* @param accessToken 网页授权接口调用凭证
* @param openId 用户标识
* @return SNSUserInfo
*/
@SuppressWarnings( "deprecation", "unchecked" )
public static SNSUserInfo getSNSUserInfo(String accessToken, String openId)
SNSUserInfo snsUserInfo = null;
// 拼接请求地址
String requestUrl = "https://api.weixin.qq.com/sns/userinfo?access_token=ACCESS_TOKEN&openid=OPENID";
requestUrl = requestUrl.replace("ACCESS_TOKEN", accessToken).replace("OPENID", openId);
// 通过网页授权获取用户信息
JSONObject jsonObject = CommonUtil.httpsRequest(requestUrl, "GET", null);
if (null != jsonObject)
try
snsUserInfo = new SNSUserInfo();
// 用户的标识
snsUserInfo.setOpenId(jsonObject.getString("openid"));
// 昵称
snsUserInfo.setNickname(jsonObject.getString("nickname"));
// 性别(1是男性,2是女性,0是未知)
snsUserInfo.setSex(jsonObject.getInt("sex"));
// 用户所在国家
snsUserInfo.setCountry(jsonObject.getString("country"));
// 用户所在省份
snsUserInfo.setProvince(jsonObject.getString("province"));
// 用户所在城市
snsUserInfo.setCity(jsonObject.getString("city"));
// 用户头像
snsUserInfo.setHeadImgUrl(jsonObject.getString("headimgurl"));
// 用户特权信息
snsUserInfo.setPrivilegeList(JSONArray.toList(jsonObject.getJSONArray("privilege"), List.class));
catch (Exception e)
snsUserInfo = null;
int errorCode = jsonObject.getInt("errcode");
String errorMsg = jsonObject.getString("errmsg");
log.error("获取用户信息失败 errcode: errmsg:", errorCode, errorMsg);
return snsUserInfo;
4 返回说明
正确时返回的JSON数据包如下:
"openid":" OPENID",
" nickname": NICKNAME,
"sex":"1",
"province":"PROVINCE"
"city":"CITY",
"country":"COUNTRY",
"headimgurl": "http://wx.qlogo.cn/mmopen/g3MonUZtNHkdmzicIlibx6iaFqAc56vxLSUfpb6n5WKSYVY0ChQKkiaJSgQ1dZuTOgvLLrhJbERQQ
4eMsv84eavHiaiceqxibJxCfHe/46",
"privilege":[ "PRIVILEGE1" "PRIVILEGE2" ],
"unionid": "o6_bmasdasdsad6_2sgVt7hMZOPfL"
参数 | 描述 |
---|---|
openid | 用户的唯一标识 |
nickname | 用户昵称 |
sex | 用户的性别,值为1时是男性,值为2时是女性,值为0时是未知 |
province | 用户个人资料填写的省份 |
city | 普通用户个人资料填写的城市 |
country | 国家,如中国为CN |
headimgurl | 用户头像,最后一个数值代表正方形头像大小(有0、46、64、96、132数值可选,0代表640*640正方形头像),用户没有头像时该项为空。若用户更换头像,原有头像URL将失效。 |
privilege | 用户特权信息,json 数组,如微信沃卡用户为(chinaunicom) |
unionid | 只有在用户将公众号绑定到微信开放平台帐号后,才会出现该字段。 |
错误时微信会返回JSON数据包如下(示例为openid无效):
"errcode":40003,"errmsg":" invalid openid "
五、检验授权凭证(access_token)是否有效
1 请求方法
http:GET(请使用https协议) https://api.weixin.qq.com/sns/auth?access_token=ACCESS_TOKEN&openid=OPENID
2 参数说明
参数 | 描述 |
---|---|
access_token | 网页授权接口调用凭证,注意:此access_token与基础支持的access_token不同 |
openid | 用户的唯一标识 |
3 返回说明
正确的JSON返回结果:
"errcode":0,"errmsg":"ok"
错误时的JSON返回示例:
"errcode":40003,"errmsg":"invalid openid"
以上是关于微信公众平台 微信网页授权的主要内容,如果未能解决你的问题,请参考以下文章
Java微信公众平台开发(十六)--微信网页授权(OAuth2.0授权)获取用户基本信息
微信公众平台,微信网页授权,redirect_uri参数错误,解决方法!