使用宏实现日志信息以及异常处理

背景：

　　在程序开发中难免会遇到一些错误，像java，C++中本身提供了一些捕获异常的机制，而C语言中并没有提供，这样C语言程序猿就要比较繁琐的处理这些问题。最近发现使用宏处理在C中的和日志记录和异常处理这样的公用模块，在每个C项目中都可以使用，感觉很方便，今天整理记录下。

　　我之前处理可能出现错误的方式：

　　1.调用一个函数；

　　2.如果返回一个错误，例如打开文件失败；

　　3.释放相关的资源；

　　4.打印错误的日志信息。

　　这样的处理意味着在调用每一个可能出现错误的函数后，我都要做相应的处理，相对比较繁琐。

解决方案：

　　使用宏定义来解决使用宏实现日志信息以及异常处理的问题，直接拿demo说话。

　　我先定义一个dbg.h头文件，这个头文件中定义了很多宏，来辅助我们高效的解决问题。

#ifndef __dbg_h__
#define __dbg_h__

#include <stdio.h>
#include <errno.h>
#include <string.h>


#define debug(M, ...) fprintf(stderr, "DEBUG %s:%d: " M "\n", __FILE__, __LINE__, ##__VA_ARGS__)

#define clean_errno() (errno == 0 ? "None" : strerror(errno))

#define log_err(M, ...) fprintf(stderr, "[ERROR] (%s:%d: errno: %s) " M "\n", __FILE__, __LINE__, clean_errno(), ##__VA_ARGS__)

#define log_warn(M, ...) fprintf(stderr, "[WARN] (%s:%d: errno: %s) " M "\n", __FILE__, __LINE__, clean_errno(), ##__VA_ARGS__)

#define log_info(M, ...) fprintf(stderr, "[INFO] (%s:%d) " M "\n", __FILE__, __LINE__, ##__VA_ARGS__)

#define check(A, M, ...) if(!(A)) { log_err(M, ##__VA_ARGS__); errno=0; goto error; }

#define sentinel(M, ...)  { log_err(M, ##__VA_ARGS__); errno=0; goto error; }

#define check_mem(A) check((A), "Out of memory.")

#define check_debug(A, M, ...) if(!(A)) { debug(M, ##__VA_ARGS__); errno=0; goto error; }

#endif

我的理解：

　　1.debug：，...与##__VA_ARGS__是对可变参数的支持，__FILE__是文件名称，__LINE__是当前行数。这样我们能够很方便的得知具体是哪个文件的哪块代码出现的问题；

　　2.clean_errno：根据错误编码，获得错误的信息，例如No such file or directory；

　　3.log_err，log_warn,log_info比较类似，通过1,2就比较容易理解啦；

　　4.check：检查A是否为true，如果不为true，把M和参数交给log_err打印，之后跳转的error,进行相关资源释放。对于M的理解看看一会的调用处就很好理解啦；

　　5.sentinel：在程序中不应该运行到的地方使用，打印出日志信息后，跳转到error。例如在if-else，swtich等分支语句中使用的情况比较多；

　　6.check_mem:这个就是针对于内存分配是否成功的检查；

用起来看看：

#include "dbg.h"
#include <stdlib.h>
#include <stdio.h>


void test_debug()
{
    // notice you don't need the \n
    debug("I have Brown Hair.");

    // passing in arguments like printf
    debug("I am %d years old.", 37);
}

void test_log_err()
{
    log_err("I believe everything is broken.");
    log_err("There are %d problems in %s.", 0, "space");
}

void test_log_warn()
{
    log_warn("You can safely ignore this.");
    log_warn("Maybe consider looking at: %s.", "/etc/passwd");
}

void test_log_info()
{
    log_info("Well I did something mundane.");
    log_info("It happened %f times today.", 1.3f);
}

int test_check(char *file_name)
{
    FILE *input = NULL;
    char *block = NULL;

    block = malloc(100);
    check_mem(block); // should work

    input = fopen(file_name,"r");
    check(input, "Failed to open %s.", file_name);

    free(block);
    fclose(input);
    return 0;

error:
    if(block) free(block);
    if(input) fclose(input);
    return -1;
}

int test_sentinel(int code)
{
    char *temp = malloc(100);
    check_mem(temp);

    switch(code) {
        case 1:
            log_info("It worked.");
            break;
        default:
            sentinel("I shouldn't run.");
    }

    free(temp);
    return 0;

error:
    if(temp) free(temp);
    return -1;
}

int test_check_mem()
{
    char *test = NULL;
    check_mem(test);

    free(test);
    return 1;

error:
    return -1;
}

int test_check_debug()
{
    int i = 0;
    check_debug(i != 0, "Oops, I was 0.");

    return 0;
error:
    return -1;
}

int main(int argc, char *argv[])
{
    check(argc == 2, "Need an argument.");

    test_debug();
    test_log_err();
    test_log_warn();
    test_log_info();

    check(test_check("ex20.c") == 0, "failed with ex20.c");
    check(test_check(argv[1]) == -1, "failed with argv");
    check(test_sentinel(1) == 0, "test_sentinel failed.");
    check(test_sentinel(100) == -1, "test_sentinel failed.");
    check(test_check_mem() == -1, "test_check_mem failed.");
    check(test_check_debug() == -1, "test_check_debug failed.");

    return 0;

error:
    return 1;
}

仔细看一看这块代码，感觉今后遇到异常处理和信息记录的问题，就好办啦。

还不够完美：

　　上面的解决方案的确能够帮助我们处理很多问题，但是我想了想。当多个异常嵌套时，发生异常，我们怎么通过一个error去释放资源呢？这很明显是不合理的。怎么才能解决这个问题呢？我相信大家对宏定义有一定理解，会很快的解决的。

 Note：如博文中存在问题，请大家及时指出，我会及时纠正，谢谢。