Android Logger 使用指南

Android Logger 使用指南

---

1. 项目目录结构及介绍

Android Logger 是一个专为 Android 平台设计的日志记录库，基于标准 Android util.Log 类实现。此库提供轻量级（<50 Kb）的SLF4J API实现，便于集成且拥有通过属性文件进行简单而强大的配置能力。以下是其大致的项目目录结构：

android-logger/
│
├── src/
│   ├── main/                  # 主要源代码所在
│   │   ├── java/              # Java 源码文件夹
│   │   │   └── com/noveogroup/android/log/      # 日志处理逻辑实现类
│   │   ├── resources/         # 资源文件夹，包含配置文件
│   │   │   └── android-logger.properties        # 配置示例文件
│   └── test/                 # 测试相关代码
│       └── java/
│           └── ...           # 测试用例
├── pom.xml                   # Maven 构建配置文件
├── LICENSE.txt               # 许可证文件
└── README.md                 # 项目读我文件，包含基本使用说明

2. 项目的启动文件介绍

在 Android 应用中集成 Android Logger，并非依赖于某个特定的“启动”文件，而是通过以下步骤来启用：

1. 添加依赖：

   • 对于Maven，在pom.xml中加入依赖。
   • 对于Gradle，在build.gradle中的dependencies块添加对应的依赖项。

2. 配置日志： 创建或修改src/main/resources/android-logger.properties文件来设置日志级别和标签等。

实际应用中，您不需要直接编写所谓的“启动文件”，只需正确配置并引入库即可。

3. 项目的配置文件介绍

• 配置文件路径: android-logger.properties

• 配置内容示例:

  # 根据需要自定义日志级别和标签
  root=ERROR:MyApplication
  
  # 针对特定包或类的日志级别配置
  logger=com.example.database=DEBUG:MyApplication-Database
  logger=com.example.ui=MyApplication-UI
  
  # 自定义消息头部格式
  

• 配置说明:

  • root: 设定默认的日志级别及其对应的标签。例如，上面的配置将只打印级别为ERROR或更高级别的日志，并使用"MyApplication"作为标签。
  • logger<包名或类名>: 可以指定特定包或类的日志行为，包括不同的级别和标签，甚至可以定制每个日志前的消息头。
  • 级别可以是VERBOSE, DEBUG, INFO, WARN, ERROR, ASSERT中的任何一个。
  • 使用%logger, %caller, %d, %p等占位符来自定义日志输出的格式，这些类似于log4j的模式配置。

集成以上配置后，通过com.noveogroup.android.log.LoggerManager.getLogger()方法获取日志实例，便可以在您的应用中开始记录日志了。

---

本指南概述了Android Logger的基本结构、集成方式以及配置文件的重要性，帮助开发者快速上手此日志工具。记得调整android-logger.properties来满足不同场景下的日志需求。