com.github.yulichang.annotation.EntityMapping Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mybatis-plus-join-annotation Show documentation

An enhanced toolkit of Mybatis-Plus to simplify development.

There is a newer version: 1.5.2

Show newest version

package com.github.yulichang.annotation;


import java.lang.annotation.*;

/**
 * 实体类关系映射注解
 *
 * @author yulichang
 * @since 1.2.0
 */
@Documented
@SuppressWarnings({"unused"})
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.ANNOTATION_TYPE})
public @interface EntityMapping {

    /**
     * 关联的数据库实体类

     * 默认获取此注解所对应的类
     */
    Class tag() default Object.class;

    /**
     * 当前类的关联的字段名称 (是实体类字段名称而不是数据库字段名称)

     * 默认获取当前类上定义的主键 @TableId
     */
    String thisField() default "";

    /**
     * 关联类的字段名称 (是实体类字段名称而不是数据库字段名称)

     * 默认获取关联类上定义的主键 @TableId
     */
    String joinField() default "";

    /**
     * 一对一查询时 如果查询到多条记录是否抛出异常

     * true  抛出异常

     * false 不抛异常，获取列表第一条数据

     */
    boolean isThrowExp() default true;

    /**
     * 注意!!! 填 属性名
     * 映射表查询条件之 select

     * 等效于 Wrappers.query().select(xxx);
     */
    String[] select() default "";

    /**
     * 映射表查询条件之 first

     * 等效于 Wrappers.query().first(xxx);
     */
    String first() default "";

    /**
     * 映射表查询条件之 apply

     * 等效于 Wrappers.query().apply(xxx);
     */
    Apply[] apply() default {};

    /**
     * 映射表查询条件
     */
    Condition[] condition() default {};

    /**
     * 映射表查询条件之 orderBy

     * 等效于 Wrappers.query().orderByAsc(xxx);
     */
    String orderByAsc() default "";

    /**
     * 映射表查询条件之 orderByDesc

     * 等效于 Wrappers.query().orderByDesc(xxx);
     */
    String orderByDesc() default "";

    /**
     * 映射表查询条件之 last

     * 建议不要在这使用分页语句，会导致关联查的时候查询不全

     * 等效于 Wrappers.query().last(xxx);
     */
    String last() default "";
}