Startseite>Programmierbezogen>AI-Quellcode
Herunterladen

mpapi

mpapi (miniProgram API), ein mit der Miniprogramm-API kompatibles Plug-in, das einmal geschrieben und auf mehreren Terminals ausgeführt werden kann.

⏰ Aktualisierungsdatum: 31.05.2019, die Funktionen des Miniprogramms werden ständig aktualisiert, die neue Version kann abweichen, bitte beachten Sie.

Das Problem, das dieses Projekt löst : Finden Sie die Unterschiede zwischen verschiedenen Miniprogramm-APIs und versuchen Sie , eine Reihe von APIs zu verwenden, um mit mehreren Miniprogrammen kompatibel zu sein .

Merkmale

  • Einmal schreiben, auf mehreren Terminals ausführen, Unterstützung: WeChat-Miniprogramm, Alipay-Miniprogramm, Baidu Smart-Miniprogramm, ByteDance-Miniprogramm
  • Unterstützt Promise (beinhaltet nur Erfolgsrückruf)
  • Optimiert für bestimmte API-Nutzung, wie zum Beispiel: api.showToast kann string direkt übergeben, api.setStorageSync muss nicht try catch 等aufrufen.
  • Unterstützen Sie die Ereignisverarbeitung spezieller APIs, z. B. request , downloadFile , „details“.
  • Unterstützt die Beurteilung an verschiedenen Enden, api.isWechat , api.isAlipay , api.isSwan , api.isTt

Installieren 

npm install mpapi --save

Nicht-npm-Installationsmethode. Führen Sie einfach mpapi.js im lib Verzeichnis direkt in das Projekt ein

verwenden 

 const api = require ( 'mpapi' )

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

Schnellansicht

  • Kompatible API-Liste
  • Andere APIs, gepackt als Promise
  • API-Unterschiede
  • Gebrauchsanweisung
  • Spezielle API-Ereignisverarbeitung, request , downloadFile , uploadFile usw.
  • Offizielle API-Dokumentation: WeChat-Miniprogramm, Alipay-Miniprogramm, Baidu Smart-Miniprogramm, ByteDance-Miniprogramm

Kompatible API-Liste

API, die von allen Miniprogrammen verwendet werden kann

  • Interaktion

    • alert
    • confirm
    • showToast
    • showLoading
    • showActionSheet

  • Navigationsleiste

    • setNavigationBarTitle
    • setNavigationBarColor

  • dokumentieren

    • saveFile
    • getFileInfo
    • getSavedFileInfo
    • getSavedFileList
    • removeSavedFile

  • Bild

    • chooseImage
    • previewImage
    • compressImage
    • saveImageToPhotosAlbum

  • fragen

    • request
    • uploadFile
    • downloadFile

  • Datencache

    • setStorageSync
    • getStorageSync
    • clearStorageSync
    • getStorageInfoSync
    • removeStorageSync

  • Systemausrüstung

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

Andere APIs, gepackt als Promise

Wird nur im Rahmen bestimmter Miniprogramme unterstützt

