使用SpringData同時訪問MySQL和Neo4j數(shù)據(jù)庫

更新時間：2025年08月08日 11:01:38 作者：磊磊落落

本文通過使用SpringData在SpringBoot中配置MySQL和Neo4j雙數(shù)據(jù)源,文中通過示例代碼介紹的非常詳細,對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧

為了使演示工程更接近于實際，我們特為該工程設(shè)定一個場景：即使用該工程實現(xiàn) MySQL 到 Neo4j 的數(shù)據(jù)遷移。技術(shù)上會涉及使用兩組 Repository 進行讀寫，以及關(guān)系型數(shù)據(jù)庫的表到 Neo4j 的 Node 和 Relationship 的轉(zhuǎn)換。

介紹工程結(jié)構(gòu)和主要代碼塊之前，先演示一下該工程實現(xiàn)的功能：

1 功能展示

該工程針對 MySQL 的三張表進行了數(shù)據(jù)遷移，遷移到 Neo4j 后變?yōu)榱?Node 和 Relationship。

MySQL 中的三張表為：actor（演員）、movie（電影）、actor_movie（演員電影關(guān)系表）。

建表語句與插入語句如下：

CREATE TABLE actor (
    id BIGINT AUTO_INCREMENT PRIMARY KEY,
    name VARCHAR(100) NOT NULL,
    nationality VARCHAR(100) NOT NULL,
    year_of_birth INT NOT NULL
);

CREATE TABLE movie (
    id BIGINT AUTO_INCREMENT PRIMARY KEY,
    name VARCHAR(100) NOT NULL,
    released_at INT NOT NULL
);

CREATE TABLE actor_movie (
    actor_id BIGINT NOT NULL,
    movie_id BIGINT NOT NULL,
    role VARCHAR(100) NOT NULL,
    PRIMARY KEY (actor_id, movie_id)
);

INSERT INTO actor(name, nationality, year_of_birth) VALUES
    ('吳京', '中國', 1974),
    ('盧靖姍', '中國', 1985);

INSERT INTO movie(name, released_at) VALUES
    ('戰(zhàn)狼 Ⅱ', 2017),
    ('太極宗師', 1998),
    ('流浪地球 Ⅱ', 2023),
    ('我和我的家鄉(xiāng)', 2020);

INSERT INTO actor_movie(actor_id, movie_id, role) VALUES
    (1, 1, '冷峰'),
    (1, 2, '楊昱乾'),
    (1, 3, '劉培強'),
    (2, 1, 'Rachel'),
    (2, 4, 'EMMA MEIER');

進行數(shù)據(jù)遷移后，Neo4j 中的 Node 和 Relationship 如下:

功能展示完成后，下面介紹該示例工程的結(jié)構(gòu)以及關(guān)鍵代碼塊。

2 工程結(jié)構(gòu)及關(guān)鍵代碼分析

該示例工程是一個使用 Maven 管理的 Spring Boot 工程，其各依賴項及其版本如下：

Java: Liberica JDK 17.0.7
Maven: 3.9.2
Spring Boot: 3.4.5

2.1 工程結(jié)構(gòu)及依賴

該示例工程的結(jié)構(gòu)如下：

spring-data-jpa-and-neo4j-demo
├─ src
│  ├─ main
│  │  ├─ java
│  │  │  └─ com.example.demo
│  │  │     ├─ config
│  │  │     │  ├─ MySQLConfig.java
│  │  │     │  └─ Neo4jConfig.java
│  │  │     ├─ repository
│  │  │     │  ├─ graph
│  │  │     │  │  ├─ GraphActorRepository.java
│  │  │     │  │  └─ GraphMovieRepository.java
│  │  │     │  └─ relational
│  │  │     │  │  ├─ ActorRepository.java
│  │  │     │  │  ├─ MovieRepository.java
│  │  │     │  │  └─ ActorMovieRepository.java
│  │  │     ├─ service
│  │  │     │  ├─ MigrationService.java
│  │  │     │  └─ impl
│  │  │     │     └─ MigrationServiceImpl.java
│  │  │     ├─ model
│  │  │     │  ├─ graph
│  │  │     │  │  ├─ GraphActor.java
│  │  │     │  │  └─ GraphMovie.java
│  │  │     │  └─ relational
│  │  │     │  │  ├─ Actor.java
│  │  │     │  │  ├─ Movie.java
│  │  │     │  │  └─ ActorMovie.java
│  │  │     └─ DemoApplication.java
│  │  └─ resources
│  │     └─ application.yaml
│  └─ test
│     └─ java
│        └─ com.example.demo
│           └─ service
│              └─ MigrationServiceTest.java
└─ pom.xml

