springboot - 搭建spring data jpa简单快速实现数据库读写

访问数据库是代码开发中最常见的任务之一，springboot搭配上spring data项目，在读写数据库的场景上非常简单方便好用，写起读写数据库代码来轻松愉快。

本次实现的功能

本次我们实现一个非常简单的数据写入、查询的功能。假设我们在开发一个股票交易系统中的一个小模块，这个模块负责上市公司的录入和查询。 需要提供的功能是能够写入上市公司名称和对应的代码，能够根据代码查询上市公司的名称。

创建数据库、建表

如果在本地搭建数据库，可以用docker快速启动一个mysql数据库，然后用IDEA自带的database连接功能，创建表查看数据，非常方便。

# my-secret-pw修改成自己要设置的数据库的root用户密码，这个命令默认安装最新版本的mysql（现在是8版本，如果用sequelpro连接可能报错，可以google搜索对应解决方案）
docker run --name some-mysql -e MYSQL_ROOT_PASSWORD=my-secret-pw -d mysql

我们建立一个名为stock的数据库和数据表，数据库表结构非常简单，一个自增id，一个code表示代码一个name表示名称。

create database stock;
use stock;
create table stock
(
    id   bigint auto_increment
        primary key,
    code varchar(120) null,
    name varchar(120) null,
    constraint stock_code_uindex
        unique (code)
);

引入spring data jpa

要在springboot中使用spring data jps访问mysql数据库，我们需要在项目中增加pom依赖和配置。

修改pom.xml，加入mysql-connector-java因为我们使用的是mysql数据库，加入spring-boot-starter-data-jpa是springboot的spring data jpa依赖。

<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>

修改application.properties或application.yml，以下以application.properties为例。注意下面的password和url按照自己的情况进行修改。

spring.datasource.username=root
spring.datasource.password=123
spring.datasource.url=jdbc:mysql://localhost:3306/stock

创建数据库对象模型Entity类

我们定义和数据库表中数据映射的Entity类，也就是我们的模型类，一般情况下和数据库里的表结构字段一一映射即可。 下面我使用了lombok省去写getsetter的操作，Entity类需要加上@Entity注解，并且需要一个@Id注解加在id字段上，id字段上还有一个@GeneratedValue表示这个id是怎么生成的，这个字段自增则使用strategy = GenerationType.IDENTITY

import lombok.Data;

import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;

@Entity
@Data
public class Stock {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String code;
    private String name;
}

定义Repository接口

下面要定义我们的DAO类了，在spring data里叫做Repository，我们定义一个StockRepository，继承于JpaRepository，这个接口提供了增删改查等常用的操作。 接口中还定义了两个泛型，前面泛型的是Repository操作的Entity类，后面的泛型是Entity类的id的类型，我们这里分别是Stock和Long。 Repository接口中还可以增加findXXXByXXX这样的方法，能够实现条件查询。我们这里增加一个findStockByCode的方法

public interface StockRepository extends JpaRepository<Stock, Long> {
    Stock findStockByCode(String code);
}

使用Repository

定义好StockRepository类后就可以在其他的bean里引用这个Repository使用了。

@Autowired
private StockRepository stockRepository;

@RequestMapping("/saveAndGet")
public Stock saveAndGet(Stock stock) {
    stockRepository.save(stock);
    return stock;
}

@RequestMapping("/getByCode")
public Stock getByCode(String code) {
    return stockRepository.findStockByCode(code);
}

总结

可以看到使用spring boot data jpa操作数据库非常简单方便快捷，不用做很多配置，操作数据库也不用写sql和手动映射代码。关于spring data jpa的使用和实现我会在后面单独写一个系列，欢迎大家关注点赞收藏转发。