完整教程:【鸿蒙生态共建】一文讲清发布共享库至openharmony三方库中心仓时Module的配置-《精通HarmonyOS NEXT :鸿蒙App开发入门与项目化实战》读者福利

在前面的内容中,介绍了如何注册到发布共享库至openharmony三方库中心仓(Module化及复用)。其中Module在上传至三方库中心仓前,需要对其进行配置,以方便审核及用户运用时,知晓所发布的共享库信息。

本篇内容是《精通HarmonyOS NEXT :鸿蒙App编写入门与项目化实战》这本书第14章内容的延续,是咱这本书读者的福利,内容Module化及复用为主体,详细介绍Module的部署。

先打个广告,对本书感兴趣的同学可以点击以下链接进行购买,或者了解我的班级参加 班级共同学习,点击链接可进入(华为官方活动)

​​

往期福利:

  1. 【页面路由导航】三步构建页面跳转的完整示例-《精通HarmonyOS NEXT :鸿蒙App开发入门与项目化实战》读者福利
  2. 【鸿蒙生态共建】一文10个示例讲懂鸿蒙系统ArkTS中的null与undefined的区别与应用-《精通HarmonyOS NEXT :鸿蒙App开发入门与项目化实战》读者福利
  3. 【鸿蒙生态共建】一文两表三实例讲清async函数与普通函数的区别-《精通HarmonyOS NEXT :鸿蒙App开发入门与项目化实战》读者福利
  4. 【鸿蒙生态共建】一文说清基础类型数据的非预期输入转换与兜底-《精通HarmonyOS NEXT :鸿蒙App开发入门与项目化实战》读者福利
  5. 【鸿蒙生态共建】一文说明兼容版本、目标版本和编译版本的区别与应用实践-《精通HarmonyOS NEXT :鸿蒙App开发入门与方案化实战》读者福利
  6. 【鸿蒙生态共建】一文说清复杂类型数据的非预期输入转换与兜底-《精通HarmonyOS NEXT :鸿蒙App开发入门与项目化实战》读者福利
  7. 【鸿蒙生态共建】鸿蒙6适配-API变化与兼容(1.基础能力篇)-《精通HarmonyOS NEXT :鸿蒙App研发入门与计划化实战》读者福利
  8. 【鸿蒙生态共建】一文讲清如何完成对开发版及发布版分别单独配置签名证书-《精通HarmonyOS NEXT :鸿蒙App开发入门与任务化实战》读者福利
  9. 【鸿蒙生态共建】鸿蒙6适配-API变化与兼容(2.UI交互与基础能力篇)--《精通HarmonyOS NEXT :鸿蒙App开发入门与项目化实战》读者福利
  10. 【鸿蒙生态共建】鸿蒙6适配-API变更与兼容(3.UI交互能力篇)-《精通HarmonyOS NEXT :鸿蒙App开发入门与任务化实战》读者福利
  11. 【鸿蒙生态共建】一文讲清从注册到发布共享库至openharmony三方库中心仓(Module化及复用)-《精通HarmonyOS NEXT :鸿蒙App编写入门与项目化实战》读者福利

1. oh-package.json5的设置

oh-package.json5资料是Module创建时默认创建的记录,在Module的根目录中。

大家将Module打包发布到 OpenHarmony 三方库中心仓,必须在Module中包含 oh-package.json5 文件,模块级oh-package.json5文件位于工程各个模块的根目录下,用来描述当前模块被其他模块依赖时的相关信息,包括:作为依赖时的依赖名(name)、作为依赖时的版本号(version)、入口文件(main/types)和子依赖项等信息。当创建一个static library模块的时候会自动生成该文档,需要对配置项进行完善。更多详细说明:

https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/ide-oh-package-json5#zh-cn_topic_0000001792256137_oh-packagejson5-字段说明

下图为mdkit的oh-package.json5文件配置

