如果对您有帮助,请点赞!
概述
WEB后端开发,需要访问数据库。Hibernate是目前主流对象关系映射框架(ORM),对JDBC进行了对象封装,可以自动生成SQL语句,使得Java程序员可以使用对象编程思维来操纵数据库。
本文讲解Spring Boot 与Hibernate的集成。通过实战完成数据库的基本操作,如插入数据、查询、更新、删除数据。
适合读者
- 具有Java编程基础
- 具有数据库基础
- Spring Boot 及 Hibernate 小白
如果你对Spring Boot 完全不了解:请移步 spring boot 入门1:环境搭建及HelloWorld
开发环境
- windows 10
- JDK 1.8.0_25
- IDEA Community 2019.2 (社区版)
- IDEA 插件:Spring Assistant
- MySql 8.x
准备工作
- 请自行安装mysql数据库,并创建一个数据库
(也可以使用其他数据库,如Oracle、DB2、MSSqlserver 等等,本文以mysql为例说明) - 请确保使用mysql客户端工具,可以连接到数据库
- 在创建项目过程中,可能需要联网,下载JAR包等资源
实战
创建项目
首先在IDEA中创建一个项目 helloHibernate ,如下图所示:
选择项目中需要使用的组件
- Spring Web Starter:
- Spring Data JPA组件 :Spring Boot使用 Hibernate作为JPA实现(JPA-JAVA持久化API)
- MySQL Driver
项目创建完成后,打开pom.xml 文件,可以看到选择的组件自动添加到了项目依赖中 。
配置数据库访问参数
打开application.properties文件 (该文件在 src\main\resources\目录下)
配置数据库访问参数,如下所示(请根据你的数据库名称、用户、密码等进行修改):
# 以下参数定义了hibernate的行为:
# spring.jpa.database-platform=org.hibernate.dialect.MySQLDialect
# spring.jpa.database-platform=org.hibernate.dialect.MySQLInnoDBDialect
# hbm2ddl.auto参数: 开发建议 update 或 create 自动测试建议 create-drop 生产环境建议 validate
spring.jpa.properties.hibernate.hbm2ddl.auto=update
# 数据库的配置
# 配置数据库驱动为mysql (如果使用其他数据库,请更改驱动)
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
# 配置数据库连接,本示例使用helloworld数据库,请更改为你自己创建的数据库
spring.datasource.url=jdbc:mysql://localhost:3306/helloworld?serverTimezone=UTC
# 访问数据库的用户名:请更改为你的数据库用户名
spring.datasource.username=root
#访问数据库的密码,请更改为你的数据库密码
spring.datasource.password=123456
通过JAVA类定义表结构
新建User.java类,并定义了两个属性,具体代码如下:
@Entity注解,可以将类映射到数据库表(user表)
@Id注解,将属性映射为表的主键字段;@GeneratedValue注解表示该字段的值可以自动生成
@Column注解,将属性映射为表的字段
//User.java
package com.example.hello.hibernate;
import javax.persistence.*;
@Entity
//@Table(name="my_user") //若表名与类名不同时,可指定表名
public class User {
@Id //声明主KEY字段
@GeneratedValue
private Long id;
@Column //(name="user_name",nullable = false, unique = false) //可指定字段的属性
private String userName;
@Column
private String address;
public User(){ //需要缺省构建函数
}
public User(Long id, String userName, String address) {
this.id = id;
this.userName = userName;
this.address = address;
}
public Long getId() {
return id;
}
public void setId(Long id) {
this.id = id;
}
public String getUserName() {
return userName;
}
public void setUserName(String userName) {
this.userName = userName;
}
public String getAddress() {
return address;
}
public void setAddress(String address) {
this.address = address;
}
}
定义操作User对象的接口
新建UserRepository.java, 并继承JpaRepository接口
//UserRepository.java
package com.example.hello.hibernate;
import org.springframework.data.jpa.repository.JpaRepository;
public interface UserRepository extends JpaRepository {
}
编写JUnit测试代码
在src\test\java目录com.example.hello.hibernate包下,新建HibernateTests.java
代码如下所示:
//HibernateTests.java
package com.example.hello.hibernate;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
@RunWith(SpringJUnit4ClassRunner.class)
@SpringBootTest
public class HibernateTests {
@Autowired
private UserRepository userRepository;
@Test
public void test() throws Exception {
userRepository.save(new User(null, "Jack" ,"重庆市"));
userRepository.save(new User(null, "Mary","四川省"));
userRepository.save(new User(null, "张三丰","重庆市"));
}
}
执行JUnit测试代码
在HibernateTests类上(或test方法上),右键执行Run 菜单:即可执行JUnit单元测试。
如果执行正常,会显示 √ 图标,如下图所示:
这时我们可以进入数据库,查看结果:
打开user表,可看到插入的记录
在REST服务中,访问数据库
新建TestRestController.java
代码如下所示:
package com.example.hello.hibernate;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class TestRestController {
@Autowired
private UserRepository userRepository;
@RequestMapping("/test") //url
public String test() {
userRepository.save(new User(null, "Jack" ,"重庆市"));
userRepository.save(new User(null, "Mary","四川省"));
userRepository.save(new User(null, "张三丰","重庆市"));
return "OK";
}
}
启动REST服务(在Application.java上右键,点“ Run" 菜单),
通过浏览器访问 REST服务地址 http://localhost:8080/test
若成功执行,将显示下图界面:
进入数据库,查看结果如下图所示:
查询数据(查询全部数据):
在TestRestController.java类中,增加如下方法:
import java.util.List;
@RequestMapping("/findall")
public List testFindAll() {
List listUser = userRepository.findAll();
return listUser;
}
重启REST服务:
通过浏览器访问 REST服务地址 http://localhost:8080/findall
查询结果将显示在界面上:
查询数据(根据ID查询数据):
在TestRestController.java类中,增加一个查询方法testFindByID(),代码如下:
import java.util.Optional;
@RequestMapping("/findbyid")
public User testFindByID() {
try {
long id=3; //请替换成数据库表中有的ID值
Optional< User> user= userRepository.findById(id);
return user.get();
}catch (Exception e){
return null;
}
}
重启REST服务:
通过浏览器访问 REST服务地址 http://localhost:8080/findbyid
查询结果将显示在界面上:
自定义查询数据
通过前面的示例,我们知道Spring Boot的JPI接口中,已经包含了一些数据查询方法。
当然还可以自定义查询(JPI): Hibernate会根据方法名,自动生成SQL语句:
- findXXX 查询
- countXXX 计数
- deleteXXX 删除
- 查询前N条数据
自定义查询数据(单一条件查询:精确查询)
在UserRepository类中,增加一个自定义查询方法
//UserRepository.java
//自定义简单查询(JPI): Hibernate会根据方法名,自动生成SQL
//findByXXX (XXX=value) 单字段条件查询
List findByUserName(String userName); //根据用户名进行查询
在TestRestController.java类中,增加一个查询测试方法testFindByName(),代码如下:
@RequestMapping("/findbyname")
public List testFindByName() {
List list= userRepository.findByUserName("张三丰");
return list;
}
以下是查询结果:
自定义查询数据(单一条件查询:模糊查询)
在UserRepository类中,增加一个自定义查询方法
//findByXXXLike (XXX like value) 单字段条件查询 (value可以使用%做为通配符)
List findByUserNameLike(String userName);
以下是测试代码(通过使用SQL的通配符,可以进行模糊查询):
List list= userRepository.findByUserNameLike("张%");
查询数据(组合条件查询)
在UserRepository类中,增加一个自定义查询方法
//findByXXXAndXXX | findByXXXOrXXX (XXX and|or XXX) 多字段条件查询
List findByUserNameLikeAndAddressLike(String userName,String address);
以下是测试代码(通过使用SQL的通配符,可以进行模糊查询):
List list= userRepository.findByUserNameLikeAndAddressLike("张%","重庆市");
查询数据(排序)
在UserRepository类中,增加自定义查询方法
//findByXXXOrderByXXX 排序
List findByAddressOrderByUserName(String address); //正序
List findByAddressOrderByUserNameDesc(String address); //倒序
以下是测试方法
List list= userRepository.findByAddressOrderByUserName("重庆市");
List list2= userRepository.findByAddressOrderByUserNameDesc("重庆市");
查询数据(分页查询)
在UserRepository类中,增加自定义查询方法
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
//Page findALL(Pageable pageable); //这个方法基类中有,可以直接使用
Page findByUserNameLike(String userName,Pageable pageable);
以下是测试方法
@RequestMapping("/page")
public Page testPage() {
int nPage=0; //取第N页,从0开始
int nSize=3; //每页数据条数
//Pageable pageable = PageRequest.of(nPage,nSize); //不需要字段排序时,使用此方法
Sort sort = new Sort(Sort.Direction.ASC, "id");
Pageable pageable = PageRequest.of(nPage,nSize,sort); //需要排序时,使用此方法
Page page= userRepository.findAll(pageable); //分页查询
return page;
}
计数查询
Long countByUserName(String userName)
新增数据
//使用save方法(前面已经有使用)
删除数据
//deleteByXXX (语法与查询相似)
Long deleteById(Long id);
更新数据
?
自定义SQL查询
修改UserRepository接口,以增加一个SQL查询接口方法findUserByName ()代码如下:
//UserRepository.java
import org.springframework.data.jpa.repository.Query;
import org.springframework.data.repository.query.Param;
import java.util.List;
//UserRepository.java
public interface UserRepository extends JpaRepository {
@Query("select t from User t where t.userName like :userName") //如果是精确查询,将like改为=
public List findUserByName(@Param("userName") String userName);
}
在TestRestController.java类中,增加一个测试方法代码如下:
@RequestMapping("/findbyname")
public List testFindByName() {
List list= userRepository.findUserByName("张三丰"); //对于like条件,可使用%进行模糊查询 例如 "张%"
return list;
}
自定义SQL:删除
修改UserRepository接口,以增加一个SQL删除数据接口方法deleteByName ()代码如下:
//UserRepository.java
import org.springframework.data.jpa.repository.Modifying;
import org.springframework.data.jpa.repository.Query;
import org.springframework.transaction.annotation.Transactional;
@Modifying //表明这是一个删除或更新SQL,返回值类型为 int,返回删除或更新的记录数量
@Transactional //删除或更新需要使用事务
@Query("delete from User t where t.userName like :userName") //如果是精确查询,将like改为=
public int deleteByName(@Param("userName") String userName);
测试删除,在TestRestController.java类中,增加一个测试方法代码如下:
@RequestMapping("/deletebyname")
public int testDeleteByName() {
int n= userRepository.deleteByName("张三丰");
return n;
}
自定义SQL:更新、新增
(略)请参考删除写法,自行编写
多表查询方法1(SQL方式)
- 首先定义一个接口:包含查询结果的字段
- 定义数据库访问接口(继承JpaRepository接口)
- 在数据库访问接口中,增加多表查询方法(在查询中使用inner join)
多表查询方法2(级联查询方式)
?
异构数据库多源支持
例如项目中,即有 mysql的查询,也有Mongodb 的查询。
?
下一篇 spring boot 从零开始入门5: RES服务接收JSON参数自动转换为JAVA对象