可以看到，其是一個標準的 Maven 工程，DemoApplication.java 為啟動類，application.yaml 為配置文件。config 包下用于放置配置類，MySQLConfig.java 和 Neo4jConfig.java 分別用于配置 MySQL 和 Neo4j 的連接信息讀取和事務(wù)管理。repository 包下用于放置訪問數(shù)據(jù)庫的 Repository 接口，其中 relational 子目錄下放置的是訪問 MySQL 的 Repository，graph 子目錄下放置的是訪問 Neo4j 的 Repository。model 包下放置 Model 類，relational 子目錄下放置的是對應(yīng) MySQL 表的 Model 類，graph 子目錄下放置的是對應(yīng) Neo4j Node 的 Model 類。此外 service 包下用于放置服務(wù)類，我們編寫的 MigrationService.java 及其實現(xiàn)即是做 MySQL 到 Neo4j 數(shù)據(jù)遷移的。

該示例工程用到的依賴如下：

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-data-jpa</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-data-neo4j</artifactId>
    </dependency>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <optional>true</optional>
    </dependency>

    <!-- driver -->
    <dependency>
        <groupId>com.mysql</groupId>
        <artifactId>mysql-connector-j</artifactId>
        <version>9.2.0</version>
    </dependency>

    <!-- test -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
</dependencies>

可以看到，該工程主要有兩項依賴 spring-boot-starter-data-jpa 和 spring-boot-starter-data-neo4j，前者用于訪問 MySQL，后者用于訪問 Neo4j。此外，使用 lombok 方便 Getters 和 Setters 的編寫，mysql-connector-j 為訪問 MySQL 的驅(qū)動，spring-boot-starter-test 為單元測試依賴。

2.2 工程配置

該工程的配置文件 application.yaml 的內(nèi)容如下

spring:
  datasource:
    jdbc-url: jdbc:mysql://localhost:3306/test?autoReconnect=true&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8
    username: root
    password: root
  jpa:
    show-sql: true
  neo4j:
    uri: bolt://localhost:7687/neo4j
    authentication:
      username: neo4j
      password: neo4j

logging:
  level:
    org.neo4j.ogm: DEBUG
    org.springframework.data.neo4j: DEBUG

可以看到，我們配置了兩個數(shù)據(jù)源：spring.datasource 配置的是 MySQL 的連接信息，spring.neo4j 配置的是 Neo4j 的連接信息。此外，我們還開啟了 SQL 和 Neo4j Cypher 語句的打印。

介紹完工程結(jié)構(gòu)、依賴和配置后，下面介紹關(guān)鍵的代碼塊。

2.3 Config 類

要支持在 Spring Boot 中同時操作 MySQL 和 Neo4j，配置類是關(guān)鍵。

下面是 MySQLConfig.java 的代碼：

package com.example.demo.config;
// ...

@Configuration
@EnableTransactionManagement
@EnableJpaRepositories(
        basePackages = "com.example.demo.repository.relational",
        entityManagerFactoryRef = "mysqlEntityManagerFactory",
        transactionManagerRef = "mysqlTransactionManager"
)
public class MySQLConfig {

    @Bean(name = "mysqlDataSource")
    @ConfigurationProperties(prefix = "spring.datasource")
    public DataSource mysqlDataSource() {
        return DataSourceBuilder.create().build();
    }

