ESP32 之 ESP-IDF 教学(十七)——组件依赖

本文章 来自原创专栏《ESP32教学专栏 (基于ESP-IDF)》,讲解如何使用 ESP-IDF 构建 ESP32 程序,发布文章并会持续为已发布文章添加新内容! 每篇文章都经过了精打细磨!

↓↓↓通过下方对话框进入专栏目录页↓↓↓
CSDN 请求进入目录       _ O x

是否进入ESP32教学导航(基于ESP-IDF)?

       确定


文章目录

  • 一、组件之间的依赖关系
    • 1、什么是组件依赖关系
    • 2、组件依赖关系的声明
    • 3、隐式依赖规则
    • 4、循环依赖
  • 二、示例

一、组件之间的依赖关系

1、什么是组件依赖关系

在我们之前的学习中,我们了解到ESP-IDF工程是“组件”式的,组件之间以依赖关系为主。本文我们将介绍这种依赖关系。

所谓“依赖”,就是“我需要你”的意思。

例如组件A实现了控制WS2812灯带的基础API。而你准备写个组件B,目标功能是通过WiFi控制WS2812。显然可以让组件B依赖组件A。

2、组件依赖关系的声明

依赖声明通过注册组件时传递REQUIRESPRIV_REQUIRES实现依赖。
例如上文举的例子:组件B要依赖组件A。需要在注册B组件时声明对组件A的依赖

# Component B 的CMakeLists.txt
idf_component_register(
    SRCS            "源文件1.c" "源文件2.cpp" ...
    INCLUDE_DIRS    "头文件夹a" "头文件夹b" ...
    REQUIRES        "组件A" ...
)

注:REQUIRESPRIV_REQUIRES区别
 
REQUIRES是声明public依赖,可供其他依赖者访问。
PRIV_REQUIRES是声明private依赖,只能被当前组件访问。

3、隐式依赖规则

为避免重复性工作,IDF构建系统会在某些特殊情况下自动依赖组件。

1. 规则一:通用依赖

各组件都会自动依赖一些“通用的”IDF组件,即使这些依赖关系没有被明确声明。这些组件的头文件会一直包含在构建系统中。

通用组件包括:
cxxnewlibfreertosesp_hw_supportheaploglwipsochalesp_romesp_commonesp_system

2. 规则二:main组件

main组件即主程序组件,它比较特别,会默认自动依赖所有其他组件。

所以不需要向main组件传递 REQUIRESPRIV_REQUIRES参数。

4、循环依赖

某些情况下容易发生组件间的循环依赖,可能造成构建失败并出现关于 “Undefined reference to …” 的链接器错误。

最好的解决办法是重构组件以消除循环依赖关系,使其模块化,并且分层清晰,这样的程序从长远来看会更容易维护。

如果有不能避免的循环依赖,请查看官方文档的说明:https://docs.espressif.com/projects/esp-idf/zh_CN/v4.4.2/esp32/api-guides/build-system.html#component-circular-dependencies

二、示例

如果依赖关系如下:

实线箭头:表示需要手动依赖的关系
虚线箭头:隐式依赖

ESP_IDF
ESP-IDF框架
xxx()
组件LEDControl
控制LED
trunOn()
trunOff()
setColor(color)
组件WiFiControl
WiFi通信
sendData()
onReceive()
组件WiFiLedThread
WiFi控制LED灯线程
start()
stop()
main
Main组件
app_main()

LEDControlWiFiControlmain组件的CMakeLists.txt至少为

# LEDControl、WiFiControl、main组件的CMakeLists.txt

idf_component_register(
    SRCS            "LEDControl.c" "其他源文件1.c" "其他源文件2.cpp" ...
    INCLUDE_DIRS    "头文件夹a" "头文件夹b" ...
)

WiFiLedThread组件的CMakeLists.txt至少为:
(需要传递REQUIRES参数传递依赖关系)

# WiFiLedThread组件的CMakeLists.txt

idf_component_register(
    SRCS            "WiFiLedThread.c" "其他源文件1.c" "其他源文件2.cpp" ...
    INCLUDE_DIRS    "头文件夹a" "头文件夹b" ...
    REQUIRES		"LEDControl" "WiFiControl"
)

你可能感兴趣的:(ESP32,教学专栏,(基于ESP-IDF),物联网,ESP32,单片机,嵌入式,c语言)