spring-data-mongo的集成

mongo的开始

最近公司的一些业务扩展让我们需要在传统的库中不断的进行修改,考虑到日后的发展,决定引入mongodb来支持部分业务模型
MongoDB是一个介于关系数据库和非关系数据库之间的产品,是非关系数据库当中功能最丰富,最像关系数据库的。他支持的数据结构非常松散,是类似json的bson格式,因此可以存储比较复杂的数据类型。Mongo最大的特点是他支持的查询语言非常强大,其语法有点类似于面向对象的查询语言,几乎可以实现类似关系数据库单表查询的绝大部分功能,而且还支持对数据建立索引。

和spring的集成

spring-data-mongo和spring的集成是比较简单,比较spring-data-mongo已经替你做了很多的事情了

  • 首先在我们的spring的xml文件中增加注解支持,并扫描你要增加的配置文件的位置
    
   
  • 配置数据层模板(mongoTemplate)
@Configuration
public class MongoConfig {

    private static final ResourceBundle bundle = ResourceBundle.getBundle("mongodb");

    private String uri = bundle.getString("mongo.uri");

    public
    @Bean
    MongoDbFactory mongoDbFactory() throws Exception {
        // mongo连接池的参数
        MongoClientOptions.Builder mongoClientOptions =
            MongoClientOptions.builder().socketTimeout(3000).connectTimeout(3000)
                .connectionsPerHost(20);
        // 设置连接池
        MongoClientURI mongoClientURI = new MongoClientURI(uri, mongoClientOptions);
        return new SimpleMongoDbFactory(mongoClientURI);
    }

    public
    @Bean
    MongoTemplate mongoTemplate() throws Exception {
        return new MongoTemplate(mongoDbFactory());
    }
}

这里需要注意的东西是mongo.uri,这货是个啥玩意呢?
让我们去我们的mongo.properties文件中查看下具体的配置

mongo.uri=mongodb://userName:[email protected]:27017/DBname

没错,这就是核心配置,就像mysql的驱动连接方式一样,spring-data-mongo也可以采用url的方式连接
上述文件中的userNamepassWordDBname替换成你自己的参数就OK了

  • 基础base操作(基类的聚合)

下面我参照了 lynnlovemin 同学这篇文章的基类(进行了部分修改),进行了集成操作

我的base类

