HarmonyOS NEXT 头像制作项目系列教程之 --- 静态库模块创建

项目源码地址

项目源码已发布到GitCode平台, 方便开发者进行下载和使用。
harmonyOSAvatar

项目效果演示

主页面效果如下：

侧边栏效果如下

简介

关于头像制作项目的布局相关内容，我们用了六个章节已经讲完了，接下来我们将创建一个库模块，用于存放我们的头像制作项目的相关数据。静态库模块可以帮助我们更好地组织代码，提高代码的复用性和可维护性。

什么是静态库模块？

静态库模块是一种特殊的模块类型，它不包含UI组件，只包含可复用的代码和数据。在鸿蒙应用开发中，静态库模块可以被其他模块引用，从而实现代码的共享和复用。通过将公共的数据类型、工具类和业务逻辑封装到静态库模块中，我们可以避免代码重复，提高开发效率。

创建库模块

首先，我们需要在项目中创建一个库模块，用于存放我们的头像制作项目的相关数据。

步骤一：创建静态库模块

1. 在项目目录中，右击目录
2. 选择New > Module
3. 选择Static Library 静态库模块，如下图所示

步骤二：配置模块信息

1. 点击Next按钮
2. 输入模块名称common（这个名称可以根据项目需求自定义）
3. Device type 选择 Default 即可
4. 点击Finish按钮创建完成，如下图所示

提示：模块名称应该能够清晰地表达该模块的用途，比如这里我们使用common表示这是一个通用的库模块。

目录文件结构

创建完成后，我们需要修改一下静态库的目录文件结构，使其更加符合我们的项目需求。

步骤一：清理默认文件

1. 删除MainPage.ets 文件（静态库不需要页面文件）
2. 在Index.ets文件中同步删除MainPage 的导出

步骤二：创建工具类文件夹

1. 创建我们的工具类文件夹 utils（右击模块目录 > New > Directory > 输入utils）
2. 在utils文件夹中创建头像数据、背景图数据以及侧边栏标题等所需的数据类型文件

完成后的目录结构如下图所示：

注意：良好的目录结构可以帮助我们更好地组织代码，提高代码的可读性和可维护性。

数据类型定义

在静态库模块中，我们需要定义一些数据类型，用于在不同模块之间共享数据。

步骤一：移动现有类

1. 将 btnContentClass 类移动到 utils 文件夹中

   • 可以创建一个新文件，如 ButtonContent.ets
   • 将原有的 btnContentClass 类代码复制到新文件中

步骤二：导出类

1. 在Index.ets 中导出 btnContentClass 类，使其可以被其他模块引用

export { btnContentClass } from './utils/dataSource';
 

使用静态库模块

创建完成静态库模块后，我们可以在其他模块中引用它。

在其他模块中引用静态库

1. 首先，需要在模块的oh-package.json5文件中添加对静态库的依赖

{
  "dependencies": {
      "common": "file:../common"
  }
}

2. 然后，在代码中导入静态库中的类或函数

// 在其他模块的代码中
import { btnContentClass } from 'common';

// 使用导入的类
const buttonContent = new btnContentClass(...);

提示：通过这种方式，我们可以在不同的模块中复用相同的数据类型和工具函数，避免代码重复。

小结

在本章中，我们学习了如何创建静态库模块，并将公共的数据类型和工具类封装到静态库中。通过这种方式，我们可以更好地组织代码，提高代码的复用性和可维护性。在接下来的章节中，我们将继续完善静态库模块，添加更多的数据类型和工具函数。