2. 程式人生 > >Spring Data Mongodb DBRef聯級儲存

Spring Data Mongodb DBRef聯級儲存

阿新 • • 發佈：2019-02-19

Spring Data MongoDB by default does not support cascade operations on referenced objects with @DBRef annotations as reference says:

The mapping framework does not handle cascading saves. If you change an Account object that is referenced by a Person object, you mustsave the Account object separately

. Calling save on the Person object will not automatically save the Account objects in the property accounts.

That’s quite problematic because in order to achieve saving child objects you need to override save method in repository in parent or create additional service methods like it is presented in 

here.

In this article I will show you how it can be achieved for all documents using generic implementation of AbstractMongoEventListener.

@CascadeSave annotation

Because we can’t change @DBRef annotation by adding cascade property lets create new annotation @CascadeSave that will be used to mark which fields should be saved when parent object is saved.

1
2
3
4
5
6
7
8
9
10
11
12

package pl.maciejwalkowiak.springdata.mongodb;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.FIELD })
public @interface CascadeSave {
}

CascadingMongoEventListener

Next part is to implement handler for this annotation. We will use for that powerful Spring Application Event mechanism. In particular we will extendAbstractMongoEventListener to catch saved object before it is converted to Mongo’s DBObject.

How does it work? When object MongoTemplate#save method is called, before object is actually saved it is being converted into DBObject from MongoDB api. CascadingMongoEventListener implemented below provides hook that catches object before its converted and:

  • goes through all its fields to check if there are fields annotated with @DBRef and @CascadeSave at once.
  • when field is found it checks if @Id annotation is present
  • child object is being saved
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

package pl.maciejwalkowiak.springdata.mongodb;
import org.bson.types.ObjectId;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.annotation.Id;
import org.springframework.data.mapping.model.MappingException;
import org.springframework.data.mongodb.core.MongoOperations;
import org.springframework.data.mongodb.core.mapping.DBRef;
import org.springframework.data.mongodb.core.mapping.event.AbstractMongoEventListener;
import org.springframework.stereotype.Component;
import org.springframework.util.ReflectionUtils;
import java.lang.reflect.Field;
public class CascadingMongoEventListener extends AbstractMongoEventListener {
  @Autowired
  private MongoOperations mongoOperations;
  @Override
  public void onBeforeConvert(final Object source) {
      ReflectionUtils.doWithFields(source.getClass(), new ReflectionUtils.FieldCallback() {
          public void doWith(Field field) throws IllegalArgumentException, IllegalAccessException {
              ReflectionUtils.makeAccessible(field);
              if (field.isAnnotationPresent(DBRef.class) && field.isAnnotationPresent(CascadeSave.class)) {
                  final Object fieldValue = field.get(source);
                  DbRefFieldCallback callback = new DbRefFieldCallback();
                  ReflectionUtils.doWithFields(fieldValue.getClass(), callback);
                  if (!callback.isIdFound()) {
                      throw new MappingException("Cannot perform cascade save on child object without id set");
                  }
                  mongoOperations.save(fieldValue);
              }
          }
      });
  }
  private static class DbRefFieldCallback implements ReflectionUtils.FieldCallback {
      private boolean idFound;
      public void doWith(Field field) throws IllegalArgumentException, IllegalAccessException {
          ReflectionUtils.makeAccessible(field);
          if (field.isAnnotationPresent(Id.class)) {
              idFound = true;
          }
      }
      public boolean isIdFound() {
          return idFound;
      }
  }
}

Mapping requirements

As you can see in order to make thing work you need to follow some rules:

  • parent’s class child property has to be mapped with @DBRef and @CascadeSave
  • child class needs to have property annotated with @Id and if that id is supposed to be autogenerated it should by type of ObjectId

Usage

In order to use cascade saving in your project you need just to register CascadingMongoEventListener in Spring Context:

1

<bean class="pl.maciejwalkowiak.springdata.mongodb.CascadingMongoEventListener" />

Let’s test it

In order to show an example I made two document classes:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

