BAEL-5404 - UUID as Entity ID in MongoDB

Commit to spring-data-mongodb-2
2022-06-27 15:32:38 +02:00
parent 02e904b225
commit 073a07f4ca
12 changed files with 456 additions and 0 deletions
@@ -0,0 +1,59 @@
+package com.baeldung.uuid;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.data.mongodb.core.MongoOperations;
+import org.springframework.data.mongodb.core.query.Criteria;
+import org.springframework.data.mongodb.core.query.Query;
+import org.springframework.test.context.ContextConfiguration;
+import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
+
+import com.baeldung.uuid.config.CustomRepositoryMongoConfig;
+import com.baeldung.uuid.model.Book;
+import com.baeldung.uuid.repository.BookRepository;
+
+/**
+ * 
+ * This test requires:
+ * * mongodb instance running on the environment
+ *
+ */
+@RunWith(SpringJUnit4ClassRunner.class)
+@ContextConfiguration(classes = CustomRepositoryMongoConfig.class)
+public class CustomRepositoryLiveTest {
+
+    @Autowired
+    private BookRepository bookRepository;
+
+    @Autowired
+    private MongoOperations mongoOps;
+
+    @Before
+    public void testSetup() {
+        if (!mongoOps.collectionExists(Book.class)) {
+            mongoOps.createCollection(Book.class);
+        }
+    }
+
+    @After
+    public void tearDown() {
+        mongoOps.dropCollection(Book.class);
+    }
+
+    @Test
+    public void whenInsertingBook_thenBookIsInserted() {
+        final Book book = new Book();
+        book.setTitle("The Lord of the Rings");
+        book.setAuthor("JRR Tolkien");
+        Book savedBook = bookRepository.save(book);
+                
+        Book result = mongoOps.findOne(Query.query(Criteria.where("_id").is(savedBook.getId())), Book.class);
+                
+        assertEquals(result.getTitle(), "The Lord of the Rings");
+    }
+}
@@ -0,0 +1,64 @@
+package com.baeldung.uuid;
+
+import static org.junit.Assert.assertNotNull;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.data.mongodb.core.MongoOperations;
+import org.springframework.data.mongodb.core.query.Criteria;
+import org.springframework.data.mongodb.core.query.Query;
+import org.springframework.test.context.ContextConfiguration;
+import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
+
+import com.baeldung.uuid.config.EntityCallbackMongoConfig;
+import com.baeldung.uuid.model.Book;
+import com.baeldung.uuid.repository.BookRepository;
+
+/**
+ * 
+ * This test requires:
+ * * mongodb instance running on the environment
+ *
+ */
+@RunWith(SpringJUnit4ClassRunner.class)
+@ContextConfiguration(classes = EntityCallbackMongoConfig.class)
+public class EntityCallbackLiveTest {
+
+    @Autowired
+    private BookRepository bookRepository;
+
+    @Autowired
+    private MongoOperations mongoOps;
+
+    @Before
+    public void testSetup() {
+        if (!mongoOps.collectionExists(Book.class)) {
+            mongoOps.createCollection(Book.class);
+        }
+    }
+
+    @After
+    public void tearDown() {
+        mongoOps.dropCollection(Book.class);
+    }
+
+    @Test
+    public void whenSavingArticle_thenArticleIsInserted() {
+        final Book book = new Book();
+        book.setTitle("The Lord of the Rings");
+        book.setAuthor("JRR Tolkien");
+        
+        Book savedArticle = bookRepository.save(book);
+                
+        Book result = mongoOps.findOne(Query.query(Criteria.where("_id").is(savedArticle.getId())), Book.class);
+        
+        assertNotNull(result);
+        assertEquals(result.getTitle(), "The Lord of the Rings");
+    }
+
+
+}
@@ -0,0 +1,64 @@
+package com.baeldung.uuid;
+
+import static org.junit.Assert.assertNotNull;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.data.mongodb.core.MongoOperations;
+import org.springframework.data.mongodb.core.query.Criteria;
+import org.springframework.data.mongodb.core.query.Query;
+import org.springframework.test.context.ContextConfiguration;
+import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
+
+import com.baeldung.uuid.config.EventMongoConfig;
+import com.baeldung.uuid.model.Book;
+import com.baeldung.uuid.repository.BookRepository;
+
+/**
+ * 
+ * This test requires:
+ * * mongodb instance running on the environment
+ *
+ */
+@RunWith(SpringJUnit4ClassRunner.class)
+@ContextConfiguration(classes = EventMongoConfig.class)
+public class EventLiveTest {
+
+    @Autowired
+    private BookRepository bookRepository;
+
+    @Autowired
+    private MongoOperations mongoOps;
+
+    @Before
+    public void testSetup() {
+        if (!mongoOps.collectionExists(Book.class)) {
+            mongoOps.createCollection(Book.class);
+        }
+    }
+
+    @After
+    public void tearDown() {
+        mongoOps.dropCollection(Book.class);
+    }
+
+    @Test
+    public void whenSavingArticle_thenArticleIsInserted() {
+        final Book book = new Book();
+        book.setTitle("The Lord of the Rings");
+        book.setAuthor("JRR Tolkien");
+        
+        Book savedArticle = bookRepository.save(book);
+                
+        Book result = mongoOps.findOne(Query.query(Criteria.where("_id").is(savedArticle.getId())), Book.class);
+        
+        assertNotNull(result);
+        assertEquals(result.getTitle(), "The Lord of the Rings");
+    }
+
+
+}
@@ -0,0 +1,32 @@
+package com.baeldung.uuid.config;
+
+import org.bson.UuidRepresentation;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.data.mongodb.core.MongoTemplate;
+import org.springframework.data.mongodb.repository.config.EnableMongoRepositories;
+
+import com.baeldung.uuid.repository.impl.CustomMongoRepositoryImpl;
+import com.mongodb.ConnectionString;
+import com.mongodb.MongoClientSettings;
+import com.mongodb.client.MongoClient;
+import com.mongodb.client.MongoClients;
+
+@Configuration
+@EnableMongoRepositories(basePackages = "com.baeldung.uuid.repository", repositoryBaseClass = CustomMongoRepositoryImpl.class)
+public class CustomRepositoryMongoConfig {
+
+    @Bean
+    public MongoClient mongo() throws Exception {
+        final ConnectionString connectionString = new ConnectionString("mongodb://localhost:27017/test");
+        final MongoClientSettings mongoClientSettings = MongoClientSettings.builder()
+                                                                    .uuidRepresentation(UuidRepresentation.STANDARD)
+                                                                    .applyConnectionString(connectionString).build();
+        return MongoClients.create(mongoClientSettings);
+    }
+
+    @Bean
+    public MongoTemplate mongoTemplate() throws Exception {
+        return new MongoTemplate(mongo(), "test");
+    }
+}
@@ -0,0 +1,48 @@
+package com.baeldung.uuid.config;
+
+import java.util.UUID;
+
+import org.bson.UuidRepresentation;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.data.mongodb.core.MongoTemplate;
+import org.springframework.data.mongodb.core.mapping.event.BeforeConvertCallback;
+import org.springframework.data.mongodb.repository.config.EnableMongoRepositories;
+
+import com.baeldung.uuid.model.UuidIdentifiedEntity;
+import com.mongodb.ConnectionString;
+import com.mongodb.MongoClientSettings;
+import com.mongodb.client.MongoClient;
+import com.mongodb.client.MongoClients;
+
+@Configuration
+@EnableMongoRepositories(basePackages = "com.baeldung.uuid.repository")
+public class EntityCallbackMongoConfig {
+
+    @Bean
+    public MongoClient mongo() throws Exception {
+        final ConnectionString connectionString = new ConnectionString("mongodb://localhost:27017/test");
+        final MongoClientSettings mongoClientSettings = MongoClientSettings.builder()
+                                                                    .uuidRepresentation(UuidRepresentation.STANDARD)
+                                                                    .applyConnectionString(connectionString).build();
+        return MongoClients.create(mongoClientSettings);
+    }
+
+    @Bean
+    public MongoTemplate mongoTemplate() throws Exception {
+        return new MongoTemplate(mongo(), "test");
+    }
+    
+    @Bean
+    public BeforeConvertCallback<UuidIdentifiedEntity> beforeSaveCallback() {
+        
+        return (entity, collection) -> {
+          
+            if(entity.getId() == null) {
+                entity.setId(UUID.randomUUID());
+            }
+            return entity;
+        };        
+    }
+    
+}
@@ -0,0 +1,38 @@
+package com.baeldung.uuid.config;
+
+import org.bson.UuidRepresentation;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.data.mongodb.core.MongoTemplate;
+import org.springframework.data.mongodb.repository.config.EnableMongoRepositories;
+
+import com.baeldung.uuid.event.UuidIdentifiedEntityEventListener;
+import com.mongodb.ConnectionString;
+import com.mongodb.MongoClientSettings;
+import com.mongodb.client.MongoClient;
+import com.mongodb.client.MongoClients;
+
+@Configuration
+@EnableMongoRepositories(basePackages = "com.baeldung.uuid.repository")
+public class EventMongoConfig {
+
+    @Bean
+    public MongoClient mongo() throws Exception {
+        final ConnectionString connectionString = new ConnectionString("mongodb://localhost:27017/test");
+        final MongoClientSettings mongoClientSettings = MongoClientSettings.builder()
+                                                                    .uuidRepresentation(UuidRepresentation.STANDARD)
+                                                                    .applyConnectionString(connectionString).build();
+        return MongoClients.create(mongoClientSettings);
+    }
+
+    @Bean
+    public MongoTemplate mongoTemplate() throws Exception {
+        return new MongoTemplate(mongo(), "test");
+    }
+    
+    @Bean
+    public UuidIdentifiedEntityEventListener uuidIdentifiedEntityEventListener() {
+  
+        return new UuidIdentifiedEntityEventListener();
+    }
+}