概述

JPA是一种规范，它简化了现有持久化的开发，并且充分吸收了Hibernate、TopLInk、JDO等框架。SpringData JPA是全自动框架，不需要自己写sql,当然也可以自己写sql实现。而自动生成sql这点是优点，也是缺点，因为生成的sql可读性差，而且一些业务比如执行逻辑删除等还是需要自己来实现sql。

JPA的优点

• 可持久化Java对象。JPA能够直接持久化复杂的Java对象，并能够使用JPQL语言进行复杂的查询。JPQL是JPA专用的查询语言，是类似于SQL的面向对象的查询语言。

• 使用简单。JPA使用注释（Annotation）定义Java对象与关系数据库之间的映射，而传统的ORM多使用xml配置文件。JPA使用起来比ORM要方便。使用JPA不用关注底层使用什么数据库。

• 规范标准化。JPA是JCP组织发布的，是Java官方规定的统一的API。目前已经有多种框架实现JPA标准。使用了JPA的系统可以自由选择遵循JPA标准的框架，并能够自由更换。

• 事务性、大数据量。JPA底层使用关系数据库进行存储，因此具备关系数据库的特点，例如事务性、数据完整性、并发访问、大数据量等。

• 与其他持久化技术相比，JPA有很大的技术优势。表列出了JPA与其他持久化技术的比较。

在Springboot中集成

需求：有一张股票日行情表，表名是XTRD0001。现在需要封装API分页查询股票的行情数据。表结构如下：

