【Java笔记+踩坑】Spring Data JPA

简介: 从常用注解、实体类和各层编写方法入手,详细介绍JPA框架在增删改查等方面的基本用法,以及填充用户名日期、分页查询等高级用法。

 导航:

【Java笔记+踩坑汇总】Java基础+JavaWeb+SSM+SpringBoot+SpringCloud+瑞吉外卖/谷粒商城/学成在线+设计模式+面试题汇总+性能调优/架构设计+源码解析

目录

一、JPA介绍

二、准备

2.0 导入jpa依赖

2.1 用户表准备

2.2 实体类:@Entity,@Table,@Id,@Column

2.2.1 核心注解

2.2.2 代码示例:@Entity,@Table,@Id,@Column

2.2.3 主键策略:@GeneratedValue

2.3 增删改时填充用户名和日期

2.3.0 引导类开启审计:@EnableJpaAuditing

2.3.1 设置填充的用户名:AuditorAware

2.3.2 实体类填充注解:@EntityListeners(AuditingEntityListener.class)

二、DAO层

2.1 基本用法:继承JpaRepository<实体,ID类型>  

2.2 常用增删改查方法

2.2.1 查:find

2.2.2 增:save

2.2.3 改:save

2.2.4 删:delete

2.3 高级增删改查

2.3.1 分页查找

三、Service层

四、Controller层


一、JPA介绍

JPA即Java Persistence API,就是java持久化api,是SUN公司推出的一套基于ORM的规范。

ORM(Object-Relational Mapping):对象关系映射,简单来说为了不用JDBC那一套原始方法来操作数据库,ORM框架横空出世(mybatis、hibernate等等)。

二、准备

2.0 导入jpa依赖

<!-- Spring Boot JPA 依赖 -->
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-data-jpa</artifactId>
    </dependency>

image.gif

2.1 用户表准备

