文档首页 > > 开发指南> 产品开发> 开发编解码插件> 线下开发指导> 编解码插件打包

编解码插件打包

更新时间:2019/06/25 GMT+08:00

本节介绍编解码完成后如何打包和制作插件包。

编解码Maven打包

完成插件编程后使用Maven进行打包,Windows中步骤如下:

  1. 打开DOS窗口,进入“pom.xml”所在的目录。
  2. 输入maven打包命令:mvn package。
  3. DOS窗口中显示“BUILD SUCCESS”后,打开与“pom.xml”目录同级的target文件夹,获取打包好的jar包。

    jar包命名规范为:设备类型-厂商ID-设备型号-版本.jar,例如:WaterMeter-Huawei-NBIoTDevice-version.jar。

    图1 Jar包结构图
    • com目录存放的是class文件。
    • META-INF下存放的是OSGI框架下的jar的描述文件(根据pom.xml配置生成的)。
    • OSGI-INF下存放的是服务配置文件,把编解码注册为服务,供平台调用(只能有一个xml文件)。
    • 其他jar是编解码引用到的jar包。

制作插件包

  1. 新建文件夹命名为“package”,包含一个“preload/”子文件夹。
  2. 将打包好的jar包放到“preload/”文件夹。

    图2 插件包结构图

  3. “package”文件夹中,新建“package-info.json”文件。该文件的字段说明和模板如下:

    说明:

    “package-info.json”需要以UTF-8无BOM格式编码。仅支持英文字符。

    表1 “package-info.json”字段说明

    字段名

    字段描述

    是否必填

    specVersion

    描述文件版本号,填写固定值:"1.0"。

    fileName

    软件包文件名,填写固定值:"codec-demo"

    version

    软件包版本号。描述package.zip的版本,请与下面的bundleVersion取值保持一致。

    deviceType

    设备类型,与Profile文件中的定义保持一致。

    manufacturerName

    制造商名称,与Profile文件中的定义保持一致,否则无法上传到平台。

    model

    产品型号,与Profile文件中的定义保持一致。

    platform

    平台类型,本插件包运行的IoT平台的操作系统,填写固定值:"linux"。

    packageType

    软件包类型,该字段用来描述本插件最终部署的平台模块,填写固定值:"CIGPlugin"。

    date

    出包时间,格式为:"yyyy-MM-dd HH-mm-ss",如"2017-05-06 20:48:59"。

    description

    对软件包的自定义描述。

    ignoreList

    忽略列表,默认为空值。

    bundles

    一组bundle的描述信息。

    说明:

    bundle就是压缩包中的jar包,只需要写一个bundle。

    表2 bundles的字段说明

    字段名

    字段描述

    是否必填

    bundleName

    插件名称,和上文中pom.xml的Bundle-SymbolicName保持一致。

    bundleVersion

    插件版本,与上面的version取值保持一致。

    priority

    插件优先级,可赋值默认值:5。

    fileName

    插件jar的文件名称。

    bundleDesc

    插件描述,用来介绍bundle功能。

    versionDesc

    插件版本描述,用来介绍版本更迭时的功能特性。

    package-info.json文件模板:

    {
        "specVersion":"1.0",
        "fileName":"codec-demo",
        "version":"1.0.0",
        "deviceType":"WaterMeter",
        "manufacturerName":"Huawei",
        "model":"NBIoTDevice",
        "description":"codec",
        "platform":"linux",
        "packageType":"CIGPlugin",
        "date":"2017-02-06 12:16:59",
        "ignoreList":[],
        "bundles":[
        {
            "bundleName": "WaterMeter-Huawei-NBIoTDevice",
            "bundleVersion": "1.0.0",
            "priority":5,
            "fileName": "WaterMeter-Huawei-NBIoTDevice-1.0.0.jar",
            "bundleDesc":"",
            "versionDesc":""
        }]
    }

  4. 选中“package”文件夹中的全部文件,打包成zip格式(“package.zip”)。

    说明:

    “package.zip”中不能包含“package”这层目录。

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

在文档使用中是否遇到以下问题







请至少选择或填写一项反馈信息

字符长度不能超过200

反馈内容不能为空!

提交反馈 取消