Spring Boot集成Neo4j OGM 2.1.3：如何获取Session注册EventListener？

我刚好对这个版本的Neo4j OGM和Spring Boot整合比较熟悉，给你整理几个可行的方案：

一、获取Neo4j OGM Session的两种常用方式 #

方式1：通过注入SessionFactory获取 #

在Spring Boot 1.5.x的自动配置下，SessionFactory会被自动创建并纳入Spring容器管理，你可以直接注入它，然后调用openSession()方法获取Session实例：

import org.neo4j.ogm.session.Session;
import org.neo4j.ogm.session.SessionFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

@Component
public class Neo4jSessionManager {

    private final SessionFactory sessionFactory;

    @Autowired
    public Neo4jSessionManager(SessionFactory sessionFactory) {
        this.sessionFactory = sessionFactory;
    }

    // 获取Session实例
    public Session getNeo4jSession() {
        return sessionFactory.openSession();
    }
}

方式2：通过Neo4jTemplate获取 #

如果你已经在使用Spring Data Neo4j的Neo4jTemplate，也可以直接通过它获取Session，内部已经封装了SessionFactory的调用：

import org.springframework.data.neo4j.template.Neo4jTemplate;
import org.neo4j.ogm.session.Session;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class SomeNeo4jService {

    @Autowired
    private Neo4jTemplate neo4jTemplate;

    public void doSomethingWithSession() {
        Session session = neo4jTemplate.getSession();
        // 这里就可以用session做后续操作了
    }
}

二、注册EventListener的正确姿势 #

Neo4j OGM的EventListener需要绑定到Session上，推荐在Spring容器初始化完成后统一注册，避免重复注册或Session生命周期问题，这里给你两种实现方式：

方式1：利用Spring容器刷新事件注册 #

创建一个监听ContextRefreshedEvent的组件，在容器初始化完成后获取Session并注册监听器：

import org.neo4j.ogm.event.EventListeners;
import org.neo4j.ogm.session.Session;
import org.neo4j.ogm.session.SessionFactory;
import org.springframework.context.ApplicationListener;
import org.springframework.context.event.ContextRefreshedEvent;
import org.springframework.stereotype.Component;

@Component
public class Neo4jListenerRegistrar implements ApplicationListener<ContextRefreshedEvent> {

    private final SessionFactory sessionFactory;
    private final CustomNeo4jEventListener customEventListener;

    @Autowired
    public Neo4jListenerRegistrar(SessionFactory sessionFactory, CustomNeo4jEventListener customEventListener) {
        this.sessionFactory = sessionFactory;
        this.customEventListener = customEventListener;
    }

    @Override
    public void onApplicationEvent(ContextRefreshedEvent event) {
        // 获取Session
        Session session = sessionFactory.openSession();
        // 获取Session的事件监听器容器
        EventListeners eventListeners = session.getEventListeners();
        // 注册自定义监听器
        eventListeners.register(customEventListener);
    }
}

方式2：自定义SessionFactory配置（全局生效） #

如果希望所有新创建的Session都自动带上监听器，可以自定义SessionFactory的配置，在创建SessionFactory时就注入监听器：

import org.neo4j.ogm.config.Configuration;
import org.neo4j.ogm.session.SessionFactory;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class Neo4jConfig {

    @Bean
    public SessionFactory sessionFactory() {
        Configuration config = new Configuration();
        // 这里配置你的Neo4j连接信息，也可以直接复用application.properties中的配置
        config.driverConfiguration()
                .setDriverClassName("org.neo4j.ogm.drivers.http.driver.HttpDriver")
                .setURI("http://localhost:7474")
                .setCredentials("neo4j", "your-password");

        // 创建SessionFactory时，直接传入监听器
        SessionFactory sessionFactory = new SessionFactory(config, "com.your.package.domain");
        // 注册全局监听器（所有新创建的Session都会继承这个监听器）
        sessionFactory.register(new CustomNeo4jEventListener());
        return sessionFactory;
    }
}

三、自定义EventListener示例 #

不管用哪种注册方式，你需要先实现Neo4j OGM的EventListener接口，推荐继承AbstractEventListener来针对性处理特定事件（比如前置保存、后置删除等）：

import org.neo4j.ogm.event.AbstractEventListener;
import org.neo4j.ogm.event.PostSaveEvent;
import org.neo4j.ogm.event.PreDeleteEvent;
import org.springframework.stereotype.Component;

// 记得加上@Component让Spring容器管理这个监听器
@Component
public class CustomNeo4jEventListener extends AbstractEventListener {

    // 处理实体保存后的事件
    @Override
    public void onPostSave(PostSaveEvent event) {
        System.out.println("实体已保存：" + event.getEntity().getClass().getSimpleName() + " ID: " + event.getEntityId());
    }

    // 处理实体删除前的事件
    @Override
    public void onPreDelete(PreDeleteEvent event) {
        System.out.println("即将删除实体：" + event.getEntity().getClass().getSimpleName() + " ID: " + event.getEntityId());
    }
}

注意事项 #

• 确保你的自定义EventListener被Spring容器管理（加上@Component或通过@Bean注册）
• 在多线程场景下，Session是线程不安全的，不要长期持有Session实例，用完即释放
• 如果使用Spring Data Neo4j的Repository，底层会自动管理Session生命周期，无需手动创建Session

内容的提问来源于stack exchange，提问作者Ali.Wassouf