深入理解 @TableName 和 @TableField 注解

简介: 深入理解 @TableName 和 @TableField 注解

@TableName 注解


@TableName 注解用于指定 Java 实体类与数据库表的映射关系,尤其在表名与实体类名不一致或不符合命名规范时(驼峰命名)时非常有用。这个注解通常与对象关系映射(ORM)框架一同使用,比如 MyBatis 或 Hibernate。


例子:
@TableName(value = "custom_table_name")
public class CustomEntity {
    // 类的定义
}


在这个例子中,CustomEntity 类将映射到数据库表 "custom_table_name"。


custom_table_name是数据库表的名称。通过在类上添加@TableName注解并指定表名,ORM框架将会将该类与指定的数据库表进行映射。


使用@TableName注解的好处是可以提高代码的可读性和维护性。通过在类上直接指定表名,我们可以清晰地了解该类对应的数据库表是哪个,避免了在代码中散落的表名字符串,提高了代码的可读性和可维护性。


注意

具体的ORM框架可能有自己的注解,例如MyBatis中使用的是@Table注解。因此,在具体使用时,应根据所使用的ORM框架来选择相应的注解。


@TableField 注解

@TableField 注解主要解决两个问题:一是实体类的字段名与数据库中字段名不匹配,二是实体类中存在的属性在表中不存在的问题。


例子:
public class User {
    @TableField(value = "user_age")
    private Integer age;
    
    @TableField(exist = false)
    private String additionalField;
 
    // 其他属性和方法
}


  • @TableField(value = "user_age"): 解决了数据库中字段名为 "user_age",而实体类中的属性为 age 的不匹配问题。
  • @TableField(exist = false): 表示实体类中的 additionalField 属性在数据库表中不存在,这在某些场景下是非常有用的。

@TableId 注解

@TableId 注解用于标识实体类的属性为主键,并可以指定主键的生成策略。这个注解通常与数据库表的主键字段相关联。


通俗来讲,在关系型数据库中,每个表都需要一个主键来唯一标识表中的每一行数据。在ORM框架中,我们可以使用@TableId注解来指定Java类的某个字段作为数据库表的主键。

例子:
1. @TableId(value = "column_name",type = IdType.AUTO)
2.private Long id;
  • @TableId(type = IdType.AUTO): 表示 id 属性是主键,并使用自动增长(AUTO)的方式生成主键值。IdType 提供了多种生成策略,比如全局唯一ID、UUID 等。

这里将id字段作为主键,它对应数据库表中的column_name列。

更多注解的拓展

除了上述注解外,ORM框架还可能提供其他注解,如 @Version 用于乐观锁控制,@TableLogic 用于逻辑删除标记等。这些注解能够更精细地定义实体类与数据库表之间的映射关系,以及实现一些高级的数据库操作功能。

例子:

@Version
private Integer version; // 乐观锁字段
 
@TableLogic
private Integer deleted; // 逻辑删除标记字段


@Version 用于标识乐观锁字段,@TableLogic 用于标记逻辑删除字段。这样的注解能够使得实体类更加灵活,适应不同的业务场景。


总体而言,通过深入理解这些注解,开发人员可以更好地利用ORM框架,提高代码的可维护性和数据库操作的灵活性。


如果有其他问题,可以留言或者私信哈~


相关文章
|
14天前
|
Java 数据库连接
hibernate注解实体类(Dept.java)
hibernate注解实体类(Dept.java)
18 1
|
14天前
|
Java 数据库连接
Hibernate中使用Criteria查询及注解——(Dept.java)
Hibernate中使用Criteria查询及注解——(Dept.java)
17 1
|
14天前
|
SQL Java 数据库连接
不标识@TableName、@TableField和@TableID注解会发生什么?
不标识@TableName、@TableField和@TableID注解会发生什么?
|
14天前
|
存储 Java 关系型数据库
MyBatisPlus中的TypeHandler | 自定义字段类型转换Handler
MyBatisPlus中的TypeHandler | 自定义字段类型转换Handler
207 0
|
14天前
|
Java 数据库连接
Hibernate中使用Criteria查询及注解——(Emp.java)
Hibernate中使用Criteria查询及注解——(Emp.java)
10 0
|
14天前
|
Java 数据库连接
Hibernate中使用Criteria查询及注解——(Emp.hbm.xml)
Hibernate中使用Criteria查询及注解——(Emp.hbm.xml)
14 2
|
14天前
|
Java 数据库连接
hibernate注解实体类(Emp.java)
hibernate注解实体类(Emp.java)
18 1
|
Java 数据库连接
Hibernate中使用Criteria查询及注解——(Dept.hbm.xml)
Hibernate中使用Criteria查询及注解——(Dept.hbm.xml)
28 0
|
Java 数据库连接
Hibernate中使用Criteria查询及注解——(HibernateUtil)
Hibernate中使用Criteria查询及注解——(HibernateUtil)
31 0
|
数据库 索引
@Table注解
@Table注解