H5定位终极解决方案

时间 2020-02-04

原文原文链接

背景

到新公司的第二个项目，就是和小伙伴们一块儿作一个H5的商城，主要在微信内，但也要考虑到其余浏览器。其中，首页须要根据当前用户的经纬度找到距离最近的门店并展现。前端须要作的工做就是获取用户的经纬度而后查询后台接口并渲染页面。javascript

目标与分析

咱们的目标是通过封装以后，只须要调用一个方法就能够拿到返回的位置信息。html

咱们须要作的事情是，针对不一样的端（微信H5和其余浏览器环境）封装不一样的类，再经过一个方法经过 UA 区分，调用不一样环境对应的类获取位置。前端

在微信内部，通过反复的实践以后，不管是经过原生的 HTML5 定位，仍是经过第三方(如百度或腾讯地图) jsapi 获取位置，不只定位时间长，甚至常常出现定位失败的状况，严重影响用户体验，尤为对于大部分信息流都依赖于用于位置的商城首页来讲，是彻底没法接受的。因此在微信内咱们只有微信 sdk 这一种选择；java

而对于浏览器端，经过第三方的地图 jsapi 或定位组件，能够稳定且较快速地获取位置信息，为了与微信内尽可能保持一致，咱们选择的是腾讯地图 jsapi。git

解决方案

Talk is cheap, show me the code. 废话很少说，直接上代码：web

1. 在浏览器中，经过腾讯地图jsapi获取位置

1.1 在项目的 html 模版文件中引入腾讯地图 jsapi

<!-- index.html -->
<script charset="utf-8" src="https://map.qq.com/api/js?v=2.exp&key=腾讯地图key&referer=应用名称"></script>
复制代码

说明：api

使用腾讯地图 jsapi, 须要先去腾讯地图开放平台申请本身的帐号，而后建立本身的应用，将腾讯地图key 和建立的应用名称替换上面的值。浏览器

1.2 调用获取位置接口，获取位置信息

为了方便复用，咱们单独封装一个腾讯地图 jsapi 的类，命名为 tMap.js微信

// tMap.js
const qq = window.qq
var geolocation = null
if (qq && qq.maps) {
  // 初始化定位组件
  geolocation = new qq.maps.Geolocation(
    'QVLBZ-YUULR-OUMW7-WKXFD-4SUWS-UDBIA',
    'mymap'
  )
}

class TMap {
  // 获取定位计数器 用于定位失败时累计次数 超过3次后再也不继续，抛出定位失败错误
  getPositionCount = 0

  // 对外暴露的获取位置接口
  getLocation () {
    return new Promise((resolve, reject) => {
      // 定位成功回调
      this.getTMapLocation(resolve, reject)
    })
  }

  // 调用腾讯地图获取位置
  getTMapLocation (success, fail) {
    const _self = this

    // 定位成功回调
    const showPosition = position => {
      uni.setStorage({
        key: 'positionData',
        data: position
      })
      success(position)
    }

    // 定位失败回调
    const showErr = (err) => 
      // 若是获取定位失败超过3次 抛出错误 不然继续获取定位信息
      if (this.getPositionCount > 3) {
        fail('超过3次 获取定位失败')
      } else {
        // 定位失败递归
        _self.getPositionCount = _self.getPositionCount + 1
        _self.getTMapLocation(success, fail)
      }
    }

    // 调用腾讯web定位组件获取位置信息
    if (geolocation) {
      geolocation.getIpLocation(showPosition, showErr, {
        timeout: 6000,  // 定位超时时长 单位ms
        failTipFlag: true
      })
    }
  }
}

export default new TMap()
复制代码

2. 在微信 webview 中, 经过微信sdk获取位置信息

2.1 微信 js-sdk 相关的准备工做

2.1.1 引入js文件

/** * 微信sdk异步加载 * @param {*} src * @param {*} callback api接口 */
export const handlerLoadScript = callback => {
  const src = `https://res.wx.qq.com/open/js/jweixin-1.4.0.js`
  if (!(typeof callback === 'function')) {
    callback = function() {}
  }
  var check = document.querySelectorAll(`script[src="${src}"]`)
  if (check.length > 0) {
    check[0].addEventListener('load', function() {
      callback()
    })
    callback()
    return
  }
  var script = document.createElement('script')
  var head = document.getElementsByTagName('head')[0]
  script.type = 'text/javascript'
  script.charset = 'UTF-8'
  script.src = src
  if (script.addEventListener) {
    script.addEventListener(
      'load',
      function() {
        callback()
      },
      false
    )
  } else if (script.attachEvent) {
    script.attachEvent('onreadystatechange', function() {
      var target = window.event.srcElement
      if (target.readyState === 'loaded') {
        callback()
      }
    })
  }
  head.appendChild(script)
}
复制代码

2.1.2 注入权限验证配置

全部须要使用JS-SDK的页面必须先注入配置信息，不然将没法调用。一般是经过后台接口获取配置信息。app

/** * 注入权限验证配置 * @param {object} 微信 js-sdk 权限验证配置 */
export const wxconfigInfo = config => {
  wx.config({
    debug: false, // 开启调试模式,调用的全部api的返回值会在客户端alert出来，若要查看传入的参数，能够在pc端打开，参数信息会经过log打出，仅在pc端时才会打印。
    appId: config.appId,
    timestamp: parseInt(config.timestamp),
    nonceStr: config.nonceStr,
    signature: config.signature,
    jsApiList: [   // 须要使用的 jsapi 列表
      ...,
      'getLocation'  // 获取地理位置
    ]
  })
}
复制代码

