每次调试打印日志都很头痛

Posted 嘴巴吃糖了

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了每次调试打印日志都很头痛相关的知识，希望对你有一定的参考价值。

引子

当代码的运行效果不符合预期时就得进行调试，排查下整个数据链路上到底是哪个环节出了问题。

断点调试当然是首选，因为它可以单步执行程序，并查看当前执行步骤中所有的数据值。但有些场景下，断点调试就显得笨拙。比如大量异步并发的场景，当程序不是线性执行而是跳来跳去时，就会发生你期望下一步是执行到这里，断点调试却跳到了另一个线程，这样的复杂度，让正在执行的代码变得难以理解。除此之外，有些型号的手机，一断点调试就卡的不行，甚至 crash。

在这种情况下，打日志就是唯一的选择了。

日志输出一个简单的变量值是一件轻而易举的事情：

Log.v("test", "duration=$duration")

但在复杂的业务场景中，会存在各种嵌套的复杂结构，比如 List，Map。断点调试中，可以轻松地点开这些数据结构，查看任何感兴趣的字段，甚至还可以当场计算。在输出日志时有什么好办法能够轻松地输出这些复杂的数据结构吗？

打印列表 & Map

刚开始开发 android 时，我是这样打印列表的：

for (int i = 0; i < list.size(); i++) 
    Log.d("test", "list item="+list.get(i));

用一个 for 循环来打印列表所有元素。

后来我学会了用更高级的语法来简化日志输出：

for (String str:list) 
    Log.v("test", "list item="+str);

这样的写法是无法被复用的，因为不同的业务场景，数据类型都不一样。为了调试，这样的 for 循环就会散落在各处。

这样写还有一个坏处，输出的列表信息可能被其他日志穿插。因为每一个列表内容都是一条新得日志，中间极有可能被别的 log 打断。

有没有一个函数可以打印包含任意数据类型的列表，并将列表内容组织成更具可读性的字符串？

用 Kotlin 的扩展函数+泛型+高阶函数就能优雅地做到：

fun <T> Collection<T>.print(mapper: (T) -> String) =
    StringBuilder("\\n[").also  sb ->
        //遍历集合元素将元素转换成感兴趣的字串，并独占一行
        this.forEach  e -> sb.append("\\n\\t$mapper(e),") 
        sb.append("\\n]")
    .toString()

为集合的基类Collection新增一个扩展函数，它是一个高阶函数，因为它的参数是另一个函数，该函数用 lambda 表示。再把集合元素抽象成泛型。通过StringBuilder将所有集合内容拼接成一个自动换行的字符串。

写段测试代码看下效果：

data class Person(var name: String, var age: Int)

val persons = listOf(
    Person("Peter", 16),
    Person("Anna", 28),
    Person("Anna", 23),
    Person("Sonya", 39)
)

persons.print  "$it.name_$it.age" .let  Log.v("test",it)

打印结果如下：

V/test: [
    	Peter_16,
    	Anna_28,
    	Anna_23,
    	Sonya_39,
    ]

这样整个列表内容会作为一条log输出。

同样地，可以如法炮制一个打印 Map 的扩展函数：

fun <K, V> Map<K, V?>.print(mapper: (V?) -> String): String =
    StringBuilder("\\n").also  sb ->
        this.iterator().forEach  entry ->
            sb.append("\\n\\t[$entry.key] = $mapper(entry.value)")
        
        sb.append("\\n")
    .toString()

打印复杂数据结构

有些数据类字段比较多，调试时，想把它们通通打印出来，在 Java 中，借助于 AndroidStudio 的 toString功能倒是可以方便地生成可读性很高的字串：

public class Person 
    private String name;
    private int age;

    @Override
    public String toString() 
        return ”Person“ +
                ”name=‘“ + name + ’\\” +
                ”, age=“ + age +
                ‘’;

但是每新建一个数据类都要手动生成一个toString()方法也挺麻烦。

利用 Kotlin 的 data class可以省去这一步，但打印效果是所有字段都在同一行中：

data class Person(var name: String, var age: Int)

Log.v(“test”, “person=$Person("Peter", 16)”)

//输出如下：
V/test: person=Person(name=Peter, age=16)

如果字段很多，把它们都打印在一行中可读性很差。

有没有一种方法，可以读取一个类中所有的字段信息？

这样我们就可以将他们组织成想要的形状。

请看下面这个方法：

