Java实体类常用注解的用法

 更新时间:2025年06月20日 08:41:38   作者:hoho不爱喝酒  
这篇文章主要介绍了Java实体类常用注解的用法,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教

在 Java 开发中,实体类(Entity Class)是表示数据结构的重要组成部分。为了方便地对实体类进行操作和管理,我们经常会使用一些注解来标记实体类的属性和方法。

本文将介绍一些常用的 Java 实体类注解,并解释它们的作用和用法。

一、属性赋值,构造方法

引入依赖:

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.4</version>
</dependency>

1、@Data

是 Lombok 提供的注解,用于简化 Java 类的编写,自动生成 Getter、Setter、equals、hashCode、toString 等方法。@Data 注解包含以下注解的功能:

  1. @Getter:自动生成 Getter 方法。
  2. @Setter:自动生成 Setter 方法。
  3. @ToString:自动生成 toString 方法。
  4. @EqualsAndHashCode:自动生成 equals 和 hashCode 方法。

使用 @Data 注解可以减少重复的样板代码,提高代码的简洁性和可读性。例如:

@Data
public class Person {
    private String name;
    private int age;
}

上述代码等效于手动编写了以下代码:

public class Person {
    private String name;
    private int age;
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public int getAge() {
        return age;
    }
    public void setAge(int age) {
        this.age = age;
    }
    @Override
    public String toString() {
        return "Person{" +
                "name='" + name + '\'' +
                ", age=" + age +
                '}';
    }
    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        Person person = (Person) o;
        return age == person.age &&
                Objects.equals(name, person.name);
    }
    @Override
    public int hashCode() {
        return Objects.hash(name, age);
    }
}

可以看到,使用 @Data 注解可以大大简化类的编写,减少了样板代码。

2、@NoArgsConstructor、@AllArgsConstructor

@NoArgsConstructor相当于无参构造方法、@AllArgsConstructor相当于有参构造方法

二、数据库映射

以上是mybatis-plus常用实体注解

1、@TableName

表名注解,标识实体类对应的表

2、@TableId

主键注解,与@TableField不能同时使用

3、@TableField

字段注解(非主键)

使用:

@TableName("student")
public class Student{
    @TableId
    private String id;
    @TableField("stu_name")
    private String stuName;
    @TableField("stu_age")
    private Integer stuAge;
    @TableField("birth_date")
    private Date birthDate;
}

三、属性格式校验

1、@NotNull

被注释的字段不能为空

2、@NotEmpty

被注释的字符串必须非空

3、@Email

被注释的元素必须是电子邮件地址

4、@Pattern

正则校验,例如:

@Pattern(regexp="1\\d{10}",message="手机号格式错误")

四、日期格式转换

1、@DatetimeFormat

将String转换成Date。

2、@JsonFormat(pattern=“yyyy-MM-dd”)

将Date转换成指定时间格式的String。

@JsonFormat(pattern = "yyyy-MM-dd")
private Date createTime;

3、@JsonFormat(pattern=“yyyy-MM-dd”,timezone=“GMT+8”)

会让时间以0区时间显示。

@JsonFormat(pattern="yyyy-MM-dd",timezone="GMT+8")
private Date createTime;

五、类/属性说明

1、@ApiModel

用于实体类,表示对类进行说明,用于参数用实体类接收。

2、@ApiModelProperty

用于类中属性,表示对 属性的说明。

总结

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • Java利用POI读写Excel文件工具类

    Java利用POI读写Excel文件工具类

    这篇文章主要为大家详细介绍了Java利用POI读写Excel文件的工具类,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2020-12-12
  • Java中的按值传递和按引用传递的代码详解

    Java中的按值传递和按引用传递的代码详解

    本文通过实例代码给大家介绍了Java中的按值传递和按引用传递的相关知识,感兴趣的朋友跟随脚本之家小编一起学习吧
    2018-06-06
  • springboot单文件下载和多文件压缩zip下载的实现

    springboot单文件下载和多文件压缩zip下载的实现

    这篇文章主要介绍了springboot单文件下载和多文件压缩zip下载的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-11-11
  • Springboot swagger配置过程详解(idea社区版2023.1.4+apache-maven-3.9.3-bin)

    Springboot swagger配置过程详解(idea社区版2023.1.4+apache-maven-3

    这篇文章主要介绍了Springboot-swagger配置(idea社区版2023.1.4+apache-maven-3.9.3-bin),本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2023-07-07
  • java实现多客户聊天功能

    java实现多客户聊天功能

    这篇文章主要为大家详细介绍了java实现多客户聊天功能,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-08-08
  • 关于Maven依赖冲突解决之exclusions

    关于Maven依赖冲突解决之exclusions

    这篇文章主要介绍了关于Maven依赖冲突解决之exclusions用法,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-12-12
  • springboot整合jquery和bootstrap框架过程图解

    springboot整合jquery和bootstrap框架过程图解

    这篇文章主要介绍了springboot整合jquery和bootstrap框架过程图解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-12-12
  • Spring Cloud 专题之Sleuth 服务跟踪实现方法

    Spring Cloud 专题之Sleuth 服务跟踪实现方法

    这篇文章主要介绍了Spring Cloud 专题之Sleuth 服务跟踪,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-08-08
  • 使用ClassFinal实现SpringBoot项目jar包加密的操作指南

    使用ClassFinal实现SpringBoot项目jar包加密的操作指南

    在实际开发中,保护项目的安全性和保密性是至关重要的,针对于 Spring Boot 项目,我们需要将 JAR 包进行加密从而有效地防止未经授权的访问和修改,本文将介绍如何使用ClassFinal在 Spring Boot 项目中实现 JAR 包加密,需要的朋友可以参考下
    2024-06-06
  • mybatis实现mapper代理模式的方式

    mybatis实现mapper代理模式的方式

    本文向大家讲解mybatis的mapper代理模式,以根据ide值查询单条数据为例编写xml文件,通过mapper代理的方式进行讲解增删改查,分步骤给大家讲解的很详细,对mybatis mapper代理模式相关知识感兴趣的朋友一起看看吧
    2021-06-06

最新评论