Главная страница>Связанные с программированием>AI Исходный код
Скачать

мпапи

mpapi (miniProgram API), плагин, совместимый с API мини-программ, написанный один раз и запускаемый на нескольких терминалах.

⏰ Дата обновления: 31 мая 2019 г., функции мини-программы постоянно обновляются, новая версия может отличаться, обратите внимание.

Проблема, которую решает этот проект : найти различия между различными API-интерфейсами мини-программ и попытаться использовать набор API-интерфейсов, совместимых с несколькими мини-программами .

Функции

  • Напишите один раз, запустите на нескольких терминалах, поддержка: мини-программа WeChat, мини-программа Alipay, мини-программа Baidu smart, мини-программа ByteDance.
  • Поддерживает Promise (включает только обратный вызов при успешном выполнении)
  • Оптимизирован для определенного использования API, например: api.showToast может передавать string напрямую, api.setStorageSync не требует вызова try catch 等
  • Поддержка обработки событий специальных API, таких как: request , downloadFile , Details.
  • Поддерживает суждение на разных концах: api.isWechat , api.isAlipay , api.isSwan , api.isTt

Установить 

npm install mpapi --save

Метод установки, отличный от npm, просто добавьте mpapi.js в каталог lib непосредственно в проект.

использовать 

 const api = require ( 'mpapi' )

api . alert ( { ... } ) . then ( ( res ) => { } )
api . confirm ( { ... } ) . then ( ( res ) => { } )
api . getLocation ( ) . then ( ( res ) => { } )
. . .

быстрый просмотр

  • Список совместимых API
  • Другие API, упакованные как Promise
  • Различия API
  • Инструкция по применению
  • Специальная обработка событий API, request , downloadFile , uploadFile и т. д.
  • Официальная документация API: мини-программа WeChat, мини-программа Alipay, мини-программа Baidu smart, мини-программа ByteDance.

Список совместимых API

API, который может использоваться всеми мини-программами

  • взаимодействие

    • alert
    • confirm
    • showToast
    • showLoading
    • showActionSheet

  • Панель навигации

    • setNavigationBarTitle
    • setNavigationBarColor

  • документ

    • saveFile
    • getFileInfo
    • getSavedFileInfo
    • getSavedFileList
    • removeSavedFile

  • картина

    • chooseImage
    • previewImage
    • compressImage
    • saveImageToPhotosAlbum

  • просить

    • request
    • uploadFile
    • downloadFile

  • Кэш данных

    • setStorageSync
    • getStorageSync
    • clearStorageSync
    • getStorageInfoSync
    • removeStorageSync

  • Системное оборудование

    • getSystemInfoSync
    • setScreenBrightness
    • getScreenBrightness
    • makePhoneCall
    • scanCode
    • setClipboardData
    • getClipboardData

Другие API, упакованные как Promise

Поддерживается только в определенных мини-программах

