同福

Java的Hibernate、JPA、Spring data jpa学习笔记【20210611】

介绍

介绍

Hibernate是一种基于ORM规范的框架,ORM就是Object-Relational-Mapping,简单说就是对象关系映射,就是说ORM的设计思想就是把物理的数据转换成项目里面的对象模型,这个想法可以让我们在编写程序的时候忘记数据结构和对象模型之间的关系问题只关注业务本身,这个在开放大型项目的时候是非常非常有利的。

JPA是Java Persistence API的简写,JPA提供了一些基于ORM规范的接口模型,使用JPA省去了自己搭建控制器的麻烦,增加了模型的通用性。

Spring data是一个将JPA的接口功能进行了具体实现的一套库,可以实现CRUD操作,可以实现数据翻页、查询等等功能。

总结来说就是Hibernate是一套实现ORM规范的驱动,JPA是一套实现ORM规范的接口模型,Spring data实现了JPA定义的接口的功能。

安装

pom.xml

在pom.xml里面添加spring data的依赖库,因为spring data jpa包含了hibernate库,所以我们只需要导入spring data jpa库就可以了。

<!-- spring data jpa -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>

application.properties

在application.properties里面增加如下设置。

##############################################################################
# jpa
##############################################################################

spring.jpa.hibernate.ddl-auto=update
spring.jpa.show-sql=true

TfspringApplication.java

在启动程序里面添加EnableJpaAuditing这个JPA审计功能。

@EnableJpaAuditing
public class TfspringApplication {

使用

数据表

福哥使用的是TFUMS项目的数据库tfums的用户表user。

CREATE TABLE `user` (
  `userID` int(11) NOT NULL AUTO_INCREMENT,
  `passwd` char(32) NOT NULL,
  `createDT` datetime NOT NULL,
  `lastLoginDT` datetime DEFAULT NULL,
  `userFlag` tinyint(4) NOT NULL,
  `userState` tinyint(4) NOT NULL,
  `userEmail` varchar(245) DEFAULT NULL,
  `userName` varchar(45) NOT NULL,
  PRIMARY KEY (`userID`),
  UNIQUE KEY `u_userName` (`userName`),
  UNIQUE KEY `u_userEmail` (`userEmail`)
)

Entity实体对象

建立一个实体对象JpaUser,使用JpaUser实体对象映射物理表user。

JpaUser

实体对象。

@Data
@Entity
@Table(name = "user")
@EntityListeners(AuditingEntityListener.class)
public class JpaUser {

    @Id
    @Column(name = "userID")
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    Long userId;

    @Column(name = "userName")
    String userName;

    @Column(name = "passwd")
    String passwd;

    @Column(name = "userFlag")
    Integer userFlag;

    @Column(name = "userState")
    Integer userState;

    @Column(name = "userEmail")
    String userEmail;

    @Column(name = "createDT")
    @CreatedDate
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
    Date createDT;

    @Column(name = "lastLoginDT")
    @LastModifiedDate
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
    Date lastLoginDT;
}

Repository数据层

数据层就是用来实现针对数据库的INSERT/UPDATE/DELETE/SELECT操作,由于强大的JPA的威力整个数据仓库对象不需要实现任何方法,真的是太NB了~~

UserRepository

public interface UserRepository extends JpaRepository<JpaUser, Long> {
}

Service逻辑层

逻辑层就是完成各种CRUD功能的具体方法,可以用来创建用户、编辑用户、删除用户、查询用户等等。

Service层需要分层,接口定义和功能实现。

UserService

接口定义。

public interface UserService {
    /**
     * add
     * @param user
     * @return
     */
    JpaUser add(JpaUser user);

    /**
     * delete
     * @param id
     */
    void delete(Long id);

    /**
     * modify
     * @param user
     * @return
     */
    JpaUser mod(JpaUser user);

    List<JpaUser> getAll();

    JpaUser get(Long id);
}

UserServiceImpl

功能实现。

@Service
public class UserServiceImpl implements UserService {

    @Resource
    UserRepository repository;

    @Override
    public JpaUser add(JpaUser user) {
        return repository.save(user);
    }