    @Bean(name = "mysqlEntityManagerFactory")
    public LocalContainerEntityManagerFactoryBean mysqlEntityManagerFactory(
            EntityManagerFactoryBuilder builder,
            @Qualifier("mysqlDataSource") DataSource dataSource) {
        return builder.dataSource(dataSource)
                .packages("com.example.demo.model.relational")
                .persistenceUnit("mysql")
                .build();
    }

    @Bean(name = "mysqlTransactionManager")
    public PlatformTransactionManager mysqlTransactionManager(
            @Qualifier("mysqlEntityManagerFactory") EntityManagerFactory factory) {
        return new JpaTransactionManager(factory);
    }
}

可以看到，我們在該類中指定了 MySQL Repository 的位置、數(shù)據(jù)庫連接信息在配置文件中的位置，并配置了 MySQL 的實體管理器和事務(wù)管理器。

下面是 Neo4jConfig.java 的代碼：

package com.example.demo.config;
// ...

@Configuration
@EnableTransactionManagement
@EnableNeo4jRepositories(
        basePackages = "com.example.demo.repository.graph",
        transactionManagerRef = "neo4jTransactionManager"
)
public class Neo4jConfig {

    @Bean(name = "neo4jTransactionManager")
    public PlatformTransactionManager transactionManager(Driver driver) {
        return Neo4jTransactionManager.with(driver)
                .build();
    }
}

可以看到，我們在該配置類中指定了 Neo4j Repository 的位置并配置了 Neo4j 的事務(wù)管理器。

2.4 Model 類

Model 類用于對應(yīng) MySQL 數(shù)據(jù)庫的表或?qū)?yīng) Neo4j 數(shù)據(jù)庫的 Node。

下面是 Actor.java 的代碼，其對應(yīng) MySQL 的 actor 表。

package com.example.demo.model.relational;
// ...

@Data
@Entity(name = "actor")
public class Actor {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    @Column(name = "id")
    private Long actorId;
    private String name;
    private String nationality;
    private Integer yearOfBirth;
}

下面是 GraphActor.java 的代碼，其對應(yīng) Neo4j 的 Actor Node。

package com.example.demo.model.graph;
// ...

@Data
@Node("Actor")
public class GraphActor {

    @Id
    @GeneratedValue
    private Long id;

    private Long actorId;
    private String name;
    private String nationality;
    private Integer yearOfBirth;
}

relational 或 graph 包下其它的 Model 類與此兩者類似，為了控制篇幅，其代碼就不在這里一一列出了。

2.5 Repository 接口

Repository 用于真正與數(shù)據(jù)庫交互。

下面是 ActorRepository.java 的代碼，其用于對 MySQL 的 actor 表進行增刪改查。

package com.example.demo.repository.relational;
// ...

public interface ActorRepository extends JpaRepository<Actor, Long> {
}

下面是 GraphActorRepository.java 的代碼，其用于對 Neo4j 的 Actor Node 進行增刪改查。

package com.example.demo.repository.graph;
// ...

public interface GraphActorRepository extends Neo4jRepository<GraphActor, Long> {

    @Transactional("neo4jTransactionManager")
    @Query("""
            UNWIND $actors AS actor
            MERGE (a:Actor {actorId: actor.actorId})
            ON CREATE SET a = actor
            ON MATCH SET a += actor
            """)
    void batchInsertOrUpdate(List<Map<String, Object>> actors);
}

可以看到，與普通 JPA Repository 類似，Neo4j 的 Repository 上同樣支持編寫自定義查詢。之所以編寫該方法，是因為使用該自定義 Cypher 方式編寫的 Actor 批量插入或更新方法比原生方式效率更高。

relational 或 graph 包下其它的 Repository 與此兩者類似，這里也不一一列出了。

2.6 Service 類

