Spring Boot MongoDB

194 篇文章 3 订阅
15 篇文章 0 订阅

 

Spring Boot MongoDB

 

欢迎使用Spring Boot MongoDB示例。Spring Boot是快速启动spring项目的最简单方法,而MongoDB是最受欢迎的NoSQL数据库。让我们看看如何将spring与MongoDB数据库集成。

目录[ 隐藏 ]

Spring Boot MongoDB

我们需要以下API来使用Spring Boot和MongoDB数据库。

  • Spring Data MongoDB
  • 春季启动

有两种方法可以连接到MongoDB数据库 - MongoRepositoryMongoTemplate。我们将尝试确定一个API提供的内容,以及何时应该为您的用例选择其中任何一个。我们将使用Spring Initializr工具快速设置项目。那么,让我们开始吧。

Spring Boot MongoDB项目安装程序

我们将使用Spring Initializr工具快速设置项目。我们将只使用两个依赖项,如下所示:
使用spring initializr的spring boot mongodb项目设置

下载项目并解压缩。然后将其导入您最喜欢的IDE - Eclipse或IntelliJ IDEA。

 

Maven依赖

虽然我们已经使用该工具完成了设置,但如果您想手动设置它,我们将为此项目使用Maven构建系统,这里是我们使用的依赖项:


<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>

	<groupId>com.journaldev.spring</groupId>
	<artifactId>spring-boot-mongodb</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<packaging>jar</packaging>

	<name>spring-boot-mongodb</name>
	<description>Spring Boot MongoDB Example</description>

	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>1.5.9.RELEASE</version>
		<relativePath /> <!-- lookup parent from repository -->
	</parent>

	<properties>
		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
		<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
		<java.version>1.8</java.version>
	</properties>

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

		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-test</artifactId>
			<scope>test</scope>
		</dependency>
	</dependencies>

	<build>
		<plugins>
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
			</plugin>
		</plugins>
	</build>
</project>

确保从maven中心使用Spring Boot的稳定版本。

 

Spring Boot MongoDB模型类

我们有一个简单的模型类User.java


package com.journaldev.bootifulmongodb.model;

import java.util.Date;
import java.util.HashMap;
import java.util.Map;

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

@Document
public class User {

	@Id
	private String userId;
	private String name;
	private Date creationDate = new Date();
	private Map<String, String> userSettings = new HashMap<>();

	public String getUserId() {
		return userId;
	}

	public void setUserId(String userId) {
		this.userId = userId;
	}

	public String getName() {
		return name;
	}

	public void setName(String name) {
		this.name = name;
	}

	public Date getCreationDate() {
		return creationDate;
	}

	public void setCreationDate(Date creationDate) {
		this.creationDate = creationDate;
	}

	public Map<String, String> getUserSettings() {
		return userSettings;
	}

	public void setUserSettings(Map<String, String> userSettings) {
		this.userSettings = userSettings;
	}
}

Spring Boot MongoDB API

我们将在我们的应用程序中具有以下功能和数据库交互。

  • 获取所有用户
  • 获取具有ID的用户
  • 获取用户设置
  • 从地图中获取特定密钥
  • 添加/更新用户设置

 

Spring Data MongoDB - MongoRepository

现在我们将使用Spring Data MongoDB存储库来访问我们的数据。Spring Data MongoRepository为我们提供了可以轻松插入和使用它的常用功能。

让我们定义我们的Repository接口。


package com.journaldev.bootifulmongodb.dal;

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

import com.journaldev.bootifulmongodb.model.User;

@Repository
public interface UserRepository extends MongoRepository<User, String> {
}

定义MongoDB属性

在我们布置控制器之前,重要的是我们与MongoDB的本地实例建立连接。我们将使用Spring Boot属性来执行此操作。


#Local MongoDB config
spring.data.mongodb.authentication-database=admin
spring.data.mongodb.username=root
spring.data.mongodb.password=root
spring.data.mongodb.database=user_db
spring.data.mongodb.port=27017
spring.data.mongodb.host=localhost

# App config
server.port=8102
spring.application.name=BootMongo
server.context-path=/user

因此,应用程序将在端口8102上运行,并使用提供的凭据连接到本地mongoDB实例。如果您在未启用授权的情况下拥有本地实例,则只需删除前三行配置即可。

定义Spring Controller

让我们最后转到制作我们的Controller类。


package com.journaldev.bootifulmongodb.controller;

import java.util.List;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;

import com.journaldev.bootifulmongodb.dal.UserRepository;
import com.journaldev.bootifulmongodb.model.User;

@RestController
@RequestMapping(value = "/")
public class UserController {

	private final Logger LOG = LoggerFactory.getLogger(getClass());

	private final UserRepository userRepository;

