更新记录

1.1.16（2023-09-28） 下载此版本

• 注释临时代码

1.1.15（2023-09-28） 下载此版本

• quick添加方法：chooseLocation：打开地图选择位置

1.1.14（2023-09-26） 下载此版本

• 修改坐标系转换的bug

平台兼容性

hf-middleware

中间件

app使用不同底座，使用不同底座提供的底层方法，通过中间件，统一参数、返回数据格式、调用方式

API

• 快应

• 自研

• uniapp

使用

配置

main.js

import './plugin/middleware.js'

plugin/middleware

import configService from '@/envCfg.js';

import { setConfig } from '@/uni_modules/hf-middleware';

setConfig({
    usedApi: configService.usedApi,
    usedConfig: configService.usedConfig,
    coordinateSystem: configService.coordinateSystem
});

envCfg.js

import { QUICK_API } from '@/uni_modules/hf-middleware';
export default {
    // 中间件
    usedApi: QUICK_API,    // 使用的 API
    usedConfig: {
        protocol: 'kysk-fzsy-app://',    // app自定义协议
        path: 'native',
    },
    coordinateSystem: 'wgs84'   // 中间件返回的经纬度坐标系
}

基本用法

<view>
    <u-gap></u-gap>
    <view class="btns">
        <view class="btn">
            <u-button @click="chooseImage">chooseImage</u-button>
        </view>
        <view class="btn">
            <u-button @click="chooseFile">chooseFile</u-button>
        </view>
        <view class="btn">
            <u-button @click="chooseVideo">chooseVideo</u-button>
        </view>
        <view class="btn">
            <u-button @click="getLocation">getLocation</u-button>
        </view>
    </view>
    <u-gap></u-gap>
    <view class="block">
        <u-text :text="usedApi"></u-text>
    </view>
    <u-gap></u-gap>
    <view class="block">
        <image v-for="(item, index) in path" :key="index" :src="item" mode="aspectFit"></image>
    </view>
    <u-gap></u-gap>
    <view class="block">
        <video v-for="(item, index) in video" :key="index" :src="item"></video>
    </view>
    <u-gap></u-gap>
    <view class="block" @click="handleClick">
        <text class="pre">{{ result }}</text>
    </view>
</view>

import { usedApi, chooseImage, chooseFile, chooseVideo, getLocation } from '@/uni_modules/hf-middleware';
export default {
    data() {
        return {
            usedApi,
            result: {},
            path: [],
            video: []
        };
    },
    methods: {
        async chooseImage() {
            const res = await chooseImage();
            this.result = res;
            this.path = res.map(item => (item.path));
        },
        async chooseFile() {
            const res = await chooseFile();
            this.result = res;
            this.video = res.map(item => (item.path));
        },
        async chooseVideo() {
            const res = await chooseVideo();
            this.result = res;
            this.video = res.map(item => (item.path));
        },
        async getLocation() {
            const res = await getLocation();
            this.result = res;
        },
        handleClick() {
            uni.setClipboardData({
                data: JSON.stringify(this.result),
                success: function () {
                    uni.showToast({ title: '已复制' });
                }
            });
        }
    }
}

API

都是promise的处理，成功走.then，失败走.catch

媒体

chooseImage(OBJECT)

从本地相册选择图片或使用相机拍照

平台差异说明

OBJECT 参数说明

返回参数说明

Array 选择的图片列表

示例

chooseImage({ count: 2 }).then((res) => {
    console.log(res);
    // [{path: 'blob:http://localhost:8080/xxx.jpg', name: 'xxx.jpg', size: '123456', type: 'image/jpeg'}];
});

chooseVideo(OBJECT)

拍摄视频或从手机相册中选视频，返回视频的临时文件路径。

平台差异说明

OBJECT 参数说明

返回参数说明

Array 选择的视频列表

示例

chooseVideo().then((res) => {
    console.log(res);
    // [{path: 'blob:http://localhost:8080/xxx.mp4', name: 'xxx.mp4', size: '123456', type: 'video/mp4'}]; 
});

chooseMedia(OBJECT)

选择图片或视频

平台差异说明

返回参数说明

Array 选择的视频列表

示例

chooseMedia().then((res) => {
    console.log(res);
    // [{path: 'blob:http://localhost:8080/xxx.mp4', name: 'xxx.mp4', size: '123456', type: 'video/mp4'}]; 
});

chooseFile(OBJECT)

选择文件

平台差异说明

OBJECT 参数说明

返回参数说明

Array 选择的文件列表