Апплет WeChatшх , приложение Alipayмой , умное приложение Baiduлебедь , апплет ByteDanceтт , если значок есть, значит поддерживается только соответствующий апплет, если значка нет, значит поддерживаются все.

  • взаимодействие

    • hideToast
    • hideLoading
    • showModal %= фунт %> %= фунт %>%= фунт %>
    • prompt %= фунт %>

  • кэш

    • getStorage
    • setStorage
    • removeStorage
    • getStorageInfo

  • маршрутизация

    • reLaunch
    • switchTab
    • redirectTo
    • navigateTo
    • navigateBack

  • Расположение

    • getLocation
    • openLocation
    • chooseLocation %= фунт %> %= фунт %>%= фунт %>

  • Изображение файла

    • saveImage %= фунт %>
    • getImageInfo
    • chooseVideo %= фунт %> %= фунт %>%= фунт %>
    • chooseMessageFile %= фунт %>
    • saveVideoToPhotosAlbum %= фунт %> %= фунт %>%= фунт %>
    • openDocument %= фунт %> %= фунт %>

  • Аудио

    • stopVoice %= фунт %>
    • playVoice %= фунт %>
    • getAvailableAudioSources %= фунт %>
    • stopBackgroundAudio %= фунт %>
    • playBackgroundAudio %= фунт %>
    • seekBackgroundAudio %= фунт %>
    • pauseBackgroundAudio %= фунт %>
    • getBackgroundAudioPlayerState %= фунт %>
    • setInnerAudioOption %= фунт %> %= фунт %>
    • startRecord %= фунт %>
    • stopRecord %= фунт %>
    • stopRecord %= фунт %>

  • Панель навигации

    • getTitleColor %= фунт %>
    • setNavigationBar %= фунт %>
    • showNavigationBarLoading %= фунт %> %= фунт %>%= фунт %>
    • hideNavigationBarLoading %= фунт %> %= фунт %>%= фунт %>

  • фон

    • setBackgroundTextStyle %= фунт %> %= фунт %>%= фунт %>
    • setBackgroundColor %= фунт %> %= фунт %>%= фунт %>
    • showTabBar %= фунт %> %= фунт %>%= фунт %>
    • hideTabBar %= фунт %> %= фунт %>%= фунт %>
    • setTabBarItem %= фунт %> %= фунт %>%= фунт %>
    • setTabBarStyle %= фунт %> %= фунт %>%= фунт %>
    • showTabBarRedDot %= фунт %> %= фунт %>%= фунт %>
    • hideTabBarRedDot %= фунт %> %= фунт %>%= фунт %>
    • setTabBarBadge %= фунт %> %= фунт %>%= фунт %>
    • removeTabBarBadge %= фунт %> %= фунт %>%= фунт %>

  • Потяните вниз, чтобы обновить

    • startPullDownRefresh
    • stopPullDownRefresh

  • прокрутка

    • pageScrollTo
    • sendSocketMessage %= фунт %> %= фунт %>%= фунт %>
    • connectSocket
    • closeSocket %= фунт %> %= фунт %>%= фунт %>
    • startLocalServiceDiscovery %= фунт %>
    • stopLocalServiceDiscovery %= фунт %>

  • прикрепить сверху

    • setTopBarText %= фунт %>

  • холст

    • canvasGetImageData %= фунт %> %= фунт %>%= фунт %>
    • canvasPutImageData %= фунт %> %= фунт %>%= фунт %>
    • canvasToTempFilePath %= фунт %> %= фунт %>%= фунт %>

  • Поделиться и переслать

    • getShareInfo %= фунт %>
    • updateShareMenu %= фунт %>
    • showShareMenu %= фунт %> %= фунт %>
    • hideShareMenu %= фунт %> %= фунт %>%= фунт %>
    • showFavoriteGuide %= фунт %>
    • openShare %= фунт %>

  • Вход, авторизация, информация о пользователе

    • login %= фунт %> %= фунт %>%= фунт %>
    • checkSession %= фунт %> %= фунт %>%= фунт %>
    • getUserInfo %= фунт %> %= фунт %>%= фунт %>
    • getAuthCode %= фунт %>
    • getAuthUserInfo %= фунт %>
    • getPhoneNumber %= фунт %>
    • authorize %= фунт %> %= фунт %>

  • платить

    • tradePay %= фунт %>
    • requestPayment %= фунт %> %= фунт %>
    • requestPolymerPayment %= фунт %>

  • открытый интерфейс

    • getSetting
    • openSetting
    • reportAnalytics
    • chooseInvoiceTitle %= фунт %> %= фунт %>
    • navigateToMiniProgram %= фунт %> %= фунт %>
    • navigateBackMiniProgram %= фунт %> %= фунт %>

  • Открытый интерфейс — апплет WeChat

    • addCard %= фунт %>
    • openCard %= фунт %>
    • chooseInvoice %= фунт %>
    • startSoterAuthentication %= фунт %>
    • checkIsSoterEnrolledInDevice %= фунт %>
    • checkIsSupportSoterAuthentication %= фунт %>
    • getWeRunData %= фунт %>

  • Открытый интерфейс — апплет Alipay

    • startZMVerify %= фунт %>
    • textRiskIdentification %= фунт %>
    • addCardAuth %= фунт %>
    • getRunScene %= фунт %>
    • chooseCity %= фунт %>
    • datePicker %= фунт %>
    • optionsSelect %= фунт %>
    • multiLevelSelect %= фунт %>
    • rsa %= фунт %>

  • Открытый интерфейс — умный апплет Baidu

    • getSwanId %= фунт %>
    • navigateToSmartProgram %= фунт %>
    • navigateBackSmartProgram %= фунт %>
    • setPageInfo %= фунт %>
    • setMetaDescription %= фунт %>
    • setMetaKeywords %= фунт %>
    • setDocumentTitle %= фунт %>
    • loadSubPackage %= фунт %>

  • Контактное лицо

    • chooseAddress %= фунт %> %= фунт %>%= фунт %>
    • chooseContact %= фунт %>
    • choosePhoneContact %= фунт %>
    • chooseAlipayContact %= фунт %>
    • addPhoneContact %= фунт %> %= фунт %>%= фунт %>

  • Загрузка шрифта

    • loadFontFace %= фунт %> %= фунт %>

  • Информация о системе

    • getSystemInfo
    • getBatteryInfo %= фунт %> %= фунт %>%= фунт %>
    • getNetworkType
    • setKeepScreenOn %= фунт %> %= фунт %>%= фунт %>
    • startAccelerometer %= фунт %> %= фунт %>%= фунт %>
    • stopAccelerometer %= фунт %> %= фунт %>%= фунт %>
    • startCompass %= фунт %> %= фунт %>%= фунт %>
    • stopCompass %= фунт %> %= фунт %>%= фунт %>
    • startDeviceMotionListening %= фунт %> %= фунт %>
    • stopDeviceMotionListening %= фунт %> %= фунт %>
    • startGyroscope %= фунт %> %= фунт %>
    • stopGyroscope %= фунт %> %= фунт %>
    • vibrate %= фунт %>
    • vibrateShort
    • vibrateLong
    • watchShake %= фунт %>
    • setEnableDebug %= фунт %> %= фунт %>
    • getServerTime %= фунт %>
    • scan %= фунт %>

  • Bluetooth беспроводной

    • getBeacons %= фунт %> %= фунт %>
    • startBeaconDiscovery %= фунт %> %= фунт %>
    • stopBeaconDiscovery %= фунт %> %= фунт %>
    • startWifi %= фунт %>
    • stopWifi %= фунт %>
    • setWifiList %= фунт %>
    • getWifiList %= фунт %>
    • connectWifi %= фунт %>
    • getConnectedWifi %= фунт %>
    • getBLEDeviceServices %= фунт %> %= фунт %>
    • getBLEDeviceCharacteristics %= фунт %> %= фунт %>
    • createBLEConnection %= фунт %> %= фунт %>
    • closeBLEConnection %= фунт %> %= фунт %>
    • writeBLECharacteristicValue %= фунт %> %= фунт %>
    • readBLECharacteristicValue %= фунт %> %= фунт %>
    • notifyBLECharacteristicValueChange %= фунт %> %= фунт %>
    • startBluetoothDevicesDiscovery %= фунт %> %= фунт %>
    • stopBluetoothDevicesDiscovery %= фунт %> %= фунт %>
    • openBluetoothAdapter %= фунт %> %= фунт %>
    • getConnectedBluetoothDevices %= фунт %> %= фунт %>
    • getBluetoothDevices %= фунт %> %= фунт %>
    • getBluetoothAdapterState %= фунт %> %= фунт %>
    • closeBluetoothAdapter %= фунт %> %= фунт %>
    • stopHCE %= фунт %>
    • startHCE %= фунт %>
    • getHCEState %= фунт %>
    • sendHCEMessage %= фунт %>

  • Сторонняя платформа

    • getExtConfig %= фунт %> %= фунт %>

  • API глубокого уровня, обратите внимание: методы имеют префикс $

    • api.apмой
      • api.ap.$faceVerify
      • api.ap.$navigateToAlipayPage
      • ...
    • api.aiлебедь
      • api.ai.$ocrIdCard
      • api.ai.$ocrBankCard
      • ...

  • Какой-то новый экземпляр объекта над API

    • createMapContext %= фунт %> %= фунт %>%= фунт %>
    • createVideoContext %= фунт %> %= фунт %>
    • createAudioContext %= фунт %>
    • createCameraContext %= фунт %> %= фунт %>
    • createInnerAudioContext %= фунт %> %= фунт %>%= фунт %>
    • createLivePusherContext %= фунт %>
    • createLivePlayerContext %= фунт %>
    • getBackgroundAudioManager %= фунт %> %= фунт %>
    • getRecorderManager %= фунт %> %= фунт %>%= фунт %>
    • createSelectorQuery
    • getFileSystemManager %= фунт %>
    • createARCameraContext %= фунт %>