	public UserController(UserRepository userRepository) {
		this.userRepository = userRepository;
	}
}

我们只是自动化了存储库接口依赖关系,接下来我们将使用它。

定义API

对于我们提到的功能,我们现在将制作API并访问userRepository依赖项,该依赖项将在内部使用Spring Data MongoRepository API。请注意,我们不必在接口中编写任何数据库交互代码,因为Spring Data会为我们完成所有操作。

获得所有用户


@RequestMapping(value = "", method = RequestMethod.GET)
public List<User> getAllUsers() {
	LOG.info("Getting all users.");
	return userRepository.findAll();
}

findAll() 只是Spring Data MongoRepository内部提供的方法。

按ID获取用户

现在,让我们来获取具有ID的特定用户。


@RequestMapping(value = "/{userId}", method = RequestMethod.GET)
public User getUser(@PathVariable String userId) {
	LOG.info("Getting user with ID: {}.", userId);
	return userRepository.findOne(userId);
}

findOne() 只是一个Spring Data MongoRepository内部提供的方法,用于通过ID获取Object。

添加新用户

我们将在下面的函数中添加一个新用户。


@RequestMapping(value = "/create", method = RequestMethod.POST)
public User addNewUsers(@RequestBody User user) {
	LOG.info("Saving user.");
	return userRepository.save(user);
}

获取用户设置

现在我们已经将示例数据添加到数据库中,让我们尝试提取它的一部分。


@RequestMapping(value = "/settings/{userId}", method = RequestMethod.GET)
public Object getAllUserSettings(@PathVariable String userId) {
	User user = userRepository.findOne(userId);
	if (user != null) {
		return user.getUserSettings();
	} else {
		return "User not found.";
	}
}

获取特定的用户设置


@RequestMapping(value = "/settings/{userId}/{key}", method = RequestMethod.GET)
public String getUserSetting(@PathVariable String userId, @PathVariable String key) {
	User user = userRepository.findOne(userId);
	if (user != null) {
		return user.getUserSettings().get(key);
	} else {
		return "User not found.";
	}
}

请注意,在上面的查询中,我们获取了用户对象,然后提取了完整的Setting map(可能包含1000个对象),最后得到了我们自己的值。当我们将它用作直接API时,这是Spring Data查询的缺点。

添加新的用户设置

让我们尝试将一些数据添加到现有用户:


@RequestMapping(value = "/settings/{userId}/{key}/{value}", method = RequestMethod.GET)
public String addUserSetting(@PathVariable String userId, @PathVariable String key, @PathVariable String value) {
	User user = userRepository.findOne(userId);
	if (user != null) {
		user.getUserSettings().put(key, value);
		userRepository.save(user);
		return "Key added";
	} else {
		return "User not found.";
	}
}

使用我们编写的所有代码,很明显除了定义存储库接口和自动装配依赖项之外,我们不必编写一行代码来访问数据库。

 

这是Spring Data MongoRepositoryAPI为我们提供的便利,但它也有一些缺点。我们在定义MongoTemplate版本时也会详细说明。让我们开始吧。

 

Spring Data MongoDB - MongoTemplate

我们将在这里定义MongoTemplate数据库查询。使用MongoTemplate,您将看到我们对查询内容以及结果中包含的数据进行了更精细的控制。

定义DAL接口

为了在数据库访问层提供契约,我们将首先定义一个与Spring Data内置方法一样的接口。


package com.journaldev.bootifulmongodb.dal;

import java.util.List;

import com.journaldev.bootifulmongodb.model.User;

public interface UserDAL {

	List<User> getAllUsers();

	User getUserById(String userId);

	User addNewUser(User user);

	Object getAllUserSettings(String userId);

	String getUserSetting(String userId, String key);

	String addUserSetting(String userId, String key, String value);
}

实现DAL接口

让我们继续并定义这些方法。


package com.journaldev.bootifulmongodb.dal;

import java.util.List;

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.Repository;

import com.journaldev.bootifulmongodb.model.User;

@Repository
public class UserDALImpl implements UserDAL {

	@Autowired
	private MongoTemplate mongoTemplate;

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

	@Override
	public User getUserById(String userId) {
		Query query = new Query();
		query.addCriteria(Criteria.where("userId").is(userId));
		return mongoTemplate.findOne(query, User.class);
	}

	@Override
	public User addNewUser(User user) {
		mongoTemplate.save(user);
		// Now, user object will contain the ID as well
		return user;
	}

	@Override
	public Object getAllUserSettings(String userId) {
		Query query = new Query();
		query.addCriteria(Criteria.where("userId").is(userId));
		User user = mongoTemplate.findOne(query, User.class);
		return user != null ? user.getUserSettings() : "User not found.";
	}

