New @Mapper marker annotation for DI frameworks

[emacarron]

A new annotation has been created so they can use it for scanning purposes.

Change in b6977e6

Know about the history in mybatis/spring-boot-starter#46

[jefffangji]

The @Mapper annotation is not showed in Mapper Annotations of document http://www.mybatis.org/mybatis-3/java-api.html. Is the annotation public to the users without using spring, boot or CDI?

[mnesarco]

Hi Guys, I have just noticed this message and I am wondering if is there any conflict with the Mapper annotation already existing in mybatis-cdi: https://github.com/mybatis/cdi/blob/master/src/main/java/org/mybatis/cdi/Mapper.java

…

On Fri, Apr 21, 2017 at 1:24 AM, Jeff Fang ***@***.***> wrote: The @Mapper <https://github.com/Mapper> annotation is not showed in Mapper Annotations of document http://www.mybatis.org/ mybatis-3/java-api.html. Is the annotation public to the users without using spring, boot or CDI? — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#629 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ABCXVWonqDspUOaxjZcT250ywe-j0E6-ks5ryEungaJpZM4IDpUm> .

-- Frank D. Martínez M.

[jefffangji]

Hi Mnesarco, I'm not using mybatis-cdi. Actually, I want to scan the mapper interfaces by myself with the new added @Mapper interface, but the annotation seems not be displayed in mybatis document. Is it recommended to use the annotation for scanning mapper interfaces for regular users(not mybatis-cdi or spring-boot developer)?

[harawata]

@mnesarco ,
I am not sure if it actually causes issue or not, but it probably makes more sense to use the one in the core.

@jefffangji ,
What happens if your project adopt MyBatis-CDI or Spring in future?
If there is no change required, it may be fine to use this annotation.
Otherwise, it would be safer to use a custom marker annotation.

[jefffangji]

Our project is based on Play and MyBatis-Guice. And I don't find there is mapper auto-scan functionality in MyBatis-Guice. That's why I need to scan the mappers by myself.

[mnesarco]

@harawata ,
The Annotation in the core is a little different from the one in cdi. To make the Annotation work friendly with cdi containers it should be annotated with Stereotype, also the annotation in cdi is only targeted to TYPE. What I propose is to make cdi aware of both annotations, but it will work better with the annotation in cdi. I am afraid the annotation in the core was created without a real use case, it was created just in case for future use and is not included in documentation. I prefer each DI framework to have their own annotations.

[harawata]

@mnesarco ,
Thank you for the explanation.

I prefer each DI framework to have their own annotations.

Now I agree with you.
I assumed that @Mapper in the core can be used in CDI as well, but if that's not the case, it may be better to 1) have one in each module and 2) deprecate the core one.
It could be a confusing change to mybatis-spring-boot users, though.

@emacarron @eddumelendez @kazuki43zoo @jeffgbutler
Any thoughts?

@jefffangji ,
As you can see, you should create and use your own annotation :)

[kazuki43zoo]

@harawata @mnesarco
I agree with you.

It could be a confusing change to mybatis-spring-boot users, though.

I think so. I think we should be provide a migration period for mybatis-spring-boot users. (e.g. Change to deprecated annotation (+ provide a new annotation) -> Remove @Mapper annotation in core)

[kazuki43zoo]

@harawata @eddumelendez

I will propose adding new @Mapper annotation on mybatis-spring (not rather than mybatis-spring-boot) because mapper scaning feature provide by mybatis-spring.

[harawata]

@kazuki43zoo Sounds good to me.
You should create a PR on mybatis-spring and ask others for a review.
Thank you!