公司目前做了一个基于Vuejs为前端加Java为后端的H5系统,公司很多客户希望对接企业微信单点登录。这里记录下开发企业微信单点登录模式。
为了测试方便,建立测试公司来做测试。
企业微信单点登录流程
要实现单点登录,先要注册公司企业微信,然后配置应用,并配置相关的URL,信任域名,回调地址等。
简单操作开发逻辑:
配置企业微信单点登录
注册企业
首先需要注册一个测试的企业:
- 填写企业名称等基本信息
- 填写管理员信息
- 用微信扫码绑定管理员微信
- 注册成功
注册成功后可以进入管理后台,可以配置应用了。
配置应用
注册好企业之后,进入管理控制后台,可以在企业中配置应用了,点击【创建应用】
- 配置应用基本信息,logo等
- 创建应用之后,AgentId和Secret在调用接口的时候需要用到。
- 配置应用信任域名,如果没有域名可以尝试修改hosts来实现,但是只能在配置了hosts的机器上做测试
如果需要使用JS-SDK的话(只做单点登录不需要配置),还需要验证域名:
- 配置应用主页信息
后面有详细的应用【单点登录地址】章节说明信息
- 完成之后如下
单点登录地址
企业微信使用oauth2单点登录,因此地址是一个oauth2单点登录的地址,如下网址:
https://open.weixin.qq.com/connect/oauth2/authorize?response_type=code&scope=snsapi_base&appid=wwc0af1b81c7xxxxx&redirect_uri=REDIRECT_URI#wechat_redirect
文档地址:
https://work.weixin.qq.com/api/doc/90000/90135/91020
https://work.weixin.qq.com/api/doc/90000/90135/91022
参数说明:
参数 | 必须 | 说明 |
---|---|---|
appid | 是 | 企业的CorpID |
redirect_uri | 是 | 授权后重定向的回调链接地址,此链接是开发者提前开发出来,会在微信登录成功的时候跳转到此URL,并附带一个名为code的请求参数,然后可以根据这个code来获取用户信息,请使用urlencode对链接进行处理 |
response_type | 是 | 返回类型,此时固定为:code |
scope | 是 | 应用授权作用域。企业自建应用固定填写:snsapi_base |
state | 否 | 重定向后会带上state参数,企业可以填写a-zA-Z0-9的参数值,长度不可超过128个字节 |
#wechat_redirect | 是 | 终端使用此参数判断是否需要带上身份信息,注意URL hash是必须带上的 |
redirect_uri需要转码之后拼接到URL之后
URL转码工具:https://tool.oschina.net/encode?type=4
注意上面的corpId来源是:
开发单点登录
微信单点登录已经有人开源出来一些调用工具,把相关token获取(token有效期处理)和接口调用等工作封装好,目前选择此开源库
https://github.com/Wechat-Group/WxJava
选用企业微信模块即可:
<dependency>
<groupId>com.github.binarywang</groupId>
<artifactId>weixin-java-cp</artifactId>
<version>3.7.0</version>
</dependency>
参考文档地址:https://github.com/Wechat-Group/WxJava/wiki/CP_Quick-Start
如果不是用开源库,使用HttpClient等工具直接调用其API接口也能实现,参考官方文档地址:
https://work.weixin.qq.com/api/doc/90000/90135/90664
具体开发代码:
public class QyWeixinLoginTest {
private static final Logger logger = LoggerFactory.getLogger(QyWeixinLoginTest.class);
public static final String CORP_ID = ""; // 企业的corpId
public static final Integer AGENT_ID = 1000002; // 企业应用的AgentId
public static final String APP_SECRET = ""; // 企业应用的Secret
public static final String CODE = ""; // OAUTH2 REDIRECT_URI接收的code(测试的时候可以在浏览器地址栏中复制出来)
@Test
public void test() throws Exception {
// 初始化WxCpService
WxCpService wxCpService = new WxCpServiceImpl();
WxCpDefaultConfigImpl wxCpConfigStorage = new WxCpDefaultConfigImpl();
wxCpConfigStorage.setCorpId(CORP_ID); // 企业的corpId
wxCpConfigStorage.setAgentId(AGENT_ID); // 企业应用的AgentId
wxCpConfigStorage.setCorpSecret(APP_SECRET); // 企业应用的Secret
wxCpService.setWxCpConfigStorage(wxCpConfigStorage);
// 调用获取用户信息
// 根据oauth2获取到的code获取用户基本信息
WxCpOauth2UserInfo userInfo = wxCpService.getOauth2Service().getUserInfo(CODE);
if (userInfo != null) {
String userId = userInfo.getUserId();
if (StringUtils.isBlank(userId)) { // 用openId换取userId
userId = wxCpService.getUserService().openid2UserId(userInfo.getOpenId());
}
// 根据userId查询微信中用户详情
WxCpUser userDetail = wxCpService.getUserService().getById(userId);
logger.debug("{}", userDetail);
}
}
}
// 拿到用户信息之后就可以根据用户的信息模拟登录操作
测试单点登录
如果有外网域名或者手机可以改hosts的话,单点登录可以在手机上测试,但是却没有调试功能,最好的方式是使用【微信开发者工具】来做测试
下载微信开发者工具:
https://developers.weixin.qq.com/miniprogram/dev/devtools/download.html
下载安装之后,可以按照上面【单点登录地址】拼接出URL地址,并复制到开发者工具的地址栏测试(开发者工具需要登录和授权):
简简单单微信扫二维码可以登录,登录成功后再次操作,可能遇到需要授权问题,提示信息:未绑定企业号开发者
在企业控制后台中配置开发者工具授权:
然后可以测试可以获取到用户信息。