mindol1004/spring-data-mongodb
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Polished MongoTemplate

Browse Source 
- default converter to SimpleMongoConverter in constructor already
- made potential final members final
- use error message template instead of repeating the same String over and over again
- removed _-prefix from id variables
- extracted "_id" to ID constant
- fixed inevitable NullPointerExceptions in updateFirst(…), updateMulti(…) and remove(…)
- remove special handling of non available username and password in getDb() as MongoDbUtils.getDB already handles them correctly
- removed throws Exception form afterPropertiesSet() as it does not throw any checked exception
- use String as type for passwords at MongoTemplate API and only turn it into the underlying char[] when handing it to MongoDbUtils
- added assertions for mandatory constructor arguments
This commit is contained in:
Oliver Gierke
2011-01-04 10:45:23 +01:00
parent 70059760bb
commit b88ce28709
2 changed files with 147 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

101
spring-data-mongodb/src/main/java/org/springframework/data/document/mongodb/MongoTemplate.java
View File

@@ -16,6 +16,7 @@
package org.springframework.data.document.mongodb;
import static java.lang.String.*;
import java.beans.PropertyDescriptor;
import java.util.ArrayList;
@@ -28,6 +29,7 @@ import org.springframework.beans.PropertyAccessorFactory;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.dao.DataRetrievalFailureException;
import org.springframework.dao.InvalidDataAccessApiUsageException;
import org.springframework.util.Assert;
import com.mongodb.BasicDBObject;
import com.mongodb.CommandResult;
@@ -40,22 +42,32 @@ import com.mongodb.MongoException;
import com.mongodb.WriteResult;
import com.mongodb.util.JSON;
/**
* Primary implementation of {@link MongoOperations}.
*
* @author Thomas Risberg
* @author Graeme Rocher
* @author Mark Pollack
* @author Oliver Gierke
*/
public class MongoTemplate implements InitializingBean, MongoOperations {
private static final String ID = "_id";
private static final String COLLECTION_ERROR_TEMPLATE = "Error creating collection %s: %s";
private final MongoConverter mongoConverter;
private final Mongo mongo;
private String defaultCollectionName;
private MongoConverter mongoConverter;
//TODO expose configuration...
private CollectionOptions defaultCollectionOptions;
private Mongo mongo;
private String databaseName;
private String username;
private char[] password;
private String password;
public MongoTemplate(Mongo mongo, String databaseName) {
@@ -71,7 +83,11 @@ public class MongoTemplate implements InitializingBean, MongoOperations {
}
public MongoTemplate(Mongo mongo, String databaseName, String defaultCollectionName, MongoConverter mongoConverter) {
this.mongoConverter = mongoConverter;
Assert.notNull(mongo);
Assert.notNull(databaseName);
this.mongoConverter = mongoConverter == null ? new SimpleMongoConverter() : mongoConverter;
this.defaultCollectionName = defaultCollectionName;
this.mongo = mongo;
this.databaseName = databaseName;
@@ -92,7 +108,8 @@ public class MongoTemplate implements InitializingBean, MongoOperations {
*
* @param password The password to use
*/
public void setPassword(char[] password) {
public void setPassword(String password) {
this.password = password;
}
@@ -101,6 +118,7 @@ public class MongoTemplate implements InitializingBean, MongoOperations {
}
public void setDatabaseName(String databaseName) {
Assert.notNull(databaseName);
this.databaseName = databaseName;
}
@@ -191,7 +209,7 @@ public class MongoTemplate implements InitializingBean, MongoOperations {
try {
return getDb().createCollection(collectionName, new BasicDBObject());
} catch (MongoException e) {
throw new InvalidDataAccessApiUsageException("Error creating collection " + collectionName + ": " + e.getMessage(), e);
throw new InvalidDataAccessApiUsageException(format(COLLECTION_ERROR_TEMPLATE, collectionName, e.getMessage()), e);
}
}
@@ -202,7 +220,7 @@ public class MongoTemplate implements InitializingBean, MongoOperations {
try {
getDb().createCollection(collectionName, convertToDbObject(collectionOptions));
} catch (MongoException e) {
throw new InvalidDataAccessApiUsageException("Error creating collection " + collectionName + ": " + e.getMessage(), e);
throw new InvalidDataAccessApiUsageException(format(COLLECTION_ERROR_TEMPLATE, collectionName, e.getMessage()), e);
}
}
@@ -213,7 +231,7 @@ public class MongoTemplate implements InitializingBean, MongoOperations {
try {
return getDb().getCollection(collectionName);
} catch (MongoException e) {
throw new InvalidDataAccessApiUsageException("Error creating collection " + collectionName + ": " + e.getMessage(), e);
throw new InvalidDataAccessApiUsageException(format(COLLECTION_ERROR_TEMPLATE, collectionName, e.getMessage()), e);
}
}
@@ -268,8 +286,8 @@ public class MongoTemplate implements InitializingBean, MongoOperations {
public <T> void insert(String collectionName, T objectToSave, MongoWriter<T> writer) {
BasicDBObject dbDoc = new BasicDBObject();
writer.write(objectToSave, dbDoc);
Object _id = insertDBObject(collectionName, dbDoc);
populateIdIfNecessary(objectToSave, _id);
Object id = insertDBObject(collectionName, dbDoc);
populateIdIfNecessary(objectToSave, id);
}
/* (non-Javadoc)
@@ -296,10 +314,11 @@ public class MongoTemplate implements InitializingBean, MongoOperations {
writer.write(o, dbDoc);
dbObjectList.add(dbDoc);
}
List<Object> _ids = insertDBObjectList(collectionName, dbObjectList);
List<Object> ids = insertDBObjectList(collectionName, dbObjectList);
for (int i = 0; i < listToSave.size(); i++) {
if (i < _ids.size())
populateIdIfNecessary(listToSave.get(i), _ids.get(i));
if (i < ids.size()) {
populateIdIfNecessary(listToSave.get(i), ids.get(i));
}
}
}
@@ -323,8 +342,8 @@ public class MongoTemplate implements InitializingBean, MongoOperations {
public <T> void save(String collectionName, T objectToSave, MongoWriter<T> writer) {
BasicDBObject dbDoc = new BasicDBObject();
writer.write(objectToSave, dbDoc);
Object _id = saveDBObject(collectionName, dbDoc);
populateIdIfNecessary(objectToSave, _id);
Object id = saveDBObject(collectionName, dbDoc);
populateIdIfNecessary(objectToSave, id);
}
@@ -333,7 +352,7 @@ public class MongoTemplate implements InitializingBean, MongoOperations {
WriteResult wr = null;
try {
wr = getDb().getCollection(collectionName).insert(dbDoc);
return dbDoc.get("_id");
return dbDoc.get(ID);
} catch (MongoException e) {
throw new DataRetrievalFailureException(wr.getLastError().getErrorMessage(), e);
}
@@ -344,20 +363,19 @@ public class MongoTemplate implements InitializingBean, MongoOperations {
}
protected List<Object> insertDBObjectList(String collectionName, List<DBObject> dbDocList) {
if (dbDocList.size() > 0 ) {
if (!dbDocList.isEmpty()) {
List<Object> ids = new ArrayList<Object>();
WriteResult wr = null;
try {
wr = getDb().getCollection(collectionName).insert(dbDocList);
for (DBObject dbo : dbDocList) {
ids.add(dbo.get("_id"));
ids.add(dbo.get(ID));
}
return ids;
} catch (MongoException e) {
throw new DataRetrievalFailureException(wr.getLastError().getErrorMessage(), e);
}
}
else {
} else {
return null;
}
}
@@ -367,12 +385,11 @@ public class MongoTemplate implements InitializingBean, MongoOperations {
WriteResult wr = null;
try {
wr = getDb().getCollection(collectionName).save(dbDoc);
return dbDoc.get("_id");
return dbDoc.get(ID);
} catch (MongoException e) {
throw new DataRetrievalFailureException(wr.getLastError().getErrorMessage(), e);
}
}
else {
} else {
return null;
}
}
@@ -388,11 +405,11 @@ public class MongoTemplate implements InitializingBean, MongoOperations {
* @see org.springframework.data.document.mongodb.MongoOperations#updateFirst(java.lang.String, com.mongodb.DBObject, com.mongodb.DBObject)
*/
public void updateFirst(String collectionName, DBObject queryDoc, DBObject updateDoc) {
WriteResult wr = null;
try {
wr = getDb().getCollection(collectionName).update(queryDoc, updateDoc);
getDb().getCollection(collectionName).update(queryDoc, updateDoc);
} catch (MongoException e) {
throw new DataRetrievalFailureException("Error during update using " + queryDoc + ", " + updateDoc + ": " + wr.getLastError().getErrorMessage(), e);
throw new DataRetrievalFailureException("Error during update using " + queryDoc + ", " + updateDoc + "!", e);
}
}
@@ -407,11 +424,10 @@ public class MongoTemplate implements InitializingBean, MongoOperations {
* @see org.springframework.data.document.mongodb.MongoOperations#updateMulti(java.lang.String, com.mongodb.DBObject, com.mongodb.DBObject)
*/
public void updateMulti(String collectionName, DBObject queryDoc, DBObject updateDoc) {
WriteResult wr = null;
try {
wr = getDb().getCollection(collectionName).updateMulti(queryDoc, updateDoc);
getDb().getCollection(collectionName).updateMulti(queryDoc, updateDoc);
} catch (MongoException e) {
throw new DataRetrievalFailureException("Error during updateMulti using " + queryDoc + ", " + updateDoc + ": " + wr.getLastError().getErrorMessage(), e);
throw new DataRetrievalFailureException("Error during updateMulti using " + queryDoc + ", " + updateDoc + "!", e);
}
}
@@ -426,11 +442,10 @@ public class MongoTemplate implements InitializingBean, MongoOperations {
* @see org.springframework.data.document.mongodb.MongoOperations#remove(java.lang.String, com.mongodb.DBObject)
*/
public void remove(String collectionName, DBObject queryDoc) {
WriteResult wr = null;
try {
wr = getDb().getCollection(collectionName).remove(queryDoc);
getDb().getCollection(collectionName).remove(queryDoc);
} catch (MongoException e) {
throw new DataRetrievalFailureException("Error during remove using " + queryDoc + ": " + wr.getLastError().getErrorMessage(), e);
throw new DataRetrievalFailureException("Error during remove using " + queryDoc + "!", e);
}
}
@@ -586,10 +601,7 @@ public class MongoTemplate implements InitializingBean, MongoOperations {
}
public DB getDb() {
if(username != null && password != null) {
return MongoDbUtils.getDB(mongo, databaseName, username, password);
}
return MongoDbUtils.getDB(mongo, databaseName);
return MongoDbUtils.getDB(mongo, databaseName, username, password == null ? null : password.toCharArray());
}
@@ -614,7 +626,7 @@ public class MongoTemplate implements InitializingBean, MongoOperations {
BeanWrapper bw = PropertyAccessorFactory.forBeanPropertyAccess(savedObject);
PropertyDescriptor idPd = BeanUtils.getPropertyDescriptor(savedObject.getClass(), "id");
if (idPd == null) {
idPd = BeanUtils.getPropertyDescriptor(savedObject.getClass(), "_id");
idPd = BeanUtils.getPropertyDescriptor(savedObject.getClass(), ID);
}
if (idPd != null) {
Object v = bw.getPropertyValue(idPd.getName());
@@ -627,19 +639,18 @@ public class MongoTemplate implements InitializingBean, MongoOperations {
}
}
}
}
public void afterPropertiesSet() throws Exception {
/*
* (non-Javadoc)
* @see org.springframework.beans.factory.InitializingBean#afterPropertiesSet()
*/
public void afterPropertiesSet() {
if (this.getDefaultCollectionName() != null) {
DB db = getDb();
if (! db.collectionExists(getDefaultCollectionName())) {
db.createCollection(getDefaultCollectionName(), null);
}
}
if (this.mongoConverter == null) {
mongoConverter = new SimpleMongoConverter();
}
}
}

90
spring-data-mongodb/src/test/java/org/springframework/data/document/mongodb/MongoTemplateUnitTests.java Normal file
View File

@@ -0,0 +1,90 @@
/*
* Copyright 2010-2011 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.data.document.mongodb;
import static org.junit.Assert.*;
import static org.mockito.Mockito.*;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mock;
import org.mockito.runners.MockitoJUnitRunner;
import org.springframework.dao.DataRetrievalFailureException;
import org.springframework.test.util.ReflectionTestUtils;
import com.mongodb.DB;
import com.mongodb.Mongo;
import com.mongodb.MongoException;
/**
* Unit tests for {@link MongoTemplate}.
*
* @author Oliver Gierke
*/
@RunWith(MockitoJUnitRunner.class)
public class MongoTemplateUnitTests {
MongoTemplate template;
@Mock
Mongo mongo;
@Mock
DB db;
@Before
public void setUp() {
this.template = new MongoTemplate(mongo, "database");
}
@Test(expected = IllegalArgumentException.class)
public void rejectsNullDatabaseName() throws Exception {
new MongoTemplate(mongo, null);
}
@Test(expected = IllegalArgumentException.class)
public void rejectsNullMongo() throws Exception {
new MongoTemplate(null, "database");
}
@Test(expected = DataRetrievalFailureException.class)
public void removeHandlesMongoExceptionProperly() throws Exception {
MongoTemplate template = mockOutGetDb();
when(db.getCollection("collection")).thenThrow(new MongoException("Exception!"));
template.remove("collection", null);
}
@Test
public void defaultsConverterToSimpleMongoConverter() throws Exception {
MongoTemplate template = new MongoTemplate(mongo, "database");
assertTrue(ReflectionTestUtils.getField(template, "mongoConverter") instanceof SimpleMongoConverter);
}
/**
* Mocks out the {@link MongoTemplate#getDb()} method to return the {@link DB} mock instead of executing the actual
* behaviour.
*
* @return
*/
private MongoTemplate mockOutGetDb() {
MongoTemplate template = spy(this.template);
stub(template.getDb()).toReturn(db);
return template;
}
}