mongodb_基础到进阶 – MongoDB 快速上手(四)
一、MongoDB :文章评论 需求&表结构&技术选型
1、文章评论:需求分析
1)参考某头条的文章评论业务,文章示例参考:早晨空腹喝水,是对还是错?
https://www.toutiao.com/article/6721476546088927748/
2)需要实现以下功能:
- 1)基本增删改查API
- 2)根据文章 id 查询评论
- 3)评论点赞
2、表结构分析
专栏文章评论 | comment | ||
---|---|---|---|
字段名称 | 字段含义 | 字段类型 | 备注 |
_id | ID | ObjectId或String | Mongo的主键的字段 |
articleid | 文章ID | String | |
content | 评论内容 | String | |
userid | 评论人ID | String | |
nickname | 评论人昵称 | String | |
createdatetime | 评论的日期时间 | Date | |
likenum | 点赞数 | Int32 | |
replynum | 回复数 | Int32 | |
state | 状态 | String | 0:不可见;1:可见; |
parentid | 上级ID | String | 如果为0表示文章的顶级评论 |
3、技术选型: mongodb-driver
1)mongodb-driver 是 mongo 官方推出的 java 连接 mongoDB 的驱动包,相当于 JDBC 驱动。我们通过一个入门的案例来了解 mongodb-driver 的基本使用。
2)官方驱动说明和下载: http://mongodb.github.io/mongo-java-driver/
3)官方驱动示例文档:http://mongodb.github.io/mongo-java-driver/3.8/driver/getting-started/quick-start/
4、技术选型: SpringDataMongoDB
1)SpringData 家族成员之一,用于操作 MongoDB 的持久层框架,封装了底层的 mongodb-driver。
2)官网主页: https://projects.spring.io/spring-data-mongodb/
二、MongoDB :文章微服务模块搭建
1、打开 idea,创建 article-mongodb 的 maven 工程。
--> idea --> File
--> New --> Project
--> Maven
Project SDK: ( 1.8(java version "1.8.0_131" )
--> Next
--> Groupld : ( djh.it )
Artifactld : ( article-mongodb )
Version : 1.0-SNAPSHOT
--> Name: ( article-mongodb )
Location: ( ...\article-mongodb\ )
--> Finish
2、在工程 article-mongodb (模块)中的 pom.xml 中导入依赖
<?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>djh.it</groupId>
<artifactId>article-mongodb</artifactId>
<version>1.0-SNAPSHOT</version>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.1.6.RELEASE</version>
<relativePath></relativePath>
</parent>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-mongodb</artifactId>
</dependency>
</dependencies>
</project>
<!-- article-mongodb\pom.xml -->
3、在工程 article-mongodb (模块)中,创建配置文件 application.yml
# article-mongodb\src\main\resources\application.yml
spring:
# 数据源配置
data:
mongodb:
# 主机地址
host: 172.18.30.110
# 数据库
database: articledb
# 默认端口27017
port: 27017
# 也可以使用uri连接
# uri mongodb //172.18.30.110:27017/articledb
4、在工程 article-mongodb (模块)中,创建启动类 ArticleApplication.java
/**
* article-mongodb\src\main\java\djh\it\article\ArticleApplication.java
*
* 2024-7-28 创建启动类 ArticleApplication.java
*/
package djh.it.article;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class ArticleApplication {
public static void main( String[] args ) {
SpringApplication.run(ArticleApplication.class, args);
}
}
三、MongoDB :文章评论实体类的编写
1、在工程 article-mongodb (模块)中,创建 文章评论实体类 Comment.java
/**
* article-mongodb\src\main\java\djh\it\article\pojo\Comment.java
*
* 2024-7-28 创建 文章评论实体类 Comment.java
*/
package djh.it.article.pojo;
import org.springframework.data.annotation.Id;
import org.springframework.data.mongodb.core.index.CompoundIndex;
import org.springframework.data.mongodb.core.index.Indexed;
import org.springframework.data.mongodb.core.mapping.Document;
import org.springframework.data.mongodb.core.mapping.Field;
import java.io.Serializable;
import java.time.LocalDateTime;
import java.util.Date;
//把一个java类声明为mongodb的文档,可以通过collection参数指定这个类对应的文档。
//@Document(collection="mongodb 对应 collection 名")
// 若未加 @Document ,该 bean save 到 mongo 的 comment collection
// 若添加 @Document ,则 save 到 comment collection
@Document(collection="comment")//可以省略,如果省略,则默认使用类名小写映射集合
//复合索引
@CompoundIndex( def = "{'userid': 1, 'nickname': -1}")
public class Comment implements Serializable {
//主键标识,该属性的值会自动对应mongodb的主键字段"_id",如果该属性名就叫“id”,则该注解可以省略,否则必须写
// @Id
private String id;//主键
//该属性对应mongodb的字段的名字,如果一致,则无需该注解
@Field("content")
private String content;//吐槽内容
private Date publishtime;//发布日期
//添加了一个单字段的索引
@Indexed
private String userid;//发布人ID
private String nickname;//昵称
private LocalDateTime createdatetime;//评论的日期时间
private Integer likenum;//点赞数
private Integer replynum;//回复数
private String state;//状态
private String parentid;//上级ID
private String articleid;
//getter and setter.....
public String getId() {
return id;
}
public void setId(String id) {
this.id = id;
}
public String getContent() {
return content;
}
public void setContent(String content) {
this.content = content;
}
public Date getPublishtime() {
return publishtime;
}
public void setPublishtime(Date publishtime) {
this.publishtime = publishtime;
}
public String getUserid() {
return userid;
}
public void setUserid(String userid) {
this.userid = userid;
}
public String getNickname() {
return nickname;
}
public void setNickname(String nickname) {
this.nickname = nickname;
}
public LocalDateTime getCreatedatetime() {
return createdatetime;
}
public void setCreatedatetime(LocalDateTime createdatetime) {
this.createdatetime = createdatetime;
}
public Integer getLikenum() {
return likenum;
}
public void setLikenum(Integer likenum) {
this.likenum = likenum;
}
public Integer getReplynum() {
return replynum;
}
public void setReplynum(Integer replynum) {
this.replynum = replynum;
}
public String getState() {
return state;
}
public void setState(String state) {
this.state = state;
}
public String getParentid() {
return parentid;
}
public void setParentid(String parentid) {
this.parentid = parentid;
}
public String getArticleid() {
return articleid;
}
public void setArticleid(String articleid) {
this.articleid = articleid;
}
@Override
public String toString() {
return "Comment{" +
"id='" + id + '\'' +
", content='" + content + '\'' +
", publishtime=" + publishtime +
", userid='" + userid + '\'' +
", nickname='" + nickname + '\'' +
", createdatetime=" + createdatetime +
", likenum=" + likenum +
", replynum=" + replynum +
", state='" + state + '\'' +
", parentid='" + parentid + '\'' +
", articleid='" + articleid + '\'' +
'}';
}
}
2、说明:
索引可以大大提升查询效率,一般在查询字段上添加索引,索引的添加可以通过Mongo的命令来添加,也可以在Java的实体类中通过注解添加。
1)单字段索引注解@Indexed
org.springframework.data.mongodb.core.index.Indexed.class 声明该字段需要索引,建索引可以大大的提高查询效率。
Mongo命令参考:
db.comment.createIndex({"userid":1})
2 )复合索引注解 @CompoundIndex
org.springframework.data.mongodb.core.index.CompoundIndex.class
复合索引的声明,建复合索引可以有效地提高多字段的查询效率。
Mongo命令参考:
db.comment.createIndex({"userid":1,"nickname":-1})
四、MongoDB :文章评论的基本增删改查
1、在工程 article-mongodb (模块)中,创建 dao 接口类 CommentRepository.java
/**
* article-mongodb\src\main\java\djh\it\article\dao\CommentRepository.java
*
* 2024-7-28 创建 dao 接口类 CommentRepository.java
*/
package djh.it.article.dao;
import djh.it.article.pojo.Comment;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.mongodb.repository.MongoRepository;
public interface CommentRepository extends MongoRepository<Comment,String > {
Page<Comment> findByParentid(String parentid,Pageable pageable);
}
2、在工程 article-mongodb (模块)中,创建 service 类 CommentService.java
/**
* article-mongodb\src\main\java\djh\it\article\service\CommentService.java
*
* 2024-7-28 创建 service 类 CommentService.java
*/
package djh.it.article.service;
import djh.it.article.dao.CommentRepository;
import djh.it.article.pojo.Comment;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.PageRequest;
import org.springframework.data.domain.Pageable;
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.data.mongodb.core.query.Update;
import org.springframework.stereotype.Service;
import java.util.List;
@Service
public class CommentService {
@Autowired
private CommentRepository commentRepository;
@Autowired
private MongoTemplate mongoTemplate;
/**
* 保存一个评论
* @param comment
*/
public void saveComment( Comment comment){
//如果需要自定义主键,可以在这里指定主键;如果不指定主键,MongoDB会自动生成主键
//设置一些默认初始值。。。
//调用dao
commentRepository.save(comment);
}
/**
* 更新评论
* @param comment
*/
public void updateComment(Comment comment){
//调用dao
commentRepository.save(comment);
}
/**
* 根据id删除评论
* @param id
*/
public void deleteCommentById(String id){
//调用dao
commentRepository.deleteById(id);
}
/**
* 查询所有评论
* @return
*/
public List<Comment> findCommentList(){
//调用dao
return commentRepository.findAll();
}
/**
* 根据id查询评论
* @param id
* @return
*/
public Comment findCommentById(String id){
//调用dao
return commentRepository.findById(id).get();
}
public Page<Comment> findCommentListByParentid(String parentid,int page,int size) {
return commentRepository.findByParentid(parentid,PageRequest.of(page-1,size));
}
public void updateCommentLikenum(String id){
// 查询条件
Query query = Query.query(Criteria.where("_id").is(id));
// 更新条件
Update update = new Update();
update.inc("likenum");
mongoTemplate.updateFirst(query,update,Comment.class);
}
}
3、在工程 article-mongodb (模块)中,创建测试类 CommentServiceTest.java
/**
* article-mongodb\src\test\java\djh\it\article\service\CommentServiceTest.java
*
* 2024-7-28 创建测试类 CommentServiceTest.java
*/
package djh.it.article.service;
import djh.it.article.pojo.Comment;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.data.domain.Page;
import org.springframework.test.context.junit4.SpringRunner;
import java.time.LocalDateTime;
import java.util.List;
@RunWith(SpringRunner.class)
@SpringBootTest
public class CommentServiceTest {
@Autowired
private CommentService commentService;
@Test
public void testFindCommentList() {
List<Comment> commentList = commentService.findCommentList();
System.out.println(commentList);
}
@Test
public void testFindCommentById() {
Comment commentById = commentService.findCommentById("1");
System.out.println(commentById);
}
@Test
public void testSaveComment(){
Comment comment=new Comment();
comment.setArticleid("100000");
comment.setContent("测试添加的数据");
comment.setCreatedatetime(LocalDateTime.now());
comment.setUserid("1003");
comment.setNickname("凯撒大帝");
comment.setState("1");
comment.setLikenum(0);
comment.setReplynum(0);
commentService.saveComment(comment);
}
@Test
public void testFindCommentListByParentid() {
Page<Comment> page = commentService.findCommentListByParentid("3", 1, 2);
System.out.println(page.getTotalElements());
System.out.println(page.getContent());
}
@Test
public void testUpdateCommentLikenum() {
commentService.updateCommentLikenum("1");
}
}
4、运行测试类,进行增删改查 测试。
五、MongoDB :根据上级ID查询文章评论的分页列表
1、在工程 article-mongodb (模块)中,CommentRepository.java 新增方法定义
/**
* article-mongodb\src\main\java\djh\it\article\dao\CommentRepository.java
*
* 2024-7-28 创建 dao 接口类 CommentRepository.java
*/
package djh.it.article.dao;
import djh.it.article.pojo.Comment;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.mongodb.repository.MongoRepository;
public interface CommentRepository extends MongoRepository<Comment,String > {
//根据父id,查询子评论的分页列表, 方法名固定,不能随便更改。否则会报错
Page<Comment> findByParentid(String parentid,Pageable pageable);
}
2、在工程 article-mongodb (模块)中,CommentService.java 新增方法
/**
* article-mongodb\src\main\java\djh\it\article\service\CommentService.java
*
* 2024-7-28 创建 service 类 CommentService.java
*/
package djh.it.article.service;
import djh.it.article.dao.CommentRepository;
import djh.it.article.pojo.Comment;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.PageRequest;
import org.springframework.data.domain.Pageable;
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.data.mongodb.core.query.Update;
import org.springframework.stereotype.Service;
import java.util.List;
@Service
public class CommentService {
@Autowired
private CommentRepository commentRepository;
@Autowired
private MongoTemplate mongoTemplate;
/**
* 保存一个评论
* @param comment
*/
public void saveComment( Comment comment){
//如果需要自定义主键,可以在这里指定主键;如果不指定主键,MongoDB会自动生成主键
//设置一些默认初始值。。。
//调用dao
commentRepository.save(comment);
}
/**
* 更新评论
* @param comment
*/
public void updateComment(Comment comment){
//调用dao
commentRepository.save(comment);
}
/**
* 根据id删除评论
* @param id
*/
public void deleteCommentById(String id){
//调用dao
commentRepository.deleteById(id);
}
/**
* 查询所有评论
* @return
*/
public List<Comment> findCommentList(){
//调用dao
return commentRepository.findAll();
}
/**
* 根据id查询评论
* @param id
* @return
*/
public Comment findCommentById(String id){
//调用dao
return commentRepository.findById(id).get();
}
/**
* 根据父id查询分页列表,方法名固定,不能随便更改。否则会报错
* @param parentid
* @param page
* @param size
* @return
*/
public Page<Comment> findCommentListByParentid(String parentid,int page,int size) {
return commentRepository.findByParentid(parentid,PageRequest.of(page-1,size));
}
public void updateCommentLikenum(String id){
// 查询条件
Query query = Query.query(Criteria.where("_id").is(id));
// 更新条件
Update update = new Update();
update.inc("likenum");
mongoTemplate.updateFirst(query,update,Comment.class);
}
}
3、在工程 article-mongodb (模块)中,测试类 CommentServiceTest.java 新增方法。
/**
* article-mongodb\src\test\java\djh\it\article\service\CommentServiceTest.java
*
* 2024-7-28 创建测试类 CommentServiceTest.java
*/
package djh.it.article.service;
import djh.it.article.pojo.Comment;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.data.domain.Page;
import org.springframework.test.context.junit4.SpringRunner;
import java.time.LocalDateTime;
import java.util.List;
@RunWith(SpringRunner.class)
@SpringBootTest
public class CommentServiceTest {
@Autowired
private CommentService commentService;
@Test
public void testFindCommentList() {
List<Comment> commentList = commentService.findCommentList();
System.out.println(commentList);
}
@Test
public void testFindCommentById() {
Comment commentById = commentService.findCommentById("1");
System.out.println(commentById);
}
@Test
public void testSaveComment(){
Comment comment=new Comment();
comment.setArticleid("100000");
comment.setContent("测试添加的数据");
comment.setCreatedatetime(LocalDateTime.now());
comment.setUserid("1003");
comment.setNickname("凯撒大帝");
comment.setState("1");
comment.setLikenum(0);
comment.setReplynum(0);
commentService.saveComment(comment);
}
//测试根据父id查询子评论的分页列表
@Test
public void testFindCommentListByParentid() {
Page<Comment> page = commentService.findCommentListByParentid("3", 1, 2);
System.out.println("======总记录数: "+page.getTotalElements());
System.out.println("======当前页数据: "+page.getContent());
}
@Test
public void testUpdateCommentLikenum() {
commentService.updateCommentLikenum("1");
}
}
4、测试:使用 compass 快速插入一条测试数据,数据的内容是对3号评论内容进行评论。
执行测试,结果:
======总记录数: 1
======当前页数据: [Comment{id='33', content='你年轻,火力大', publishtime=null, userid='1003', nickname='张三丰', createdatetime=null, likenum=null, replynum=null, state='null', parentid='3', articleid='100001'}]
六、MongoDB :MongoTemplate 实现评论点赞
1、在工程 article-mongodb (模块)中,CommentService.java 新增方法
/**
* article-mongodb\src\main\java\djh\it\article\service\CommentService.java
*
* 2024-7-28 创建 service 类 CommentService.java
*/
package djh.it.article.service;
import djh.it.article.dao.CommentRepository;
import djh.it.article.pojo.Comment;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.PageRequest;
import org.springframework.data.domain.Pageable;
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.data.mongodb.core.query.Update;
import org.springframework.stereotype.Service;
import java.util.List;
@Service
public class CommentService {
@Autowired
private CommentRepository commentRepository;
//注入MongoTemplate
@Autowired
private MongoTemplate mongoTemplate;
/**
* 保存一个评论
* @param comment
*/
public void saveComment( Comment comment){
//如果需要自定义主键,可以在这里指定主键;如果不指定主键,MongoDB会自动生成主键
//设置一些默认初始值。。。
//调用dao
commentRepository.save(comment);
}
/**
* 更新评论
* @param comment
*/
public void updateComment(Comment comment){
//调用dao
commentRepository.save(comment);
}
/**
* 根据id删除评论
* @param id
*/
public void deleteCommentById(String id){
//调用dao
commentRepository.deleteById(id);
}
/**
* 查询所有评论
* @return
*/
public List<Comment> findCommentList(){
//调用dao
return commentRepository.findAll();
}
/**
* 根据id查询评论
* @param id
* @return
*/
public Comment findCommentById(String id){
//调用dao
return commentRepository.findById(id).get();
}
/**
* 根据父id查询分页列表,方法名固定,不能随便更改。否则会报错
* @param parentid
* @param page
* @param size
* @return
*/
public Page<Comment> findCommentListByParentid(String parentid,int page,int size) {
return commentRepository.findByParentid(parentid,PageRequest.of(page-1,size));
}
/**
* 点赞-此方法虽然实现起来比较简单,但是执行效率并不高,因为我只需要将点赞数加1就可以了,没必要查询出所有字段修改后再更新所有字
段。(蝴蝶效应),效率低
* @param id
*/
public void updateCommentThumbupToIncrementingOld(String id) {
Comment comment = commentRepository.findById(id).get();
comment.setLikenum(comment.getLikenum() + 1);
commentRepository.save(comment);
}
//MongoTemplate实现评论点赞, 点赞数+1,执行效率较高。
public void updateCommentLikenum(String id){
// 查询条件
Query query = Query.query(Criteria.where("_id").is(id));
// 更新条件
Update update = new Update();
// //局部更新,相当于$set
// update.set(key,value)
// //递增$inc
// update.inc("likenum",1);
update.inc("likenum");
//参数1:查询对象
//参数2:更新对象
//参数3:集合的名字或实体类的类型Comment.class
mongoTemplate.updateFirst(query,update,Comment.class);
}
}
2、在工程 article-mongodb (模块)中,测试类 CommentServiceTest.java 新增方法。
/**
* article-mongodb\src\test\java\djh\it\article\service\CommentServiceTest.java
*
* 2024-7-28 创建测试类 CommentServiceTest.java
*/
package djh.it.article.service;
import djh.it.article.pojo.Comment;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.data.domain.Page;
import org.springframework.test.context.junit4.SpringRunner;
import java.time.LocalDateTime;
import java.util.List;
@RunWith(SpringRunner.class)
@SpringBootTest
public class CommentServiceTest {
@Autowired
private CommentService commentService;
@Test
public void testFindCommentList() {
List<Comment> commentList = commentService.findCommentList();
System.out.println(commentList);
}
@Test
public void testFindCommentById() {
Comment commentById = commentService.findCommentById("1");
System.out.println(commentById);
}
@Test
public void testSaveComment(){
Comment comment=new Comment();
comment.setArticleid("100000");
comment.setContent("测试添加的数据");
comment.setCreatedatetime(LocalDateTime.now());
comment.setUserid("1003");
comment.setNickname("凯撒大帝");
comment.setState("1");
comment.setLikenum(0);
comment.setReplynum(0);
commentService.saveComment(comment);
}
//测试根据父id查询子评论的分页列表
@Test
public void testFindCommentListByParentid() {
Page<Comment> page = commentService.findCommentListByParentid("3", 1, 2);
System.out.println("======总记录数: "+page.getTotalElements());
System.out.println("======当前页数据: "+page.getContent());
}
//点赞测试1:方法简单,执行效率低
@Test
public void testUpdateCommentThumbupToIncrementingOld(){
commentService.updateCommentThumbupToIncrementingOld("1");
}
//点赞测试2:方法稍复杂,执行效率高
@Test
public void testUpdateCommentLikenum() {
commentService.updateCommentLikenum("1");
}
}
3、执行测试用例后,发现点赞数+1了:
# 测试用例执行前:
{"_id":"1","content":"我们不应该把清晨浪费在手机上,健康很重要,一杯温水幸福你我他。","userid":"1000","nickname":"相忘于江湖","createdatetime":"2019-08-05T22:08:15.522Z","likenum":"1002","state":"1","articleid":"100001","_class":"djh.it.article.pojo.Comment"}
# 测试用例执行后(执行了2次):
{"_id":"1","content":"我们不应该把清晨浪费在手机上,健康很重要,一杯温水幸福你我他。","userid":"1002","nickname":"相忘于江湖","createdatetime":"2019-08-05T22:08:15.522Z","likenum":"1002","state":"1","articleid":"100001","_class":"djh.it.article.pojo.Comment"}
上一节关联文档请点击
# mongodb_基础到进阶 – MongoDB 快速上手(三)