2.2 调用 api 获取位置信息

/** * 微信获取位置 */
export const handleGetLocation = (config) => {
  return new Promise((resolve, reject)=>{
    wxconfigInfo(config)
    wx.ready(function () {
      wx.getLocation({
        type: 'wgs84', // 默认为wgs84的gps坐标，若是要返回直接给openLocation用的火星坐标，可传入'gcj02'
        success: function (res) {
          console.warn('微信sdk定位成功', res)
          resolve({
            lat: res.latitude, // 纬度
            lng: res.longitude, // 经度
            speed: res.speed, // 速度，以米/每秒计
            accuracy: res.accuracy // 位置精度
          })
        },
        fail: function (err) {
          console.error('微信sdk定位失败', err)
          reject(err)
        }
      })
    })
    wx.error(function(err) {
      // config信息验证失败会执行error函数，如签名过时致使验证失败，具体错误信息能够打开config的debug模式查看，也能够在返回的res参数中查看，对于SPA能够在这里更新签名。
      console.log('wxjsapi-error=', err)
      reject(`wxjsapi-error: ${err}`)
    })
  })
复制代码

2.3 根据不一样运行环境调用不一样的定位方法

// public.js

/** * UA枚举 */
const UA = {
  /** * 微信h5 */
  WECHAT: 'WECHAT',
  /** * 支付宝h5 */
  ALIPAY: 'ALIPAY',
  /** * 其余 */
  OTHERS: 'OTHERS'
}


/** * 判断客户端运行环境 这里只判断微信和浏览器h5 */
export const getUserAgent = () => {
  var userAgent = navigator.userAgent.toLowerCase()

  if (userAgent.match(/Alipay/i) == 'alipay') {
    return UA.ALIPAY
  } else if (userAgent.match(/MicroMessenger/i) == 'micromessenger') {
    return UA.WECHAT
  } else {
    return UA.OTHERS
  }
}
复制代码

// js-sdk.js
/** * 唤起微信api * @param {*} _href 当前页面url * @param {*} options 分享信息 * @param {*} apiType 调用api类型 */
export const handleWXSDKCall = (_href, apiType, options) => {
  return new Promise((resolve, reject)=>{
    // 经过后台接口获取配置信息
    WeChatServivce.sign(_href)
      .then(res => {
        if (res) {
          if ( apiType === 'location' ) {
            handleGetLocation(res).then((res)=>{
              resolve(res)
            }).catch(err=>{
              reject(err)
            })
          }
        }
      })
      .catch(err => {
        reject(`err-sign: ${err}`)
        uni.showToast({
          title: err.data.code + err.data.msg,
          mask: true,
          icon: 'none'
        })
      })
  })
}
复制代码

// getLocation.js
import { getUserAgent, handlerLoadScript } from '@/module/utils'
import { handleWXSDKCall } from '@/module/utils/wechat/wxJsApiSdk'
import UA from '@/module/enums/userAgent'
import TMap from '@/module/utils/tMap'

/** * 对外暴露的获取位置方法 * @return Promise resolve一个 positionData 对象 lat-纬度 lng-经度 */
const getLocation = () => {
  return new Promise((resolve, reject) => {
    console.log('进入全局获取用户位置方法')
    const storageData = uni.getStorageSync('positionData')
    const userAgent = getUserAgent()
    if (storageData) {
      resolve(storageData)
    } else {
      // 根据环境判断 若是在微信内使用微信sdk 其余使用腾讯地图定位组件
      if (userAgent === UA.WECHAT) {
        handlerLoadScript(() => {
          handleWXSDKCall(window.location.href, 'location').then((res) => {
            uni.setStorageSync('positionData', res)
            resolve(res)
          }).catch(err => {
            reject(err)
          })
        })
      } else {
        TMap.getLocation().then(res => {
          uni.setStorageSync('positionData', res)
          resolve(res)
        }).catch((err) => {
          reject(err)
        })
      }
    }
  })
}

export default getLocation
复制代码

3. 页面调用

3.1 绑定方法到 Vue 原型上

import getLocation from '@/module/utils/getLocation'
Vue.prototype.$getLocation = getLocation
复制代码

3.2 在页面组件中调用

onShow() {
  // 获取位置信息后请求后台接口
  this.$getLocation()
    .then(res => {
      console.warn('首页获取位置成功', res)
      this.latitude = res.lat
      this.longitude = res.lng
      // 这里根据获取到的经纬度请求后台接口...
    })
    .catch(err => {
      console.error('首页获取位置失败', err)
      // 错误处理
    })
}

复制代码

总结

遇到的坑以及须要注意的点：

使用微信sdk获取位置信息须要按顺序完成如下步骤：

异步加载微信sdk
经过接口获取配置信息，配置微信sdk
在wx.ready回调中调用方法

必须严格按顺序完成以上的三个步骤，不然是没法调用微信sdk的功能的。

总之，经过这篇文章，能够解决 H5 定位 99% 以上的应用场景。