阅读:57
刚进公司,人生地不熟,偷偷藏着本《mybatis入土为安》,以为可以靠mybatis混的轻松点,谁知天有不测风云,大家用的是JPA。
我这个小白没有听说过,全英文名叫Java Persistence API
,就是java持久化api,是SUN公司推出的一套基于ORM
的规范。
持久化想必如雷贯耳,都0202年了,谁还不用个持久化框架啊,举起mybatis。
ORM呢?全英文名为Object-Relational Mapping
:对象关系映射,简单来说为了不用JDBC那一套原始方法来操作数据库,ORM框架横空出世(mybatis、hibernate等等)。
然而ORM框架出的太多了,百花齐放,琳琅满目,你一套标准我一套标准,要是想换一套框架实现项目,可能要从头再写。啊这?入土吧。
百度这样介绍SUN的JPA规范:
Sun引入新的JPA ORM规范出于两个原因:
其一,简化现有Java EE和Java SE应用开发工作;
其二,Sun希望整合ORM技术,实现天下归一。
有气魄,我喜欢,学他丫的。
学jpa哪家强?哪家简单学哪家,spring-data-jpa最简单。介绍如下:
Spring Data JPA是Spring Data家族的一部分,可以轻松实现基于JPA的存储库。 此模块处理对基于JPA的数据访问层的增强支持。 它使构建使用数据访问技术的Spring驱动应用程序变得更加容易。
总的来说JPA是ORM规范,Hibernate、TopLink等是JPA规范的具体实现,这样的好处是开发者可以面向JPA规范进行持久层的开发,而底层的实现则是可以切换的。Spring Data Jpa则是在JPA之上添加另一层抽象(Repository层的实现),极大地简化持久层开发及ORM框架切换的成本。
也就是如下图所示:
话不多说,使用Maven管理包,使用springboot框架,建个空maven项目就行
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.2.4.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<dependencies>
<!--web-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!--spring-data-jpa-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>
<!--druid连接池-->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid-spring-boot-starter</artifactId>
<version>1.1.23</version>
</dependency>
<!--oracle桥接器-->
<dependency>
<groupId>com.oracle.ojdbc</groupId>
<artifactId>ojdbc8</artifactId>
<scope>runtime</scope>
</dependency>
<!--lombok-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
</dependencies>
看到lombok没?记得下插件,好用滴很。
spring:
datasource:
type: com.alibaba.druid.pool.DruidDataSource
url: jdbc:oracle:thin:@localhost:1521:XE
username: JPADEMO
password: oracle
driver-class-name: oracle.jdbc.OracleDriver
jpa:
hibernate:
ddl-auto: update #自动更新
show-sql: true #日志中显示sql语句
application:
name: spring-data-jpa-demo
server:
port: 2333 #端口号
标准的MVC结构,有助于解耦的实现;
实体类放在 pojo/entity
下
dao(数据访问对象 data access object)在JPA中叫做repository
,请遵守这个规范,就像mybaits的dao叫mapper
一样。
复习一下oracle建数据库和表的操作吧
Jpa支持mySQL和Oracle数据库,这里使用Oracle做例子
mysql数据库也就实体类的主键声明
和使用的桥接器
不同,之后的章节会做具体解释
1.1 建库前先看一下这个库存不存在
-- 查看当前已有的用户
SELECT Username FROM dba_users;
1.2 oracle建数据库语句
-- 创建用户(schema)账号:JPADEMO 密码:oracle
create user JPADEMO identified by oracle
-- 授权
grant create session to JPADEMO;
grant create table to JPADEMO;
grant create sequence to JPADEMO;
grant unlimited tablespace to JPADEMO;
2.1 建一张用户表吧
-- 创建一张表
create table JPA_USER
(
id number not null,
name varchar2(100),
object_version number not null,
created_by varchar2(50),
created_date date,
last_updated_by varchar2(50),
last_updated_date date
);
-- 给表加主键 单列主键 主键命名为JPA_USER_PK1
alter table JPA_USER add constraint JPA_USER_PK1 primary key (id);
-- 给表加注释
COMMENT ON table JPA_USER IS '用户信息表';
-- 给字段加注释
comment on column JPA_USER.id is 'id';
comment on column JPA_USER.name is '用户名称';
-- 创建序列 命名为JPA_USER_S
create sequence JPA_USER_S
minvalue 1
maxvalue 9999999999999999999999999999
start with 1
increment by 1
cache 20;
--创建索引 命名为JPA_USER_INDEX1
create index JPA_USER_INDEX1 on JPA_USER(name);
1.4 运行sql,成功!
环境配好了,开始demo吧!
SpringContextApplication
/**
* 启动类
*/
@EnableJpaAuditing
@SpringBootApplication
public class SpringContextApplication {
public static void main(String[] args) {
SpringApplication.run(SpringContextApplication.class, args);
}
}
注意注意:
除了@SpringBootApplication
启动注解外,
还有一个注解@EnableJpaAuditing
,它是用来启动Jpa的审计功能,比如说在使用建表中经常会加入 版本号、创建时间、修改时间 、创建者、修改者 这五个字段。因此为了简化开发, 我们可以将其交给jpa来自动填充。
审计功能的创建人和修改者的注入方式下一节再讲哦,贪多嚼不烂。
自下而上,先把实体创建
JpaUser
package org.example.jpademo.pojo.entity;
import com.fasterxml.jackson.annotation.JsonFormat;
import lombok.Data;
import org.springframework.data.annotation.CreatedBy;
import org.springframework.data.annotation.CreatedDate;
import org.springframework.data.annotation.LastModifiedBy;
import org.springframework.data.annotation.LastModifiedDate;
import org.springframework.data.jpa.domain.support.AuditingEntityListener;
import javax.persistence.*;
import java.util.Date;
/**
* @Classname JpaUser
* @Description TODO 用户实体类
* @Date 2020/8/13 14:52
* @Created by orange
*/
@Data
@Entity
@Table(name = "JPA_USER")
@EntityListeners(AuditingEntityListener.class)
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
private String createdBy;
@Column(name = "CREATED_DATE")
@CreatedDate
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
private Date createdDate;
@Column(name = "LAST_UPDATED_BY" )
@LastModifiedBy
private String lastUpdatedBy;
@Column(name = "LAST_UPDATED_DATE" )
@LastModifiedDate
@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")
private Date lastUpdatedDate;
}
这里把引入的包也贴了出来,防止大家导错包,
可以看到有非常多的注解,他们各个是什么意思呢?请看下方表格:
注解 | 作用 | 常用属性 |
---|---|---|
@Data | 给实体类加get/set/toString/EqualsAndHashCode方法,是lombok的注解 | |
@Entity | 指定当前类是实体类 | |
@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:国际时间 |
注意:
有了@EntityListeners(AuditingEntityListener.class)
这个注解,@CreatedBy
、@CreatedDate
、@LastModifiedBy
、@LastModifiedDate
才生效哦,而且创建人和更新人需要另作注入操作,此篇埋个伏笔。
此处便是整个spring-data-jpa中最令人虎躯一震的地方!
震惊,一个接口居然可以实现常用的所有操作!
明天来UC上班(我把槽都吐了,你们就没得吐了)
JpaUserRepository代码如下:
package org.example.jpademo.repository;
import org.example.jpademo.pojo.entity.JpaUser;
import org.springframework.data.jpa.repository.JpaRepository;
/**
* @Classname JpaUserRepository
* @Description TODO
* @Date 2020/8/13 15:12
* @Created by orange
*/
public interface JpaUserRepository extends JpaRepository<JpaUser, Long> {
}
你以为才开始吗?不,已经结束了。
可以看到,这个接口继承了JpaRepository<实体,ID>
,spring-data-jpa只需要这个信息,就可以帮你完成常用的操作:增删查改。
这一节不具体展开JpaRepository
中所包含的所有方法,单纯使用最简单的增删查改来过瘾
业务逻辑层是程序的逻辑核心,所有的重要的逻辑操作都应该往Service中写,而不是写到Controller控制层里去哦。
而且Service层是需要分层的:接口和实现类,这个不必多说,规范!规范!
我们实现最简单的新增、删除、修改、查询功能
接口如下:
JpaUserService
public interface JpaUserService {
/**
* 新增用户
* @param user 用户对象
*/
JpaUser insertUser(JpaUser user);
/**
* 删除用户
* @param id 删除id
*/
void deleteUser(Long id);
/**
* 修改用户
* @param user 用户信息
*/
JpaUser updateUser(JpaUser user);
/**
* 查询所有用户
*/
List<JpaUser> findAllUser();
/**
* 通过id查询用户
* @param id 用户id
*/
JpaUser findUserById(Long id);
}
接口实现:
JpaUserServiceImpl
@Service
public class JpaUserServiceImpl implements JpaUserService {
@Resource
private JpaUserRepository jpaUserRepository;
@Override
public JpaUser insertUser(JpaUser user) {
return jpaUserRepository.save(user);
}
@Override
public void deleteUser(Long id) {
jpaUserRepository.deleteById(id);
}
@Override
public JpaUser updateUser(JpaUser user) {
return jpaUserRepository.save(user);
}
@Override
public List<JpaUser> findAllUser() {
return jpaUserRepository.findAll();
}
@Override
public JpaUser findUserById(Long id) {
return jpaUserRepository.findById(id).orElse(null);
}
}
是滴,你没有看错,一个sql语句也没有见着,直接通过jpaUserRepository接口把方法点了出来。
这一点比mybatis做的好,不过你要硬说mybatis-plus牛逼我也没办法。
数据访问层(dao)被确确实实的优化的很简便,这是spring-data-jpa很大的亮点。
细心的同学可能发现了,新增和修改都调用的save()方法,jpa靠什么区分是insert还是update呢?
靠的是主键id有没有赋值判断~id有值为update,id无值为insert。
控制层是前后台交互的层,我采用的是restful编写格式的接口,对于资源的具体操作类型,由HTTP动词表示。
简单借用晨瑞大佬文章中的解释:
简化一下:
举个栗子:
好,如果你看懂了什么是restful编写格式,那么就看看控制层代码:
JpaUserController
@RestController
@RequestMapping("/user")
public class JpaUserController {
@Resource
private JpaUserService jpaUserService;
/**
* 新增用户
*/
@PostMapping("")
public JpaUser addUser(@RequestBody JpaUser user){
return jpaUserService.insertUser(user);
}
/**
* 删除用户
*/
@DeleteMapping("/{id}")
public void deleteUser(@PathVariable("id") Long id){
jpaUserService.deleteUser(id);
}
/**
* 修改用户
*/
@PutMapping("")
public JpaUser updateUser(@RequestBody JpaUser user){
return jpaUserService.updateUser(user);
}
/**
* 全查用户
*/
@GetMapping("")
public List<JpaUser> findAll(){
return jpaUserService.findAllUser();
}
/**
* id查用户
*/
@GetMapping("/{id}")
public JpaUser findbyId(@PathVariable("id") Long id){
return jpaUserService.findUserById(id);
}
}
代码ok,开始测试!
单单讲spring-data-jpa的话,就没有加swagger注解了,那么测试我们就使用postman来进行
POST提交
URL:localhost:2333/user
body数据:
{
"name":"orange4"
}
返回数据:
{
"id": 4,
"name": "orange4",
"objectVersion": 0,
"createdBy": null,
"createdDate": "2020-08-13 16:58:35",
"lastUpdatedBy": null,
"lastUpdatedDate": "2020-08-13 16:58:35"
}
分析:
id自动通过序列生成,
name是提交的数据,
版本号自动插入为0,
createdBy,lastUpdatedBy由于还未配置完整,暂时没有数据,
createdDate,lastUpdatedDate在插入时皆为当前时间
DELETE提交
URL:localhost:2333/user/4
返回数据:状态码 200
分析:
状态码200,代表服务器响应正确,删除成功
GET提交
URL:localhost:2333/user
返回数据:
[
{
"id": 2,
"name": "banana",
"objectVersion": 1,
"createdBy": null,
"createdDate": "2020-08-13 15:35:44",
"lastUpdatedBy": null,
"lastUpdatedDate": "2020-08-13 16:39:55"
},
{
"id": 3,
"name": "orange2",
"objectVersion": 0,
"createdBy": null,
"createdDate": "2020-08-13 15:36:00",
"lastUpdatedBy": null,
"lastUpdatedDate": "2020-08-13 15:36:00"
}
]
分析:
上面插入的id为4的用户此处全查没有,也代表着删除操作的成功
修改的时候需要全部实体数据哦,因为jpa的save()是全部修改,前端少传一个字段,数据库更新可能就变成null了,特别注意。之后会讲部分更新的实现。
PUT提交
URL:localhost:2333/user
body数据:
{
"id": 2,
"name": "banana-update",
"objectVersion": 1,
"createdBy": null,
"createdDate": "2020-08-13 15:35:44",
"lastUpdatedBy": null,
"lastUpdatedDate": "2020-08-13 16:39:55"
}
返回数据:
{
"id": 2,
"name": "banana-update",
"objectVersion": 2,
"createdBy": null,
"createdDate": "2020-08-13 15:35:44",
"lastUpdatedBy": null,
"lastUpdatedDate": "2020-08-13 20:08:18"
}
分析:
因为有了id值,save()方法变为了修改方法,
name的值从banana修改成banana-update,
objectVersion版本号因为@Version注解,从1变为了2,
createdBy和createdDate别看没变,是因为前端传的字段中带了值,如果不传值,数据库会被清成null,切记切记,
lastUpdatedBy和lastUpdatedDate不需要管,传不传值都会自动更新。
注意点:
@Version注解加上后开启乐观锁,更新必须加上objectVersion字段,且值一定要和数据库中的版本号一致,这样才会触发更新操作。
如果不加objectVersion字段,且后端没有验证操作,id值会被忽略,从更新操作变为新增操作,这是一个坑。
GET提交
URL:localhost:2333/user/2
返回数据:
{
"id": 2,
"name": "banana-update",
"objectVersion": 2,
"createdBy": null,
"createdDate": "2020-08-13 15:35:44",
"lastUpdatedBy": null,
"lastUpdatedDate": "2020-08-13 20:08:18"
}
分析:
和修改后的数据一样,就是个简单的id查询
总的来说,jpa带给我的惊喜很多,惊吓也很多,和mybaits各有所长,你们选择哪一个呢?
小孩子才做选择,我全都要!
真·总结:
1.@Version
注解加上后,更新操作一定要带上注解修饰的字段,且要与数据库中的值一致。
2.@CreatedBy
和@CreatedDate
会在更新时一并更新,需要主动去维护,或者在@Column
注解中加上updatable = false
,比如这样@Column(name = "CREATED_DATE",updatable = false)
。