Spring系列之整合MongoDB的2種方法

程式設計師阿牛 發表於 2021-09-13
MongoDB Spring

MongoDB是最流行的NoSQL資料庫,SpringBoot是使用Spring的最佳實踐。今天帶大家講一講SpringBoot整合MongoDB的兩種方式,MongoDB的安裝自行去官網查詢,本地開發最方便的做法是使用Docker方式。

一、準備工作

1、工程生成

老規矩,使用https://start.spring.io/ 選擇我們要依賴的jar包,生成一個demo,然後匯入到Idea中
file

2、配置項

在application.properties檔案中,配置MongoDB的地址

spring.data.mongodb.database=springmongo
spring.data.mongodb.username=springmongo
spring.data.mongodb.password=springmongo
spring.data.mongodb.host=localhost
spring.data.mongodb.port=27017
# 以下方式也可以,可以根據喜好來配置
# spring.data.mongodb.uri=mongodb://springmongo:[email protected]:27017/springmongo

二、使用MongoTemplate

1、建立實體UserInfo

import lombok.Data;
import org.springframework.data.annotation.Id;
import org.springframework.data.mongodb.core.mapping.Document;
/**
 * @author 公-眾-號:程式設計師阿牛
 * @Id是Spring的註解,注意不要和Mybatis的搞混
 * @Document是MongoDB的註解
 */
@Data
@Document
public class UserInfo {
    @Id
    private String userId;
    private String userName;
    private Integer age;
    private String address;
}

@Document與@Entity類似,表明是一個實體,@Id表明是主鍵

其他的Spring data mongoDB註解還有:

@Document

把一個java類宣告為mongodb的文件,可以通過collection引數指定這個類對應的文件。@Document(collection="mongodb 對應 collection 名")

@Id

文件的唯一標識,在mongodb中為ObjectId,它是唯一的

@Indexed

宣告該欄位需要索引,建索引可以大大的提高查詢效率。

@CompoundIndex

複合索引的宣告,建複合索引可以有效地提高多欄位的查詢效率。

@Field

給對映儲存到 mongodb 的欄位取別名

@Dbref

標識引用其他文件,這個文件有可能在另外的資料庫中

@Version

標識改屬性作為版本控制

@Transient

預設情況下所有的私有欄位都對映到文件,該註解標識的欄位從儲存在資料庫中的欄位列中排除(即該欄位不儲存到 mongodb)

2、定義介面

/**
 * @author 公-眾-號:程式設計師阿牛
 */
public interface UserInfoDAO {

    public UserInfo save(UserInfo userInfo);

    public UserInfo getUser(String userId);
}

3、介面實現

/**
 * @author 公-眾-號:程式設計師阿牛
 */
@Repository
public class UserInfoDaoImpl implements UserInfoDAO {
    @Autowired
    private MongoTemplate mongoTemplate;

    @Override
    public UserInfo save(UserInfo userInfo) {
        return mongoTemplate.save(userInfo);
    }

    @Override
    public UserInfo getUser(String userId) {
        UserInfo userInfo = mongoTemplate.findOne(Query.query(Criteria.where("userId").is(userId)),UserInfo.class);
        return userInfo;
    }
}

4、定義呼叫controller

/**
 * @author 公-眾-號:程式設計師阿牛
 */
@RestController
public class UserInfoController {
    @Autowired
    private UserInfoDAO userInfoDAO;
    @RequestMapping("/getUser/{userId}")
    public UserInfo getUserInfo(@PathVariable("userId")String userId){
        return userInfoDAO.getUser(userId);
    }

    @PostMapping("/addUser")
    public UserInfo addUserInfo(@RequestBody UserInfo userInfo){
        return userInfoDAO.save(userInfo);
    }

}

5、結果

使用idea自帶的httpclient測試一下
file

測試結果如下:
file

三、使用MongoRepository

1、定義介面

/**
 * @author 公-眾-號:程式設計師阿牛
 * 這裡使用的spring-data抽象的Repository介面,有興趣的可以自己去研究一下    
 */
@Repository
public interface UserInfoRepository extends MongoRepository<UserInfo, String> {
}

通過繼承介面,spring data會自動實現基本的crud方法,同時,還支援通過方法的形式擴充套件自己想要的方法,例如通過以下關鍵詞擴充套件(圖片在網上找的):

自定義查詢方法,格式為“find/get/readBy+欄位名+方法字尾”,方法傳進的引數即欄位的值。

支援的部分常用方法字尾有:
file
file

2、定義呼叫的controller

/**
 * @author 公-眾-號:程式設計師阿牛
 */
@RestController
public class UserInfo2Controller {
    @Autowired
    private UserInfoRepository userInfoRepository;
    @RequestMapping("/getUser2/{userId}")
    public Optional<UserInfo> getUserInfo(@PathVariable("userId")String userId){
        return userInfoRepository.findById(userId);
    }

    @PostMapping("/addUser2")
    public UserInfo addUserInfo(@RequestBody UserInfo userInfo){
        return userInfoRepository.save(userInfo);
    }

}

3、結果

使用idea自帶的httpclient測試一下
file
測試結果如下:
file

小結

本文基於的SpringBoot版本是2.5.4,兩種方式都可以實現與Spring的整合,具體使用哪一種根據實際的需要即可
關注我,下一篇繼續
file