YashanDB持久化框架操作示例（jpa-hibernate）

书白666

2946人浏览 · 2024-08-13 18:06:57

书白666 · 2024-08-13 18:06:57 发布

1.背景介绍

基本概念：

1.JPA（Java Persistence API）是一种标准化的Java ORM（对象关系映射）规范，它定义了一套用于对象和关系数据库之间进行映射的API。

2.Spring Data JPA是Spring框架对JPA的封装，它通过提供一系列接口和注解，简化了开发者对JPA的使用。

优势：

1.简化数据访问层开发：Spring Data JPA提供了一个自动生成常见数据访问层代码的机制，开发者只需要定义接口和方法命名规则，无需编写具体的实现代码。

2.提高代码的可读性：借助Spring Data JPA提供的接口和方法命名规则，开发者可以通过简单的方法命名来实现复杂的查询功能，使代码更加简洁和可读。

3.支持多种数据源：Spring Data JPA支持多种数据源（如关系数据库、NoSQL数据库等），开发者可以通过简单的配置切换数据源。

4.集成其他Spring组件：Spring Data JPA可以很方便地与其他Spring组件（如Spring MVC、Spring Boot等）集成，提供一体化的开发体验。

应用场景：在应用程序开发中，Spring Data JPA可以用于处理各种数据库操作，包括增删改查、复杂查询、分页等。开发者只需要定义实体类和接口，Spring Data JPA会根据方法命名规则自动生成具体的查询语句。此外，Spring Data JPA还支持事务管理，可以保证数据库操作的一致性和完整性。极大地简化了数据访问层的开发，提高了开发效率和代码质量。

2.环境说明

以使用Maven为例：

Java环境：Jdk22（安装后需配置）

hibernate-core版本：6.5.2.Final

Springboot版本：3.3.2

Maven版本：3.9.8（安装后需配置）

崖山驱动版本：1.6.9 (官网下载）

Maven的pom.xml文件：（用于验证整个jpa-hibernate与YashanDB的兼容性，所以涵盖很多的依赖包，如只需其中一种或者几种功能，保留相应的依赖即可。）

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>3.3.2</version>
</parent>

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
<dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-actuator</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId> 
        <artifactId>spring-boot-starter-data-jpa</artifactId>
    </dependency>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
    </dependency>
    <dependency>
        <groupId>org.junit.jupiter</groupId>
        <artifactId>junit-jupiter-api</artifactId>
        <version>5.10.2</version>
        <scope>test</scope>
    </dependency>
    <dependency>
        <groupId>junit</groupId>
        <artifactId>junit</artifactId>
        <version>4.13.2</version>
        <scope>test</scope>
    </dependency>
    <dependency>
        <groupId>org.testng</groupId>
        <artifactId>testng</artifactId>
        <version>RELEASE</version>
        <scope>test</scope>
    </dependency>
   </dependencies>

3.添加YashanDB驱动

打开Idea的ProjectStructure，使用Libraries添加YashanDB驱动，对于多模块，只需要添加到对应的模块即可。（YashanDB驱动：在产品软件包或安装目录的Drivers文件夹中，查找yasdb-jdbc-版本号.jar文件，例如yasdb-jdbc-1.6.9.jar）

也可以将YashanDB驱动上传到本地的Maven私服，然后在Pom文件中引入。

注：若maven无法识别，直接在工程目录下建一个lib文件夹，把jar包放进去，然后引进来

 <dependency>
        <groupId>com.yashandb</groupId>
        <artifactId>yashandb-jdbc</artifactId>
        <version>1.6.9</version>
        <scope>system</scope>
        <systemPath>${project.basedir}/lib/yashandb-jdbc-1.6.9.jar</systemPath> 
<!--项目根目录下的lib文件夹下-->
    </dependency>

4.数据源和jpa-hibernate配置

本文采用application.properties文件进行参数配置。请将下例中的host_ip、port、dbname、username和password修改为实际值。

spring.application.name=demo
spring.datasource.url=jdbc:yasdb://127.0.0.1:1688/yasdb
spring.datasource.username=regress
spring.datasource.password=regress
spring.datasource.driver-class-name=com.yashandb.jdbc.Driver
#方言设置
spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.OracleDialect
#是否自动建表
spring.jpa.properties.hibernate.hbm2ddl.auto=create
#字段名和数据库中对象名的映射关系:
spring.jpa.properties.hibernate.naming-strategy=org.hibernate.cfg.ImprovedNamingStrategy
spring.jpa.properties.hibernate.temp.use_jdbc_metadata_defaults = false

5.jpa-hibernate功能验证

创建entity

创建User用户的entity，并使其与Table对应。

package com.example.pojo;
import lombok.Data;
import org.hibernate.annotations.ColumnDefault;
import jakarta.persistence.*;

@Data
@Entity
@Table(name = "user1")
public class User {
    @Id //hibernate要求必须要一个id（主键）,不然会报错
    @GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "ID_GENERATOR")
    @SequenceGenerator(name = "ID_GENERATOR", sequenceName = "user_sequence")
    @ColumnDefault("user_sequence.nextval")
    private int id;

    @Column(name = "name")
    private String name;
    public User() {
    }
    public User(String name) {
        this.name = name;
    }
    public User(int id, String name) {
        this.id = id;
        this.name = name;
    }}

