entity 怎么用 实体类使用方法
entity 也就是实体类,核心作用是把数据库表或者业务里的数据封装成 Java 对象,让代码可以用面向对象的方式操作数据,不用直接写原生 SQL 处理字段,是 Java 后端开发尤其是 SSM SpringBoot 项目里最基础也最常用的组件,它本质就是一个普通 POJO 类,用来映射数据结构,承载数据的传输存储和业务处理。之所以要使用 entity,是因为数据库是二维表结构,而程序是面向对象编程,两者结构不一样,entity 作为中间桥梁,把表的每一列对应成类里面的成员变量,一行表数据就对应一个 entity 对象,这样增删改查的时候直接操作对象属性,代码可读性维护性都会大幅提升,还能统一数据格式,方便和前端接口传参、数据库持久层框架交互。
基础编写规范
entity 类编写有固定的基础要求,记住这几点就可以写出标准实体类
1 类名一般和业务或者数据表对应,采用大驼峰命名,比如用户表对应的类名就是 User
2 所有成员变量也就是属性,使用 private 私有修饰,不直接对外暴露
3 提供无参构造方法,持久层框架反射创建对象的时候必须依赖无参构造
4 提供全参构造方法,方便一次性给所有属性赋值
5 生成 getter 和 setter 方法,用来读取和修改私有属性
6 重写 toString 方法,方便调试打印对象内容
7 可以按需重写 equals 和 hashCode,用来比较两个实体对象是否相同
SpringBoot 搭配 JPA 或者 MyBatis 使用步骤
这里以最常见 SpringBoot 项目为例,讲解 entity 完整使用流程
第一步 新建 entity 包,包名一般为 entity 或者 domain,专门存放所有实体类,和 controller service mapper 包分开管理,保持项目分层清晰
第二步 编写实体类,添加对应的注解,如果是 JPA 需要加上 @Entity @Table 注解,@Table 用来指定对应的数据库表名,每个属性加上 @Column 指定表字段名,如果是 MyBatis 普通实体类可以不加注解,依靠字段名和表字段自动映射,开启驼峰转换即可
第三步 编写持久层接口,JPA 是 Repository 接口,MyBatis 是 Mapper 接口,接口方法就可以直接传入或者返回 entity 对象,查询数据库之后框架自动把表数据填充到 entity 对象里面
第四步 在 Service 业务层引入 Mapper 或者 Repository,业务逻辑里面操作 entity 对象,读取修改属性,完成业务计算
第五步 在 Controller 控制层接收前端参数封装成 entity,或者把查询得到的 entity 返回给前端做 JSON 响应
普通 SSM 项目 entity 使用要点
SSM 项目里面 entity 不需要 JPA 注解,就是纯 POJO,MyBatis 的 xml 映射文件里面 resultMap 可以手动配置 entity 属性和数据库列的映射关系,当数据库字段和实体属性命名不一致的时候,就靠 resultMap 完成映射,业务层拿到 entity 之后进行业务处理,DAO 层执行 SQL,查询结果自动封装成 entity 实例。
entity 使用注意事项
entity 只负责承载数据,不要在 entity 里面写复杂业务逻辑,业务代码统一放到 Service 层,保持单一职责。属性类型要和数据库字段类型匹配,数据库 varchar 对应 String,int 对应 Integer,datetime 对应 Date 或者 LocalDateTime。如果后续表新增字段,记得同步修改 entity,增加对应的属性 getter setter,不然会出现字段丢失映射失败。
表格 entity 和数据库对应关系示例
| 数据库表字段 | entity 属性 | Java 类型 |
|---|---|---|
| id | id | Long |
| user_name | userName | String |
| age | age | Integer |
| create_time | createTime | LocalDateTime |
【常见问题】
问题 1 entity 必须要加 JPA 注解才能使用吗
回答 1 entity 不是必须加 JPA 注解,普通 MyBatis 项目里面 entity 就是普通 POJO 类,不需要任何 JPA 注解,只要属性名和数据库字段匹配,开启驼峰命名转换就可以正常封装数据,JPA 注解只是 JPA 框架专用的映射标记。
问题 2 entity 里面可以写业务方法吗
回答 2 entity 不推荐写业务方法,entity 定位是数据载体,只保留属性 getter setter 构造方法,复杂业务逻辑要放到 Service 层,如果在 entity 写业务代码会破坏分层设计,后期维护会变得困难。
问题 3 entity 和 DTO 有什么区别
回答 3 entity 是和数据库表一一对应的实体类,对应持久层数据结构,DTO 是数据传输对象,专门用于接口前后端传参,可以裁剪或者合并 entity 里面的字段,不需要和数据库表保持一致。
问题 4 entity 为什么一定要有无参构造
回答 4 entity 需要无参构造,因为 MyBatis JPA 这些持久层框架底层依靠反射创建 entity 对象,如果没有无参构造,框架实例化对象会直接报错,导致查询封装失败。
【免责申明】
本文内容仅作为 Java 后端开发学习参考,不同框架版本的 entity 注解和映射规则会存在差异,实际项目开发请结合官方文档和项目规范调整,本文不对项目上线产生的问题承担责任。
