Spring Boo使用Spring Data JPA访问MySQL

桃扇骨 2023-07-08 06:59 132阅读 0赞

### 文章目录 ###

*  Spring Boo使用Spring Data JPA访问MySQL
 *   *  官方示例教程
     *  工具
     *  开发过程
     *   *  引入依赖
         *  创建表
         *  自动生成JPA Entity
         *  添加Lombok支持
         *  UserRepository接口
         *  配置数据库连接
     *  测试
     *  进一步学习
     *  常见问题
     *   *  Q: 连接数据库时报serverTimezone的错
         *  Q: 'hibernate.dialect' not set
         *  Q: ONLY\_FULL\_GROUP\_BY问题
         *  Q: Table 'XXX.hibernate\_sequence' doesn't exist
         *  Q: Field 'id' doesn't have a default value

# Spring Boo使用Spring Data JPA访问MySQL #

## 官方示例教程 ##

[Accessing data with MySQL][]

## 工具 ##

*  IDEA Ultimate 2019.2
 *  MySQL 8.0
 *  Navicat 数据库客户端
 *  Postman

## 开发过程 ##

### 引入依赖 ###

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

### 创建表 ###

不使用示例中的直接根据代码生成表结构的做法，而是先定义好表结构。

在Navicat中创建`t_user`表，DDL如下：

CREATE TABLE `t_user` (
      `id` bigint(11) NOT NULL AUTO_INCREMENT,
      `name` varchar(64) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NOT NULL,
      `email` varchar(128) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci DEFAULT NULL,
      PRIMARY KEY (`id`)
    ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci ROW_FORMAT=DYNAMIC;

记得将id列设为主键，并勾选“自动递增”。

### 自动生成JPA Entity ###

在IDEA中安装JPA Support插件。

使用JPA Support插件根据`t_user`表自动生成Entity类（User）和Repository类（UserRepository）。

User类如下：

package me.cookcode.accessingdatamysql.entity;
    
    import java.io.Serializable;
    import javax.persistence.*;
    
    import lombok.Data;
    
    @Entity
    @Table(name = "t_user")
    @Data
    public class User implements Serializable { 
        private static final long serialVersionUID = 1L;
    
        @Id
        @GeneratedValue(strategy = GenerationType.IDENTITY) 
        @Column(name = "id", insertable = false, nullable = false)
        private Long id; 
    
        @Column(name = "name", nullable = false)
        private String name;
    
        @Column(name = "email")
        private String email;
    
    }

手工调整类中的属性字段顺序，一般将id字段放在最前面。

为id列添加注解`@GeneratedValue(strategy = GenerationType.IDENTITY)`

User类使用lombok的`@Data`注解来动态注入setters/getters，使得代码更为简洁。

### 添加Lombok支持 ###

在pom.xml文件中添加lombok依赖：

<dependency>
    	<groupId>org.projectlombok</groupId>
    	<artifactId>lombok</artifactId>
    	<scope>provided</scope>
    </dependency>

在IDEA中安装lombok插件，使得IDEA可以支持lombok。

### UserRepository接口 ###

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

说明：

*  `JpaRepository` 同时继承了`CrudRepository`和 `PagingAndSortingRepository`。

### 配置数据库连接 ###

在application.properties中配置：

spring.datasource.url=jdbc:mysql://${MYSQL_HOST:localhost}:3306/db_example??useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&useSSL=true&serverTimezone=GMT%2B8
    spring.datasource.username=springuser
    spring.datasource.password=test123
    spring.jpa.database-platform=org.hibernate.dialect.MySQLDialect

可选开启后台输出SQL：

spring.jpa.show-sql=true

## 测试 ##

启动Spring Boot Application，使用Postman进行测试。

## 进一步学习 ##

官方Spring Data JPA指南：

[https://docs.spring.io/spring-data/jpa/docs/current/reference/html/\#reference][https_docs.spring.io_spring-data_jpa_docs_current_reference_html_reference]

MySQL教程：  
[https://www.runoob.com/mysql/mysql-tutorial.html][https_www.runoob.com_mysql_mysql-tutorial.html]

## 常见问题 ##

### Q: 连接数据库时报serverTimezone的错 ###

A: 需要在数据库连接URL中指定`serverTimezone=Asia/Shanghai`参数

### Q: ‘hibernate.dialect’ not set ###

A：需要在`application.properties`中指定：

spring.jpa.database-platform=org.hibernate.dialect.MySQLDialect

### Q: ONLY\_FULL\_GROUP\_BY问题 ###

A: 可以重写SQL，只返回group by中的字段，或者修改MySQL的sqlmode：

SET GLOBAL sql_mode='STRICT_TRANS_TABLES,STRICT_ALL_TABLES,NO_ZERO_IN_DATE,NO_ZERO_DATE,ERROR_FOR_DIVISION_BY_ZERO,TRADITIONAL,NO_ENGINE_SUBSTITUTION';

参考：  
[https://www.percona.com/blog/2019/05/13/solve-query-failures-regarding-only\_full\_group\_by-sql-mode/][https_www.percona.com_blog_2019_05_13_solve-query-failures-regarding-only_full_group_by-sql-mode]

### Q: Table ‘XXX.hibernate\_sequence’ doesn’t exist ###

A: 需要将`User`类的`id`字段指定`@GeneratedValue(strategy = GenerationType.IDENTITY)`

### Q: Field ‘id’ doesn’t have a default value ###

A: 需要将`t_user`表的id字段设置为自动递增，`AUTO_INCREMENT`

[Accessing data with MySQL]: https://spring.io/guides/gs/accessing-data-mysql/
[https_docs.spring.io_spring-data_jpa_docs_current_reference_html_reference]: https://docs.spring.io/spring-data/jpa/docs/current/reference/html/#reference
[https_www.runoob.com_mysql_mysql-tutorial.html]: https://www.runoob.com/mysql/mysql-tutorial.html
[https_www.percona.com_blog_2019_05_13_solve-query-failures-regarding-only_full_group_by-sql-mode]: https://www.percona.com/blog/2019/05/13/solve-query-failures-regarding-only_full_group_by-sql-mode/