CREATE TABLE `xtrd0001` (
  `SECCODE` varchar(11) NOT NULL DEFAULT '',
  `TDATE` int(11) NOT NULL COMMENT '交易日期',
  `XDBMASK` bigint(20) DEFAULT NULL COMMENT '时间戳',
  `F001N` decimal(9,4) DEFAULT NULL COMMENT '昨日收盘价',
  `F002N` decimal(9,4) DEFAULT NULL COMMENT '今日开盘价',
  `F003N` decimal(9,4) DEFAULT NULL COMMENT '最高成交价',
  `F004N` decimal(9,4) DEFAULT NULL COMMENT '最低成交价',
  `F005N` decimal(9,4) DEFAULT NULL COMMENT '收盘价',
  `F006N` bigint(20) DEFAULT NULL COMMENT '成交数量（单位：股）',
  `F007N` decimal(18,3) DEFAULT NULL COMMENT '成交金额',
  `F008N` bigint(20) DEFAULT NULL COMMENT '总笔数',
  `F009N` decimal(9,4) DEFAULT NULL COMMENT '涨跌',
  `F010N` decimal(9,4) DEFAULT NULL COMMENT '涨跌幅',
  `F011N` decimal(9,4) DEFAULT NULL COMMENT '振幅',
  `F012N` bigint(20) DEFAULT NULL COMMENT '内盘成交量',
  `F013N` bigint(20) DEFAULT NULL COMMENT '外盘成交量',
  `F014N` decimal(9,4) DEFAULT NULL COMMENT '换手率',
  `F015N` decimal(9,4) DEFAULT NULL COMMENT '成交均价',
  `F016N` decimal(18,3) DEFAULT NULL COMMENT '总市值',
  `F017N` decimal(18,3) DEFAULT NULL COMMENT '流通市值',
  PRIMARY KEY (`SECCODE`,`TDATE`),
  KEY `idx_utsdbmask` (`XDBMASK`) USING BTREE,
  KEY `XTRD0001_TDATE` (`TDATE`) USING BTREE,
  KEY `XTRD0001_TDATE+XDBMASK` (`TDATE`,`XDBMASK`),
  KEY `IDX_SECCODE` (`SECCODE`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 ROW_FORMAT=DYNAMIC;

步骤1.新建springboot项目

在idea中基于JDK1.8，使用的是springboot@2.7.5版本创建springboot项目，项目的目录结构如下图所示：

步骤2.引入相关jar包，pom.xml文件如下:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.7.5</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.hjt.yxh.hw</groupId>
    <artifactId>hqapi-server</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>hqapi-server</name>
    <description>Demo project for Spring Boot</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-jpa</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>com.mysql</groupId>
            <artifactId>mysql-connector-j</artifactId>
            <!--<scope>runtime</scope>-->
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>RELEASE</version>
            <scope>compile</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

步骤3. 配置文件application.properties设置

server.port=8080
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/xdb?useUnicode=true&useSSL=false&characterSet=utf8
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.username=root
spring.datasource.password=password

# 因为我们不需要JPA自动创建表或者修改表信息，因此禁止ddl操作
spring.jpa.hibernate.ddl-auto=none
spring.jpa.show-sql=true

spring.jpa.hibernate.ddl-auto的值有如下几个选项：

• create: 创建schema，并且销毁之前的数据
• create-drop:创建schema，并在会话结束时销毁schema
• update:在需要的时候更新数据库中的schema（和代码中定义的model对比，如果有更改，则更新数据库中的表定义）
• validate: 校验数据库中的schema，不做ddl操作
• none：不做任何操作(对数据库中的schema来说是只读操作)

步骤4. 定义表的ORM对象类

XTRD0001表的ORM对象类StockKline：

package com.hjt.yxh.hw.model;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import javax.persistence.*;
import java.io.Serializable;

@IdClass(StockKlineID.class)
@Data
@NoArgsConstructor
@AllArgsConstructor
@Entity
@Table(name = "XTRD0001")
public class StockKline implements Serializable {

    @Id
    @Column(name = "TDATE")
    private int tdate;

    @Id
    @Column(name = "SECCODE")
    private String symbol;

    @Column(name = "F002N")
    private double open;

    @Column(name = "F001N")
    private double yClose;

}

主键定义类:StockKlineID

package com.hjt.yxh.hw.model;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.io.Serializable;
@NoArgsConstructor
@AllArgsConstructor
@Data
public class StockKlineID implements Serializable {

    private int tdate;
    private String symbol;

}

总结:

1. 上述各注解的作用:

• @Entity: 修饰ORM类，表明这是一个JPA的ORM管理类
• @Table:指明类和数据库中哪张表一一对应
• @IdClass: 主键的定义类，用于联合主键(主键由多个字段组成)的表的主键定义
• @Id: 修饰字段，表明该字段为主键字段，复合主键时在每个主键字段上修饰，并定义相关的主键类
• @Column(name = “F002N”,unique=false,nullable = false) :修饰字段，可以定义表的字段，如名称，是否唯一，是否可空等等。

2. 只是做读取数据库数据的操作时，ORM定义类可以只是表中的部分字段

3. 无论是ORM定义类还是其主键定义类，都需要实现无参构造函数

步骤5. 实现数据库操作接口(Dao)

在Dao层创创建接口类：

package com.hjt.yxh.hw.dao;

import com.hjt.yxh.hw.model.StockKline;
import com.hjt.yxh.hw.model.StockKlineID;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.stereotype.Repository;

import java.util.List;

@Repository
public interface StockKlineDao extends JpaRepository<StockKline, StockKlineID> {

    /*
    列表查询: 通过条件symbol和tdate查询出符合标间的数据，生成的SQL语句类似于：Where symbol = XXX and TDATE BETWEEN start AND end;
    * */
    public List<StockKline> findBySymbolAndTdateBetween(String symbol,int startDate,int endDate);

    /*
    * 带分页的列表查询: 通过条件symbol和tdate查询出符合标间的数据，
    * 生成的SQL语句类似于：Where symbol = XXX and TDATE BETWEEN start AND end limit X,X;
    * */
    public Page<StockKline> findBySymbolAndTdateBetween(String symbol, int startDate, int endDate, Pageable pageable);

    /*
    * 带分页的列表查询: 通过条件symbol和tdate查询出符合标间的数据，
    * 生成的SQL语句类似于：Where symbol = XXX and TDATE > start limit X,X;
    * */
    public List<StockKline> findBySymbolAndTdateAfter(String symbol, int startDate, Pageable pageable);

    /*
     * 列表查询: 通过条件symbol和tdate查询出符合标间的数据，生成的SQL语句类似于：Where symbol = XXX and TDATE > start;
     * */
    public List<StockKline> findBySymbolAndTdateAfter(String symbol, int startDate);

    /*
     * 列表查询: 通过条件tdate查询出符合标间的数据，生成的SQL语句类似于：Where  TDATE = XXX;
     * */
    public List<StockKline> findByTdate(int tDate);

    /*
     * 列表查询: 通过条件Symbol和tdate字段查询出符合标间的数据，
     * 生成的SQL语句类似于：Where Symbol = XXX AND TDATE in（X1，X2，X3...);
     * */
    public List<StockKline> findBySymbolAndTdateIn(String symbol,Iterable<Integer> dateList);
}

总结：

• 1、定义的接口需要继承JpaRepository<T,ID>接口，T表示操作的ORM对象类，ID表示的是主键的类型(如long,String或者是自定义的主键类)

• 2、定义的接口需要使用@Repository注解修饰，表明这是一个Dao操作接口

• 3、该接口类提供了数据表的基本的CRUD操作，如findById，deleteById等等，也可以自定义一些条件操作。自定义的方法遵循一定的命名规则：即[操作]By[字段][运算符][条件连接符][字段][运算符]。
  操作的类型：

  • find：查询
  • delete：删除
  • saveAll
  • saveAndFlush

  条件连接符：

  • AND
  • OR

  运算符：

  • After 大于XX
  • Before 小于
  • Between 大于XX小于XX
  • In 即SQL中的IN

步骤6. 实现Controller

package com.hjt.yxh.hw.controller;

import com.hjt.yxh.hw.core.ResultT;
import com.hjt.yxh.hw.dao.StockKlineDao;
import com.hjt.yxh.hw.model.StockKline;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.PageRequest;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseBody;

import javax.annotation.Resource;

@RequestMapping(path = "/api/2.0/")
@Controller
public class KlineController {

    @Resource
    private StockKlineDao stockKlineDao;

    @ResponseBody
    @GetMapping(value = "/kline")
    public ResultT<Object> list(@RequestParam(value = "symbol",required = true) String symbol,
                        @RequestParam(value = "startDate",required = false,defaultValue = "19910101") int startDate,
                        @RequestParam(value = "endDate",required = false,defaultValue = "99991231") int endDate,
                        @RequestParam(value = "pageNo") int pageNo, @RequestParam(value = "pageSize") int pageSize)
    {
        Page<StockKline> list = stockKlineDao.findBySymbolAndTdateBetween(symbol,startDate,endDate,PageRequest.of(pageNo,pageSize));

        return ResultT.SUCCESS(list);
    }

}

测试

在Postman中可以进行测试：