Например: Примечание. Метод имеет префикс $ 

 let ctx = api . createMapContext ( 'maper' )

ctx . $getCenterLocation ( ) . then ( ( res ) => {
  console . log ( 'createMapContext:getCenterLocation' )
  console . log ( res )
} )

Различия API между апплетами

1. Несогласованная передача параметров.

Например: метод showLoading , загруженная отображаемая копия, параметр title в WeChat и Baidu и параметр content в Alipay, как показано ниже. 

 // 微信
wx . showLoading ( {
  title : '加载中'
} )

// 百度
swan . showLoading ( {
  title : '加载中'
} )

// 支付宝
my . showLoading ( {
  content : '加载中'
} )

// 使用 mpapi 之后，多端兼容
api . showLoading ( '加载中' )
api . showLoading ( {
  title : '提示内容'
} )

2. Возвращаемые параметры несовместимы.

Например: метод showActionSheet после выполнения получает выбранный индекс. В WeChat и Baidu это res.tapIndex , в Alipay — res.index , как показано ниже. 

 // 微信
wx . showActionSheet ( {
  itemList : [ '台球' , '羽毛球' , '篮球' ] ,
  success : ( res ) => {
    // res.tapIndex
  }
} )

// 支付宝
my . showActionSheet ( {
  items : [ '台球' , '羽毛球' , '篮球' ] ,
  success : ( res ) => {
    // res.index
  }
} )

