以下是在 Spring Boot 项目中集成 MongoDB 的详细步骤,包含 yml
配置、实体定义、Repository 和示例代码。
1. 创建 Spring Boot 项目
使用 Spring Initializr(https://start.spring.io/)创建项目 ,IDEA创建(推荐),选择以下依赖:
- Spring Data MongoDB
- Spring Web(可选,用于创建 REST API)
2. 添加依赖(pom.xml
)
确保 pom.xml
中包含 MongoDB 依赖:
<dependencies>
<!-- Spring Data MongoDB -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-mongodb</artifactId>
</dependency>
<!-- Spring Web(可选) -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
</dependencies>
3. 配置 MongoDB 连接(application.yml
)
在 src/main/resources/application.yml
中添加以下配置(需要确保安装了MongDB数据库):
spring:
data:
mongodb:
# 本地 MongoDB(无密码)
uri: mongodb://localhost:27017/mydatabase
# 如果启用认证(用户名密码)
# uri: mongodb://username:password@localhost:27017/mydatabase?authSource=admin
4. 定义实体类
创建一个 Java 类表示 MongoDB 文档(对应集合中的一条记录):
package com.example.demo.model;
import org.springframework.data.annotation.Id;
import org.springframework.data.mongodb.core.mapping.Document;
@Document(collection = "users") // 指定集合名称(默认类名小写)
public class User {
@Id // MongoDB 文档的唯一标识
private String id;
private String name;
private int age;
private String email;
// 构造方法、Getter 和 Setter
public User() {}
public User(String name, int age, String email) {
this.name = name;
this.age = age;
this.email = email;
}
// 省略 Getter 和 Setter(需补充)
}
5. 创建 Repository 接口
定义数据访问层接口,继承 MongoRepository
(类似于Mybatisplus的Mapper层继承BaseMapper):
package com.example.demo.repository;
import com.example.demo.model.User;
import org.springframework.data.mongodb.repository.MongoRepository;
public interface UserRepository extends MongoRepository<User, String> {
// 自定义查询方法(按名称自动生成)
User findByName(String name);
List<User> findByAgeGreaterThan(int age);
}
6. 编写 Service 层
创建业务逻辑类:
package com.example.demo.service;
import com.example.demo.model.User;
import com.example.demo.repository.UserRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import java.util.List;
@Service
public class UserService {
@Autowired
private UserRepository userRepository;
public User createUser(User user) {
return userRepository.save(user);
}
public List<User> getAllUsers() {
return userRepository.findAll();
}
public User getUserByName(String name) {
return userRepository.findByName(name);
}
public List<User> getUsersByAgeGreaterThan(int age) {
return userRepository.findByAgeGreaterThan(age);
}
public void deleteUser(String id) {
userRepository.deleteById(id);
}
}
7. 创建 Controller(可选,用于 REST API)
package com.example.demo.controller;
import com.example.demo.model.User;
import com.example.demo.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
import java.util.List;
@RestController
@RequestMapping("/api/users")
public class UserController {
@Autowired
private UserService userService;
@PostMapping
public User createUser(@RequestBody User user) {
return userService.createUser(user);
}
@GetMapping
public List<User> getAllUsers() {
return userService.getAllUsers();
}
@GetMapping("/{name}")
public User getUserByName(@PathVariable String name) {
return userService.getUserByName(name);
}
@DeleteMapping("/{id}")
public void deleteUser(@PathVariable String id) {
userService.deleteUser(id);
}
}
8. 测试 MongoDB 连接
本地 MongoDB 启动
确保 MongoDB 服务已启动:
# 启动 MongoDB(默认端口 27017)
mongod --dbpath=/data/db
通过接口测试
使用 Postman 或 curl 测试 REST API:
- 创建用户:
curl -X POST -H "Content-Type: application/json" -d '{"name":"Alice","age":25,"email":"alice@example.com"}' http://localhost:8080/api/users
- 查询所有用户:
curl http://localhost:8080/api/users
9. 高级配置
自定义 MongoDB 配置类(可选)
如果需要更复杂的配置(如连接池参数),可以添加配置类:
@Configuration
public class MongoConfig extends AbstractMongoClientConfiguration {
@Value("${spring.data.mongodb.uri}")
private String uri;
@Override
protected String getDatabaseName() {
return new MongoClientURI(uri).getDatabase();
}
@Override
public MongoClient mongoClient() {
return MongoClients.create(uri);
}
}
10. 常见问题
-
连接失败
- 检查 MongoDB 服务是否运行。
- 确认
application.yml
中的uri
格式正确。
-
认证失败
- 确保用户名密码正确,且用户有对应数据库的权限。
-
实体映射问题
- 使用
@Field
注解指定字段名映射:@Field("email_address") private String email;
- 使用
通过以上步骤,即可在 Spring Boot 项目中集成 MongoDB 并实现基本的 CRUD 操作!如果需要更复杂的查询,可以参考 Spring Data MongoDB 的 @Query
注解或聚合管道(Aggregation Pipeline)。