C#基于内置函数的自定义控制台输出函数

古城微笑少年丶 2024-04-03 12:51 81阅读 0赞

#### （一）设计目的 ####

对于C\#的控制台程序，通常我们的输出是在调试控制台，但是C\#会自动输出控制台程序的加载信息，这些并不是我们想要关注的信息，所以为了更直观地查看我们的程序在控制台中输出的信息，我们可以通过自定义控制台输出函数结合控制台筛选器来实现这个目的。

自定义控制台输出函数是基于System.Diagnostics.Debug中的Write和WriteLine方法进行简单的自定义，并非是完全自主实现控制台输出方法。也就是将内置的这两个方法进行封装，给我们的调试信息加上一些特殊标记，这样我们就可以通过调试控制台的筛选器结合特殊标记筛选控制台信息，从而实现控制台仅显示具有该特殊标记的信息。

#### （二）代码示例（C\#） ####

public static class MyPrint
    {
        /// <summary>
        /// 标记，默认为"<b>(MyPrint)</b>"
        /// </summary>
        public static string mFlag
        {
            get { return flag; }
            set { if (value != null) flag = value; }
        }
    
        private static string flag;
        private static bool isFirst;
    
        static MyPrint()
        {
            flag = "(MyPrint)";
            isFirst = true;
        }
    
        //该特性使得调试时直接跳过该方法
        [System.Diagnostics.DebuggerStepThrough]
        public static void WriteLine(object str)
        {
            if (str == null) System.Diagnostics.Debug.WriteLine($"{flag} Null");
            else if (str.Equals(string.Empty)) System.Diagnostics.Debug.WriteLine("");
            else System.Diagnostics.Debug.WriteLine($"{flag} " + str.ToString());
        }
    
        [System.Diagnostics.DebuggerStepThrough]
        public static void WriteLine()
        {
            System.Diagnostics.Debug.WriteLine("");
        }
    
        [System.Diagnostics.DebuggerStepThrough]
        public static void Write(object str)
        {
            if (isFirst)
            {
                if (str == null) System.Diagnostics.Debug.Write($"{flag} Null");
                else System.Diagnostics.Debug.Write($"{flag} " + str.ToString());
                isFirst = false;
            }
            else System.Diagnostics.Debug.Write(str);
        }
    }

#### （三）测试 ####

##### （1）MyPrint测试 #####

###### ①WriteLine()测试 ######

// MyPrint.WriteLine测试
    MyPrint.WriteLine("Hello world!");
    MyPrint.WriteLine("My name is Jack.");

![92ff2f89f1ec4366b31a46baa1355a18.png][] 图 1 测试结果

###### ②Wirte()测试 ######

// MyPrint.Write测试
    string[] v_strs1 = { "Hello ", "world." };
    foreach (string str in v_strs1)
    {
        MyPrint.Write(str);
    }
    string[] v_strs2 = { "My ", "name ", "is ", "Jack." };
    foreach (string str in v_strs2)
    {
        MyPrint.Write(str);
    }

![c9c58d9532d74537832f370ec433b2fb.png][] 图 2 测试结果

###### ③WriteLine()和Write()联调测试 ######

MyPrint.WriteLine("Hello Jack.");
    string[] v_strs1 = { "Hello ", "world." };
    foreach (string str in v_strs1)
    {
        MyPrint.Write(str);
    }
    MyPrint.WriteLine("");
    string[] v_strs2 = { "My ", "name ", "is ", "Jack." };
    foreach (string str in v_strs2)
    {
        MyPrint.Write(str);
    }
    MyPrint.WriteLine("My name is Mary.");

![3ad85b7e2540445fae240dcce06481e6.png][] 图 3 测试结果

##### （2）对比测试 #####

通过System.Diagnostics.Debug与MyPrint中的函数Write和WriteLine实现相同的逻辑并对输出结果进行对比。以下三个测试基于System.Diagnostics.Debug实现。

###### ①WriteLine()测试 ######

// WriteLine测试
    System.Diagnostics.Debug.WriteLine("Hello world!");
    System.Diagnostics.Debug.WriteLine("My name is Jack.");

![6397398b42eb474d848db2c6f2a492eb.png][] 图 4 测试结果

###### ②Wirte()测试 ######

// Write测试
    string[] v_strs1 = { "Hello ", "world." };
    foreach (string str in v_strs1)
    {
        System.Diagnostics.Debug.Write(str);
    }
    string[] v_strs2 = { "My ", "name ", "is ", "Jack." };
    foreach (string str in v_strs2)
    {
        System.Diagnostics.Debug.Write(str);
    }

![062b35ee192d44f38d48eaf33196ceaf.png][] 图 5 测试结果

###### ③WriteLine()和Write()联调测试 ######

System.Diagnostics.Debug.WriteLine("Hello Jack.");
    string[] v_strs1 = { "Hello ", "world." };
    foreach (string str in v_strs1)
    {
        System.Diagnostics.Debug.Write(str);
    }
    System.Diagnostics.Debug.WriteLine("");
    string[] v_strs2 = { "My ", "name ", "is ", "Jack." };
    foreach (string str in v_strs2)
    {
        System.Diagnostics.Debug.Write(str);
    }
    System.Diagnostics.Debug.WriteLine("My name is Mary.");

