【数据库系列】MongoTemplate 基本入门：MongoDB 的增删改查

MongoDB 是一种流行的 NoSQL 数据库，适合存储大量的非结构化数据。在 Spring 框架中，MongoTemplate 提供了一种方便的方式来与 MongoDB 进行交互，支持基本的增删改查操作。本文将详细介绍 MongoTemplate 的基本用法，包含语法介绍和具体的使用示例。

1. 环境准备

1.1 依赖配置

首先，确保你已经创建了一个 Spring Boot 项目，并在 pom.xml 中添加了 MongoDB 的依赖：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-mongodb</artifactId>
</dependency>

1.2 数据库配置

在 src/main/resources/application.properties 中，配置 MongoDB 的连接信息：

spring.data.mongodb.uri=mongodb://localhost:27017/testdb

2. MongoTemplate 的基本用法

2.1 创建 MongoTemplate Bean

在 Spring Boot 中，MongoTemplate 通常作为 Bean 注入使用。你可以在主应用类中或配置类中创建它：

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.mongodb.MongoDatabaseFactory;
import org.springframework.data.mongodb.core.MongoTemplate;

@Configuration
public class MongoConfig {
    @Bean
    public MongoTemplate mongoTemplate(MongoDatabaseFactory mongoDatabaseFactory) {
        return new MongoTemplate(mongoDatabaseFactory);
    }
}

2.2 实体类定义

接下来，定义一个实体类 User，用于存储用户信息：

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

@Document(collection = "users")
public class User {
    @Id
    private String id;
    private String name;
    private String email;

    // Getters and Setters
    public String getId() {
        return id;
    }
    public void setId(String id) {
        this.id = id;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public String getEmail() {
        return email;
    }
    public void setEmail(String email) {
        this.email = email;
    }
}

3. 基本操作示例

3.1 增加用户（Create）

使用 MongoTemplate 的 insert 方法插入用户信息：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.mongodb.core.MongoTemplate;
import org.springframework.stereotype.Service;

@Service
public class UserService {
    @Autowired
    private MongoTemplate mongoTemplate;

    public User addUser(User user) {
        return mongoTemplate.insert(user);
    }
}

3.2 查询用户（Read）

使用 find 方法查询用户信息：

import org.springframework.data.mongodb.core.query.Criteria;
import org.springframework.data.mongodb.core.query.Query;

public User getUserById(String id) {
    return mongoTemplate.findById(id, User.class);
}

public List<User> getAllUsers() {
    return mongoTemplate.findAll(User.class);
}

public User getUserByEmail(String email) {
    Query query = new Query();
    query.addCriteria(Criteria.where("email").is(email));
    return mongoTemplate.findOne(query, User.class);
}

3.3 更新用户（Update）

使用 save 方法更新用户信息：

public User updateUser(User user) {
    return mongoTemplate.save(user);
}

3.4 删除用户（Delete）

使用 remove 方法删除用户信息：

public void deleteUser(String id) {
    Query query = new Query();
    query.addCriteria(Criteria.where("id").is(id));
    mongoTemplate.remove(query, User.class);
}

4. 完整示例

将上述代码整合到一个完整的服务类中：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.mongodb.core.MongoTemplate;
import org.springframework.data.mongodb.core.query.Criteria;
import org.springframework.data.mongodb.core.query.Query;
import org.springframework.stereotype.Service;

import java.util.List;

@Service
public class UserService {
    @Autowired
    private MongoTemplate mongoTemplate;

    public User addUser(User user) {
        return mongoTemplate.insert(user);
    }

    public User getUserById(String id) {
        return mongoTemplate.findById(id, User.class);
    }

    public List<User> getAllUsers() {
        return mongoTemplate.findAll(User.class);
    }

    public User getUserByEmail(String email) {
        Query query = new Query();
        query.addCriteria(Criteria.where("email").is(email));
        return mongoTemplate.findOne(query, User.class);
    }

    public User updateUser(User user) {
        return mongoTemplate.save(user);
    }

    public void deleteUser(String id) {
        Query query = new Query();
        query.addCriteria(Criteria.where("id").is(id));
        mongoTemplate.remove(query, User.class);
    }
}

5. 测试 API

可以通过构建 REST 控制器来测试以上服务。例如，创建一个 UserController：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;

import java.util.List;

@RestController
@RequestMapping("/api/users")
public class UserController {
    @Autowired
    private UserService userService;

    @PostMapping
    public ResponseEntity<User> createUser(@RequestBody User user) {
        return ResponseEntity.ok(userService.addUser(user));
    }

    @GetMapping("/{id}")
    public ResponseEntity<User> getUser(@PathVariable String id) {
        return ResponseEntity.ok(userService.getUserById(id));
    }

    @GetMapping
    public ResponseEntity<List<User>> getAllUsers() {
        return ResponseEntity.ok(userService.getAllUsers());
    }

    @PutMapping
    public ResponseEntity<User> updateUser(@RequestBody User user) {
        return ResponseEntity.ok(userService.updateUser(user));
    }

    @DeleteMapping("/{id}")
    public ResponseEntity<Void> deleteUser(@PathVariable String id) {
        userService.deleteUser(id);
        return ResponseEntity.noContent().build();
    }
}

结论

通过本文的介绍，你已经掌握了使用 MongoTemplate 与 MongoDB 进行基本的增删改查操作。MongoTemplate 提供了一个灵活而强大的方式来操作 MongoDB 数据库，非常适合在 Spring 应用中使用。你可以根据自己的需求，进一步扩展和优化这些基础操作。希望这篇文章能对你有所帮助！