定义Repository接口，可以继承JpaRepository，也可以继承CrudRepository，视个人使用习惯或者团队要求自由选择，本例子中使用JpaRepository：

package com.example.dao;
import com.example.pojo.User;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.stereotype.Repository;

@Repository
public interface UserRepository extends JpaRepository<User,Integer> {//注意JpaRepository<User,Integer>这里传入的泛型类型,第一个是我们上面定义的Entity,第二个是Entity的主键的类型//里面可以不实现任何接口,JpaRepository的默认接口已经足够我们使用了。}

主类

package com.example.demo;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.domain.EntityScan;
import org.springframework.data.jpa.repository.config.EnableJpaRepositories;

@SpringBootApplication
@EnableJpaRepositories(basePackages = "com.example.dao")
@EntityScan(basePackages = "com.example.pojo")
public class DemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}

创建单元测试类

package com.example;
import com.example.dao.UserRepository;
import com.example.pojo.User;
import org.junit.Before;
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.SpringRunner;
import java.util.List;
import static org.junit.Assert.assertEquals;

@RunWith(SpringRunner.class)
@SpringBootTest
public class UserTest {
    @Autowired
    private UserRepository repository;
    @Before
    public void deleteAllUser(){
        repository.deleteAll();
    }

    @Test
    public void testAddUser() {
        User user = new User("sasa");
        repository.save(user);
        List<User> list = repository.findAll();
        assertEquals(1, list.size());
    }}

6.常见问题

(1) 重新加载maven项目后YashanDB驱动包丢失

通过Libraries添加的YashanDB驱动和方言包在重新加载maven项目后可能会丢失导致报错

解决方法：直接在工程目录下建一个lib文件夹，把jar包放进去，然后引进来

<dependency>
        <groupId>com.yashandb</groupId>
        <artifactId>yashandb-jdbc</artifactId>
        <version>1.6.9</version>
        <scope>system</scope>
        <systemPath>${project.basedir}/lib/yashandb-jdbc-1.6.9.jar</systemPath> 
<!--项目根目录下的lib文件夹下-->
</dependency>

（2）Spring Data JPA 异常 “IllegalArgumentException: Not a Managed Type”

有如下两种可能出现的情况：

1.从 javax.persistance 迁移jakarta.persistance

在将应用迁移到 Jakarta Persistence API 时，可能会遇到这种异常情况。

重现问题：

假设有如下实体：

import jakarta.persistence.Entity;
import jakarta.persistence.Id;
@Entity
public class EntityWithJakartaAnnotation {    
@Id    
private Long id;
}

如上，使用了 jakarta.persistence 包，但我们仍在使用 Spring Boot 2，再以与上一节类似的方式创建 Repository 和 Application 类，运行后，“Not a managed type” 异常出现。 JPA 实体扫描器（Entity Scanner）希望我们使用 javax.persistence.Entity 注解，而不是 jakarta.persistence.Entity 注解。

修复问题：

在这种情况下，有两种可能的解决方案。

1.升级到 Spring Boot 3，然后使用 jakarta.persistence。

2.如果还没准备好升级，就继续使用 javax.persistence.Entity。

2.缺少或错误配置了 @EntityScan

另一种可能遇到 “Not a managed type” 异常的常见情况是， JPA 实体扫描器（Entity Scanner）无法在预期路径中找到实体。

重现问题：

首先，创建另一个实体：

package com.baeldung.spring.entity;
@Entity
public class CorrectEntity {    
@Id    
private Long id;
}

它带有 @Entity 注解，并被置于 entity 包中。现在，创建一个 Repository：

package com.baeldung.spring.repository;
public interface CorrectEntityRepository extends JpaRepository<CorrectEntity, Long> {
}

Repository 接口放在 repository 包中。最后，创建一个 Application 类：

package com.baeldung.spring.app;
@SpringBootApplication
@EnableJpaRepositories(basePackages = "com.baeldung.spring.repository")
public class WrongEntityScanApplication {
}