	@Override
	public String getUserSetting(String userId, String key) {
		Query query = new Query();
		query.fields().include("userSettings");
		query.addCriteria(Criteria.where("userId").is(userId).andOperator(Criteria.where("userSettings." + key).exists(true)));
		User user = mongoTemplate.findOne(query, User.class);
		return user != null ? user.getUserSettings().get(key) : "Not found.";
	}

	@Override
	public String addUserSetting(String userId, String key, String value) {
		Query query = new Query();
		query.addCriteria(Criteria.where("userId").is(userId));
		User user = mongoTemplate.findOne(query, User.class);
		if (user != null) {
			user.getUserSettings().put(key, value);
			mongoTemplate.save(user);
			return "Key added.";
		} else {
			return "User not found.";
		}
	}
}

上面的类中的方法实现使用MongoTemplate依赖项。

了解getUserById(...)方法如何获取用户。我们构造一个查询并传递必需的参数。

您更感兴趣的是getUserSetting查询。让我们了解上面发生的事情:

  • 我们使用标准构建查询以检查相等性。
  • include方法包括从DB中提取结果时应包含的字段名称。这意味着,在这种情况下,将提取userSettings键,这将节省大量要获取的数据,这是不需要的
  • 此外,我们查询了用户和地图密钥。如果找不到任何一个,我们返回空数据意味着找不到所需的密钥。如果不存在所需的密钥,则甚至可以完全取出用户对象

 

Spring Data MongoDB测试运行

我们只需使用一个命令即可运行此应用程序:


mvn spring-boot:run

应用程序运行后,我们可以尝试使用此API保存新用户:


http://localhost:8102/user/create

由于这将是一个POST请求,我们也将发送JSON数据:


{
  "name" : "Shubham",
  "userSettings" : {
    "bike" : "pulsar"
  }
}

当我们返回Mongo响应本身时,我们会得到类似的结果:

{
  "userId": "5a5f28cc3178058b0fafe1dd",
  "name": "Shubham",
  "creationDate": 1516165830856,
  "userSettings": {
    "bike" : "pulsar"
  }
}

Spring Data MongoDB MongoRepository示例创建

您可以使用API​​作为GET请求来获取所有用户:


http://localhost:8102/user/

我们会得到类似的东西:

[
  {
    "userId": "5a5f28cc3178058b0fafe1dd",
    "name": "Shubham",
    "creationDate": 1516165830856,
    "userSettings": {
      "bike" : "pulsar"
    }
  }
]

Spring Data MongoDB

如果您看到上面的UserController类,我们还没有连接使用MongoTemplate。下面的代码片段显示了使用MongoTemplate读取用户设置所需的更改。


//define Data Access Layer object
private final UserDAL userDAL;

//initialize DAL object via constructor autowiring
public UserController(UserRepository userRepository, UserDAL userDAL) {
	this.userRepository = userRepository;
	this.userDAL = userDAL;
}

//change method implementation to use DAL and hence MongoTemplate
@RequestMapping(value = "/settings/{userId}", method = RequestMethod.GET)
public Object getAllUserSettings(@PathVariable String userId) {
    User user = userRepository.findOne(userId);
    if (user != null) {
        return userDAL.getAllUserSettings(userId);
    } else {
        return "User not found.";
    }
}

//change method implementation to use DAL and hence MongoTemplate
@RequestMapping(value = "/settings/{userId}/{key}", method = RequestMethod.GET)
public String getUserSetting(
        @PathVariable String userId, @PathVariable String key) {
    return userDAL.getUserSetting(userId, key);
}

重新启动应用程序并运行方案以获取所有用户设置并获取任何特定密钥。下图显示了Postman应用程序的输出。

Spring Data MongoDB MongoTemplate示例

 

MongoTemplate与MongoRepository

 

  • MongoTemplate在查询数据和从数据库中提取的数据方面提供了更多控制。
  • Spring Data存储库为我们提供了如何获取数据的便捷视图。
  • MongoTemplate依赖于数据库。这意味着,使用Spring Data存储库,您可以通过简单地使用MySQL或Neo4J或其他任何东西的不同Spring Data存储库轻松切换到不同的数据库。MongoTemplate无法做到这一点。

Spring Boot MongoDB摘要

在本课程中,我们研究了MongoTemplate如何为Spring Data存储库提供更多控制,但在涉及更深入的查询时也会有点复杂。因此,这完全是您在开发想法时选择的内容。请随时留下评论。

从下面的链接下载源代码。请确保在运行提供的应用程序之前更改MongoDB凭据。

下载Spring Boot MongoDB示例项目

 

转载来源:https://www.journaldev.com/18156/spring-boot-mongodb

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值