fun Any.ofMap() =
    // 过滤掉除data class以外的其他类
    this::class.takeIf  it.isData 
        // 遍历类的所有成员 过滤掉成员方法 只考虑成员属性
        ?.members?.filterIsInstance<KProperty<Any>>()
        // 将成员属性名和值存储在Pair中
        ?.map  it.name to it.call(this) 
        // 将Pair转换成map
        ?.toMap()

为任意 Kotlin 中的类添加一个扩展函数，它的功能是将data class中所有的字段名及其对应值存在一个 map 中。其中用到的 Kotlin 语法糖如下：

  • isData是KClass中的一个属性，用于判断该类是不是一个data class。KClass是 Kotlin 中用来描述 类的类型，KClass可以通过对象::class语法获得。

  • members也是KClass中的一个属性，它以列表的形式返回了类中所有的方法和属性。

  • filterIsInstance()是Iterable接口的扩展函数，用于过滤出集合中指定的类型。

  • to是一个infix扩展函数，它的定义如下：

public infix fun <A, B> A.to(that: B): Pair<A, B> = Pair(this, that)
  • 带有infix标识的函数只允许带有一个参数，并且在调用时可以省略包裹参数的括号。这种语法叫中缀表达式，它用于简化方法调用。

写段测试代码，结合上一节的打印 map 函数看下效果：

data class Person(var name: String, var age: Int)

Person("Peter", 16).ofMap()?.print  it.toString() .let  Log.v("test","$it")

测试代码先将Person实例转换成 map，然后打印 map。输出结果如下：

V/test:
    
    	[age] = 16
    	[name] = Peter

若data class嵌套会发生什么？

//位置，嵌套在Person类中
data class Location(var x: Int, var y: Int)
data class Person(
    var name: String,
    var age: Int, 
    var locaton: Location? = null
)

Person("Peter", 16, Location(20, 30))
    .ofMap()
    ?.print  it.toString() 
    .let  Log.v("test", "$it") 

// 打印结果如下 
    
    	[age] = 16
    	[locaton] = Location(x=20, y=30)
    	[name] = Peter

期望得到类似 Json 的打印效果，但输出结果还差一点。是因为将Person转化成Map时并没有将嵌套的Location也转化成键值对。

需要将ofMap()方法重构成递归调用：

fun Any.ofMap(): Map<String, Any?>? 
    return this::class.takeIf  it.isData 
        ?.members?.filterIsInstance<KProperty<Any>>()
        ?.map  member ->
            val value = member.call(this)?.let  v->
                //'若成员变量是data class，则递归调用ofMap()，将其转化成键值对，否则直接返回值'
                if (v::class.isData) v.ofMap()
                else v
            
            member.name to value
        
        ?.toMap()

为了让打印结果也有嵌套缩进效果，打印 Map 的函数也需要相应地重构：

/**
 * 打印 Map，生成结构化键值对子串
 * @param space 行缩进量
 */
fun <K, V> Map<K, V?>.print(space: Int = 0): String 
    //'生成当前层次的行缩进，用space个空格表示，当前层次每一行内容都需要带上缩进'
    val indent = StringBuilder().apply 
        repeat(space)  append(" ") 
    .toString()
    return StringBuilder("\\n$indent").also  sb ->
        this.iterator().forEach  entry ->
            //'如果值是 Map 类型，则递归调用print()生成其结构化键值对子串，否则返回值本身'
            val value = entry.value.let  v ->
                (v as? Map<*, *>)?.print("$indent$entry.key = ".length) ?: v.toString()
            
            sb.append("\\n\\t$indent[$entry.key] = $value,")
        
        sb.append("\\n$indent")
    .toString()

写段测试代码，看看效果：

//'坐标类，嵌套在Location类中'
data class Coordinate(var x: Int, var y: Int)
//'位置类，嵌套在Person类中'
data class Location(
    var country: String, 
    var city: String, 
    var coordinate: Coordinate
)
data class Person(
    var name: String, 
    var age: Int, 
    var locaton: Location? = null
)

Person("Peter", 16, Location("china", "shanghai", Coordinate(10, 20)))
    .ofMap()
    ?.print()
    .let  Log.v("test", "$it") 

//'打印效果如下'
    
    	[age] = 16,
    	[locaton] = 
              
    	          [city] = shanghai,
    	          [coordinate] = 
                           
    	                       [x] = 10,
    	                       [y] = 20,
                           ,
    	          [country] = china,
              ,
    	[name] = Peter,

推荐阅读

业务代码参数透传满天飞？（一）

业务代码参数透传满天飞？（二）

全网最优雅安卓控件可见性检测

全网最优雅安卓列表项可见性检测

