Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adennie/fb-android-dagger
A set of helper classes for using dagger 1 with Android components such as Applications, Activities, Fragments, BroadcastReceivers, and Services.
https://github.com/adennie/fb-android-dagger
Last synced: 9 days ago
JSON representation
A set of helper classes for using dagger 1 with Android components such as Applications, Activities, Fragments, BroadcastReceivers, and Services.
- Host: GitHub
- URL: https://github.com/adennie/fb-android-dagger
- Owner: adennie
- License: apache-2.0
- Created: 2013-05-24T16:17:26.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2015-10-06T12:44:56.000Z (about 9 years ago)
- Last Synced: 2024-08-02T09:29:05.281Z (3 months ago)
- Language: Java
- Homepage:
- Size: 454 KB
- Stars: 282
- Watchers: 13
- Forks: 24
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
##fb-android-dagger
A set of helper classes for using [dagger](https://github.com/square/dagger) with Android components such as
Applications, Activities, Fragments, BroadcastReceivers, and Services.
Maven users:
```xml
com.fizz-buzz
fb-android-dagger
1.0.6
```
Note: this project's POM specifies dependencies for the Android SDK and the support v4 library using the
group IDs, artifact IDs, and version numbers created by the [Maven Android SDK Deployer]
(https://github.com/mosabua/maven-android-sdk-deployer), as opposed to the ones in Maven Central, which contains
artifacts that are unofficial and out of date. If you want to use the ones in Maven Central anyway, just update
those dependencies in the POM.
####Overview
fb-android-dagger provides a set of base classes for using dagger in Android applications. It follows a convention exemplified by Square's sample application, whereby a base class calls getModules() to gather the set of modules that its subclass(es) need to be part of the graph, then creates an object graph from those modules and injects itself.
The following classes are provided, each implementing this technique in the method indicated in parentheses:
- `InjectingApplication` (onCreate)
- `InjectingBroadcastReceiver` (onReceive)
- `InjectingAppWidgetProvider` (onReceive)
- `InjectingService` (onCreate)
- `InjectingActivity` (onCreate)
- `InjectingActionBarActivity` (onCreate)
- `InjectingFragmentActivity` (onCreate)
- `InjectingPreferenceActivity` (onCreate)
- `InjectingFragment` (onAttach)
- `InjectingListFragment` (onAttach)
- `InjectingDialogFragment` (onAttach)
####The graphs
`InjectingApplication` creates an application-scope graph.
`InjectingBroadcastReciever`, `InjectingAppWidgetProvider`, `InjectingService`, and the various `Injecting...Activity` classes each extend the application-scope graph with their own module(s), resulting in a graph scoped to their own component.
The various `Injecting...Fragment` classes extend their corresponding activity's graph.
####Modules
Each component type has an associated module:
- `InjectingActivityModule`
- `InjectingServiceModule`
- `InjectingBroadcastRecieverModule`
- `InjectingActivityModule`
- `InjectingFragmentModule`
The last two are shared by the `Injecting...Activity` classes and the `Injecting...Fragment` classes, respectively. These modules define provider methods which enable injection of objects relevant to their component type. They all have a provider that returns the component itself in the form of an Injector interface:
```java
public interface Injector {
public ObjectGraph getObjectGraph();
public void inject(Object target);
}
```
Qualifier annotations defined in the various modules allow for specific components' injectors to be accessed:
```java
class Foo1 {
@Inject @Application Injector appInjector;
@Inject @Activity Injector activityInjector;
@Inject @Fragment Injector fragInjector;
//...
}
```
Application and Activity Contexts are similarly accessible:
```java
class Foo2 {
@Inject @Application Context appContext;
@Inject @Activity Context activityContext;
// ...
}
```
...as are the typed components themselves:
```java
class Foo3 {
@Inject Application theApp;
@Inject Activity myActivity;
@Inject Fragment myFragment;
// ...
}
```
####Developed by
Andy Dennie - [email protected]
####License
Copyright 2014 Fizz Buzz LLC
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.