Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/int02h/primaree
A simple library for safe initialization of multi-process Android applications
https://github.com/int02h/primaree
Last synced: 3 months ago
JSON representation
A simple library for safe initialization of multi-process Android applications
- Host: GitHub
- URL: https://github.com/int02h/primaree
- Owner: int02h
- License: mit
- Created: 2020-03-24T18:51:59.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-07-13T12:07:19.000Z (12 months ago)
- Last Synced: 2024-01-17T02:31:09.156Z (5 months ago)
- Language: Kotlin
- Homepage:
- Size: 148 KB
- Stars: 70
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-list - int02h/primaree - A simple library for safe initialization of multi-process Android applications (Kotlin)
README
# Primaree
[](https://travis-ci.com/github/int02h/primaree)
[](https://github.com/int02h/primaree/releases/latest)
Primaree - a simple library for safe initialization of multi-process
Android applications.
### But I have only one process
You think so. But if you take a look at your merged
`AndroidManifest.xml` you may notice that there are some services,
content providers or other Android components that specify
`android:process` - so they work in different processes.
### What's the problem?
The problem is that your `Application.onCreate()` method is being called
as many times as many processes your application has. It means that you
can accidentally initialize your code twice, thrice or even more times.
This may lead to deadlocks or concurrent access to entities that are not
supposed to have concurrent access. For example, SQLite.
### What Primaree actually does?
Just look at the following code:
```kotlin
class App : PrimareeApplication() {
override fun onPrimaryCreate() {
// ...
}
override fun onSecondaryCreate(name: String) {
// ...
}
override fun onPrimaryConfigurationChanged() {
// ...
}
override fun onSecondaryConfigurationChanged(name: String) {
// ...
}
}
```
Primaree provides abstract class `PrimareeApplication` you can inherit
from. Its main purpose is to separate every considerable call in
Application (such as `onCreate` or `onConfigurationChanged`) into two
calls like `onPrimaryCreate` and `onSecondaryCreate`. These methods are
called in the primary process of your application and every secondary
process respectively. All secondary calls also receive the name of the
secondary process as their argument in the same format it appears in
`AndroidManifest.xml`.
It worth to be mentioned that `onCreate` and other considerable calls
are marked `final` so you forced to split your app initialization for
primary and secondary processes. It makes you never forget that
the application is multi-process.
### What if my application class inherits another base class?
In this situation, Primaree is still able to help. It has few handy
extensions for the Application class. You may use them as the following:
```kotlin
class App : Application() {
override fun onCreate() {
super.onCreate()
runIfPrimaryProcess {
// do something in primary process
}
if (isPrimaryProcess) {
// do something in primary process
} else {
// do something in secondary process
}
}
}
```
## Download
Add the following dependency to your `build.gradle` script:
```groovy
dependencies {
implementation 'com.dpforge:primaree:1.2.2'
}
```
## License
Copyright (c) 2023 Daniil Popov
Licensed under the [MIT](LICENSE) License.