未验证 提交 8d1c4560 编写于 作者: 打打卡夫卡's avatar 打打卡夫卡 提交者: Gitee

update docs/plugin/uts-plugin.md.

Signed-off-by: 打打卡夫卡's avatar杜庆泉 <zmobs0@163.com>
上级 fc033589
...@@ -27,7 +27,7 @@ UTS语言编译到Android平台,会转为kotlin;编译到iOS平台,会转 ...@@ -27,7 +27,7 @@ UTS语言编译到Android平台,会转为kotlin;编译到iOS平台,会转
|开发语言|java/oc|uts| |开发语言|java/oc|uts|
|开发环境|Android studio/XCode|HBuilderX| |开发环境|Android studio/XCode|HBuilderX|
|打包方式|外挂aar 等产出物|编译时生成原生代码| |打包方式|外挂aar 等产出物|编译时生成原生代码|
|调用方式|uni.requireNativePlugin()|普通的js直接import| |调用方式|uni.requireNativePlugin()|普通的js函数/对象,可以直接使用|
uts插件的优势: uts插件的优势:
...@@ -88,59 +88,74 @@ package.json为插件的清单文件,这里集成了整个UTS插件的配置 ...@@ -88,59 +88,74 @@ package.json为插件的清单文件,这里集成了整个UTS插件的配置
插件目录下: 插件目录下:
index.d.ts文件是对当前插件能力的声明, index.d.ts文件是对当前插件能力的**声明**
index.uts文件是对当前插件能力的实现
针对一些通用的功能,可以用过index.uts实现即可。 index.uts文件是对当前插件能力的**实现**
但是类似获取电量等原生相关的场景,不同的平台有不同的代码实现,即使使用UTS也无法完全抹平。
针对一些通用的功能,可以用过插件根目录下 index.uts实现即可。
但是类似获取电量等原生强相关的场景,不同的平台有不同的语法和API差异。
因此我们设计了 app-android、app-ios 等目录,用以存放不同的平台的能力实现 因此我们设计了 app-android、app-ios 等目录,用以存放不同的平台的能力实现
``` ```
插件标识 插件标识
- utssdk - utssdk
+ app-android + app-android //Android平台目录
* index.uts * index.uts
* config.json * config.json
+ app-ios + app-ios //ios平台目录
* index.uts * index.uts
* config.json * config.json
+ web + web //web 平台目录
* index.uts
+ mp-weixin
* index.uts * index.uts
+ mp-xxx + mp-xxx // 其他平台,待实现
- common - common
- static - static
- package.json - package.json
- index.d.ts - index.d.ts // 插件能力声明
- index.uts - index.uts // 插件能力实现
``` ```
下面以app-android 平台为例,介绍具体平台实现的构成
app-android 文件夹下 index.uts 下面以 android 平台为例,介绍平台目录的使用。
app-android 文件夹下存在两个文件
|文件名|用途|
|index.uts|index.d.ts声明的能力在Android平台下的实现|
|config.json|Android平台下的配置文件|
config.json 存放是该插件能力android平台下实现的配置。
下面是一个实例 下面是一个config.json 实例,这里的格式与原有的 package.json保持一致的。[关于package.json的更多说明](https://uniapp.dcloud.net.cn/plugin/uni_modules.html#package-json)
```json ```json
{ {
// 依赖某些arr
"libs": [ "libs": [
"xxx.aar" "xxx.aar"
], ],
// 依赖某些gradle配置
"dependencies": [{ "dependencies": [{
"id": "com.xxx.richtext:richtext", "id": "com.xxx.richtext:richtext",
"source": "implementation 'com.xxx.richtext:richtext:3.0.7'" "source": "implementation 'com.xxx.richtext:richtext:3.0.7'"
}], }],
// Android系统版本要求,最低Android 5.0
"minSdkVersion": 21 "minSdkVersion": 21
}, },
``` ```
*注意:当同时存在平台目录的index.uts和 根目录index.uts时,会优先获取具体的平台目录*
## 3 开发UTS原生插件 ## 3 开发UTS原生插件
以android平台获取电量为例,介绍UTS原生插件开发步骤 以android平台获取电量为例,介绍UTS原生插件开发步骤
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册