Common Annotations

Bean Management Annotations

Data Binding Annotations

Database Annotations

1. EzyAutoImpl

When you annotate a interface with EzyAutoImpl annotation, a framework will recognize this interface and implement it automatically. In this example ChatMessageRepo will be implemented by ezydata-mongodb.

    @EzyAutoImpl("messageRepo")
    public interface ChatMessageRepo extends EzyMongoRepository {}

2. EzyFeature

When you want to map a feature name with an API, a method or a class (apply for all methods in the class), you can use EzyFeature annotation. In MetricsController every APIs will be mapped with a feature name:

    @Controller
    public class MetricsController implements ManagementController {
        @EzyFeature(DEFAULT_FEATURE_NAME)
        @DoGet("/management/start-time")
        public long getStartTime() {}
    }

3. EzyId

When you have a composite id in an entity, you can use EzyId annotation for the id class, example ChatChannelUserId:

    @EzyId
    public class ChatChannelUserId {
        private long channelId;
        private String user;
    }

If you want to indicate a field or a methods (getter/setter) is the id property of an entity, you can use this annotation, example ChatChannel:

    @EzyId
    public class ChatChannelUserId {
        private long channelId;
        private String user;
    }

4. EzyImport

Sometimes, you don't want to scan a package, you just want to include some classes to the bean management, you can use EzyImport annotation, example:

    @EzyImport(DatabaseConfiguration.class)
    public class Configuration {}

5. EzyKeyValue

If you want to add some additional properties to a bean, you can use EzyKeyValue annotation, example:

    @EzySingleton(properties = {
        @EzyKeyValue(key = "type", value = "request_listener"),
        @EzyKeyValue(key = "cmd", value = "1"),
        @EzyKeyValue(key = "priority", value = "1")
    })
    public class HelloRequestHandler {}

6. EzyManagement

If you want to indicate an API or a method or a class (apply to all methods in the classes) is management, you can use EzyManagement annotation, example:

    @Controller("/api/v1")
    public class MetricsController {
        @EzyManagement
        @DoGet("/metrics")
        public Object metricsGet() {}
    }

7. EzyPackagesToScan

Sometimes you will need include one or more packages to scan beans. you can use EzyPackagesToScan, example:

    @EzyPackagesToScan("com.example.app.api")
    public class GlobalConfig {}

8. EzyPayment

If you want to indicate an API or a method or a class (apply to all methods in the classes) is payment, you can use EzyPayment annotation, example:

    @EzyPayment
    @Controller("/api/v1.2.2")
    public class PaymentController {
        @DoGet("/get-something")
        public void getSomeThing() {}
        @DoGet("/get-and-buy-something")
        public void getAndBuySomeThing() {}
    }

9. EzyProperty

When you want to map a property value or system property value or system environment value to a field or setter method, you can use EzyProperty annotation like this:

    @Setter
    public class GameProperty {
        @EzyProperty("game.max_room")
        private int maxRoom;
        @EzyProperty("game.max_player")
        private int maxPlayers;
    }