WeChat-Appletwx , Alipay-AppletMein , Intelligentes Baidu-AppletSchwan , ByteDance-Applettt Wenn ein Symbol vorhanden ist, bedeutet dies, dass nur das entsprechende Applet unterstützt wird. Wenn kein Symbol vorhanden ist, bedeutet dies, dass alle unterstützt werden.

  • Interaktion

    • hideToast
    • hideLoading
    • showModal%= lbl %> %= lbl %>%= lbl %>
    • prompt%= lbl %>

  • Cache

    • getStorage
    • setStorage
    • removeStorage
    • getStorageInfo

  • Routenführung

    • reLaunch
    • switchTab
    • redirectTo
    • navigateTo
    • navigateBack

  • Standort

    • getLocation
    • openLocation
    • chooseLocation%= lbl %> %= lbl %>%= lbl %>

  • Dateibild

    • saveImage%= lbl %>
    • getImageInfo
    • chooseVideo%= lbl %> %= lbl %>%= lbl %>
    • chooseMessageFile%= lbl %>
    • saveVideoToPhotosAlbum%= lbl %> %= lbl %>%= lbl %>
    • openDocument%= lbl %> %= lbl %>

  • Audio

    • stopVoice%= lbl %>
    • playVoice%= lbl %>
    • getAvailableAudioSources%= lbl %>
    • stopBackgroundAudio%= lbl %>
    • playBackgroundAudio%= lbl %>
    • seekBackgroundAudio%= lbl %>
    • pauseBackgroundAudio%= lbl %>
    • getBackgroundAudioPlayerState%= lbl %>
    • setInnerAudioOption%= lbl %> %= lbl %>
    • startRecord%= lbl %>
    • stopRecord%= lbl %>
    • stopRecord%= lbl %>

  • Navigationsleiste

    • getTitleColor%= lbl %>
    • setNavigationBar%= lbl %>
    • showNavigationBarLoading%= lbl %> %= lbl %>%= lbl %>
    • hideNavigationBarLoading%= lbl %> %= lbl %>%= lbl %>

  • Hintergrund

    • setBackgroundTextStyle%= lbl %> %= lbl %>%= lbl %>
    • setBackgroundColor%= lbl %> %= lbl %>%= lbl %>
    • showTabBar%= lbl %> %= lbl %>%= lbl %>
    • hideTabBar%= lbl %> %= lbl %>%= lbl %>
    • setTabBarItem%= lbl %> %= lbl %>%= lbl %>
    • setTabBarStyle%= lbl %> %= lbl %>%= lbl %>
    • showTabBarRedDot%= lbl %> %= lbl %>%= lbl %>
    • hideTabBarRedDot%= lbl %> %= lbl %>%= lbl %>
    • setTabBarBadge%= lbl %> %= lbl %>%= lbl %>
    • removeTabBarBadge%= lbl %> %= lbl %>%= lbl %>

  • Zum Aktualisieren nach unten ziehen

    • startPullDownRefresh
    • stopPullDownRefresh

  • scrollen

    • pageScrollTo
    • sendSocketMessage%= lbl %> %= lbl %>%= lbl %>
    • connectSocket
    • closeSocket%= lbl %> %= lbl %>%= lbl %>
    • startLocalServiceDiscovery%= lbl %>
    • stopLocalServiceDiscovery%= lbl %>

  • Nach oben stecken

    • setTopBarText%= lbl %>

  • Leinwand

    • canvasGetImageData%= lbl %> %= lbl %>%= lbl %>
    • canvasPutImageData%= lbl %> %= lbl %>%= lbl %>
    • canvasToTempFilePath%= lbl %> %= lbl %>%= lbl %>

  • Teilen und weiterleiten

    • getShareInfo%= lbl %>
    • updateShareMenu%= lbl %>
    • showShareMenu%= lbl %> %= lbl %>
    • hideShareMenu%= lbl %> %= lbl %>%= lbl %>
    • showFavoriteGuide%= lbl %>
    • openShare%= lbl %>

  • Login, Autorisierung, Benutzerinformationen

    • login%= lbl %> %= lbl %>%= lbl %>
    • checkSession%= lbl %> %= lbl %>%= lbl %>
    • getUserInfo%= lbl %> %= lbl %>%= lbl %>
    • getAuthCode%= lbl %>
    • getAuthUserInfo%= lbl %>
    • getPhoneNumber%= lbl %>
    • authorize%= lbl %> %= lbl %>

  • zahlen

    • tradePay%= lbl %>
    • requestPayment%= lbl %> %= lbl %>
    • requestPolymerPayment%= lbl %>

  • offene Schnittstelle

    • getSetting
    • openSetting
    • reportAnalytics
    • chooseInvoiceTitle%= lbl %> %= lbl %>
    • navigateToMiniProgram%= lbl %> %= lbl %>
    • navigateBackMiniProgram%= lbl %> %= lbl %>

  • Offene Schnittstelle – WeChat-Applet

    • addCard%= lbl %>
    • openCard%= lbl %>
    • chooseInvoice%= lbl %>
    • startSoterAuthentication%= lbl %>
    • checkIsSoterEnrolledInDevice%= lbl %>
    • checkIsSupportSoterAuthentication%= lbl %>
    • getWeRunData%= lbl %>

  • Offene Schnittstelle – Alipay-Applet

    • startZMVerify%= lbl %>
    • textRiskIdentification%= lbl %>
    • addCardAuth%= lbl %>
    • getRunScene%= lbl %>
    • chooseCity%= lbl %>
    • datePicker%= lbl %>
    • optionsSelect%= lbl %>
    • multiLevelSelect%= lbl %>
    • rsa%= lbl %>

  • Offene Schnittstelle – Baidu Smart Applet

    • getSwanId%= lbl %>
    • navigateToSmartProgram%= lbl %>
    • navigateBackSmartProgram%= lbl %>
    • setPageInfo%= lbl %>
    • setMetaDescription%= lbl %>
    • setMetaKeywords%= lbl %>
    • setDocumentTitle%= lbl %>
    • loadSubPackage%= lbl %>

  • Ansprechpartner

    • chooseAddress%= lbl %> %= lbl %>%= lbl %>
    • chooseContact%= lbl %>
    • choosePhoneContact%= lbl %>
    • chooseAlipayContact%= lbl %>
    • addPhoneContact%= lbl %> %= lbl %>%= lbl %>

  • Laden der Schriftart

    • loadFontFace%= lbl %> %= lbl %>

  • Systeminformationen

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

  • Bluetooth drahtlos

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

  • Plattform eines Drittanbieters

    • getExtConfig%= lbl %> %= lbl %>

  • Deep-Level-API, Hinweis: Den Methoden wird $ vorangestellt

    • api.apMein
      • api.ap.$faceVerify
      • api.ap.$navigateToAlipayPage
      • ...
    • api.aiSchwan
      • api.ai.$ocrIdCard
      • api.ai.$ocrBankCard
      • ...

  • Eine neue Instanz des Objekts über der API

    • createMapContext%= lbl %> %= lbl %>%= lbl %>
    • createVideoContext%= lbl %> %= lbl %>
    • createAudioContext%= lbl %>
    • createCameraContext%= lbl %> %= lbl %>
    • createInnerAudioContext%= lbl %> %= lbl %>%= lbl %>
    • createLivePusherContext%= lbl %>
    • createLivePlayerContext%= lbl %>
    • getBackgroundAudioManager%= lbl %> %= lbl %>
    • getRecorderManager%= lbl %> %= lbl %>%= lbl %>
    • createSelectorQuery
    • getFileSystemManager%= lbl %>
    • createARCameraContext%= lbl %>

