Spring Data MongoDB 快速入门

无厘头码手6个月前发布

Spring Data MongoDB 是 Spring Data 系列的一部分，它提供了与 MongoDB 的集成和操作支持，类似于 JPA 对关系型数据库的支持。通过使用 Spring Data MongoDB，您可以使用类似于 JPA 的 Repository 接口、自动映射功能以及其他便利特性来访问和操作 MongoDB 数据库。

1.Spring Data MongoDB接入

1.1 添加依赖：

在项目的构建文件（如 Maven 的 pom.xml 或 Gradle 的 build.gradle）中添加 Spring Data MongoDB 的依赖项。例如，在 Maven 中添加以下依赖项：

<dependencies>
  <!-- 其他依赖 -->
  <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-mongodb</artifactId>
  </dependency>
</dependencies>

1.2 创建实体类：

使用 MongoDB 的注解来定义实体类，并将其映射到 MongoDB 的集合（collection）。注解包括 @Document、@Field、@Id 等。

import org.springframework.data.mongodb.core.mapping.Document;
import org.springframework.data.annotation.Id;

@Document(collection = "users")
public class User {

  @Id
  private String id;

  @Field("name")
  private String name;

  // getter and setter methods
}

1.3 创建 Repository 接口：

　　创建一个继承自 MongoRepository（或其他 Spring Data MongoDB 提供的 Repository 接口）的接口，用于访问和操作实体类对应的 MongoDB 数据

import org.springframework.data.mongodb.repository.MongoRepository;

public interface UserRepository extends MongoRepository<User, String> {
    // 可根据需要添加自定义查询方法
}

1.4 配置 MongoDB 连接信息：

在 Spring Boot 的配置文件中，配置 MongoDB 的连接信息，例如数据库名称、主机地址、端口等。

spring.data.mongodb.host=localhost
spring.data.mongodb.port=27017
spring.data.mongodb.database=mydatabase

使用 Repository 进行操作：在需要使用 MongoDB 操作的地方，通过注入 Repository 接口对象来调用相应的方法。

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class UserService {

  private final UserRepository userRepository;

  @Autowired
  public UserService(UserRepository userRepository) {
    this.userRepository = userRepository;
  }

  public User saveUser(User user) {
    return userRepository.save(user);
  }

  public User getUserById(String id) {
    return userRepository.findById(id).orElse(null);
  }

  // 其他操作方法
}

上述示例是一个简单的使用 JPA 和 MongoDB 的流程。它包括创建实体类、定义 Repository 接口、配置 MongoDB 的连接信息和使用 Repository 进行操作。这样可以使用 Spring Data MongoDB 结合 JPA 和 MongoDB 进行开发，并享受到 Spring Data 提供的便利特性。

2.Spring Data MongoDB 自定义方法解析使用

　　在 UserRepository 中定义使用的方法非常简单。Spring Data MongoDB 提供了一套命名规则，它根据方法名自动解析和生成查询语句。您可以按照规则给方法命名，而不需要编写具体的查询语句。

　　以下是一些常见的方法命名规则及其解析方式：

根据属性查询：
- findBy<PropertyName>：根据属性名称进行查询，例如 findByName(String name)。
- findBy<PropertyName>And<OtherProperty>：根据多个属性进行查询，并通过 “And” 连接，例如 findByNameAndAge(String name, int age)。
按条件查询：
- findBy<PropertyName>Equals：根据属性的精确匹配进行查询，例如 findByNameEquals(String name)。
- findBy<PropertyName>In：根据属性值在给定集合中的条件进行查询，例如 findByAgeIn(Collection<Integer> ages)。
模糊查询：
- findBy<PropertyName>Like：根据属性值进行模糊查询，例如 findByNameLike(String keyword)。

除了以上示例，还有更多可用的方法命名规则，可以根据具体需求查阅 Spring Data MongoDB 文档以获得更全面的了解。

注意事项：

方法名称必须遵循命名规则，否则可能会导致查询失败。
方法参数的数量和类型必须与属性的类型和数量匹配。
在使用一些特殊操作时，如模糊查询、集合查询等，可以使用 Like、In 等关键字来指定更复杂的条件。

以下是一个简单的示例：

import org.springframework.data.mongodb.repository.MongoRepository;
import java.util.List;

public interface UserRepository extends MongoRepository<User, String> {
    List<User> findByName(String name);
    List<User> findByAgeGreaterThan(int age);
    List<User> findByEmailNotNull();
    List<User> findByAgeIn(List<Integer> ages);
    List<User> findByNameLike(String keyword);
}

在上述示例中，UserRepository 定义了五个查询方法：根据名称查询用户、根据年龄大于给定值查询用户、查询邮箱不为 null 的用户、根据年龄在给定集合中查询用户以及根据名称进行模糊查询。这些方法会根据方法名自动解析为相应的查询条件，并返回符合条件的用户列表。

请注意，在实际使用过程中，可能需要处理一些特定的查询场景或复杂的条件，可能需要编写自定义的查询语句。Spring Data MongoDB 提供了注解和其他方式来支持自定义查询，以满足更复杂的需求。

3.自定义查询语句

在 Spring Data MongoDB 中，可以使用自定义的查询语句来满足特定的查询需求。以下是两种常用的方式来实现自定义查询：

3.1使用 `@Query` 注解：

在需要进行自定义查询的方法上添加 @Query 注解，并提供相应的查询语句。
在查询语句中使用命名参数（例如 :paramName）来引用方法参数。
如果有多个参数，可以通过索引位置（例如 ?0、?1）引用它们。

　　示例：

import org.springframework.data.mongodb.repository.MongoRepository;
import org.springframework.data.mongodb.repository.Query;
import java.util.List;

public interface UserRepository extends MongoRepository<User, String> {
    @Query("{ 'name' : ?0 }")
    List<User> findByName(String name);

    @Query("{ 'age' : { $gt: ?0 }, 'email' : { $ne: null } }")
    List<User> findByAgeGreaterThanAndEmailNotNull(int age);
}

在上述示例中，使用了 @Query 注解来自定义查询语句。通过 ?0 引用了方法参数，并根据属性条件进行查询。

3.2使用 Criteria API：

- 创建一个 Criteria 对象，并使用其提供的方法来构建查询条件。
- 将 Criteria 对象传递给 MongoTemplate 的 find 方法进行查询。

　　示例：

import org.springframework.data.mongodb.core.MongoTemplate;
import org.springframework.data.mongodb.core.query.Criteria;
import org.springframework.data.mongodb.core.query.Query;
import java.util.List;

public class UserRepositoryImpl implements UserRepositoryCustom {

    private final MongoTemplate mongoTemplate;

    public UserRepositoryImpl(MongoTemplate mongoTemplate) {
        this.mongoTemplate = mongoTemplate;
    }

    @Override
    public List<User> findByAgeGreaterThanAndEmailNotNull(int age) {
        Criteria criteria = Criteria.where("age").gt(age).and("email").ne(null);
        Query query = new Query(criteria);
        return mongoTemplate.find(query, User.class);
    }
}

在上述示例中，UserRepositoryImpl 实现了 UserRepositoryCustom 接口，并使用 MongoTemplate 和 Criteria API 来自定义查询方法。

在 findByAgeGreaterThanAndEmailNotNull 方法中，创建了一个 Criteria 对象，并指定年龄大于给定值且邮箱不为空的条件，然后将其传递给 Query 对象并执行查询。

评分

欢迎为Ta评分