    @Override
    public void delete(Long id) {
        repository.deleteById(id);
    }

    @Override
    public JpaUser mod(JpaUser user) {
        return repository.save(user);
    }

    @Override
    public List<JpaUser> getAll() {
        return repository.findAll();
    }

    @Override
    public JpaUser get(Long id) {
        return repository.findById(id).orElse(null);
    }
}

目录结构

福哥建立了一个repository目录,一个service目录,在service目录下面又建立了一个impl目录。这个目录结构其实没有特别的要求,只要namespace和use写对了就可以了!

home/topic/2021/1027/14/da441564c0d074628b8acd7a23cd1031.png

测试

完成了实体和模型的建立之后就可以开始编写具体业务了!

对象注入

使用的时候只需要在控制器里通过@Resource注解将Service注入进来就可以使用了。

@RestController
public class TestController {

    @Resource
    UserService userService;

创建用户

创建用户需要先自己创建一个实体对象,因为用户ID是自增列所以不要赋值,通过模型保存用户信息。

JpaUser user;

user = new JpaUser();
user.setUserName("福哥教我学JPA");
user.setPasswd(TFMD5.encode("abcdef"));
user.setUserFlag(7);
user.setUserState(1);

user = userService.add(user);

map.put("id", user.getUserId());
map.put("name", user.getUserName());

home/topic/2021/1102/10/1dd5b93e461037ca0237147e9cb95b4b.pnghome/topic/2021/1102/10/b458d4d91249b908269b882392d76c38.png

修改用户

修改用户可以先通过get方法得到当前用户,然后直接修改用户实体的属性,最后通过模型保存用户信息。

JpaUser user;

user = userService.get(Long.valueOf(1));
user.setUserEmail("tfjpa@tongfu.net");
user = userService.mod(user);

map.put("id", user.getUserId());
map.put("name", user.getUserName());

home/topic/2021/1102/10/d77026c0c415f1c49cfb8eb2d201ce52.pnghome/topic/2021/1102/11/eb48762a0c638b7aaed0681a63f41d96.png

删除用户

删除用户可以直接使用模型删除指定的用户ID对应的用户。

userService.delete(Long.valueOf(1));

home/topic/2021/1102/11/da74268208d435906a962875b7c0bbd1.pnghome/topic/2021/1102/11/330e473243b435754e521884aaa323d4.png

获取用户

因为user表数据比较多,福哥就不使用getAll功能了,我们使用get功能测试一下获取用户功能。

JpaUser user;

user = userService.get(Long.valueOf(2));

map.put("id", user.getUserId());
map.put("name", user.getUserName());

home/topic/2021/1102/11/b22fc95bcc13b5370c3a63e312daf027.png

注解

我们在实体对象的属性上面设置的那些注解都是干什么用的呢?怎么使用它们呢?福哥整理了一个列表供大家参考。

注解描述选项
@Table指定实体对象映射的物理数据表名称。name:指定数据库表的名称
@EntityListeners监听实体对象的创建、修改、删除的事件进行自动字段赋值。value:指定监听类
@Id指定属性映射的字段是主键。
@SequenceGenerator

sequenceName:数据库序列名

name:取的别名

@GeneratedValue

strategy :指定主键生成策略

generator:选择主键别名

@Column指定属性映射的字段名称。

name:指定数据库表的列名称

unique:是否唯一

nullable:是否可以为空

nserttable:是否可以插入

updateable:是否可以更新

columnDefinition: 定义建表时创建此列的DDL

@CreatedBy插入创建人信息。
@CreatedDate插入创建时间。
@LastModifiedBy更新最后修改人信息。
@LastModifiedDate更新最后修改时间。
@Version更新版本信息。
@JsonFormat设置读写时间的时候使用的时间格式。

pattern:展示格式

timezone:国际时间

总结

今天福哥带着童鞋们把Java的Hibernate学习了一番,Hibernate在Spring boot里面以JPA形式实现的,所以其实我们今天学习的是Spring boot的Spring data jpa库的使用技巧。

使用JPA可以让我们在无SQL的情况下轻轻松松操作数据库,这真的是一种非常爽的体验~~