一、什么是wx.checkSession
wx.checkSession是微信小程序中用于检测用户登录态是否过期的API。小程序中用户的登录态是由微信服务器管理的,如果用户登录小程序后长时间不进行操作,那么用户的登录态就会过期,此时需要利用wx.checkSession来判断用户的登录态是否过期。
二、wx.checkSession的使用方法
使用wx.checkSession需要先调用wx.login获取code,然后将code发送到后台服务器获取session_key和openid。在小程序中,可以使用wx.setStorage将session_key和openid保存在本地。下面是wx.checkSession的使用方法:
wx.checkSession({
success: function () {
//session_key未过期,并且在本生命周期一直有效
},
fail: function () {
// session_key已经失效,需要重新执行登录流程
wx.login() //重新登录
}
})
三、wx.checkSession返回结果的含义
当使用wx.checkSession检测用户登录态时,会有两种情况:session_key未过期,或者session_key已经失效。根据wx.checkSession返回结果的含义,我们可以进行下一步的操作。
当wx.checkSession返回成功时,说明用户的session_key未过期,此时程序可以直接使用本地的session_key和openid进行后续的操作。
wx.checkSession({
success: function () {
console.log("session_key未过期")
}
})
当wx.checkSession返回错误时,说明用户的session_key已经失效,这时候程序需要调用wx.login重新获取code,然后将code发送到后台重新获取session_key和openid。如果后台返回结果成功,那么程序可以更新本地的session_key和openid,并重新执行需要登录态的操作。如果后台返回失败,那么程序需要提示用户登录失败,或者重试登录。
wx.checkSession({
fail: function () {
console.log("session_key已经失效")
wx.login({
success:function(res){
console.log(res.code)
wx.request({
url: 'https://example.com/onLogin',
data: {
code: res.code
},
success: function (res) {
//处理后台返回的结果
},
fail:function(res){
//处理请求失败的情况
}
})
},
fail:function(res){
//处理调用wx.login失败的情况
}
})
}
})
四、wx.checkSession的使用场景
wx.checkSession主要用于检测用户的登录态是否过期,常见的使用场景包括:
1、请求需要登录态的API时,先调用wx.checkSession判断用户的登录态是否过期,如果过期则重新执行登录流程,如果未过期则直接使用本地的登录态。
2、开发者工具的调试过程中,模拟用户登录完成后长时间未操作,测试wx.checkSession的错误处理逻辑。
五、wx.checkSession的注意事项
1、wx.checkSession是异步API,需要使用回调函数来处理执行结果。
2、wx.checkSession的返回结果只是用来判断用户的登录态是否过期,如果需要操作用户数据,还需要根据用户的openid或unionId来进行后续操作。
3、wx.checkSession只能检测当前小程序的登录态是否过期,无法检测其他小程序的登录态。
六、小结
wx.checkSession是微信小程序中用于检测用户登录态是否过期的重要API,开发者在开发小程序时需要根据业务需求使用wx.checkSession来判断用户的登录态是否过期,在wx.checkSession返回结果中进行下一步的业务逻辑。