Beispiel: Hinweis: Der Methode wird $ vorangestellt 

 let ctx = api . createMapContext ( 'maper' )

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

API-Unterschiede zwischen Applets

1. Inkonsistente Parameterübertragung

Beispiel: showLoading -Methode, geladene Anzeigekopie, title in WeChat und Baidu und content in Alipay wie folgt 

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

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

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

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

2. Rückgabeparameter sind inkonsistent

Beispiel: showActionSheet -Methode: Rufen Sie nach der Ausführung den ausgewählten Index ab. In WeChat und Baidu ist es res.tapIndex , in Alipay ist es res.index , wie folgt 

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

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

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

3. Nicht unterstützt, aber kompatibel

Beispiel: Alipay verfügt über my.alert , WeChat und Baidu jedoch nicht über diese Methode. Sie können jedoch eine alert über wx.showModal von WeChat oder swan.showModal von Baidu kapseln 

 api . alert ( '提示内容' )

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

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

4. Nicht unterstützt und inkompatibel

Einige APIs sind nur in bestimmten Terminals gültig und können nicht kompatibel verarbeitet werden, wie folgt: 

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

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

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

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

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

Gebrauchsanweisung

1. Unterstützen Sie Promise -Stil

Alle Miniprogramm-APIs, sofern sie success enthalten, wurden mit Promise gekapselt und können beispielsweise direkt verwendet werden. Beide Schreibmethoden werden unterstützt 

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

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

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

2. Die in der kompatiblen Methode übergebenen und zurückgegebenen Parameter unterliegen dem WeChat-Applet-Aufruf . Parameter, die mit anderen Terminals nicht kompatibel sind, werden nicht verarbeitet (einige Parameter können nicht verarbeitet werden und werden von bestimmten Miniprogrammen nicht unterstützt, z. B.). 

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

Ereignisbehandlung für spezielle APIs

Einige APIs müssen Promise unterstützen und seine Ereignisse aufrufen, daher können die folgenden Methoden verwendet werden:

vor: 

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

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

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

Nach der Verwendung 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') // 取消下载任务

Andere APIs können ähnlich gehandhabt werden, wie zum Beispiel: request , uploadFile , connectSocket

Probleme

Wenn Sie während der Nutzung Fehler finden oder gute Vorschläge haben, können Sie diese gerne melden.

Änderungsprotokoll

Änderungsprotokoll

Lizenz

Expandieren
Zusätzliche Informationen
Ähnliche Anwendungen
Empfohlen für Sie
Ähnliche Nachrichten Alle