它在 app 包中。默认情况下， Spring Data 会扫描 main 类所在包及其子包下的 Repository 接口。因此，我们需要使用 @EnableJpaRepositories 的 basePackages 属性指定 Repository 接口所在的包。如此运行后，再次遇到了 “Not a managed type” 异常。原因是实体扫描的逻辑与 Repository 扫描的逻辑相同。我们扫描了 app 包下的组件，但没有发现任何实体，因此在构建 CorrectEntityRepository 时出现了异常。

修复问题：

要解决这个问题，可以使用 @EntityScan 注解。

再创建一个 Application 类：

@SpringBootApplication
@EnableJpaRepositories(basePackages =  "com.baeldung.spring.repository")
@EntityScan("com.baeldung.spring.entity")
public class WrongEntityScanFixedApplication {
}

如上，使用 @EnableJpaRepositories 注解指定 Repository 所在包，并使用 @EntityScan 注解指定实体包。

测试通过。我们从 Context 中成功获取到了 CorrectEntityRepository，并且 CorrectEntity 已被成功识别为 JPA 实体。

(3) 自增主键的使用

一般情况下，在使用Hibernate持久化框架时，需要定义Entity实体类，实体类中存在一个Id属性，将该属性作为业务表的自增主键列，示例如下：

@Id
@SequenceGenerator(name="generator",sequenceName="user_sequence", allocationSize =1)
@ColumnDefault("user_sequence.nextval")
@GeneratedValue(strategy= GenerationType.AUTO, generator = "generator")
private int id;

在上述示例中，user_sequence为序列名，由您自定义命名。

Note:

注意保持@SequenceGenerator参数sequenceName和@ColumnDefault中的序列名称一致。

如果sequenceName指定的序列名是驼峰格式，hibernate会把它改成下划线，和表名，列名等一样处理；但是@ColumnDefault这个注解的value是不处理驼峰格式的，所以就会导致sequenceName和ColumnDefault里面序列器名称不一致，启动时建表会失败，所以注意这里不要用驼峰命名，直接用下划线风格命名。

此外，也可以不指定@ColumnDefault，和@SequenceGenerator。

这时hibernate使用默认序列hibernate_sequence去自增，示例如下：

@Id
@GeneratedValue(strategy= GenerationType.AUTO)
private int id;

(4) 服务启动失败

使用hibernate配置hbm2ddl.auto=validate时，服务启动时会进行校验；当数据库表结构数据类型与Java实体类数据类型不一致时，Schema-validation校验失败；从而导致容器初始化Hibernate SessionFactory时失败。

spring.jpa.properties.hibernate.hbm2ddl.auto=validate

出现这个问题时，我们需要修改数据库表结构，或修改Java实体类数据类型，保持数据库表结构与Java实体类数据类型一致。

或者，将hbm2ddl.auto配置设置为none，服务启动时不进行校验。

(5) 不支持TEXT数据类型

MySQL迁移前，业务中可能使用了TEXT这一数据类型，示例如下：

@Column(name = "file_types", columnDefinition = "TEXT")
private String fileTypes;

迁移后，YashanDB不支持TEXT数据类型，导致报错。

YashanDB虽不支持TEXT类型，但支持CLOB类型，用于保存大量字符数据。因此，建议将TEXT改为CLOB，即columnDefinition = "TEXT"改为columnDefinition = "CLOB"。

https://edu.csdn.net/learn/39067/627173?utm_source=2019755004

汇聚全球AI编程工具，助力开发者即刻编程。

更多推荐

ChatGPT、Codex与Pro：AI开发为什么正在从“模型选择”转向“工作流设计”？

AI编程社区

ChatGPT、Codex与Pro：AI开发为什么正在形成“人类决策层＋AI执行层”？

AI编程社区

从0到1做Vibe Coding：不要学AI，直接用

想做一个提词器、想自动化一个流程、想用AI搭个原型，然后先打开B站看了十几个教程，收藏了一堆文档，学了半天ChatGPT的prompt怎么写……

AI编程社区

所有评论(0)

查看更多评论

书白666

@2301_80281506

已为社区贡献1条内容

YashanDB持久化框架操作示例（jpa-hibernate）

书白666

1.背景介绍

2.环境说明

3.添加YashanDB驱动

4.数据源和jpa-hibernate配置

5.jpa-hibernate功能验证

创建entity

创建单元测试类

6.常见问题

(1) 重新加载maven项目后YashanDB驱动包丢失

（2）Spring Data JPA 异常 “IllegalArgumentException: Not a Managed Type”

1.从 javax.persistance 迁移jakarta.persistance

重现问题：

修复问题：

2.缺少或错误配置了 @EntityScan

重现问题：

修复问题：

(3) 自增主键的使用

(4) 服务启动失败

(5) 不支持TEXT数据类型

所有评论(0)

温馨提示：您尚未绑定手机号

书白666