![cc2abbc0933b4bfab5cf4fcb18a46358.png][] 图 6 测试结果

#### （四）测试总结 ####

根据上述测试结果可见，在忽略输出结果中的标记"(MyPrint)"的前提下，MyPrint和内置的System.Diagnostics.Debug对于WriteLine和Write方法的控制台输出信息相同。

#### （五）使用示例 ####

示例代码如下，输出结果如图7和图8所示：

//示例代码
    MyPrint.WriteLine("【Example】");
    MyPrint.WriteLine("-----------------------------");
    string[] v_fruits = { "Apple", "Orange", "Banana", "Strawberry", "Peach" };
    string[] v_prices = { "10$", "20$", "15$", "50$", "100$" };
    for (int i = 0; i < 5; i++)
    {
        if (i < 4) MyPrint.Write($"[Fruit:{v_fruits[i]},Price:{v_prices[i]}],");
        else MyPrint.Write($"[Fruit:{v_fruits[i]},Price:{v_prices[i]}]");
    }
    MyPrint.WriteLine();
    MyPrint.WriteLine("-----------------------------");

![b6d8b9de3fff41468dc69e805e419300.png][] 图7 有标记且根据筛选器筛选标记信息

![d764a21ecf5148b7972d149120711e3f.png][] 图8 有标记但没使用筛选器

图8所示并不需要每次调试控制台程序都在筛选器输入标记来筛选信息，这个筛选器会缓存当前输入的筛选标记，所以后续只需要运行调试控制台程序编辑即可自动按照图8所示的方式显示控制台输出信息，但是值得注意的是，这个方法可能会出现错误筛选掉有效信息的情况，这种情况之一的代码如下：

//示例代码
    MyPrint.WriteLine("【Example】");
    MyPrint.WriteLine("-----------------------------");
    string[] v_fruits = { "Apple", "Orange", "Banana", "Strawberry", "Peach" };
    string[] v_prices = { "10$", "20$", "15$", "50$", "100$" };
    for (int i = 0; i < 5; i++)
    {
        if (i < 4) MyPrint.Write($"[Fruit:{v_fruits[i]},Price:{v_prices[i]}],");
        else MyPrint.Write($"[Fruit:{v_fruits[i]},Price:{v_prices[i]}]");
        MyPrint.WriteLine();//在原有示例代码基础上添加了这一段代码
    }
    MyPrint.WriteLine();
    MyPrint.WriteLine("-----------------------------");

如图9和图10所示，我们的有效信息被错误筛选掉了一部分，这是因为筛选器是按行识别的，若该行输出信息中没有指定的标记则会被过滤掉，所以这种情况建议改用WriteLine输出。

![d0cabb5c13e14b259b76a802db6e5b05.png][] 图9 有标记且根据筛选器筛选标记信息

![2d3d483c8b2e43afb9133e2acb3916cd.png][] 图10 有标记但没使用筛选器

通过WriteLine实现的代码如下，输出结果如图11和图12：

//示例代码
    MyPrint.WriteLine("【Example】");
    MyPrint.WriteLine("-----------------------------");
    string[] v_fruits = { "Apple", "Orange", "Banana", "Strawberry", "Peach" };
    string[] v_prices = { "10$", "20$", "15$", "50$", "100$" };
    for (int i = 0; i < 5; i++)
    {
        if (i < 4) MyPrint.WriteLine($"[Fruit:{v_fruits[i]},Price:{v_prices[i]}]");
        else MyPrint.WriteLine($"[Fruit:{v_fruits[i]},Price:{v_prices[i]}]");
    }
    MyPrint.WriteLine("-----------------------------");

![ccf673d77c564454953c529cfbd8d238.png][] 图11 有标记且根据筛选器筛选标记信息

![99d54125cad241608966fff4c46a7d3f.png][] 图12 有标记但没使用筛选器

**如果该文章对你有帮助，请给作者点个赞吧！**

[92ff2f89f1ec4366b31a46baa1355a18.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/ade37c0b93a1402a8d76767b09a989c5.png
[c9c58d9532d74537832f370ec433b2fb.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/3abef0be1052490f8c919ff67037a4c9.png
[3ad85b7e2540445fae240dcce06481e6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/6e8e6134de504a99b1c69e2b8bec3c1b.png
[6397398b42eb474d848db2c6f2a492eb.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/696d4ea500514da89049a24b8d49650e.png
[062b35ee192d44f38d48eaf33196ceaf.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/51d2ff0f7d0240509a825e0f99f1586c.png
[cc2abbc0933b4bfab5cf4fcb18a46358.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/a50113d725cd42abaefe65125312bd2c.png
[b6d8b9de3fff41468dc69e805e419300.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/df141bcd010b4ad6bb67d4c427d481bd.png
[d764a21ecf5148b7972d149120711e3f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/aa7ba61501bc4189a7c89a4b16e2870b.png
[d0cabb5c13e14b259b76a802db6e5b05.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/234952df855b4cdba4770930b17656b9.png
[2d3d483c8b2e43afb9133e2acb3916cd.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/47a4387817e7409081390fcd54563e66.png
[ccf673d77c564454953c529cfbd8d238.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/92647ab9488f48d680a6b0ef5006308d.png
[99d54125cad241608966fff4c46a7d3f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/03/cccdad0c812f488fb6458ea140e85c4e.png