页面曝光难点分析及应对方案

你的代码太啰嗦了 | 这么多对象名？

你的代码太啰嗦了 | 这么多方法调用？

作者：唐子玄
链接：https://juejin.cn/post/7171031370511155231

最后

如果想要成为架构师或想突破20~30K薪资范畴，那就不要局限在编码，业务，要会选型、扩展，提升编程思维。此外，良好的职业规划也很重要，学习的习惯很重要，但是最重要的还是要能持之以恒，任何不能坚持落实的计划都是空谈。

如果你没有方向，这里给大家分享一套由阿里高级架构师编写的《Android八大模块进阶笔记》，帮大家将杂乱、零散、碎片化的知识进行体系化的整理，让大家系统而高效地掌握Android开发的各个知识点。

相对于我们平时看的碎片化内容，这份笔记的知识点更系统化，更容易理解和记忆，是严格按照知识体系编排的。

一、架构师筑基必备技能

1、深入理解Java泛型
2、注解深入浅出
3、并发编程
4、数据传输与序列化
5、Java虚拟机原理
6、高效IO
……

二、Android百大框架源码解析

1.Retrofit 2.0源码解析
2.Okhttp3源码解析
3.ButterKnife源码解析
4.MPAndroidChart 源码解析
5.Glide源码解析
6.Leakcanary 源码解析
7.Universal-lmage-Loader源码解析
8.EventBus 3.0源码解析
9.zxing源码分析
10.Picasso源码解析
11.LottieAndroid使用详解及源码解析
12.Fresco 源码分析——图片加载流程

三、Android性能优化实战解析

  • 腾讯Bugly:对字符串匹配算法的一点理解
  • 爱奇艺：安卓APP崩溃捕获方案——xCrash
  • 字节跳动：深入理解Gradle框架之一：Plugin, Extension, buildSrc
  • 百度APP技术：Android H5首屏优化实践
  • 支付宝客户端架构解析：Android 客户端启动速度优化之「垃圾回收」
  • 携程：从智行 Android 项目看组件化架构实践
  • 网易新闻构建优化：如何让你的构建速度“势如闪电”？
  • …

四、高级kotlin强化实战

1、Kotlin入门教程
2、Kotlin 实战避坑指南
3、项目实战《Kotlin Jetpack 实战》

  • 从一个膜拜大神的 Demo 开始

  • Kotlin 写 Gradle 脚本是一种什么体验？

  • Kotlin 编程的三重境界

  • Kotlin 高阶函数

  • Kotlin 泛型

  • Kotlin 扩展

  • Kotlin 委托

  • 协程“不为人知”的调试技巧

  • 图解协程：suspend

五、Android高级UI开源框架进阶解密

1.SmartRefreshLayout的使用
2.Android之PullToRefresh控件源码解析
3.Android-PullToRefresh下拉刷新库基本用法
4.LoadSir-高效易用的加载反馈页管理框架
5.Android通用LoadingView加载框架详解
6.MPAndroidChart实现LineChart（折线图）
7.hellocharts-android使用指南
8.SmartTable使用指南
9.开源项目android-uitableview介绍
10.ExcelPanel 使用指南
11.Android开源项目SlidingMenu深切解析
12.MaterialDrawer使用指南

六、NDK模块开发

1、NDK 模块开发
2、JNI 模块
3、Native 开发工具
4、Linux 编程
5、底层图片处理
6、音视频开发
7、机器学习

七、Flutter技术进阶

1、Flutter跨平台开发概述
2、Windows中Flutter开发环境搭建
3、编写你的第一个Flutter APP
4、Flutter开发环境搭建和调试
5、Dart语法篇之基础语法(一)
6、Dart语法篇之集合的使用与源码解析(二)
7、Dart语法篇之集合操作符函数与源码分析(三)
…

八、微信小程序开发

1、小程序概述及入门
2、小程序UI开发
3、API操作
4、购物商场项目实战……

全套视频资料：

一、面试合集

二、源码解析合集


三、开源框架合集


欢迎大家一键三连支持，若需要文中资料，直接点击文末CSDN官方认证微信卡片免费领取↓↓↓

以上是关于每次调试打印日志都很头痛的主要内容，如果未能解决你的问题，请参考以下文章

在 PySpark 作业上打印 Kafka 调试消息

每次调试测试后更改文档位置

如何调试 Flask 应用程序

c#实现把异常写入日志示例(异常日志)

QT软件开发: QPlainTextEdit当做日志显示窗口

5-6 使用axios拦截器打印前端日志