示例

chooseFile({ count: 1 }).then((res) => {
    console.log(res);
    // [{path: 'blob:http://localhost:8080/xxx.mp4', name: 'xxx.mp4', size: '123456', type: 'video/mp4'}]; 
});

getRecord()

录音

平台差异说明

返回参数说明

Array 录音列表（其实只有一项 和其他统一一致...）

示例

<u-button @click="getRecord">录音</u-button>
<audio
       :src="audit.src"
       :name="audit.name"
       author="xxx"
       controls
></audio>

import { getRecord } from '@/uni_modules/hf-middleware';
export default {
    data() {
        return {
            audit: {
                src: '',
                name: ''
            }
        }
    },
    methods: {
        async getRecord() {
            const res = await getRecord();
            console.log('--- 录音 --->', res);
            // [{path: 'blob:http://localhost:8080/xxx.mp3', name: '6月30日 17点40分.mp3', size: '79848', type: 'audit/mpeg'}]; 
            this.audit.src = res[0].path;
            this.audit.name = res[0].name;
        },
    }
}

位置

注意：H5 端 使用地图和定位相关，需要在 manifest.json 内配置腾讯或谷歌等三方地图服务商申请的秘钥（key）

getLocation(OBJECT)

获取当前的地理位置

平台差异说明

OBJECT 参数说明

返回参数说明

示例

getLocation().then((res) => {
    console.log(res);
    // {latitude: 57.123456, longitude:123.123456, address: 'xxx'}
});

chooseLocation(OBJECT)

打开地图选择位置

平台差异说明

OBJECT 参数说明

返回参数说明

示例

chooseLocation({ latitude: 57.123456, longitude:123.123456 }).then((res) => {
    console.log(res);
    // {latitude: 57.123456, longitude:123.123456, address: 'xxx'}
});

设备

makePhoneCall(phoneNumber)

拨打电话

平台差异说明

参数说明

示例

makePhoneCall('13912341234');

anyRtc(OBJECT)

视频、语音

平台差异说明

OBJECT 参数说明

示例

anyRtc({userId: 'xxx', type: 1});

scanCode

调起客户端扫码界面，扫码成功后返回对应的结果

平台差异说明

OBJECT 参数说明

说明：仅uni有参数，参数同uni.scanCode

返回参数说明

说明：返回参数同uni.scanCode（除uni的其他API，返回参数仅有result）

示例

scanCode().then((res) => {
    console.log(res);    // { result: 'xxx' }
})

getSystemInfo()

获取系统信息

平台差异说明

示例

getSystemInfo().then(res => {
    console.log(res);    // { statusBarHeight: 25 }
});

getVersion()

获取版本号

平台差异

示例

getVersion().then(res => {
    console.log(res);    // { versionCode: xx, versionName: xx }
});

softInputMode(OBJECT)

布局静默

平台差异说明

OBJECT 参数说明

示例

softInputMode({ type: 1 });

openDocument

打开文档

平台差异说明

OBJECT 参数说明

示例

openDocument({ path: 'http://xxx/xxx.pdf' }).then(() => {
    console.log('--- 文件预览成功 --->');
});

第三方服务

logout()

退出登录

平台差异说明

示例

logout();    // 底座回到登录页

getUserInfo()

获取用户信息

平台差异说明

示例

getUserInfo().then((res) => {
    console.log(res);
    // {...}
});

getIdCardOcr(OBJECT)

证件OCR正/反面

平台差异说明

OBJECT 参数说明

返回参数说明

ocrType为1

ocrType为2

示例

getIdCardOcr({ ocrType: 1 }).then((res) => {
    console.log(res);
    // { name: '姓名', sex: '男', nation: '汉族', birthday: '1997-10-19', address: 'xx省xx市xx镇xx村xx号', idcard: '123456123412121234' }
});
getIdCardOcr({ ocrType: 2 }).then((res) => {
    console.log(res);
    // { expirationDate: '2025-05-07' }
});

getToken

获取token

平台差异说明

示例

getToken().then((token) => {
    console.log(token);    // 'xxxx'
})

refreshToken

刷新token

平台差异说明

示例

refreshToken().then((token) => {
    console.log(token);    // 'xxxx'
})

目录说明

• api：各平台api，导出统一参数、返回格式、调用方式的方法
  • quick.js：快应
  • self.js：自研
  • uni.js：uniapp
• utils：一些工具方法
  • image-conversion：图片转换的第三方库文件
  • index.js：工具方法
• config.js：配置文件
• index.js：入口文件