https://github.com/getactivity/logcat
Android 日志打印框架，在手机上可以直接看到 Logcat 日志啦
https://github.com/getactivity/logcat
android android-studio debug debugger log logcat-viewer logcatview logcatviewer logger logging logutils xlog xlogger
Last synced: 3 days ago
JSON representation
Android 日志打印框架，在手机上可以直接看到 Logcat 日志啦
- Host: GitHub
- URL: https://github.com/getactivity/logcat
- Owner: getActivity
- License: apache-2.0
- Created: 2020-01-24T04:56:07.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2025-09-03T08:46:56.000Z (7 months ago)
- Last Synced: 2025-09-03T10:25:43.171Z (7 months ago)
- Topics: android, android-studio, debug, debugger, log, logcat-viewer, logcatview, logcatviewer, logger, logging, logutils, xlog, xlogger
- Language: Java
- Homepage:
- Size: 48.2 MB
- Stars: 939
- Watchers: 10
- Forks: 116
- Open Issues: 2
-
Metadata Files:
- Readme: README-en.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# [中文文档](README.md)
# Log Viewing Framework
* Project address: [Github](https://github.com/getActivity/Logcat)
* [Click here to download demo apk directly](https://github.com/getActivity/Logcat/releases/download/13.0/Logcat.apk)
  
#### Integration Steps
* If your project's Gradle configuration is `7.0 or below`, add the following to your `build.gradle` file:
```groovy
allprojects {
repositories {
// JitPack remote repository: https://jitpack.io
maven { url 'https://jitpack.io' }
}
}
```
* If your Gradle configuration is `7.0 or above`, add the following to your `settings.gradle` file:
```groovy
dependencyResolutionManagement {
repositories {
// JitPack remote repository: https://jitpack.io
maven { url 'https://jitpack.io' }
}
}
```
* After configuring the remote repository, add the remote dependency in the `build.gradle` file under the app module:
```groovy
android {
// Supports JDK 1.8 and above
compileOptions {
targetCompatibility JavaVersion.VERSION_1_8
sourceCompatibility JavaVersion.VERSION_1_8
}
}
dependencies {
// Log debugging framework: https://github.com/getActivity/Logcat
debugImplementation 'com.github.getActivity:Logcat:13.0'
}
```
#### Support library compatible
* Option 1: Use remote dependencies of the old version framework
```groovy
dependencies {
// Log debugging framework: https://github.com/getActivity/Logcat
debugImplementation 'com.github.getActivity:Logcat:12.5'
}
```
* Option 2: If your project is still in the Support phase and it's not convenient to migrate to **AndroidX** yet, but you want to use the latest version of the framework, you can use the [JetifierStandalone](https://developer.android.com/tools/jetifier#install) tool provided by **Google** to convert the **aar** packages from the released Release versions into **Support-compatible aar** packages using reverse mode.
* You can choose either of the above two options, but it's still not recommended. These are only stopgap measures, not long-term solutions. Subsequent versions of the framework will no longer support **Support** projects. The best approach is to migrate your project to **AndroidX**.
#### compileSdk Version Requirement
* If your project's `compileSdkVersion` is less than 34, please upgrade it to 34 first:
```groovy
android {
compileSdkVersion 34
}
```
* If your project's `compileSdkVersion` is greater than or equal to 34, no modification is needed.
#### Compilation Error Handling
* If you encounter the following compilation error after referencing the framework dependency:
```text
AAPT: error: unexpected element found in .
```
* This indicates that your `Gradle` and `Android Gradle Plugin` versions are too low. Please upgrade `Gradle` to `gradle-7.4-all` or above, and upgrade `Android Gradle Plugin` to `7.1.0` or above.
#### Usage
* No need to call any methods, just run the app and grant the floating window permission.
* It works directly in debug mode. In release mode, the library will not be included in the official package, so you can rest assured.
## [For detailed usage of the framework, please click here](HelpDoc-en.md)
#### Framework Highlights
* Only integration is required, no need to call any methods
* Long press on logs to copy or share
* Supports saving logs locally
* Long logs can be collapsed or expanded by clicking
* Log search results support text highlighting
* Supports filtering logs by specified TAG
* Multiple logs with the same TAG are automatically merged and displayed
* Integrated only in Debug, no manual initialization required
#### Other Open Source Projects by the Author
* Android middle office: [AndroidProject](https://github.com/getActivity/AndroidProject)
* Android middle office kt version: [AndroidProject-Kotlin](https://github.com/getActivity/AndroidProject-Kotlin)
* Permissions framework: [XXPermissions](https://github.com/getActivity/XXPermissions)  
* Toast framework: [Toaster](https://github.com/getActivity/Toaster)
* Network framework: [EasyHttp](https://github.com/getActivity/EasyHttp)
* Title bar framework: [TitleBar](https://github.com/getActivity/TitleBar)
* Floating window framework: [EasyWindow](https://github.com/getActivity/EasyWindow)
* Device compatibility framework：[DeviceCompat](https://github.com/getActivity/DeviceCompat)  
* Shape view framework: [ShapeView](https://github.com/getActivity/ShapeView)
* Shape drawable framework: [ShapeDrawable](https://github.com/getActivity/ShapeDrawable)
* Language switching framework: [Multi Languages](https://github.com/getActivity/MultiLanguages)
* Gson parsing fault tolerance: [GsonFactory](https://github.com/getActivity/GsonFactory)
* Nested scrolling layout framework：[NestedScrollLayout](https://github.com/getActivity/NestedScrollLayout)  
* Android version guide: [AndroidVersionAdapter](https://github.com/getActivity/AndroidVersionAdapter)
* Android code standard: [AndroidCodeStandard](https://github.com/getActivity/AndroidCodeStandard)
* Android resource summary：[AndroidIndex](https://github.com/getActivity/AndroidIndex)  
* Android open source leaderboard: [AndroidGithubBoss](https://github.com/getActivity/AndroidGithubBoss)
* Studio boutique plugins: [StudioPlugins](https://github.com/getActivity/StudioPlugins)
* Emoji collection: [EmojiPackage](https://github.com/getActivity/EmojiPackage)
* China provinces json: [ProvinceJson](https://github.com/getActivity/ProvinceJson)
* Markdown documentation：[MarkdownDoc](https://github.com/getActivity/MarkdownDoc)  
## License
```text
Copyright 2020 Huang JinQun
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```