下面为配置项的说明
{
  "name": "mdkit",        // 名称
  "version": "0.0.8",     // 版本号
  "description": "毛豆工具集、提供基础的、常用的能力",  // 描述信息,大于6小于512,否则会在提交时报错。
  "main": "Index.ets",    // 指定加载的入口文件
  "keywords": ["工具"],    // 关键字信息数组,便于搜索使用
  "author": {"name": 'xxx',"email": "xxx"}, // 包含 name 字段(必选)、 email 字段(可选)、url字段(可选),可通过格式对象或字符串格式配置。
  "license": "Apache-2.0",  // 当前项目的开源许可证。
}

2. README.md的配置

readme.md文件在Module创建时,没有创建,需要研发人员自行创建,在Module的根目录中。

该文件中的内容主要用于介绍Module是什么,如何使用。基于md语法书写。

常见于包含简介、安装、示例、限制、结果等主要信息。mdkit的配置如下:

同时该文件的信息也会在三方中心仓中公开如下图所示。

3. CHANGELOG.md的配置

CHANGELOG.md文件在Module创建时,没有创建,需要研发人员自行创建,在Module的根目录中。

该文件中的内容主要用于介绍Module的变更记录,重要的版本升级等。基于md语法书写。mdkit的配置如下:

写的过于简单,初版也是为了学习如何发布,实际发布时,许可带的信息很多,如功能的介绍、研发人员信息、时间信息、接口变动等等

同时该文件的信息也会在三方中心仓中公开如下图所示。

4. LICENSE的配置

LICENSE的配置,具有法律效应,研发人员根据实际需要,选择合适的开源协议,这里就不作过多的介绍。

总结:

本文是《精通HarmonyOSNEXT:鸿蒙App开发入门与项目化实战》的读者福利内容,重点介绍如何部署Module以发布到OpenHarmony三方库中心仓。文章详细说明了四个关键配置文件的设置:1) oh-package.json5资料(包括模块名称、版本、入口文件等基本信息);2) README.md文件(模块功能和使用说明);3) CHANGELOG.md文件(版本变更记录);4) LICENSE文件(开源协议选择)。这些配备是共享库发布前的必要步骤,将直接影响模块的审核和利用体验。

打个广告,对本书感兴趣的同学可以点击以下链接进行购买,或者了解我的班级参加 班级共同学习,点击链接可进入(华为官方活动)

​​

往期福利:

  1. 【页面路由导航】三步搭建页面跳转的完整示例-《精通HarmonyOS NEXT :鸿蒙App开发入门与项目化实战》读者福利
  2. 【鸿蒙生态共建】一文10个示例讲懂鸿蒙系统ArkTS中的null与undefined的区别与应用-《精通HarmonyOS NEXT :鸿蒙App开发入门与工程化实战》读者福利
  3. 【鸿蒙生态共建】一文两表三实例讲清async函数与普通函数的区别-《精通HarmonyOS NEXT :鸿蒙App创建入门与项目化实战》读者福利
  4. 【鸿蒙生态共建】一文说清基础类型素材的非预期输入转换与兜底-《精通HarmonyOS NEXT :鸿蒙App开发入门与项目化实战》读者福利
  5. 【鸿蒙生态共建】一文说明兼容版本、目标版本和编译版本的区别与应用实践-《精通HarmonyOS NEXT :鸿蒙App开发入门与计划化实战》读者福利
  6. 【鸿蒙生态共建】一文说清艰难类型内容的非预期输入转换与兜底-《精通HarmonyOS NEXT :鸿蒙App开发入门与项目化实战》读者福利
  7. 【鸿蒙生态共建】鸿蒙6适配-API变化与兼容(1.基础能力篇)-《精通HarmonyOS NEXT :鸿蒙App开发入门与项目化实战》读者福利
  8. 【鸿蒙生态共建】一文讲清如何实现对开发版及发布版分别单独配置签名证书-《精通HarmonyOS NEXT :鸿蒙App开发入门与项目化实战》读者福利
  9. 【鸿蒙生态共建】鸿蒙6适配-API变化与兼容(2.UI交互与基础能力篇)--《精通HarmonyOS NEXT :鸿蒙App制作入门与方案化实战》读者福利

posted @ 2025-11-24 12:47  gccbuaa  阅读(8)  评论(0)    收藏  举报