CREATE TABLE `user` (
    `id` bigint(20) NOT NULL AUTO_INCREMENT,
    `name` varchar(20) DEFAULT NULL COMMENT '姓名',    #DEFAULT是默认约束,DEFAULT NULL即默认是空
    `age` int(11) DEFAULT NULL COMMENT '年龄',
    `sex` varchar(1) DEFAULT NULL COMMENT '性别',
    `address` varchar(255) DEFAULT NULL COMMENT '地址',
    `phone` varchar(20) DEFAULT NULL COMMENT '电话',
    `create_time` varchar(20) DEFAULT NULL,
    PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=4 DEFAULT CHARSET=utf8;

image.gif

这里只有id是非空的,其他像姓名、年龄这些都可以是空。

+------------+---------------+------+-----+---------+-------+--------------+
|   列名     |     类型      | 空值 | 键  | 默认值  | 注释  |
+------------+---------------+------+-----+---------+-------+--------------+
|    id      |  bigint(20)   |  NO  | PRI |   AUTO_INCREMENT   | 供应商ID |
|   name     |  varchar(20)  |  YES |     |   NULL  | 姓名 |
|   age      |  int(11)      |  YES |     |   NULL  | 年龄 |
|   sex      |  varchar(1)   |  YES |     |   NULL  | 性别 |
|  address   |  varchar(255) |  YES |     |   NULL  | 地址 |
|   phone    |  varchar(20)  |  YES |     |   NULL  | 电话 |
| create_time|  varchar(20)  |  YES |     |   NULL  | 创建时间 |
+------------+---------------+------+-----+---------+-------+--------------+

image.gif

该表格展示了表的结构,包括列名、数据类型、是否允许空值、主键约束、默认值和注释。

2.2 实体类:@Entity,@Table,@Id,@Column

2.2.1 核心注解

注解 作用 常用属性
@Entity 指定当前类是实体类
@Table("表名") 指定实体类和表之间的对应关系 name:指定数据库表的名称
@EntityListeners 在实体类增删改的时候监听,为创建人/创建时间等基础字段赋值

value:指定监听类

@Id 指定当前字段是主键
@SequenceGenerator 指定数据库序列别名 sequenceName:数据库序列名
name:取的别名
@GeneratedValue 指定主键的生成方式 strategy :指定主键生成策略。默认AUTO自增,
generator:选择主键别名
@Column("表字段名") 指定实体类属性和数据库表之间的对应关系 name:指定数据库表的列名称。
unique:是否唯一
nullable:是否可以为空
nserttable:是否可以插入
updateable:是否可以更新
columnDefinition: 定义建表时创建此列的DDL
@CreatedBy 自动插入创建人,须搭配@EntityListeners
@CreatedDate 自动插入创建时间,须搭配@EntityListeners
@LastModifiedBy 自动修改更新人,须搭配@EntityListeners
@LastModifiedDate 自动修改更细时间,须搭配@EntityListeners
@Version 自动更新版本号
@JsonFormat 插入/修改/读取的时间转换成想要的格式 pattern:展示格式
timezone:国际时间

2.2.2 代码示例:@Entity,@Table,@Id,@Column

package com.example.entity;
import javax.persistence.*;
@Entity    // @Entity表明是一个实体类
@Table(name = "user")    //指定表名
public class User {
    @Id    //指定主键
    @GeneratedValue(strategy = GenerationType.IDENTITY)    //指定生成策略
    private Long id;
    private String name;
    private Integer age;
    private String sex;
    private String address;
    private String phone;
    @Column(name = "create_time")    //指定列名
    private String createTime;
    public Long getId() {
        return id;
    }
    public void setId(Long id) {
        this.id = id;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public Integer getAge() {
        return age;
    }
    public void setAge(Integer age) {
        this.age = age;
    }
    public String getSex() {
        return sex;
    }
    public void setSex(String sex) {
        this.sex = sex;
    }
    public String getAddress() {
        return address;
    }
    public void setAddress(String address) {
        this.address = address;
    }
    public String getPhone() {
        return phone;
    }
    public void setPhone(String phone) {
        this.phone = phone;
    }
    public String getCreateTime() {
        return createTime;
    }
    public void setCreateTime(String createTime) {
        this.createTime = createTime;
    }
}

image.gif

2.2.3 主键策略:@GeneratedValue

  1. 自增长(Auto Increment)策略:
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Long id;
  1. image.gif
  2. UUID策略:
@Id
@GeneratedValue(generator = "uuid")
@GenericGenerator(name = "uuid", strategy = "org.hibernate.id.UUIDGenerator")
private String id;
  1. image.gif

JPA本身不支持雪花算法。

2.3 增删改时填充用户名和日期

2.3.0 引导类开启审计:@EnableJpaAuditing

@EnableJpaAuditing

image.gif

2.3.1 设置填充的用户名:AuditorAware

@Configuration
public class UserAuditorAware implements AuditorAware<String> {
    @Override
    public Optional<String> getCurrentAuditor() {
        // TODO: 根据实际情况取真实用户,这里固定返回"admin"
        return Optional.of("admin");
    }
}

image.gif

2.3.2 实体类填充注解:@EntityListeners(AuditingEntityListener.class)

@Data
@Entity
@Table(name = "JPA_USER")
@EntityListeners(AuditingEntityListener.class)    //当Entity增改时,监听信息。
public class JpaUser {
    @Id
    @Column(name = "ID")
    @GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "JPA_USER_S")
    @SequenceGenerator(sequenceName = "JPA_USER_S", name = "JPA_USER_S", allocationSize = 1)
    private Long id;
    @Column(name = "NAME")
    private String name;
    @Column(name = "OBJECT_VERSION" )
    @Version    //乐观锁。版本号字段会在每次更新实体时自动递增,并在更新时进行检查。如果两个并发的操作尝试更新同一个实体对象,只有其中一个操作会成功,而另一个操作会失败并抛出异常。
    private Long objectVersion;
    @Column(name = "CREATED_BY")
    @CreatedBy    //创建时,自动填充创建人。需要搭配上面的@EntityListeners
    private String createdBy;
    @Column(name = "CREATED_DATE")
    @CreatedDate    //创建时,自动填充创建时间。需要搭配上面的@EntityListeners
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
    private Date createdDate;
    @Column(name = "LAST_UPDATED_BY" )
    @LastModifiedBy    //修改时,自动填充修改人。需要搭配上面的@EntityListeners
    private String lastUpdatedBy;
    @Column(name = "LAST_UPDATED_DATE" )
    @LastModifiedDate    //修改时,自动填充修改时间。需要搭配上面的@EntityListeners
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
    private Date lastUpdatedDate;
}

image.gif

二、DAO层

2.1 基本用法:继承JpaRepository<实体,ID类型>  

@Repository
public interface UserRepository extends JpaRepository<User, Long> {
}

image.gif

2.2 常用增删改查方法

2.2.1 查:find

  • findById(id):根据ID查询单个实体对象。
Optional<User> user = userRepository.findById(1L);

image.gif

  • findAll():查询所有实体对象。
List<User> users = userRepository.findAll();

image.gif

  • findAllById(ids):根据ID列表查询多个实体对象。
List<User> users = userRepository.findAllById(Arrays.asList(1L, 2L, 3L));

image.gif

  • count():统计实体对象的总数。
long count = userRepository.count();

image.gif

2.2.2 增:save

save(entity):保存单个实体对象,根据实体对象的状态(新建或已存在)执行插入或更新操作。

saveAll(List<entitiy>):批量保存

User user = new User("John Doe", 25);
userRepository.save(user);

image.gif

2.2.3 改:save

save(entity):保存单个实体对象,根据实体对象的状态(新建或已存在)执行插入或更新操作。

User user = userRepository.findById(1L).orElse(null);
if (user != null) {
    user.setName("Updated Name");
    userRepository.save(user);
}

image.gif

2.2.4 删:delete

  • delete(entity):删除单个实体对象。
  • deleteById(id):根据ID删除单个实体对象。
  • deleteAll():删除所有实体对象。
  • deleteAll(List<entitiy>):批量删除多个实体对象。
User user = userRepository.findById(1L).orElse(null);
if (user != null) {
    userRepository.delete(user);
}
userRepository.deleteById(1L);
userRepository.deleteAll();
List<User> users = userRepository.findAllById(Arrays.asList(1L, 2L, 3L));
userRepository.deleteAll(users);

image.gif

2.3 高级增删改查

2.3.1 分页查找

public Page<User> findPage(Integer pageNum, Integer pageSize, String name) {
        // 构建分页查询条件
        Sort sort = new Sort(Sort.Direction.DESC, "create_time");
        Pageable pageRequest = PageRequest.of(pageNum - 1, pageSize, sort);
        return userRepository.findByNameLike(name, pageRequest);
    }

image.gif

三、Service层

@Service
public class UserServiceImpl implements UserService {
    @Resource
    private UserRepository userRepository;
    public void save(User user) {
        String now = new SimpleDateFormat("yyyy-MM-dd").format(new Date());
        user.setCreateTime(now);
        userRepository.save(user);
    }
    public void delete(Long id) {
        userRepository.deleteById(id);
    }
    public User findById(Long id) {
        return userRepository.findById(id).orElse(null);
    }
    public List<User> findAll() {
        return userRepository.findAll();
    }
    public Page<User> findPage(Integer pageNum, Integer pageSize, String name) {
        // 构建分页查询条件,建议写SQL分页
        Sort sort = new Sort(Sort.Direction.DESC, "create_time");
        Pageable pageRequest = PageRequest.of(pageNum - 1, pageSize, sort);
        return userRepository.findByNameLike(name, pageRequest);
    }
}

image.gif

四、Controller层

@RestController
@RequestMapping("/user")
public class JpaUserController {
    @Resource
    private JpaUserService jpaUserService;
    /**
     * 新增用户
     */
    @PostMapping("/add")
    public JpaUser addUser(@RequestBody JpaUser user){
        return jpaUserService.insertUser(user);
    }
    /**
     * 删除用户
     */
    @DeleteMapping("/delete/{id}")
    public void deleteUser(@PathVariable("id") Long id){
        jpaUserService.deleteUser(id);
    }
    /**
     * 修改用户
     */
    @PutMapping("/update")
    public JpaUser updateUser(@RequestBody JpaUser user){
        return jpaUserService.updateUser(user);
    }
    /**
     * 全查用户
     */
    @GetMapping("/all")
    public List<JpaUser> findAll(){
        return jpaUserService.findAllUser();
    }
    /**
     * id查用户
     */
    @GetMapping("/get/{id}")
    public JpaUser findbyId(@PathVariable("id") Long id){
        return jpaUserService.findUserById(id);
    }
}

image.gif


相关文章
|
4天前
|
设计模式 Java 关系型数据库
【Java笔记+踩坑汇总】Java基础+JavaWeb+SSM+SpringBoot+SpringCloud+瑞吉外卖/谷粒商城/学成在线+设计模式+面试题汇总+性能调优/架构设计+源码解析
本文是“Java学习路线”专栏的导航文章,目标是为Java初学者和初中高级工程师提供一套完整的Java学习路线。
|
4天前
|
缓存 前端开发 Java
【Java面试题汇总】Spring,SpringBoot,SpringMVC,Mybatis,JavaWeb篇(2023版)
Soring Boot的起步依赖、启动流程、自动装配、常用的注解、Spring MVC的执行流程、对MVC的理解、RestFull风格、为什么service层要写接口、MyBatis的缓存机制、$和#有什么区别、resultType和resultMap区别、cookie和session的区别是什么?session的工作原理
【Java面试题汇总】Spring,SpringBoot,SpringMVC,Mybatis,JavaWeb篇(2023版)
|
4天前
|
设计模式 Java 关系型数据库
【Java笔记+踩坑】设计模式——原型模式
对比原型模式和传统方式的实现思路、代码方案、优缺点,阐述原型模式的使用场景,以及深拷贝、浅拷贝等相关概念,并扩展原型模式在Spring源码中的应用。
【Java笔记+踩坑】设计模式——原型模式
|
4天前
|
缓存 Java 数据库
【Java面试题汇总】Spring篇(2023版)
IoC、DI、aop、事务、为什么不建议@Transactional、事务传播级别、@Autowired和@Resource注解的区别、BeanFactory和FactoryBean的区别、Bean的作用域,以及默认的作用域、Bean的生命周期、循环依赖、三级缓存、
【Java面试题汇总】Spring篇(2023版)
|
5天前
|
Java 开发者 数据格式
【Java笔记+踩坑】SpringBoot基础4——原理篇
bean的8种加载方式,自动配置原理、自定义starter开发、SpringBoot程序启动流程解析
【Java笔记+踩坑】SpringBoot基础4——原理篇
消息中间件 缓存 监控
18 0
|
5天前
|
运维 Java 关系型数据库
【Java笔记+踩坑】SpringBoot基础2——运维实用
SpringBoot程序的打包与运行、临时配置、多环境配置、日志
【Java笔记+踩坑】SpringBoot基础2——运维实用
|
5天前
|
SQL Java 数据库连接
【Java笔记+踩坑】MyBatisPlus基础
MyBatisPlus简介、标准数据层开发CRUD、业务层继承IService、ServiceImpl、条件查询、LambdaQueryWrapper、id生成策略、逻辑删除、乐观锁@Version、代码生成器、ActiveRecord
【Java笔记+踩坑】MyBatisPlus基础
|
Java Spring Kotlin
第2讲 Kotlin + Spring Boot 集成 JPA 【Kotlin + Spring Boot 服务端开发课程系列】
【Kotlin + Spring Boot 服务端开发课程系列】第2讲 Kotlin + Spring Boot 集成 JPA 【视频教程】 投影片01.
1064 0
|
Java Spring 测试技术
Spring Boot集成JPA的Column注解命名字段无效的问题
偶然发现,Spring Boot集成jpa编写实体类的时候,默认使用的命名策略是下划线分隔的字段命名。
3960 0