## 场景介绍

自定义字体是指开发者根据应用需求创建或选择的字体，通常用于实现特定的文字风格或满足独特的设计要求。当应用需要使用特定的文本样式和字符集时，可以注册并使用自定义字体进行文本渲染。

## 实现流程

**自定义字体的注册**是指将字体文件（如ttf、otf文件等）从应用资源注册到系统中，使得应用能够使用这些字体进行文本渲染。注册过程通常指将字体文件通过字体管理接口注册到系统字体库中，以便在应用中进行调用。

**自定义字体的使用**是指在应用中显式指定使用已注册的自定义字体进行文本绘制。开发者可以根据需要选择特定的文本样式（如常规、粗体、斜体等），并将其应用到UI元素、文本控件或其他文本展示区域，以确保符合设计要求并提供一致的视觉效果。

## 接口说明

注册使用自定义字体的相关接口如下所示，详细接口说明请参考[Drawing](https://developer.huawei.com/consumer/cn/doc/harmonyos-references/capi-drawing)。

展开

| 接口名 | 描述 |
| --- | --- |
| OH\_Drawing\_CreateSharedFontCollection (void) | 创建可共享的字体集对象OH\_Drawing\_FontCollection。 |
| OH\_Drawing\_RegisterFont (OH\_Drawing\_FontCollection\* , const char\* fontFamily, const char\* familySrc ) | 用于在字体管理器中注册自定义字体，支持的字体文件格式包含：ttf、otf。 |
| OH\_Drawing\_CreateTextStyle(void) | 创建指向OH\_Drawing\_TextStyle对象的指针，用于设置文本样式。 |
| OH\_Drawing\_SetTextStyleFontFamilies (OH\_Drawing\_TextStyle \*, int, const char \*fontFamilies[]) | 设置字体类型。 |
| OH\_Drawing\_UnregisterFont (OH\_Drawing\_FontCollection\* , const char\* fontFamily) | 通过字体家族名称取消注册自定义字体。 |

## 开发步骤

1. 在工程的src/main/cpp/CMakeLists.txt文件中添加以下lib。

   收起

   自动换行

   深色代码主题

   复制

   ```
   1. libnative_drawing.so
   ```
2. 导入依赖的相关头文件。

   收起

   自动换行

   深色代码主题

   复制

   ```
   1. #include <native_drawing/drawing_font_collection.h>
   2. #include <native_drawing/drawing_text_typography.h>
   3. #include <native_drawing/drawing_register_font.h>
   ```
3. 创建字体管理器，建议优先使用OH\_Drawing\_CreateSharedFontCollection()创建可共享的字体集对象。

   说明

   使用OH\_Drawing\_CreateFontCollection()和OH\_Drawing\_CreateSharedFontCollection()均可创建字体管理器OH\_Drawing\_FontCollection对象，但前者创建的字体集指针对象只能被一个段落生成器OH\_Drawing\_TypographyCreate对象使用，无法被多个段落生成器OH\_Drawing\_TypographyCreate对象共享使用。如需在多个段落生成器OH\_Drawing\_TypographyCreate对象间共享使用，请使用后者创建可共享的字体集对象。

   收起

   自动换行

   深色代码主题

   复制

   ```
   1. OH_Drawing_FontCollection *fontCollection = OH_Drawing_CreateSharedFontCollection();
   ```
4. 设置自定义字体的字体家族名和字体文件所在的沙箱路径。

   说明

   确保需注册的可用自定义字体文件已正确放置在应用设备的/system/fonts/NotoSerifTamil[wdth,wght].ttf路径下。

   收起

   自动换行

   深色代码主题

   复制

   ```
   1. // 后续使用自定义字体时，需使用到该字体家族名
   2. const char* fontFamily = "myFamilyName";
   3. // 该路径是待注册的自定义字体文件在应用设备下的路径，确保该自定义字体文件已正确放置在该路径下
   4. const char* fontPath = "/system/fonts/NotoSerifTamil[wdth,wght].ttf";
   ```
5. 在字体管理器中使用OH\_Drawing\_RegisterFont()注册自定义字体。

   可通过接口返回结果，查看具体情况，确认注册成功与否。

   OH\_Drawing\_RegisterFont接口返回结果的几种情况及含义如下所示：

   0表示注册成功，1表示文件不存在，2表示打开文件失败，3表示读取文件失败，4表示寻找文件失败，5表示获取大小失败，9表示文件损坏。

   收起

   自动换行

   深色代码主题

   复制

   ```
   1. // 返回0为成功，1为文件不存在，2为打开文件失败，3为读取文件失败，4为寻找文件失败，5为获取大小失败，9文件损坏
   2. int errorCode = OH_Drawing_RegisterFont(fontCollection, fontFamily, fontPath);
   ```
6. 确保自定义字体注册成功后，使用OH\_Drawing\_CreateTextStyle()接口创建文本样式对象，并使用OH\_Drawing\_SetTextStyleFontFamilies()接口加入自定义字体。

   收起

   自动换行

   深色代码主题

   复制

   ```
   1. // 如果已经注册成功自定义字体，填入自定义字体的字体家族名
   2. const char* myFontFamilies[] = {"myFamilyName"};
   3. // 加入可使用的自定义字体
   4. OH_Drawing_SetTextStyleFontFamilies(textStyle, 1, myFontFamilies);
   ```
7. 生成最终段落文本，使用自定义字体，以便实现最终的文本绘制和显示。

   收起

   自动换行

   深色代码主题

   复制

   ```
   1. // 设置其他文本样式
   2. OH_Drawing_SetTextStyleColor(textStyle , OH_Drawing_ColorSetArgb(0xFF, 0x00, 0x00, 0x00));
   3. // 设置字体大小为60.0
   4. OH_Drawing_SetTextStyleFontSize(textStyle, 60.0);
   5. // 创建一个段落样式对象，以设置排版风格
   6. OH_Drawing_TypographyStyle *typographyStyle = OH_Drawing_CreateTypographyStyle();
   7. OH_Drawing_SetTypographyTextAlign(typographyStyle, TEXT_ALIGN_LEFT); // 设置段落样式为左对齐
   8. // 创建一个段落生成器
   9. OH_Drawing_TypographyCreate* handler = OH_Drawing_CreateTypographyHandler(typographyStyle, fontCollection);
   10. // 在段落生成器中设置文本样式
   11. OH_Drawing_TypographyHandlerPushTextStyle(handler, textStyle);
   12. // 在段落生成器中设置文本内容
   13. const char* text = "hello, 这段文字使用了自定义字体";
   14. OH_Drawing_TypographyHandlerAddText(handler, text);
   15. // 通过段落生成器生成段落
   16. OH_Drawing_Typography* typography = OH_Drawing_CreateTypography(handler);
   17. // 设置页面最大宽度
   18. double maxWidth = width_;
   19. OH_Drawing_TypographyLayout(typography, maxWidth);
   20. // 将文本绘制到画布(0,100)上
   21. OH_Drawing_TypographyPaint(typography, cCanvas_, 0, 100);
   ```
8. 如果需要释放自定义字体，可以使用OH\_Drawing\_UnregisterFont接口。

   收起

   自动换行

   深色代码主题

   复制

   ```
   1. // 注销对应的自定义字体
   2. OH_Drawing_UnregisterFont(fontCollection, fontFamily);
   3. OH_Drawing_TypographyCreate* handler1 = OH_Drawing_CreateTypographyHandler(typographyStyle, fontCollection);
   4. // 在段落生成器中设置文本样式
   5. OH_Drawing_TypographyHandlerPushTextStyle(handler1, textStyle);
   6. // 在段落生成器中设置文本内容
   7. const char* text1 = "hello, 这段文本的自定义字体被注销了";
   8. OH_Drawing_TypographyHandlerAddText(handler1, text1);
   9. // 通过段落生成器生成段落
   10. OH_Drawing_Typography* typography1 = OH_Drawing_CreateTypography(handler1);
   11. OH_Drawing_TypographyLayout(typography1, maxWidth);
   12. // 将文本绘制到画布(0,300)上
   13. OH_Drawing_TypographyPaint(typography1, cCanvas_, 0, 300);
   ```