Kotlin中定义调试用TAG常量的正确方式：伴生对象内还是顶层

首先回答命名空间冲突的问题 #

顶层声明的const val不会引发无感知的命名空间冲突，规则非常明确：

• 如果给顶层常量加private修饰，它的作用域严格限定在当前文件内，其他文件完全不可见。哪怕同包下100个文件都写了自己的private const val TAG = "XXX"，互相之间完全隔离，既不会冲突，也不会被误引用，是最安全的写法。
• 如果不加private，顶层常量属于所在包的公共声明，只有同包下出现同名同修饰符的顶层常量时，编译器才会直接报重复定义错误，根本无法通过编译，不会出现运行时引用到错误值的情况。不同包下的同名顶层常量互不影响，引用时需要明确导包，不会自动串值。

你提到的「其他类同样声明顶层const val TAG = "OtherClass"」的场景，只要每个文件都给自己的TAG加private，就完全不会有任何问题。 #

两种写法的选择建议 #

没有绝对的对错，按使用场景选就行：

• 90%的日常场景（TAG只在当前类/当前文件内使用，不需要对外暴露），优先选private顶层常量：
  写法比伴生对象简洁很多，不用写嵌套的companion object代码块；同时const val的值会在编译期直接内联到调用处，不会生成伴生对象对应的额外类，也没有伴生对象初始化的微小开销，是性能最优的写法。
  参考代码：

  private const val TAG = "MainActivity"
  class MainActivity : AppCompatActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
          super.onCreate(savedInstanceState)
          Log.d(TAG, "onCreate Called")
    }
    // 其他类内代码
  }
  

• 如果你需要在类的外部复用这个TAG（比如其他工具类、其他页面需要打印和MainActivity相关的统一日志），就把TAG定义在伴生对象中：
  这种写法相当于Java里的类静态常量，外部可以直接通过类名访问到TAG；如果需要兼容Java代码调用，可以加@JvmField注解，避免Java调用时出现MainActivity.Companion.getTAG()的冗余写法。
  参考代码：

  class MainActivity : AppCompatActivity() {
      companion object{
          const val TAG = "MainActivity"
      }
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        Log.d(TAG, "onCreate Called")
    }
    // 其他类内代码
  }
  

不要被Java的编码习惯束缚：Kotlin的顶层声明是原生支持的正式语法，专门用于存放不需要和类绑定的文件级常量，加了private修饰的顶层常量，作用域比类内部伴生对象的常量更收敛，根本不存在“污染全局命名空间”的问题。

内容的提问来源于stack exchange，提问作者TecBrat