__weak关键字：程序模块相互独立的大杀器

[导读]在STM32 HAL库开发中，我们经常会看到__weak这个关键字，到底是什么意思呢？出于这个好奇心，我们来打开KEIL的帮助手册找到它的出处。

在STM32 HAL库开发中，我们经常会看到__weak这个关键字，到底是什么意思呢？出于这个好奇心我们来打开KEIL的帮助手册找到它的出处：

意思就是，它是一个弱符号，可以用于修饰变量和函数；不过我们经常看到的是对函数的修饰，所以这里我们仅讨论下函数的修饰就可以了，也就是说，当一个函数前面加上__weak这样的修饰符以后，允许用户在其它文件中定义一个和__weak修饰过的一模一样的函数，最终当编译器编译的时候，会选择用户定义的函数，如果用户没有重新实现这个函数，则编译器就会去执行带__weak修饰的函数。

所以在HAL库里，比如我们经常会看到像下面这样的函数：

__weak void HAL_UART_TxHalfCpltCallback(UART_HandleTypeDef *huart)
{
    UNUSED(huart);
}

__weak void HAL_UART_RxCpltCallback(UART_HandleTypeDef *huart)
{
    UNUSED(huart);
}

....等等....

通常HAL库源码里带__weak这个弱函数很多内部都没有实现，它把主动权让给用户自己根据自己的需要去定义一个一模一样的函数，然后去做自己想做的事情，这里的UNUSED起到一个防止编译器报警告的作用，原型如下：

#define UNUSED(X) (void)X      /* To avoid gcc/g++ warnings */

这样就非常好了，我们可以用这样的机制轻松实现程序模块的相互独立，如何来实现呢？我把我最近做的项目做一个分享，我完成的是一个金属检测传感器的模块框架，为了未来能够不费吹灰之力移植到别的STM32的平台，我是这么来做的：

Metal.h

#define UNUSED_METAL(X) (void)X  

/*金属传感器数据采集结构体*/
typedef struct
{
    int Serial_Number ;              /*流水号*/
    uint16_t Heating_Value ;         /*加热值*/
    uint16_t Heating_Signal_Value ;  /*信号值*/
    uint16_t Devalue ;               /*差值*/
} Metal_Sensor ;
extern Metal_Sensor Metal_Sensor_Device ;
extern Metal_Sensor Meatl_Sensor_Parse  ;

/*注册金属传感器*/
void Register_Metal_Sensor(void);
/*获取并解析传感器数据*/
void Get_Metal_Sensor_Data(char *data, Metal_Sensor *sensor_data);

Metal.c

/*解析金属数据格式结构体*/
typedef struct
{
    int Para1 ;
    int Para2 ;
    int Para3 ;
    int Para4 ;
} Parse_Metal_Passage_Value ;

Metal_Sensor Meatl_Sensor_Parse ;
Metal_Sensor Metal_Sensor_Device ;
__weak void __Register_Metal_Sensor(void);
__weak void CallBack_Metal_Logic(Metal_Sensor *sensor_data);


/*解析传感器数据*/
void Split_Sensor_Metal_Data(char *Data, Parse_Metal_Passage_Value *Sensor_Data_Info)
{
    char *temp = NULL ;
    Sensor_Data_Info->Para1 = atoi(Data);
    temp = strstr(Data, " ");
    Sensor_Data_Info->Para2 = atoi(temp + 1);
    temp = strstr(temp + 1, " ");
    Sensor_Data_Info->Para3 = atoi(temp + 1);
    temp = strstr(temp + 1, " ");
    Sensor_Data_Info->Para4 = atoi(temp + 1);
    temp = strstr(temp + 1, " ");
}

/*金属传感器注册*/
void Register_Metal_Sensor(void)
{
    __Register_Metal_Sensor();
}

void Get_Metal_Sensor_Data(char *data, Metal_Sensor *sensor_data)
{
    Parse_Metal_Passage_Value para_0 ;
    Split_Sensor_Metal_Data(data, ¶_0);
    sensor_data->Serial_Number    = para_0.Para1 ;
    sensor_data->Heating_Value = para_0.Para2 ;
    sensor_data->Devalue  = para_0.Para3 ;
    sensor_data->Heating_Signal_Value   = para_0.Para4 ;
    CallBack_Metal_Logic(sensor_data);
}

__weak void __Register_Metal_Sensor(void)
{
    UNUSED_METAL(NULL);
}

__weak void CallBack_Metal_Logic(Metal_Sensor *sensor_data)
{
    UNUSED_METAL(sensor_data);
}

这里提供给外面应用逻辑两个接口，一个是用户需要提供注册金属传感器的逻辑，他只需要实现__Register_Metal_Sensor函数就可以完成金属传感器的注册了；另一个是用户拿到解析金属传感器的数据以后去做他自己要做的事情，那么他只需要实现CallBack_Metal_Logic这个函数就可以了。

然后在另一个metal_detect_app.c文件中，直接实现这两个与Metal.c中一模一样的函数即可：

/*注册金属传感器*/
void __Register_Metal_Sensor(void)
{
    HAL_UART_DMAStop(&huart6);
    memset(Metal_Sensor_Handler.SensorU6Buffer, 0, SENSOR_U6_BUFFER_SIZE);
    HAL_UART_Receive_DMA(&huart6, (uint8_t*)Metal_Sensor_Handler.SensorU6Buffer, SENSOR_U6_BUFFER_SIZE);
    //开启空闲中断
    __HAL_UART_ENABLE_IT(&huart6, UART_IT_IDLE);
}

/*调用具体的应用逻辑*/
void CallBack_Metal_Logic(Metal_Sensor *sensor_data)
{
    /*在不同的页面执行不同的逻辑*/
    switch(Flow_Cursor.flow_cursor)
    {
    case MAIN_PAGE:
        //实现应用业务逻辑
        break ;

    case METAL_TEST_PAGE:
        //实现应用业务逻辑
        break ;

    default:
        break ;
    }

    /*重新开启串口DMA接收*/
    memset(Metal_Sensor_Handler.SensorU6Buffer, 0, SENSOR_U6_BUFFER_SIZE);
    HAL_UART_Receive_DMA(&huart6, (uint8_t*)Metal_Sensor_Handler.SensorU6Buffer, SENSOR_U6_BUFFER_SIZE);
}

最后，在我的任务中做如下调用：

/* 金属传感器线程入口函数 */
static void metal_thread_entry(void *parameter)
{
    static rt_err_t result;
    /* 创建一个动态信号量，初始值是 0 */
    metal_sem = rt_sem_create("mt_sem", 0, RT_IPC_FLAG_FIFO);

    if (metal_sem == RT_NULL)
    {
        rt_kprintf("create mt_sem failed.\n");
        return ;
    }

    /*注册金属传感器*/
    Register_Metal_Sensor();

    while (1)
    {
        /*获取金属传感器信号量*/
        result = rt_sem_take(metal_sem, RT_WAITING_FOREVER);

        if (RT_EOK == result)
            Get_Metal_Sensor_Data((char *)Metal_Sensor_Handler.SensorU6Buffer, &Meatl_Sensor_Parse);
    }
}