Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Chesire/LifecykleLog
Android library to log out Activity and Fragment lifecycle methods
https://github.com/Chesire/LifecykleLog
activity-lifecycle android android-activity android-activity-lifecycle android-architecture android-fragments android-library android-lifecycle android-logging annotation fragment-lifecycle hacktoberfest kotlin kotlin-android lifecycle-methods
Last synced: about 2 months ago
JSON representation
Android library to log out Activity and Fragment lifecycle methods
- Host: GitHub
- URL: https://github.com/Chesire/LifecykleLog
- Owner: Chesire
- License: apache-2.0
- Created: 2019-03-22T21:14:00.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-15T09:56:46.000Z (over 1 year ago)
- Last Synced: 2024-07-11T13:00:26.831Z (2 months ago)
- Topics: activity-lifecycle, android, android-activity, android-activity-lifecycle, android-architecture, android-fragments, android-library, android-lifecycle, android-logging, annotation, fragment-lifecycle, hacktoberfest, kotlin, kotlin-android, lifecycle-methods
- Language: Kotlin
- Homepage:
- Size: 387 KB
- Stars: 22
- Watchers: 2
- Forks: 4
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-list - Chesire/LifecykleLog - Android library to log out Activity and Fragment lifecycle methods (Kotlin)
README
# LifecykleLog
> Library to easily log out Android lifecycle methods for Activities and Fragments.
[](https://android-arsenal.com/details/1/7752)
[](https://codecov.io/gh/Chesire/LifecykleLog)
## Installation
Gradle:
Make sure you have JitPack as a source
```groovy
maven { url 'https://jitpack.io' }
```
add the following line to your `build.gradle`, with version being the latest tag.
```groovy
implementation 'com.github.chesire:lifecyklelog:{version}'
```
## Usage example
Initialize in your application class.
```kotlin
class ApplicationOverride : Application() {
override fun onCreate() {
super.onCreate()
LifecykleLog.initialize(this)
}
}
```
Add the `@LogLifecykle` annotation to the Activity or Fragment that the
lifecycle methods should be logged for.
```kotlin
@LogLifecykle
class MainActivity : AppCompatActivity() { ...
@LogLifecykle
class MainFragment : Fragment() { ...
```
Then lifecycle events will be logged out in logcat.
```text
D/Lifecykle: MainActivity ⇀ onStart
D/Lifecykle: MainFragment ⇀ onAttach
D/Lifecykle: MainFragment ⇀ onCreate
D/Lifecykle: MainFragment ⇀ onCreateView
D/Lifecykle: MainFragment ⇀ onActivityCreated
D/Lifecykle: MainFragment ⇀ onStart
D/Lifecykle: MainActivity ⇀ onResume
D/Lifecykle: MainFragment ⇀ onResume
D/Lifecykle: MainActivity ⇀ onPause
D/Lifecykle: MainFragment ⇀ onPause
D/Lifecykle: MainActivity ⇀ onStop
D/Lifecykle: MainFragment ⇀ onStop
```
## Configuration
### Logging mechanism
By default LogLifecykle will output to `Log.d` with a tag of `Lifecykle`, to
override this behaviour pass an implementation into the
`LifecykleLog.logHandler`.
```kotlin
LifecykleLog.logHandler = LogHandler { clazz, lifecycleEvent, bundle ->
Log.e(clazz, lifecycleEvent)
}
```
This can allow you to use other logging frameworks such as Timber.
```kotlin
LifecykleLog.logHandler = LogHandler { clazz, lifecycleEvent, bundle ->
Timber.i("$clazz -> $lifecycleEvent - $bundle")
}
```
For lifecycle methods which pass a bundle along, it will automatically be pushed
through the LogHandler. In instances where there is no bundle, or it is empty,
then the value will simply be "null".
### Lifecycle methods
To customise which lifecycle methods are logged out, an array of the
`LifecycleEvent` enum can be passed into `LifecykleLog.logEvents`, this can
also be done with the `@LogLifecykle` annotation.
```kotlin
LifecykleLog.logEvents = arrayOf(
LifecycleEvent.ON_CREATE,
LifecycleEvent.ON_DESTROY
)
@LogLifecykle(overrideLogEvents = [LifecycleEvent.ON_START])
class MainActivity : AppCompatActivity() {
@LogLifecykle(overrideLogEvents = [LifecycleEvent.ON_ACTIVITY_CREATED, LifecycleEvent.ON_ATTACH])
class MainFragment : Fragment() {
```
If `logEvents` is provided to the `LifecykleLog` then it will override the
defaults.
If `overrideLogEvents` is provided on the annotation, **only** the methods that
are provided in this will be logged out.
### Class name
To customise the class name that is logged out, a new name can be provided to
the annotation.
```kotlin
@LogLifecykle(className = "MainActivity")
class MainActivity : AppCompatActivity() {
@LogLifecykle(className = "MaybeMainFragment")
class MainFragment : Fragment() {
```
This can be useful if ProGuard strips out the class names and you really need to
see them in the logs. By default the name will be pulled from the objects
`class.java.simpleName`.
### Remove Annotation
If you want to perform logging of *ALL* Activities and Fragments, without
needing to add the annotation to them, then the configuration option
`requireAnnotation` can be set to `false`.
```kotlin
LifecykleLog.requireAnnotation = false
```
This will ignore any annotations that are currently set, and perform logging for
every Activity and Fragment on the lifecycle events defined in
`LifecykleLog.logEvents`.
_For more examples and usage, please refer to the
[sample](https://github.com/Chesire/LifecykleLog/tree/master/lifecyklelog-sample)._
## Contributing
Please read
[CONTRIBUTING.md](https://github.com/Chesire/LifecykleLog/blob/master/CONTRIBUTING.md)
for details on how to contribute.
## License
Apache 2.0 - See
[LICENSE](https://github.com/Chesire/LifecykleLog/blob/master/LICENSE) for more
information.