Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README table #512

Merged
merged 4 commits into from
Feb 25, 2024
Merged

Update README table #512

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
dbae85d
javadoc badge
SentryMan Feb 23, 2024
06ab2a5
Update README.md
SentryMan Feb 23, 2024
fb607cb
Add dagger to the DI comparison
SentryMan Feb 25, 2024
bdf3e26
Update README.md
SentryMan Feb 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
102 changes: 34 additions & 68 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
[![Discord](https://img.shields.io/discord/1074074312421683250?color=%237289da&label=discord)](https://discord.gg/Qcqf9R27BR)
[![Build](https://github.com/avaje/avaje-inject/actions/workflows/build.yml/badge.svg)](https://github.com/avaje/avaje-inject/actions/workflows/build.yml)
[![JDK EA](https://github.com/avaje/avaje-inject/actions/workflows/jdk-ea.yml/badge.svg)](https://github.com/avaje/avaje-inject/actions/workflows/jdk-ea.yml)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/avaje/avaje-inject/blob/master/LICENSE)
[![Maven Central : avaje-inject](https://img.shields.io/maven-central/v/io.avaje/avaje-inject.svg?label=Maven%20Central)](https://maven-badges.herokuapp.com/maven-central/io.avaje/avaje-inject)
[![Discord](https://img.shields.io/discord/1074074312421683250?color=%237289da&label=discord)](https://discord.gg/Qcqf9R27BR)
[![javadoc](https://javadoc.io/badge2/io.avaje/avaje-inject/javadoc.svg?color=purple)](https://javadoc.io/doc/io.avaje/avaje-inject)

# [Avaje-Inject](https://avaje.io/inject)
APT-based dependency injection for server-side developers - https://avaje.io/inject
Expand All @@ -25,19 +26,6 @@ APT-based dependency injection for server-side developers - https://avaje.io/inj
</dependency>
```

**JDK 23+**

In JDK 23+, annotation processors are disabled by default, you will need to add a flag in maven to re-enable the processor.
```xml
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
<compilerArgument>-proc:full</compilerArgument>
</configuration>
</plugin>
```

#### 3. Create a Bean Class annotated with @Singleton
```java
@Singleton
Expand Down Expand Up @@ -84,60 +72,6 @@ module org.example {
}
```

## Similar to [Dagger](https://google.github.io/dagger/)

- Uses Java annotation processing for dependency injection
- Generates source code
- Avoids any use of reflection or classpath scanning (so low overhead and fast startup)

## Differences to Dagger

- Aimed specifically for server-side development (rather than Android)
- Supports lifecycle methods with `@PostConstruct` and `@PreDestory`
- Supports `@Factory` and `@Bean`
- Provides API to obtain all bean instances that implement an interface
- Provides API to obtain all bean instances that have an annotation
- Integration with server-side web frameworks Javalin, Helidon

## Spring DI comparison

| Avaje | Spring
| :--- | :--- |
| [@Singleton](https://avaje.io/inject/#singleton) | @Component, @Service, @Repository |
| [Provider&lt;T>](https://avaje.io/inject/#provider) | FactoryBean&lt;T> |
| [@Inject](https://avaje.io/inject/#inject) | @Inject, @Autowired |
| [@Inject @Nullable](https://avaje.io/inject/#nullable) or [@Inject Optional&lt;T>](https://avaje.io/inject/#optional) | @Autowired(required=false) |
| [@PostConstruct](https://avaje.io/inject/#post-construct) | @PostConstruct|
| [@PreDestroy](https://avaje.io/inject/#pre-destroy) | @PreDestroy |
| [@Factory and @Bean](https://avaje.io/inject/#factory) | @Configuration and @Bean |
| [@RequiresBean and @RequiresProperty](https://avaje.io/inject/#conditional) | @Conditional |
| [@Primary](https://avaje.io/inject/#primary) | @Primary |
| [@Secondary](https://avaje.io/inject/#secondary) | @Secondary |
| [@AssistFactory](https://avaje.io/inject/#assistInject) | - |

## Generated Code

### DI classes

DI classes will be generated to call the constructors for annotated type/factory methods. Below is the class generated for the `Example` class in the above quickstart.

```java
@Generated("io.avaje.inject.generator")
public final class Example$DI {

/**
* Create and register Example.
*/
public static void build(Builder builder) {
if (builder.isAddBeanFor(Example.class)) {
var bean = new Example(builder.get(DependencyClass.class,"!d1"), builder.get(DependencyClass2.class,"!d2"));
builder.register(bean);
// depending on the type of bean, callbacks for field/method injection, and lifecycle support will be generated here as well.
}
}
}
```

### Generated Wiring Class
The inject annotation processor determines the dependency wiring order and generates a `Module` class that calls all the generated DI classes.

Expand Down Expand Up @@ -200,3 +134,35 @@ public final class ExampleModule implements Module {
}
}
```

## Similar to [Dagger](https://google.github.io/dagger/)

- Uses Java annotation processing for dependency injection
- Generates source code
- Avoids any use of reflection or classpath scanning (so low overhead and fast startup)

## Differences to Dagger

- Specifically Aimed for server-side development (rather than Android)
- Provides API to obtain all bean instances that implement an interface
- Lifecycle methods with `@PostConstruct` and `@PreDestory`
- Spring-like factory classes with `@Factory` and `@Bean`
- Conditional Wiring based on active profiles or existing beans/properties

## DI Framework comparison

| Avaje | Dagger | Spring
| :--- | :--- | :--- |
| [@Singleton](https://avaje.io/inject/#singleton) | @Singleton | @Component, @Service, @Repository |
| [Provider&lt;T>](https://avaje.io/inject/#provider) | Provider&lt;T> | FactoryBean&lt;T>
| [@Inject](https://avaje.io/inject/#inject) | @Inject | @Inject, @Autowired
| [@Inject @Nullable](https://avaje.io/inject/#nullable) or [@Inject Optional&lt;T>](https://avaje.io/inject/#optional) | @Inject @Nullable | @Autowired(required=false)
| [@Qualifier/@Named](https://avaje.io/inject/#qualifiers) | @Qualifier/@Named | @Qualifier
| [@AssistFactory](https://avaje.io/inject/#assistInject) | @AssistedFactory | - |
| [@PostConstruct](https://avaje.io/inject/#post-construct) | - | @PostConstruct
| [@PreDestroy](https://avaje.io/inject/#pre-destroy) | - | @PreDestroy
| [@Factory and @Bean](https://avaje.io/inject/#factory) | - | @Configuration and @Bean
| [@RequiresBean and @RequiresProperty](https://avaje.io/inject/#conditional) | - | @Conditional
| [@Primary](https://avaje.io/inject/#primary) | - | @Primary
| [@Secondary](https://avaje.io/inject/#secondary) | - | @Secondary
| [@InjectTest](https://avaje.io/inject/#component-testing) | - | @SpringBootTest
Loading