MigrationService 實現(xiàn)類的代碼如下，其對前面的 Model 和 Repository 進行了使用，實現(xiàn)了 MySQL 到 Neo4j 的數(shù)據(jù)遷移。

package com.example.demo.service.impl;
// ...

@Service
public class MigrationServiceImpl implements MigrationService {

    @Autowired
    private ActorRepository actorRepository;
    @Autowired
    private MovieRepository movieRepository;
    @Autowired
    private ActorMovieRepository actorMovieRepository;
    @Autowired
    private GraphActorRepository graphActorRepository;
    @Autowired
    private GraphMovieRepository graphMovieRepository;

    @Override
    public void migrateActorsAndMovies() {
        // migrate all actors
        migrateAllActors();

        // migrate all movies
        migrateAllMovies();

        // delete all ACTED_IN relations
        graphMovieRepository.deleteAllActedInRelations();

        // rebuild ACTED_IN relations
        List<Map<String, Object>> actedInRelations = getAllActedInRelations();
        graphMovieRepository.batchInsertOrUpdateActedInRelations(actedInRelations);
    }

    private void migrateAllActors() {
        List<Actor> actors = actorRepository.findAll();

        List<Map<String, Object>> graphActors = actors.stream()
                .map(this::assembleActor)
                .toList();

        graphActorRepository.batchInsertOrUpdate(graphActors);
    }

    private void migrateAllMovies() {
        List<Movie> movies = movieRepository.findAll();

        List<Map<String, Object>> graphMovies = movies.stream()
                .map(this::assembleMovie)
                .toList();

        graphMovieRepository.batchInsertOrUpdate(graphMovies);
    }

    private List<Map<String, Object>> getAllActedInRelations() {
        List<ActorMovie> actorMovies = actorMovieRepository.findAll();

        return actorMovies.stream()
                .map(this::assembleActedIn)
                .toList();
    }

    private Map<String, Object> assembleActor(Actor actor) {
        GraphActor graphActor = new GraphActor();
        BeanUtils.copyProperties(actor, graphActor);
        graphActor.setId(null);

        return ObjectToMapUtil.toMap(graphActor);
    }

    private Map<String, Object> assembleMovie(Movie movie) {
        GraphMovie graphMovie = new GraphMovie();
        BeanUtils.copyProperties(movie, graphMovie);
        graphMovie.setId(null);

        return ObjectToMapUtil.toMap(graphMovie);
    }

    private Map<String, Object> assembleActedIn(ActorMovie actorMovie) {
        return Map.of(
                "actorId", actorMovie.getId().getActorId(),
                "movieId", actorMovie.getId().getMovieId(),
                "role", actorMovie.getRole()
        );
    }
}

可以看到，該實現(xiàn)類對 MySQL 進行讀取，對 Neo4j 進行寫入，實現(xiàn)了兩個數(shù)據(jù)庫的模式轉(zhuǎn)換和數(shù)據(jù)遷移。

需要注意的是，我們使用了一個 Java 對象到 Map 類型轉(zhuǎn)換的工具類 ObjectToMapUtil.java，這是因為 Neo4j 的 Repository 目前還不能很好的支持直接傳入一個 List<Actor> 對象。

最后，在單元測試類中調(diào)用該實現(xiàn)類后，即可出現(xiàn)文章開頭展示的效果。

3 小結(jié)

綜上，我們以實現(xiàn) MySQL 到 Neo4j 數(shù)據(jù)遷移為目的演示了如何使用 Spring Data 同時訪問 MySQL 和 Neo4j 數(shù)據(jù)庫。

參考資料

[1] Spring: Spring Data JPA - https://docs.spring.io/spring-data/jpa/reference/jpa.html

[2] Spring: Spring Data Neo4j Reference Documentation - https://docs.spring.io/spring-data/neo4j/reference/

到此這篇關(guān)于使用SpringData同時訪問MySQL和Neo4j數(shù)據(jù)庫的文章就介紹到這了,更多相關(guān)SpringData同時訪問MySQL和Neo4j內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: