Spring整合MongoDB（一）----快速指南

置顶 85程序员老王

已于 2024-03-30 18:47:31 修改

阅读量1.5k

点赞数 21

分类专栏： MongoDB 文章标签： spring mongodb java

于 2024-02-19 21:37:50 首次发布

本文链接：https://blog.csdn.net/gabriel_wang_sh/article/details/134457363

版权

MongoDB 专栏收录该内容

27 篇文章 0 订阅

订阅专栏

【Spring连载】使用Spring Data访问 MongoDB（一）----快速指南

一、版本要求
二、Hello World
三、连接到MongoDB

一、版本要求

Spring Data MongoDB 4.x二进制文件需要JDK级别17及以上版本和Spring Framework 6.1.4及以上版本。
在数据库和驱动程序方面，你需要至少4.x版本的MongoDB和兼容的MongoDB Java驱动程序（4.x或5.x）。

二、Hello World

首先，需要设置一个正在运行的MongoDB服务器。请参考MongoDB安装指南，了解如何启动MongoDB实例。安装后，启动MongoDB通常是运行以下命令:/bin/mongod然后你可以创建一个Person类来持久化:

package org.springframework.data.mongodb.example;

public class Person {

	private String id;
	private String name;
	private int age;

	public Person(String name, int age) {
		this.name = name;
		this.age = age;
	}

	public String getId() {
		return id;
	}

	public String getName() {
		return name;
	}

	public int getAge() {
		return age;
	}

	@Override
	public String toString() {
		return "Person [id=" + id + ", name=" + name + ", age=" + age + "]";
	}
}

你还需要一个主应用程序来运行:

package org.springframework.data.mongodb.example;

import static org.springframework.data.mongodb.core.query.Criteria.*;

import org.springframework.data.mongodb.core.MongoOperations;
import org.springframework.data.mongodb.core.MongoTemplate;

import com.mongodb.client.MongoClients;

public class MongoApplication {

	public static void main(String[] args) throws Exception {

		MongoOperations mongoOps = new MongoTemplate(MongoClients.create(), "database");
		mongoOps.insert(new Person("Joe", 34));

		System.out.println(mongoOps.query(Person.class).matching(where("name").is("Joe")).firstValue());

		mongoOps.dropCollection("person");
	}
}

当你运行主程序时，上面的例子产生如下输出:

10:01:32,265 DEBUG o.s.data.mongodb.core.MongoTemplate - insert Document containing fields: [_class, age, name] in collection: Person
10:01:32,765 DEBUG o.s.data.mongodb.core.MongoTemplate - findOne using query: { "name" : "Joe"} in db.collection: database.Person
Person [id=4ddbba3c0be56b7e1b210166, name=Joe, age=34]
10:01:32,984 DEBUG o.s.data.mongodb.core.MongoTemplate - Dropped collection [database.person]

即使在这个简单的例子中，也有值得注意的几点：

你可以通过使用标准或反应式（reactive）MongoClient对象和要使用的数据库名称来实例化Spring Mongo的中心助手类MongoTemplate。
mapper针对标准POJO对象工作，而不需要任何额外的元数据（尽管你可以选择提供这些信息，参见这里）。
约定（Conventions）用于处理id字段，将其存储在数据库中时转换为ObjectId。
映射约定可以使用字段访问。请注意，Person类只有getter。
如果构造函数参数名称与存储文档的字段名称匹配，则它们用于实例化对象

三、连接到MongoDB

使用MongoDB和Spring的第一个任务是使用IoC容器创建MongoClient对象。有两种主要方法可以做到这一点，要么使用基于Java的bean元数据，要么使用使用基于XML的bean元数据。
对于那些不熟悉如何使用基于Java的bean元数据而不是基于XML的元数据来配置Spring容器的人，请参阅此处参考文档中的高级介绍以及此处的详细文档。

3.1 注册一个mongodb实例

下面展示了注册一个MongoClient实例的示例:
使用Java注册MongoClient

@Configuration
public class AppConfig {

  /*
   * Use the standard Mongo driver API to create a com.mongodb.client.MongoClient instance.
   */
   public @Bean com.mongodb.client.MongoClient mongoClient() {
       return com.mongodb.client.MongoClients.create("mongodb://localhost:27017");
   }
}

使用XML注册MongoClient

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:mongo="http://www.springframework.org/schema/data/mongo"
xsi:schemaLocation=
"
http://www.springframework.org/schema/data/mongo https://www.springframework.org/schema/data/mongo/spring-mongo.xsd
http://www.springframework.org/schema/beans
https://www.springframework.org/schema/beans/spring-beans.xsd">

    <!-- Default bean name is 'mongo' -->
    <mongo:mongo-client host="localhost" port="27017"/>

</beans>

这种方法允许你使用标准MongoClient实例，容器使用Spring的MongoClientFactoryBean/ReactiveMongoClientFactoryBean。与直接实例化MongoClient实例相比，FactoryBean还有一个额外的优势，即还为容器提供了ExceptionTranslator实现，该实现将MongoDB异常转换为Spring的可移植DataAccessException层次结构中的异常，用于@Repository注解的数据访问类。Spring的DAO支持特性中描述了这种层次结构和@Repository的使用。
以下示例展示了一个基于Java的bean元数据示例，该元数据支持@Repository注解类上的异常转换：
通过MongoClientFactoryBean/ReactiveMongoClientFactoryBean注册MongoClient

@Configuration
public class AppConfig {

    /*
     * Factory bean that creates the com.mongodb.client.MongoClient instance
     */
     public @Bean MongoClientFactoryBean mongo() {
          MongoClientFactoryBean mongo = new MongoClientFactoryBean();
          mongo.setHost("localhost");
          return mongo;
     }
}

要访问FactoryBean在其他@Configuration类或你自己的类中创建的MongoClient对象，请使用private @Autowired MongoClient mongoClient;字段。

3.2 MongoDatabaseFactory接口

虽然MongoClient是MongoDB驱动程序API的入口点，但连接到特定的MongoDB数据库实例需要额外的信息，例如数据库名称和可选的用户名和密码。有了这些信息，你可以获得一个MongoDB对象，并访问特定MongoDB数据库实例的所有功能。Spring提供org.springframework.data.mongodb.core.MongoDatabaseFactory&org.springframework.data.mongodb.core.ReactiveMongoDatabaseFactory接口，如以下列表所示，用于引导到数据库的连接：

public interface MongoDatabaseFactory {

  MongoDatabase getDatabase() throws DataAccessException;

  MongoDatabase getDatabase(String dbName) throws DataAccessException;
}

以下部分展示了如何将容器与基于Java或基于XML的元数据一起使用，以配置MongoDatabaseFactory接口的实例。进一步地，你可以使用MongoDatabaseFactory/ReactiveMongoDatabaseFactory实例来配置MongoTemplate/ReactiveMongoTemplate。
除了使用IoC容器来创建template的实例，你也可以在标准Java代码中使用它们，如下所示：

public class MongoApplication {

  public static void main(String[] args) throws Exception {

    MongoOperations mongoOps = new MongoTemplate(new SimpleMongoClientDatabaseFactory(MongoClients.create(), "database"));

    // ...
  }
}

上述代码展示了SimpleMongoClientDatabaseFactory的使用，是与章节二中展示的代码之间的唯一区别。当把“com.mongodb.client.MongoClient”作为选择的入口点时，请使用SimpleMongoClientDatabaseFactory。

3.3 注册一个MongoDatabaseFactory或ReactiveMongoDatabaseFactory

要在容器中注册MongoDatabaseFactory/ReactiveMongoDatabaseFactory实例，你需要编写与上一节中展示的代码非常相似的代码。下面的列表展示了一个简单的示例：

@Configuration
public class MongoConfiguration {

  @Bean
  public MongoDatabaseFactory mongoDatabaseFactory() {
    return new SimpleMongoClientDatabaseFactory(MongoClients.create(), "database");
  }
}

MongoDB Server第3代在连接到DB时更改了身份验证模型。因此，某些可用于身份验证的配置选项不再有效。你应该使用MongoClient特定的选项通过MongoCredential设置凭据以提供身份验证数据，如以下示例所示：

@Configuration
public class MongoAppConfig extends AbstractMongoClientConfiguration {

  @Override
  public String getDatabaseName() {
    return "database";
  }

  @Override
  protected void configureClientSettings(Builder builder) {

    builder
        .credential(MongoCredential.createCredential("name", "db", "pwd".toCharArray()))
        .applyToClusterSettings(settings  -> {
          settings.hosts(singletonList(new ServerAddress("127.0.0.1", 27017)));
        });
  }
}

如果你需要在用于创建SimpleMongoClientDatabaseFactory的“com.mongodb.client.MongoClient”实例上配置其他选项，你可以引用现有的bean，如下例所示。为了展示另一种常见的使用模式，以下列表显示了属性占位符的使用，它允许你参数化配置和MongoTemplate的创建：

@Configuration
@PropertySource("classpath:/com/myapp/mongodb/config/mongo.properties")
public class MongoAppConfig extends AbstractMongoClientConfiguration {

  @Autowired
  Environment env;

  @Override
  public String getDatabaseName() {
    return "database";
  }

  @Override
  protected void configureClientSettings(Builder builder) {

    builder.applyToClusterSettings(settings -> {
    settings.hosts(singletonList(
          new ServerAddress(env.getProperty("mongo.host"), env.getProperty("mongo.port", Integer.class))));
    });

    builder.applyToConnectionPoolSettings(settings -> {

      settings.maxConnectionLifeTime(env.getProperty("mongo.pool-max-life-time", Integer.class), TimeUnit.MILLISECONDS)
          .minSize(env.getProperty("mongo.pool-min-size", Integer.class))
          .maxSize(env.getProperty("mongo.pool-max-size", Integer.class))
          .maintenanceFrequency(10, TimeUnit.MILLISECONDS)
          .maintenanceInitialDelay(11, TimeUnit.MILLISECONDS)
          .maxConnectionIdleTime(30, TimeUnit.SECONDS)
          .maxWaitTime(15, TimeUnit.MILLISECONDS);
    });
  }
}

以上是基于Java的配置，下面展示基于XML的配置：

<mongo:db-factory dbname="database" />

当基于XML的配置中使用的用户名和密码凭据包含保留字符（如:, %, @, 或 ,）时，这些凭据必须是URL-encoded的。以下示例展示了编码的凭据：m0ng0@dmin:mo_res:bw6},Qsdxx@admin@database → m0ng0%40dmin:mo_res%3Abw6%7D%2CQsdxx%40admin@database有关更多详细信息，请参阅RFC 3986的第2.2节。

<context:property-placeholder location="classpath:/com/myapp/mongodb/config/mongo.properties"/>

<mongo:mongo-client host="${mongo.host}" port="${mongo.port}">
  <mongo:client-settings connection-pool-max-connection-life-time="${mongo.pool-max-life-time}"
    connection-pool-min-size="${mongo.pool-min-size}"
    connection-pool-max-size="${mongo.pool-max-size}"
    connection-pool-maintenance-frequency="10"
    connection-pool-maintenance-initial-delay="11"
    connection-pool-max-connection-idle-time="30"
    connection-pool-max-wait-time="15" />
</mongo:mongo-client>

<mongo:db-factory dbname="database" mongo-ref="mongoClient"/>

<bean id="anotherMongoTemplate" class="org.springframework.data.mongodb.core.MongoTemplate">
  <constructor-arg name="mongoDbFactory" ref="mongoDbFactory"/>
</bean>

85程序员老王

关注

21
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
Spring整合MongoDB（一）----快速指南

虽然MongoClient是MongoDB驱动程序API的入口点，但连接到特定的MongoDB数据库实例需要额外的信息，例如数据库名称和可选的用户名和密码。与直接实例化MongoClient实例相比，FactoryBean还有一个额外的优势，即还为容器提供了ExceptionTranslator实现，该实现将MongoDB异常转换为Spring的可移植DataAccessException层次结构中的异常，用于@Repository注解的数据访问类。首先，需要设置一个正在运行的MongoDB服务器。
复制链接

扫一扫