// 使用 mpapi，多端兼容
api . showActionSheet ( {
  itemList : [ '台球' , '羽毛球' , '篮球' ] ,
  success : ( res ) => {
    // res.tapIndex
  }
} )

3. Не поддерживается, но совместим

Например: у Alipay есть my.alert , но у WeChat и Baidu этого метода нет. Однако вы можете инкапсулировать метод alert через wx.showModal от WeChat или swan.showModal от Baidu, как показано ниже. 

 api . alert ( '提示内容' )

api . alert ( {
  content : '提示内容'
} )

// 请求数据，兼容多端
api . request ( { ... } ) . then ( ( res ) => { } )

4. Не поддерживается и несовместимо.

Некоторые API действительны только в определенных терминалах и не могут быть обработаны в режиме совместимости, например: 

 // 只在支付宝里面有效，微信和百度小程序里面会报错
api . startZMVerify ( { ... } )

// 建议这样处理
if ( api . isAlipay ) {
  api . startZMVerify ( { ... } )
}

// 只在微信里面有效，支付宝或百度小程序里面会报错
api . setTopBarText ( { ... } )

// 建议这样处理
if ( api . isWechat ) {
  api . setTopBarText ( { ... } )
}

// 百度智能小程序的特殊 API 一样的道理
if ( api . isSwan ) {
  api . getSwanId ( ) . then ( ( res ) => { } )
}

Инструкция по применению

1. Поддержка стиля Promise

Все API-интерфейсы мини-программ, если они включают обратные вызовы success , инкапсулированы с помощью Promise и могут использоваться напрямую, например, поддерживаются оба метода записи. 

 // 使用回调
api . showActionSheet ( {
  itemList : [ '台球' , '羽毛球' , '篮球' ] ,
  success : ( res ) => {
    // res.tapIndex
  }
} )

// 或者
api . showActionSheet ( {
  itemList : [ '台球' , '羽毛球' , '篮球' ]
} ) . then ( ( res ) => {
    // res.tapIndex
} )

// 其它
api . setStorage ( { ... } ) . then ( ( res ) => { } )
api . chooseImage ( { ... } ) . then ( ( res ) => { } )
. . .

2. Параметры, передаваемые и возвращаемые в совместимом методе , подлежат вызову апплета WeChat . Параметры, несовместимые с другими терминалами, не обрабатываются (некоторые параметры не могут быть обработаны и не поддерживаются конкретными мини-программами, на которые следует обратить внимание разработчикам, например). 

 api . chooseImage ( {
  count : 1 ,
  sizeType : [ 'original' , 'compressed' ] , // 只在微信可用
  sourceType : [ 'album' , 'camera' ] ,
} ) . then ( ( res ) => {
  // res.tempFilePaths 在微信和支付宝都可用
  // res.tempFiles 只在微信可用
} )

Обработка событий для специальных API

Некоторым API необходимо поддерживать Promise и вызывать его события, поэтому можно использовать следующие методы:

до: 

 const downloadTask = wx . downloadFile ( {
  url : 'https://example.com/audio/123' , // 仅为示例，并非真实的资源
  success ( res ) {
    console . log ( res )
  }
} )

downloadTask . onProgressUpdate ( ( res ) => {
  console . log ( res )
} )

downloadTask . abort ( ) // 取消下载任务

После использования mpapi : 

 const api = require ( 'mpapi' )

const downloadTask = api . downloadFile ( {
  url : 'https://example.com/audio/123' // 仅为示例，并非真实的资源
} ) . then ( ( res ) => {
  console . log ( 'success' )
  console . log ( res )
} )

downloadTask . $event ( 'onProgressUpdate' , ( res ) => {
  console . log ( res )
} )

// downloadTask.$event('abort') // 取消下载任务

Другие API могут обрабатываться аналогичным образом, например: request , uploadFile , connectSocket

Проблемы

Если вы обнаружите ошибки во время использования или у вас есть хорошие предложения, пожалуйста, сообщите о них.

Журнал изменений

Журнал изменений

Лицензия

Расширять
Дополнительная информация
Связанные приложения
Рекомендуем вам
Связанные новости Все