@Document
public class User {
  @Id
  private ObjectId id;
  private String name;
  @DBRef
  @CascadeSave
  private Address address;
  public User(String name) {
      this.name = name;
  }
  // ... getters, setters, equals hashcode
}

1
2
3
4
5
6
7
8
9
10
11
12

@Document
public class Address {
  @Id
  private ObjectId id;
  private String city;
  public Address(String city) {
      this.city = city;
  }
  // ... getters, setters, equals hashcode
}

In test there is one user with address created and then user is saved. Test will cover only positive scenario and its just meant to show that it actually works (applcationContext-tests.xml contains only default Spring Data MongoDB beans and CascadingMongoEventListener registered):

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations = {"classpath:applcationContext-tests.xml"})
public class CascadingMongoEventListenerTest {
  @Autowired
  private MongoOperations mongoOperations;
  /**
  * Clean collections before tests are executed
  */
  @Before
  public void cleanCollections() {
      mongoOperations.dropCollection(User.class);
      mongoOperations.dropCollection(Address.class);
  }
  @Test
  public void testCascadeSave() {
      // given
      User user = new User("John Smith");
      user.setAddress(new Address("London"));
      // when
      mongoOperations.save(user);
      // then
      List&lt;User&gt; users = mongoOperations.findAll(User.class);
      assertThat(users).hasSize(1).containsOnly(user);
      User savedUser = users.get(0);
      assertThat(savedUser.getAddress()).isNotNull().isEqualTo(user.getAddress());
      List&lt;Address&gt; addresses = mongoOperations.findAll(Address.class);
      assertThat(addresses).hasSize(1).containsOnly(user.getAddress());
  }
}

We can check that also in Mongo console:

1
2
3
4

> db.user.find()
{ "_id" : ObjectId("4f9d1bab1a8854250a5bf13e"), "_class" : "pl.maciejwalkowiak.springdata.mongodb.domain.User", "name" : "John Smith", "address" : { "$ref" : "address", "$id" : ObjectId("4f9d1ba41a8854250a5bf13d") } }
> db.address.find()
{ "_id" : ObjectId("4f9d1ba41a8854250a5bf13d"), "_class" : "pl.maciejwalkowiak.springdata.mongodb.domain.Address", "city" : "London" }

Summary

With this simple solution we can finally save child objects with one method call without implementing anything special for each document class.

I believe that we will find this functionality together with cascade delete as part Spring Data Mongo

相關推薦

Spring Data Mongodb DBRef聯級儲存

Spring Data MongoDB by default does not support cascade operations on referenced objects with @DBRef annotations as reference says: T

Spring Data MongoDB：使用GridFS儲存二進位制檔案

在MongoDB中，可以使用GridFS儲存二進位制檔案。本文介紹如何使用GridFsTemplate儲存和讀取圖片檔案。 1. GridFS - 儲存（使用Spring註解方式） impo

關於spring-data-mongodb用戶名密碼登錄報錯問題：Failed to authenticate to database

數據 base 設置 thread read ber ram tro pat 一.問題 　　1.spring-data-mongodb用戶名密碼登錄報錯問題：Failed to authenticate to database org.springframew

How to convert BigDecimal to Double in spring-data-mongodb framework

public 行存儲 沒有 err 自己 dbr tom odbc sim 問題描述：我們都知道對於涉及錢的數據必須使用BigDecimal類型進行存儲，今天在查詢mongo時仍然有精度問題，雖然我在代碼中使用了Big Decimal類型，但mongo中使用的是double

Mongodb系列- 使用spring-data-mongodb實現分頁查詢

mon 分頁查詢 rep template list pre pri 自動生成 aging 在用spring-data-mongodb框架開發的過程中,需要實現分頁查詢,就百度了下,沒找到滿意的又google了下,找到了思路. 在spring-data-mongodb 官

spring data jpa 如何呼叫mysql儲存過程？

  A:首先定義儲存過程依賴的jpa表：     @Entity     @Table(name="evenmngt_childthingtree_tmp")//資料庫中的表名     @Name

spring-data-mongodb

