实体类注解说明

目前支持的注解

---

@Table

注明该实体类对应数据库的表名，标注在class上。使用QmData的auto系列必须注明该注解。一共有两个参数，name/style，如果不提供任何参数，则默认以类名作为表名。

设置表名

• 属性(name)

  该属性标注实体类对应的表名，使用QmData的auto方法必须提供该注解。标注在实体类的class上即可。

设置实体类风格

• 属性(style)

  该属性标注该实体类字段风格类型，参数类型QmStyle枚举类，默认为QmStyle.HUMP即下划线模式，如要修改为驼峰模式则提供QmStyle.HUMP。

---

@Id

注明该字段为主键字段，使用QmData的autoUpdate、autoDelete方法必须提供该注解，而这些方法是通过id进行对数据表的操作。

设置主键别名

• 属性(name)

  > 当类中主键属性名与数据库的主键字段名不一致时，使用`name`属性可改变`QmData`识别的主键字段名，默认为使用当前属性名作为主键。
  

---

@Param

当该字段不需要识别或名称与数据库不一致时，可以使用该注解进行标注。

设置字段别名

• 属性(name)

  当类中属性名与数据库的字段名不一致时，使用name属性可改变QmData识别的字段名，默认为使用当前属性名作为字段名。

排除字段

• 属性(except)

  > 如果在实体类中需要排除某些字段不进行操作，则给`except`设置为`true`即可。默认为`flase`。
  

@OrderBy

从 1.1.0 版本支持自动SQL的排序，注明该实体类使用ORDER BY排序，标注在class上。

设置排序SQL

• 属性(value)

  它的值为ORDER BY关键字后面跟随的字符串。

示例： 进行一次student表中的学号排序，字段如下：

student 表

id	name	st_number
1	浅梦	3
2	唐昊	5
3	宁风致	2

实体类标注@OrderBy("st_number DESC")

@Table(name = "student")
@OrderBy("st_number DESC")
public class Student {
    
    @Id
    private Integer id;
    private String name;
    private Integer stNumber;
    
    // getting setting 省略 ...
}

返回结果

id	name	st_number
2	唐昊	5
1	浅梦	3
3	宁风致	2

上述示例等同于在自动化SQL当中加入了这一条语句： ORDER BY st_number DESC