/**
 * 

* mongo查询基类 *

* * @author wangguangdong * @version 1.0 * @Date 16/3/8 */ @Component public abstract class BaseMongoDAOImpl { /** * spring mongodb 集成操作类 */ protected MongoTemplate mongoTemplate; public List find(Query query) { return mongoTemplate.find(query, this.getEntityClass()); } public T findOne(Query query) { return mongoTemplate.findOne(query, this.getEntityClass()); } public void update(Query query, Update update) { mongoTemplate.findAndModify(query, update, this.getEntityClass()); } public T save(T entity) { mongoTemplate.insert(entity); return entity; } public T findById(String id) { return mongoTemplate.findById(id, this.getEntityClass()); } //@Override public T findById(String id, String collectionName) { return mongoTemplate.findById(id, this.getEntityClass(), collectionName); } public long count(Query query) { return mongoTemplate.count(query, this.getEntityClass()); } /** * 获取需要操作的实体类class * * @return */ private Class getEntityClass() { return ReflectionUtils.getSuperClassGenricType(getClass()); } public void remove(Query query) { mongoTemplate.remove(query, this.getEntityClass()); } /** * 注入mongodbTemplate * * @param mongoTemplate */ protected abstract void setMongoTemplate(MongoTemplate mongoTemplate); }

ReflectionUtils反射工具类


/**
 * 

* 反射工具类 *

* * @author wangguangdong * @version 1.0 * @Date 16/3/8 */ public class ReflectionUtils { private static Logger logger = Logger.getLogger(ReflectionUtils.class); /** * 调用Getter方法. */ public static Object invokeGetterMethod(Object obj, String propertyName) { String getterMethodName = "get" + StringUtils.capitalize(propertyName); return invokeMethod(obj, getterMethodName, new Class[] {}, new Object[] {}); } /** * 调用Setter方法.使用value的Class来查找Setter方法. */ public static void invokeSetterMethod(Object obj, String propertyName, Object value) { invokeSetterMethod(obj, propertyName, value, null); } /** * 调用Setter方法. * * @param propertyType 用于查找Setter方法,为空时使用value的Class替代. */ public static void invokeSetterMethod(Object obj, String propertyName, Object value, Class propertyType) { Class type = propertyType != null ? propertyType : value.getClass(); String setterMethodName = "set" + StringUtils.capitalize(propertyName); invokeMethod(obj, setterMethodName, new Class[] {type}, new Object[] {value}); } /** * 直接读取对象属性值, 无视private/protected修饰符, 不经过getter函数. */ public static Object getFieldValue(final Object obj, final String fieldName) { Field field = getAccessibleField(obj, fieldName); if (field == null) { throw new IllegalArgumentException( "Could not find field [" + fieldName + "] on target [" + obj + "]"); } Object result = null; try { result = field.get(obj); } catch (IllegalAccessException e) { logger.error("不可能抛出的异常" + e.getMessage()); } return result; } /** * 直接设置对象属性值, 无视private/protected修饰符, 不经过setter函数. */ public static void setFieldValue(final Object obj, final String fieldName, final Object value) { Field field = getAccessibleField(obj, fieldName); if (field == null) { throw new IllegalArgumentException( "Could not find field [" + fieldName + "] on target [" + obj + "]"); } try { field.set(obj, value); } catch (IllegalAccessException e) { logger.error("不可能抛出的异常" + e.getMessage()); } } /** * 循环向上转型, 获取对象的DeclaredField, 并强制设置为可访问. *

* 如向上转型到Object仍无法找到, 返回null. */ public static Field getAccessibleField(final Object obj, final String fieldName) { Assert.notNull(obj, "object不能为空"); Assert.hasText(fieldName, "fieldName"); for (Class superClass = obj.getClass(); superClass != Object.class; superClass = superClass.getSuperclass()) { try { Field field = superClass.getDeclaredField(fieldName); field.setAccessible(true); return field; } catch (NoSuchFieldException e) {//NOSONAR // Field不在当前类定义,继续向上转型 } } return null; } /** * 直接调用对象方法, 无视private/protected修饰符. * 用于一次性调用的情况. */ public static Object invokeMethod(final Object obj, final String methodName, final Class[] parameterTypes, final Object[] args) { Method method = getAccessibleMethod(obj, methodName, parameterTypes); if (method == null) { throw new IllegalArgumentException( "Could not find method [" + methodName + "] on target [" + obj + "]"); } try { return method.invoke(obj, args); } catch (Exception e) { throw convertReflectionExceptionToUnchecked(e); } } /** * 循环向上转型, 获取对象的DeclaredMethod,并强制设置为可访问. * 如向上转型到Object仍无法找到, 返回null. *

* 用于方法需要被多次调用的情况. 先使用本函数先取得Method,然后调用Method.invoke(Object obj, Object... args) */ public static Method getAccessibleMethod(final Object obj, final String methodName, final Class... parameterTypes) { Assert.notNull(obj, "object不能为空"); for (Class superClass = obj.getClass(); superClass != Object.class; superClass = superClass.getSuperclass()) { try { Method method = superClass.getDeclaredMethod(methodName, parameterTypes); method.setAccessible(true); return method; } catch (NoSuchMethodException e) {//NOSONAR // Method不在当前类定义,继续向上转型 } } return null; } /** * 通过反射, 获得Class定义中声明的父类的泛型参数的类型. * 如无法找到, 返回Object.class. * eg. * public UserDao extends HibernateDao * * @param clazz The class to introspect * @return the first generic declaration, or Object.class if cannot be determined */ @SuppressWarnings({"unchecked", "rawtypes"}) public static Class getSuperClassGenricType(final Class clazz) { return getSuperClassGenricType(clazz, 0); } /** * 通过反射, 获得Class定义中声明的父类的泛型参数的类型. * 如无法找到, 返回Object.class. *

* 如public UserDao extends HibernateDao * * @param clazz clazz The class to introspect * @param index the Index of the generic ddeclaration,start from 0. * @return the index generic declaration, or Object.class if cannot be determined */ @SuppressWarnings("rawtypes") public static Class getSuperClassGenricType(final Class clazz, final int index) { Type genType = clazz.getGenericSuperclass(); if (!(genType instanceof ParameterizedType)) { logger.warn(clazz.getSimpleName() + "'s superclass not ParameterizedType"); return Object.class; } Type[] params = ((ParameterizedType) genType).getActualTypeArguments(); if (index >= params.length || index < 0) { logger.warn( "Index: " + index + ", Size of " + clazz.getSimpleName() + "'s Parameterized Type: " + params.length); return Object.class; } if (!(params[index] instanceof Class)) { logger.warn(clazz.getSimpleName() + " not set the actual class on superclass generic parameter"); return Object.class; } return (Class) params[index]; } /** * 将反射时的checked exception转换为unchecked exception. */ public static RuntimeException convertReflectionExceptionToUnchecked(Exception e) { if (e instanceof IllegalAccessException || e instanceof IllegalArgumentException || e instanceof NoSuchMethodException) { return new IllegalArgumentException("Reflection Exception.", e); } else if (e instanceof InvocationTargetException) { return new RuntimeException("Reflection Exception.", ((InvocationTargetException) e).getTargetException()); } else if (e instanceof RuntimeException) { return (RuntimeException) e; } return new RuntimeException("Unexpected Checked Exception.", e); } }

  • 如何使用
    首先我们的拥有一个实体类作为bean
    例如我们的user类
    class User implements Serializable{
        private String userName;
        private String passWord;
        public String getUserName() {
            return userName;
        }
        public void setUserName(String userName) {
            this.userName = userName;
        }
        public String getPassWord() {
            return passWord;
        }
        public void setPassWord(String passWord) {
            this.passWord = passWord;
        }
        
    }

我们需要些一个UserDao来实现User在mongo数据库上的操作

@Repository
public class UserDAO extends BaseMongoDAOImpl {

    @Autowired
    @Override
    protected void setMongoTemplate(MongoTemplate mongoTemplate) {
        this.mongoTemplate = mongoTemplate;
    }
}

这时候我们只需要在想用到UserDAO的地方声明这个属性并注入进去,就可以使用baseDao中的基础方法了,如果想实现一些别的方法,可以自行进行扩展

比如查询一个用户名是NB的人的时候,我们的就可以这么做

    
    Query query = new Query();
    query.addCriteria(Criteria.where("userName").is("NB"));
    User user = userDAO.findOne(query);

又比如我用户名为NB的人要把密码改成123

    Query query = new Query();
    query.addCriteria(Criteria.where("userName").is("NB"));
    Update update = Update.update("passWord", "123");
    userDAO.update(query, update);

参考链接

mongodb-java-driver基本用法
Spring整合- mongodb
Spring Data集成MongoDB访问
spring集成mongodb封装的简单的CRUD
spring-data-mongo官方wiki
Spring Data MongoDB hello world 示例
Mongodb与spring集成(1)------配置
spring data mongodb更新或删除子元素为数组的数据
spring集成mongodb封装的简单的CRUD

你可能感兴趣的:(spring-data-mongo的集成)