一、新增 Spring  Data  MongoDB 的MongoTemplate提供了兩種儲存文件方式，分別是save和insert方法，這兩種的區別：   （1）save ：我們在新增文件時，如果有一個相同_ID的文件時，會覆蓋原來的。 　　　 

初識spring data mongodb

話不多說上demo:         首選配置檔案，主要是連線mongodb資料庫使用： application.properties spring.data.mongodb.host=127.0.0.1 spring.data.mongodb.p

spring-data-mongodb 使用原生aggregate語句（更新中）

comm bject gre 大量 存儲過程 ODB 結果 查詢 方法 除了特殊註釋外，本文的測試結果均基於 spring-data-mongodb:1.10.6.RELEASE(spring-boot-starter:1.5.6.RELEASE)，MongoDB 3.0.

Spring Data MongoDB 分頁查詢

分享一下我老師大神的人工智慧教程！零基礎，通俗易懂！http://blog.csdn.net/jiangjunshow 也歡迎大家轉載本篇文章。分享知識，造福人民，實現我們中華民族偉大復興！        

mongo中的遊標與資料一致性的取捨 spring-data-mongodb 使用原生aggregate語句 mongo的runCommand與集合操作函式的關係 spring-data-mongodb與mongo shell的對應關係 mongo中的遊標與資料一致性的取捨

除了特殊註釋外，本文的測試結果均基於 spring-data-mongodb:1.10.6.RELEASE(spring-boot-starter:1.5.6.RELEASE)，MongoDB 3.0.6 　　我們在學習了一門程式語言時，一定要明白語句底層的意義，比如 User user= n

Hibernate 聯級儲存或更新 java

在看這篇文章之前，需要掌握一下知識點： 1、主體類的對映檔案 https://blog.csdn.net/qq_37591637/article/details/84337701 2、hibernate的核心檔案 https://blog.csdn.net/qq_37591637

springboot系列十一 Spring-Data-MongoDB

mongodb MongoDB 是一個基於分散式檔案儲存的NoSQL資料庫。由 C++ 語言編寫。旨在為 WEB 應用提供可擴充套件的高效能資料儲存解決方案。 MongoDB 是一個介於關係資料庫和非關係資料庫之間的產品，是非關係資料庫當中功能最豐富，最像關係資料庫的。 資料儲存格式類似於json {

spring-data-mongodb兩種實現方式對比

  之前介紹過springboot和mongodb整合，使用了spring-data-mongodb，因為springboot註解和自動化配置，我們少了很多配置，這裡介紹spring整合mongodb，使用的仍然是spring-data-mongodb，這裡需要配置一個spring-mo

spring-data-mongodb 和spring 版本不相容導致的錯誤

錯誤 org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'mongoTemplate': Bean instantiation via c

【Spring Data Access】SimplJdbcCall呼叫儲存過程

SimpleJdbcCall 呼叫儲存過程 SimpleJdbcCall主要用來進行呼叫儲存過程，這個方法使用起來也比較簡單，先通過一個比較簡單的示例來熟悉一下api import org.springframework.context.ApplicationC

Spring系列學習之Spring Data MongoDB資料訪問

英文原文：https://spring.io/projects/spring-data-mongodb 目錄 概述 介紹 特性 快速開始 學習 文件 示例 概述 MongoDB的Spring Data是Spring Data專案的一部分，旨在為新資料儲存提

Spring Data MongoDB 五：進階文件查詢（分頁、Morphia）（二）

一．簡介      SpringData  MongoDB提供了org.springframework.data.mongodb.core.MongoTemplate對MongoDB的find

Spring Data MongoDB 一：入門篇（環境搭建、簡單的CRUD操作）

一.簡介      Spring Data  MongoDB 專案提供與MongoDB文件資料庫的整合。Spring Data MongoDB POJO的關鍵功能區域為中心的模型與MongoDB的DBCollection輕鬆地編寫一個儲存庫互動資料訪問。 二.Spring

Spring Data MongoDB簡單的增刪改查

專案結構 具體程式碼 – 簡單的Bean類 package org.spring.mongodb.example.bean; /** * * 2015-10-17 * @category 直接複製的官網上的類 * @auth