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.

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

My hometask dependency injection #1005

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
3 changes: 1 addition & 2 deletions src/main/java/mate.academy/Main.java
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,8 @@
public class Main {

public static void main(String[] args) {
// Please test your Injector here. Feel free to push this class as a part of your solution
Injector injector = Injector.getInjector();
ProductService productService = null;
ProductService productService = (ProductService) injector.getInstance(ProductService.class);
List<Product> products = productService.getAllFromFile("products.txt");
products.forEach(System.out::println);
}
Expand Down
8 changes: 7 additions & 1 deletion src/main/java/mate.academy/lib/Component.java
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
package mate.academy.lib;

public @interface Component {
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Component {
}
8 changes: 7 additions & 1 deletion src/main/java/mate.academy/lib/Inject.java
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
package mate.academy.lib;

public @interface Inject {
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Inject {
}
71 changes: 70 additions & 1 deletion src/main/java/mate.academy/lib/Injector.java
Original file line number Diff line number Diff line change
@@ -1,13 +1,82 @@
package mate.academy.lib;

import java.lang.reflect.Constructor;
import java.lang.reflect.Field;
import java.util.HashMap;
import java.util.Map;
import mate.academy.service.FileReaderService;
import mate.academy.service.ProductParser;
import mate.academy.service.ProductService;
import mate.academy.service.impl.FileReaderServiceImpl;
import mate.academy.service.impl.ProductParserImpl;
import mate.academy.service.impl.ProductServiceImpl;

public class Injector {

static {
interfaceImplementations =
Map.of(FileReaderService.class, FileReaderServiceImpl.class,
ProductParser.class, ProductParserImpl.class,
ProductService.class, ProductServiceImpl.class
);
}

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make Interface Implementations map a class field. You can fill it in using Map.of(). However, it should be initialized in a static block or directly upon declaration, not in both places.


private static final Injector injector = new Injector();
private static final Map<Class<?>, Class<?>> interfaceImplementations;
private final Map<Class<?>, Object> instances = new HashMap<>();

public static Injector getInjector() {
return injector;
}

public Object getInstance(Class<?> interfaceClazz) {
return null;

Object clazzImplementationInstance = null;
Class<?> clazzImplementation = findImplementation(interfaceClazz);
if (!clazzImplementation.isAnnotationPresent(Component.class)) {
throw new RuntimeException("Class implementation: "
+ clazzImplementation.getName()
+ "doesn't have 'Component' annotation ");

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When throwing an exception, add an informative message to it. Also, include the caught exception in the RuntimeException to provide a stack trace for easier debugging. For example: throw new RuntimeException("Injection failed, missing @Component annotation on the class " + clazzImplementation.getName(), e);

}
Field[] fields = clazzImplementation.getFields();

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You should use clazz.getDeclaredFields() instead of clazz.getFields() to also include private fields in your search, as getFields() only returns public fields including inherited ones.


for (Field field : fields) {
if (field.isAnnotationPresent(Inject.class)) {
Object fieldTypeObject = getInstance(field.getType());
clazzImplementationInstance = createNewInstance(clazzImplementation);
try {
field.setAccessible(true);
field.set(clazzImplementationInstance, fieldTypeObject);
} catch (IllegalAccessException e) {
throw new RuntimeException("Can't initialize field: " + field.getName());

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When rethrowing the exception, you should include the original exception as a cause to maintain the stack trace. For example: throw new RuntimeException("Can't initialize field: " + field.getName(), e);

}
}
}
if (clazzImplementationInstance == null) {
clazzImplementationInstance = createNewInstance(clazzImplementation);
}
return clazzImplementationInstance;
}

private Object createNewInstance(Class<?> clazzImplementation) {
if (instances.containsKey(clazzImplementation)) {
return instances.get(clazzImplementation);
}
try {
Constructor<?> constructor = clazzImplementation.getConstructor();
Object newInstance = constructor.newInstance();
instances.put(clazzImplementation, newInstance);
return newInstance;
} catch (ReflectiveOperationException e) {

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is better to replace many exceptions that have a common parent with a general parental exception. In this case, you can catch ReflectiveOperationException instead of listing all reflective exceptions separately.

throw new RuntimeException("Can't create instance of class: "
+ clazzImplementation.getName());
}
}

private Class<?> findImplementation(Class<?> clazz) {

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't forget about annotations checks in your Injector class. You should check if the class has the @component annotation before attempting to create an instance.

if (clazz.isInterface()) {
return interfaceImplementations.get(clazz);
}
throw new RuntimeException("Unsupported type class: " + clazz.getName());

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This exception message could be more informative by explaining that the class is not an interface. For example: throw new RuntimeException("Expected an interface but got class: " + clazz.getName());

}
}
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,10 @@
import java.io.IOException;
import java.nio.file.Files;
import java.util.List;
import mate.academy.lib.Component;
import mate.academy.service.FileReaderService;

@Component
public class FileReaderServiceImpl implements FileReaderService {
@Override
public List<String> readFile(String fileName) {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
package mate.academy.service.impl;

import java.math.BigDecimal;
import mate.academy.lib.Component;
import mate.academy.model.Product;
import mate.academy.service.ProductParser;

@Component
public class ProductParserImpl implements ProductParser {
public static final int ID_POSITION = 0;
public static final int NAME_POSITION = 1;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,18 @@

import java.util.List;
import java.util.stream.Collectors;
import mate.academy.lib.Component;
import mate.academy.lib.Inject;
import mate.academy.model.Product;
import mate.academy.service.FileReaderService;
import mate.academy.service.ProductParser;
import mate.academy.service.ProductService;

@Component
public class ProductServiceImpl implements ProductService {
@Inject
private ProductParser productParser;
@Inject
private FileReaderService fileReaderService;

@Override
Expand Down
Loading